Fix error edge case for clicking query plan links (#20364)

Co-authored-by: Lauren Nathan <[email protected]>

Author: laurenastrid1

src/constants/constants.ts

@@ -168,6 +168,7 @@ export const ipAddressRegex =
     /\b(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/;
 export const xml = "xml";
 export const json = "json";
+export const queryPlan = "Query Plan";
 export const queryPlanXmlStart = "<ShowPlanXML";
 
 /**

src/controllers/mainController.ts

@@ -53,7 +53,6 @@ import {
     DatabaseObject,
 } from "../services/databaseObjectSearchService";
 import { ExecutionPlanService } from "../services/executionPlanService";
-import { ExecutionPlanWebviewController } from "./executionPlanWebviewController";
 import { MssqlProtocolHandler } from "../mssqlProtocolHandler";
 import { getErrorMessage, getUriKey, isIConnectionInfo } from "../utils/utils";
 import { getStandardNPSQuestions, UserSurvey } from "../nps/userSurvey";
@@ -93,6 +92,7 @@ import {
 } from "../deployment/dockerUtils";
 import { ScriptOperation } from "../models/contracts/scripting/scriptingRequest";
 import { getCloudId } from "../azure/providerSettings";
+import { openExecutionPlanWebview } from "./sharedExecutionPlanUtils";
 
 /**
  * The main controller class that initializes the extension
@@ -2884,18 +2884,14 @@ export default class MainController implements vscode.Disposable {
 
             vscode.commands.executeCommand("workbench.action.closeActiveEditor");
 
-            const executionPlanController = new ExecutionPlanWebviewController(
+            openExecutionPlanWebview(
                 this.context,
                 this.vscodeWrapper,
                 this.executionPlanService,
                 this.sqlDocumentService,
                 planContents,
                 docName,
             );
-
-            executionPlanController.revealToForeground();
-
-            sendActionEvent(TelemetryViews.ExecutionPlan, TelemetryActions.Open);
         }
     };
 }

src/controllers/sharedExecutionPlanUtils.ts

@@ -19,7 +19,30 @@ import { TelemetryActions, TelemetryViews } from "../sharedInterfaces/telemetry"
 import { sendActionEvent, sendErrorEvent } from "../telemetry/telemetry";
 import { sqlPlanLanguageId } from "../constants/constants";
 import { executionPlanFileFilter } from "../constants/locConstants";
+import { ExecutionPlanWebviewController } from "./executionPlanWebviewController";
+import VscodeWrapper from "./vscodeWrapper";
 
+export function openExecutionPlanWebview(
+    context: vscode.ExtensionContext,
+    vscodeWrapper: VscodeWrapper,
+    executionPlanService: ExecutionPlanService,
+    sqlDocumentService: SqlDocumentService,
+    planContents: string,
+    docName: string,
+) {
+    const executionPlanController = new ExecutionPlanWebviewController(
+        context,
+        vscodeWrapper,
+        executionPlanService,
+        sqlDocumentService,
+        planContents,
+        docName,
+    );
+
+    executionPlanController.revealToForeground();
+
+    sendActionEvent(TelemetryViews.ExecutionPlan, TelemetryActions.Open);
+}
 export async function saveExecutionPlan(
     state: QueryResultWebviewState | ExecutionPlanWebviewState,
     payload: ExecutionPlanReducers["saveExecutionPlan"],

src/queryResult/queryResultWebViewController.ts

@@ -45,7 +45,7 @@ export class QueryResultWebviewController extends ReactWebviewViewController<
     constructor(
         context: vscode.ExtensionContext,
         vscodeWrapper: VscodeWrapper,
-        private executionPlanService: ExecutionPlanService,
+        private _executionPlanService: ExecutionPlanService,
         private _sqlOutputContentProvider: SqlOutputContentProvider,
     ) {
         super(context, vscodeWrapper, "queryResult", "queryResult", {
@@ -392,8 +392,16 @@ export class QueryResultWebviewController extends ReactWebviewViewController<
         return this._sqlOutputContentProvider;
     }
 
-    public getExecutionPlanService(): ExecutionPlanService {
-        return this.executionPlanService;
+    public getContext(): vscode.ExtensionContext {
+        return this._context;
+    }
+
+    public getVsCodeWrapper(): VscodeWrapper {
+        return this.vscodeWrapper;
+    }
+
+    public get executionPlanService(): ExecutionPlanService {
+        return this._executionPlanService;
     }
 
     public set sqlDocumentService(service: SqlDocumentService) {

src/queryResult/utils.ts

@@ -8,6 +8,7 @@ import * as Constants from "../constants/constants";
 import * as vscode from "vscode";
 import { TelemetryViews, TelemetryActions } from "../sharedInterfaces/telemetry";
 import {
+    openExecutionPlanWebview,
     saveExecutionPlan,
     showPlanXml,
     showQuery,
@@ -313,7 +314,18 @@ export function registerCommonRequestHandlers(
             payload.type === Constants.xml &&
             payload.content.startsWith(Constants.queryPlanXmlStart)
         ) {
-            state.tabStates.resultPaneTab = qr.QueryResultPaneTabs.ExecutionPlan;
+            if (state.isExecutionPlan) {
+                state.tabStates.resultPaneTab = qr.QueryResultPaneTabs.ExecutionPlan;
+                return state;
+            }
+            openExecutionPlanWebview(
+                webviewViewController.getContext(),
+                webviewViewController.getVsCodeWrapper(),
+                webviewViewController.executionPlanService,
+                webviewViewController.sqlDocumentService,
+                payload.content,
+                Constants.queryPlan,
+            );
             return state;
         }