Add listSubscriptions to resourceApi (#829)

* Add listSubscriptions to resourceApi * Bump api version * Bump package * Change AzureSubscription imports * Fix test for getting v1 API
microsoft · Apr 10, 2024 · c2ce048 · c2ce048
1 parent 02492b9
commit c2ce048
Show file tree

Hide file tree

Showing 6 changed files with 219 additions and 70 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -618,7 +618,7 @@
         "@azure/arm-resources-profile-2020-09-01-hybrid": "^2.1.0",
         "@microsoft/vscode-azext-azureauth": "^2.3.0",
         "@microsoft/vscode-azext-azureutils": "^2.0.0",
-        "@microsoft/vscode-azext-utils": "^2.0.0",
+        "@microsoft/vscode-azext-utils": "^2.4.0",
         "buffer": "^6.0.3",
         "jsonc-parser": "^2.2.1",
         "uuid": "^9.0.0",

diff --git a/src/api/compatibility/AzureResourceGroupsExtensionApi.ts b/src/api/compatibility/AzureResourceGroupsExtensionApi.ts
@@ -5,10 +5,11 @@
 
 import { AzExtTreeDataProvider, AzExtTreeItem, ITreeItemPickerContext } from '@microsoft/vscode-azext-utils';
 import { Activity, AppResourceResolver, AzureHostExtensionApi, AzureResourceGroupsExtensionApi, LocalResourceProvider, PickAppResourceOptions, WorkspaceResourceProvider } from '@microsoft/vscode-azext-utils/hostapi';
+import { AzureSubscription } from 'api/src';
 import { Disposable, TreeView } from 'vscode';
 
 export class InternalAzureResourceGroupsExtensionApi implements AzureHostExtensionApi, AzureResourceGroupsExtensionApi {
-    public static apiVersion = '0.0.1';
+    public static apiVersion = '0.0.2';
 
     #appResourceTree: AzExtTreeDataProvider;
     #appResourceTreeView: TreeView<unknown>;
@@ -19,6 +20,7 @@ export class InternalAzureResourceGroupsExtensionApi implements AzureHostExtensi
     #registerWorkspaceResourceProvider: (id: string, resolver: WorkspaceResourceProvider) => Disposable;
     #registerActivity: (activity: Activity) => Promise<void>;
     #pickAppResource: <T extends AzExtTreeItem>(context: ITreeItemPickerContext, options?: PickAppResourceOptions) => Promise<T>;
+    #getSubscriptions: (filter: boolean) => Promise<AzureSubscription[]>;
 
     // This `Omit` is here because the interface expects those keys to be defined, but in this object they will not be
     // They are replaced with functions defined on this class that merely wrap the newly-named keys
@@ -33,6 +35,11 @@ export class InternalAzureResourceGroupsExtensionApi implements AzureHostExtensi
         this.#registerWorkspaceResourceProvider = options.registerWorkspaceResourceProvider;
         this.#registerActivity = options.registerActivity;
         this.#pickAppResource = options.pickAppResource;
+        this.#getSubscriptions = options.getSubscriptions;
+    }
+
+    public get getSubscriptions(): (filter: boolean) => Promise<AzureSubscription[]> {
+        return this.#getSubscriptions;
     }
 
     public get appResourceTree(): AzExtTreeDataProvider {

diff --git a/src/extension.ts b/src/extension.ts
@@ -7,6 +7,7 @@
 
 import { registerAzureUtilsExtensionVariables, setupAzureLogger } from '@microsoft/vscode-azext-azureutils';
 import { AzExtTreeDataProvider, AzureExtensionApiFactory, IActionContext, callWithTelemetryAndErrorHandling, createApiProvider, createAzExtLogOutputChannel, createExperimentationService, registerUIExtensionVariables } from '@microsoft/vscode-azext-utils';
+import { AzureSubscription } from 'api/src';
 import { GetApiOptions, apiUtils } from 'api/src/utils/apiUtils';
 import * as vscode from 'vscode';
 import { ActivityLogTreeItem } from './activityLog/ActivityLogsTreeItem';
@@ -152,6 +153,9 @@ export async function activate(context: vscode.ExtensionContext, perfStats: { lo
     ext.appResourceTree = new CompatibleAzExtTreeDataProvider(azureResourceTreeDataProvider);
     ext.workspaceTree = new CompatibleAzExtTreeDataProvider(workspaceResourceTreeDataProvider);
 
+    const getSubscriptions: (filter: boolean) => Promise<AzureSubscription[]> =
+        async (filter: boolean) => { return await (await azureResourceTreeDataProvider.getAzureSubscriptionProvider()).getSubscriptions(filter) };
+
     return createApiProvider(
         [
             {
@@ -166,6 +170,7 @@ export async function activate(context: vscode.ExtensionContext, perfStats: { lo
                     registerWorkspaceResourceProvider,
                     registerActivity,
                     pickAppResource: createCompatibilityPickAppResource(),
+                    getSubscriptions,
                 }),
             },
             v2ApiFactory,

diff --git a/src/tree/azure/AzureResourceTreeDataProviderBase.ts b/src/tree/azure/AzureResourceTreeDataProviderBase.ts
@@ -48,7 +48,7 @@ export abstract class AzureResourceTreeDataProviderBase extends ResourceTreeData
         return super.isAncestorOf(element, id)
     }
 
-    protected async getAzureSubscriptionProvider(): Promise<AzureSubscriptionProvider> {
+    public async getAzureSubscriptionProvider(): Promise<AzureSubscriptionProvider> {
         // override for testing
         if (ext.testing.overrideAzureSubscriptionProvider) {
             return ext.testing.overrideAzureSubscriptionProvider();

diff --git a/test/api/v1.test.ts b/test/api/v1.test.ts
@@ -7,7 +7,7 @@ suite('v1 API tests', async () => {
 
         assert.ok(apiProvider, 'API provider is undefined');
 
-        const v1Api = apiProvider.getApi('0.0.1', {
+        const v1Api = apiProvider.getApi('0.0.2', {
             extensionId: 'ms-azuretools.vscode-azureresourcegroups-tests',
         });