Show progress during context switch (#1969) (#1979)

* Show progress during context switch

* Address review feedback

* move the cache clearing logic to useDockerContext

* Apply suggestions from code review

Co-authored-by: Brandon Waterloo [MSFT] <36966225+bwateratmsft@users.noreply.github.com>

* remove unnecessary await

Co-authored-by: Brandon Waterloo [MSFT] <36966225+bwateratmsft@users.noreply.github.com>

Co-authored-by: Brandon Waterloo [MSFT] <36966225+bwateratmsft@users.noreply.github.com>

Author: ravipal

src/commands/context/useDockerContext.ts

@@ -8,6 +8,7 @@ import { IActionContext } from 'vscode-azureextensionui';
 import { ext } from '../../extensionVariables';
 import { localize } from '../../localize';
 import { ContextTreeItem } from '../../tree/contexts/ContextTreeItem';
+import { LocalRootTreeItemBase } from '../../tree/LocalRootTreeItemBase';
 
 export async function useDockerContext(actionContext: IActionContext, node?: ContextTreeItem): Promise<void> {
     let invokedFromCommandPalette = false;
@@ -19,7 +20,20 @@ export async function useDockerContext(actionContext: IActionContext, node?: Con
         invokedFromCommandPalette = true;
     }
 
-    await node.use(actionContext);
+    try {
+        LocalRootTreeItemBase.autoRefreshViews = false;
+        await node.runWithTemporaryDescription(
+            localize('vscode-docker.tree.context.switching', 'Switching...'),
+            async () => {
+                await node.use(actionContext);
+                // The refresh logic will use the cached contexts retrieved by polling (auto refresh logic)
+                // Since the context is changed, clear the cached contexts, otherwise the old context will be shown as active
+                ext.contextsRoot.clearPollingCache();
+            });
+    } finally {
+        LocalRootTreeItemBase.autoRefreshViews = true;
+    }
+
     await ext.contextsRoot.refresh();
 
     if (invokedFromCommandPalette) {

src/tree/LocalRootTreeItemBase.ts

@@ -54,6 +54,8 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
     public abstract getItems(): Promise<TItem[] | undefined>;
     public abstract getPropertyValue(item: TItem, property: TProperty): string;
 
+    public static autoRefreshViews: boolean = true;
+
     public groupBySetting: TProperty | CommonGroupBy;
     public sortBySetting: CommonSortBy;
     public labelSetting: TProperty;
@@ -72,6 +74,10 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
         return workspace.getConfiguration(`${configPrefix}.${this.treePrefix}`);
     }
 
+    private get autoRefreshEnabled(): boolean {
+        return window.state.focused && LocalRootTreeItemBase.autoRefreshViews;
+    }
+
     protected getRefreshInterval(): number {
         const configOptions: WorkspaceConfiguration = workspace.getConfiguration('docker');
         return configOptions.get<number>('explorerRefreshInterval', 2000)
@@ -89,8 +95,12 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
                 const refreshInterval: number = this.getRefreshInterval();
                 intervalId = setInterval(
                     async () => {
-                        if (window.state.focused && await this.hasChanged()) {
-                            await this.refresh();
+                        if (this.autoRefreshEnabled && await this.hasChanged()) {
+                            // Auto refresh could be disabled while invoking the hasChanged()
+                            // So check again before starting the refresh.
+                            if (this.autoRefreshEnabled) {
+                                await this.refresh();
+                            }
                         }
                     },
                     refreshInterval);
@@ -118,13 +128,17 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
         })];
     }
 
+    public clearPollingCache(): void {
+        this._itemsFromPolling = undefined;
+    }
+
     public async loadMoreChildrenImpl(_clearCache: boolean, context: IActionContext): Promise<AzExtTreeItem[]> {
         try {
             // eslint-disable-next-line @typescript-eslint/no-floating-promises
             ext.activityMeasurementService.recordActivity('overallnoedit');
 
             this._currentItems = this._itemsFromPolling || await this.getSortedItems();
-            this._itemsFromPolling = undefined;
+            this.clearPollingCache();
             this.failedToConnect = false;
             this._currentDockerStatus = 'Running';
         } catch (error) {
@@ -345,7 +359,7 @@ export abstract class LocalRootTreeItemBase<TItem extends ILocalItem, TProperty
             this._itemsFromPolling = await this.getSortedItems();
             pollingDockerStatus = 'Running';
         } catch (error) {
-            this._itemsFromPolling = undefined;
+            this.clearPollingCache();
             pollingDockerStatus = await dockerInstallStatusProvider.isDockerInstalled() ? 'Installed' : 'NotInstalled';
             isDockerStatusChanged = pollingDockerStatus !== this._currentDockerStatus;
         }

src/tree/contexts/ContextTreeItem.ts

@@ -52,7 +52,7 @@ export class ContextTreeItem extends AzExtTreeItem {
     }
 
     public async deleteTreeItemImpl(context: IActionContext): Promise<void> {
-        await dockerContextManager.remove(this.name);
+        return dockerContextManager.remove(this.name);
     }
 
     public async inspect(context: IActionContext): Promise<string> {