Add revealWorkspaceResource function to expose resources in Workspace tree view (#1108)

Author: sevoku

api/src/resources/resourcesApi.ts

@@ -61,6 +61,14 @@ export interface ResourcesApi {
      */
     revealAzureResource(id: string, options?: VSCodeRevealOptions): Promise<void>;
 
+    /**
+     * Reveal a resource in the Workspace tree view.
+     *
+     * @param id - The Workspace Resource ID to reveal in the Workspace tree view.
+     * @param options - Options for revealing the resource. See {@link vscode.TreeView.reveal}
+     */
+    revealWorkspaceResource(id: string, options?: VSCodeRevealOptions): Promise<void>;
+
     /**
      * Gets a list of node IDs for nodes recently used/interacted with in the Azure tree view.
      *

src/api/createAzureResourcesHostApi.ts

@@ -6,7 +6,7 @@
 import { callWithTelemetryAndErrorHandling } from '@microsoft/vscode-azext-utils';
 import * as vscode from 'vscode';
 import { AzExtResourceType, AzureResource, BranchDataProvider, ResourceModelBase, VSCodeRevealOptions, WorkspaceResource, WorkspaceResourceProvider } from '../../api/src/index';
-import { revealResource } from '../commands/revealResource';
+import { revealResource, revealWorkspaceResource } from '../commands/revealResource';
 import { AzureResourceProvider, AzureResourcesHostApiInternal } from '../hostapi.v2.internal';
 import { AzureResourceBranchDataProviderManager } from '../tree/azure/AzureResourceBranchDataProviderManager';
 import { AzureResourceTreeDataProvider } from '../tree/azure/AzureResourceTreeDataProvider';
@@ -54,6 +54,15 @@ export function createAzureResourcesHostApi(
             });
         },
 
+        revealWorkspaceResource: (id: string, options?: VSCodeRevealOptions) => {
+            return callWithTelemetryAndErrorHandling('internalRevealWorkspaceResource', context => {
+                context.errorHandling.rethrow = true;
+                context.errorHandling.suppressDisplay = true;
+                context.errorHandling.suppressReportIssue = true;
+                return revealWorkspaceResource(context, id, options);
+            });
+        },
+
         getRecentlyUsedAzureNodes: () => {
             return getRecentlyUsedAzureNodes();
         },

src/api/createWrappedAzureResourcesExtensionApi.ts

@@ -26,6 +26,7 @@ export function createWrappedAzureResourcesExtensionApi(api: AzureResourcesApiIn
             workspaceResourceTreeDataProvider: api.resources.workspaceResourceTreeDataProvider,
             ...wrapFunctionsInTelemetry({
                 revealAzureResource: api.resources.revealAzureResource.bind(api) as typeof api.resources.revealAzureResource,
+                revealWorkspaceResource: api.resources.revealWorkspaceResource.bind(api) as typeof api.resources.revealWorkspaceResource,
             }, wrapOptions),
             ...wrapFunctionsInTelemetrySync({
                 registerAzureResourceBranchDataProvider: api.resources.registerAzureResourceBranchDataProvider.bind(api) as typeof api.resources.registerAzureResourceBranchDataProvider,

src/commands/revealResource.ts

@@ -23,6 +23,17 @@ export async function revealResource(context: IActionContext, resourceId: string
     }
 }
 
+export async function revealWorkspaceResource(context: IActionContext, resourceId: string, options?: VSCodeRevealOptions): Promise<void> {
+    try {
+        const item: ResourceGroupsItem | undefined = await (ext.v2.api.resources.workspaceResourceTreeDataProvider as ResourceTreeDataProviderBase).findItemById(resourceId);
+        if (item) {
+            await ext.workspaceTreeView.reveal(item as unknown as AzExtTreeItem, options ?? { expand: false, focus: true, select: true });
+        }
+    } catch (error) {
+        context.telemetry.properties.revealError = maskUserInfo(parseError(error).message, []);
+    }
+}
+
 function setTelemetryPropertiesForId(context: IActionContext, resourceId: string): void {
     const parsedAzureResourceId = parsePartialAzureResourceId(resourceId);
     const resourceKind = getResourceKindFromId(parsedAzureResourceId);