utils & dev: Add fix for tests that fail due to having `showLoadingPr…

…ompt` set to `true` (#1807)
microsoft · Oct 30, 2024 · fb6173d · fb6173d
1 parent 9bc93be
commit fb6173d
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 8 deletions.
diff --git a/dev/index.d.ts b/dev/index.d.ts
@@ -223,6 +223,12 @@ export declare class TestUserInput {
 
     public constructor(vscode: typeof import('vscode'));
 
+    /**
+     * Boolean set to indicate whether the UI is being used for test inputs. For`TestUserInput`, this will always default to true.
+     * See: https://github.com/microsoft/vscode-azuretools/pull/1807
+     */
+    readonly isTesting: boolean;
+
     /**
      * An ordered array of inputs that will be used instead of interactively prompting in VS Code. RegExp is only applicable for QuickPicks and will pick the first input that matches the RegExp.
      */

diff --git a/dev/package-lock.json b/dev/package-lock.json
diff --git a/dev/package.json b/dev/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-dev",
     "author": "Microsoft Corporation",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "description": "Common dev dependency tools for developing Azure extensions for VS Code",
     "tags": [
         "azure",

diff --git a/dev/src/TestUserInput.ts b/dev/src/TestUserInput.ts
@@ -23,6 +23,8 @@ export class TestUserInput implements types.TestUserInput {
     private readonly _vscode: typeof vscodeTypes;
     private _inputs: (string | RegExp | TestInput)[] = [];
 
+    readonly isTesting: boolean = true;
+
     constructor(vscode: typeof vscodeTypes) {
         this._vscode = vscode;
         this._onDidFinishPromptEmitter = new this._vscode.EventEmitter<types.PromptResult>();

diff --git a/utils/package-lock.json b/utils/package-lock.json
diff --git a/utils/package.json b/utils/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-utils",
     "author": "Microsoft Corporation",
-    "version": "2.5.10",
+    "version": "2.5.11",
     "description": "Common UI tools for developing Azure extensions for VS Code",
     "tags": [
         "azure",

diff --git a/utils/src/userInput/IInternalActionContext.ts b/utils/src/userInput/IInternalActionContext.ts
@@ -7,7 +7,7 @@ import { CancellationToken } from 'vscode';
 import * as types from '../../index';
 
 export interface IInternalActionContext extends types.IActionContext {
-    ui: types.IAzureUserInput & { wizard?: IInternalAzureWizard, isPrompting?: boolean }
+    ui: types.IAzureUserInput & { wizard?: IInternalAzureWizard, isPrompting?: boolean, isTesting?: boolean };
 }
 
 export interface IInternalAzureWizard {

diff --git a/utils/src/wizard/AzureWizard.ts b/utils/src/wizard/AzureWizard.ts
@@ -114,7 +114,8 @@ export class AzureWizard<T extends (IInternalActionContext & Partial<types.Execu
 
                     if (loadingQuickPick) {
                         disposables.push(loadingQuickPick?.onDidHide(() => {
-                            if (!this._context.ui.isPrompting) {
+                            // Avoid issuing cancels during tests - see: https://github.com/microsoft/vscode-azuretools/pull/1807
+                            if (!this._context.ui.isPrompting && !this._context.ui.isTesting) {
                                 this._cancellationTokenSource.cancel();
                             }
                         }));