Plan Apply Log (#1487)

* Plan and Apply Log Download Button

This buttons to a run in the Run View that has a plan or an apply to view the raw plan or apply log inside the editor.

* Fix button label typo

* Mark execution-details as nullable

* Improve run list error message

* Add run status to hover

* Round relative year values

* Inline stripAnsi

The strip-ansi package is only available as ESM

* Don't open project filter without login

---------

Co-authored-by: Daniel Banck <[email protected]>

Author: jpogran

package-lock.json

@@ -486,6 +486,16 @@
         "title": "View Run",
         "icon": "$(globe)"
       },
+      {
+        "command": "terraform.cloud.run.plan.downloadLog",
+        "title": "View Raw Plan Log",
+        "icon": "$(book)"
+      },
+      {
+        "command": "terraform.cloud.run.apply.downloadLog",
+        "title": "View Raw Apply Log",
+        "icon": "$(output)"
+      },
       {
         "command": "terraform.cloud.workspaces.filterByProject",
         "title": "Filter by Project",
@@ -541,6 +551,14 @@
         {
           "command": "terraform.cloud.run.viewInBrowser",
           "when": "false"
+        },
+        {
+          "command": "terraform.cloud.run.plan.downloadLog",
+          "when": "false"
+        },
+        {
+          "command": "terraform.cloud.run.apply.downloadLog",
+          "when": "false"
         }
       ],
       "view/title": [
@@ -593,6 +611,16 @@
           "command": "terraform.cloud.run.viewInBrowser",
           "when": "view == terraform.cloud.runs && viewItem != empty",
           "group": "inline"
+        },
+        {
+          "command": "terraform.cloud.run.plan.downloadLog",
+          "when": "view == terraform.cloud.runs && viewItem =~ /hasPlan/",
+          "group": "inline"
+        },
+        {
+          "command": "terraform.cloud.run.apply.downloadLog",
+          "when": "view == terraform.cloud.runs && viewItem =~ /hasApply/",
+          "group": "inline"
         }
       ]
     },
@@ -650,7 +678,7 @@
       },
       {
         "view": "terraform.cloud.workspaces",
-        "contents": "No organizations found for this token. Please create a new Terraform Cloud organization to get started:\n[Create or select a organization](command:terraform.cloud.organization.picker)",
+        "contents": "No organizations found for this token. Please create a new Terraform Cloud organization to get started:\n[Create or select an organization](command:terraform.cloud.organization.picker)",
         "when": "terraform.cloud.signed-in && !terraform.cloud.organizationsExist && !terraform.cloud.organizationsChosen"
       },
       {
@@ -710,7 +738,7 @@
     "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.1",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^16.11.7",
+    "@types/node": "^16.18.36",
     "@types/vscode": "~1.75.1",
     "@types/webpack-env": "^1.18.0",
     "@types/which": "^3.0.0",

package.json

@@ -16,6 +16,7 @@ import {
 } from '../providers/tfc/organizationPicker';
 import { APIQuickPick } from '../providers/tfc/uiHelpers';
 import { TerraformCloudWebUrl } from '../terraformCloud';
+import { PlanLogContentProvider } from '../providers/tfc/contentProvider';
 
 export class TerraformCloudFeature implements vscode.Disposable {
   private statusBar: OrganizationStatusBar;
@@ -31,6 +32,9 @@ export class TerraformCloudFeature implements vscode.Disposable {
       this.reporter,
       outputChannel,
     );
+    this.context.subscriptions.push(
+      vscode.workspace.registerTextDocumentContentProvider('vscode-terraform', new PlanLogContentProvider()),
+    );
     this.statusBar = new OrganizationStatusBar(context);
 
     authProvider.onDidChangeSessions(async (event) => {

src/features/terraformCloud.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import axios from 'axios';
+import * as vscode from 'vscode';
+
+import { apiClient } from '../../terraformCloud';
+import stripAnsi from './helpers';
+
+export class PlanLogContentProvider implements vscode.TextDocumentContentProvider {
+  onDidChangeEmitter = new vscode.EventEmitter<vscode.Uri>();
+  onDidChange = this.onDidChangeEmitter.event;
+
+  async provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
+    try {
+      const logUrl = await this.getLogUrl(uri);
+      if (!logUrl) {
+        throw new Error('Unable to parse log Url');
+      }
+
+      const result = await axios.get<string>(logUrl, { headers: { Accept: 'text/plain' } });
+      return this.parseLog(result.data);
+    } catch (error) {
+      if (error instanceof Error) {
+        await vscode.window.showErrorMessage('Failed to load log:', error.message);
+      } else if (typeof error === 'string') {
+        await vscode.window.showErrorMessage('Failed to load log:', error);
+      }
+
+      console.error(error);
+      return '';
+    }
+  }
+
+  private parseLog(text: string) {
+    text = stripAnsi(text); // strip ansi escape codes
+    text = text.replace('', '').replace('', ''); // remove control characters
+
+    return text;
+  }
+
+  private async getLogUrl(uri: vscode.Uri) {
+    const id = uri.path.replace('/', '');
+
+    switch (uri.authority) {
+      case 'plan':
+        return await this.getPlanLogUrl(id);
+      case 'apply':
+        return await this.getApplyLogUrl(id);
+    }
+  }
+
+  private async getPlanLogUrl(id: string) {
+    const plan = await apiClient.getPlan({
+      params: {
+        plan_id: id,
+      },
+    });
+
+    return plan.data.attributes['log-read-url'];
+  }
+
+  private async getApplyLogUrl(id: string) {
+    const apply = await apiClient.getApply({
+      params: {
+        apply_id: id,
+      },
+    });
+
+    return apply.data.attributes['log-read-url'];
+  }
+}

src/providers/tfc/contentProvider.ts

@@ -161,6 +161,19 @@ export function RelativeTimeFormat(d: Date): string {
     const months = Math.round(diffSeconds / SECONDS_IN_MONTH);
     return rtf.format(-months, 'month');
   }
-  const years = diffSeconds / SECONDS_IN_YEAR;
+  const years = Math.round(diffSeconds / SECONDS_IN_YEAR);
   return rtf.format(-years, 'year');
 }
+
+// See https://github.com/chalk/ansi-regex/blob/02fa893d619d3da85411acc8fd4e2eea0e95a9d9/index.js#L2
+const ansiRegex = new RegExp(
+  [
+    '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+    '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-nq-uy=><~]))',
+  ].join('|'),
+  'g',
+);
+
+export default function stripAnsi(text: string) {
+  return text.replace(ansiRegex, '');
+}