WIP: handling of non-JSON plan output

hashicorp · Nov 9, 2023 · b0e703e · b0e703e
1 parent 8bcbe85
commit b0e703e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 19 deletions.
diff --git a/src/providers/tfc/planProvider.ts b/src/providers/tfc/planProvider.ts
@@ -7,6 +7,7 @@ import * as vscode from 'vscode';
 import * as readline from 'readline';
 import { Writable } from 'stream';
 import axios from 'axios';
+import semver from 'semver';
 import TelemetryReporter from '@vscode/extension-telemetry';
 
 import { apiClient } from '../../terraformCloud';
@@ -53,14 +54,17 @@ export class PlanTreeDataProvider implements vscode.TreeDataProvider<vscode.Tree
       return [];
     }
 
+    const jsonExpected =
+      this.plan.attributes['structured-run-output-enabled'] && semver.satisfies(this.plan.terraformVersion, '> 0.15.2');
+
     try {
-      return this.getPlanFromUrl(this.plan.logReadUrl);
+      return this.getPlanFromUrl(this.plan.logReadUrl, jsonExpected);
     } catch (error) {
       return [];
     }
   }
 
-  private async getPlanFromUrl(planLogUrl: string): Promise<vscode.TreeItem[]> {
+  private async getPlanFromUrl(planLogUrl: string, jsonExpected: boolean): Promise<vscode.TreeItem[]> {
     const session = await vscode.authentication.getSession(TerraformCloudAuthenticationProvider.providerID, [], {
       createIfNone: false,
     });
@@ -86,22 +90,24 @@ export class PlanTreeDataProvider implements vscode.TreeDataProvider<vscode.Tree
       const items: PlannedChange[] = [];
 
       for await (const line of lineStream) {
-        try {
-          const logLine: LogLine = JSON.parse(line);
-
-          // TODO: non-JSON output?
-
-          // TODO: resource_drift
-          // TODO: import?
-          // TODO: test_*
-
-          if (logLine.type === 'planned_change' && logLine.change) {
-            const runItem = new PlannedChange(logLine.change.action, logLine.change.resource);
-            items.push(runItem);
+        if (jsonExpected) {
+          try {
+            const logLine: LogLine = JSON.parse(line);
+
+            // TODO: resource_drift
+            // TODO: import?
+            // TODO: test_*
+
+            if (logLine.type === 'planned_change' && logLine.change) {
+              const runItem = new PlannedChange(logLine.change.action, logLine.change.resource);
+              items.push(runItem);
+            }
+          } catch (e) {
+            // skip any non-JSON lines, like Terraform version output
+            continue;
           }
-        } catch (e) {
-          // skip any non-JSON lines, like Terraform version output
-          continue;
+        } else {
+          // TODO: handle non-JSON output
         }
       }
 

diff --git a/src/providers/tfc/runProvider.ts b/src/providers/tfc/runProvider.ts
@@ -200,7 +200,7 @@ export class RunTreeDataProvider implements vscode.TreeDataProvider<TFCRunTreeIt
       if (plan) {
         const status = plan.data.attributes.status;
         const label = status === 'unreachable' ? 'Plan will not run' : `Plan ${status}`;
-        const item = new PlanTreeItem(root.planId, label, plan.data.attributes);
+        const item = new PlanTreeItem(root.planId, label, plan.data.attributes, root.attributes['terraform-version']);
         switch (status) {
           case 'unreachable':
             item.label = 'Plan will not run';
@@ -283,7 +283,12 @@ export class RunTreeItem extends vscode.TreeItem {
 export class PlanTreeItem extends vscode.TreeItem {
   public logReadUrl = '';
 
-  constructor(public id: string, public label: string, public attributes: PlanAttributes) {
+  constructor(
+    public id: string,
+    public label: string,
+    public attributes: PlanAttributes,
+    public terraformVersion: ,
+  ) {
     super(label);
     this.iconPath = GetPlanApplyStatusIcon(attributes.status);
     if (attributes) {