@microsoft/vscode-azext-azureauth 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 3.1.0 - 2024-11-26
+
+* [#1827](https://github.com/microsoft/vscode-azuretools/pull/1827) Add more comprehensive support for multi-account scenarios 
+* [#1815](https://github.com/microsoft/vscode-azuretools/issues/1815) Fix `VSCodeAzureSubscriptionProvider.getSubscriptions()` returning empty 
+
+## 3.0.1 - 2024-11-19
+* [#1819](https://github.com/microsoft/vscode-azuretools/pull/1819) Add account parameter to `AzureSubscriptionProvider.isSignedIn()` function to fix a multi-account issue [#1809](https://github.com/microsoft/vscode-azuretools/issues/1809)
+* [#1822](https://github.com/microsoft/vscode-azuretools/pull/1822) Add check in `VSCodeAzureSubscriptionProvider.getTenants()` to fix a multi-account issue [#1809](https://github.com/microsoft/vscode-azuretools/issues/1809)
+
 ## 3.0.0 - 2024-09-19
 * [#1789](https://github.com/microsoft/vscode-azuretools/pull/1789) Change `getTenants` to be compatible with the new Azure Resources tenants view. This also includes a possible breaking change where an optional parameter `account` which when passed in `getTenants` will return the tenants associated with that single account. Otherwise `getTenants` will return the tenants for all authenticated accounts.
 

package/out/src/AzureSubscriptionProvider.d.ts

@@ -34,15 +34,16 @@ export interface AzureSubscriptionProvider {
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    isSignedIn(tenantId?: string): Promise<boolean>;
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * Asks the user to sign in or pick an account to use.
      *
      * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     * @param account (Optional) Provide to sign in to a specific account.
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    signIn(tenantId?: string): Promise<boolean>;
+    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
      */

package/out/src/VSCodeAzureSubscriptionProvider.d.ts

@@ -28,7 +28,8 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * @param filter - Whether to filter the list returned, according to the list returned
      * by `getTenantFilters()` and `getSubscriptionFilters()`. Optional, default true.
      *
-     * @returns A list of Azure subscriptions.
+     * @returns A list of Azure subscriptions. The list is sorted by subscription name.
+     * The list can contain duplicate subscriptions if they come from different accounts.
      *
      * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
      * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
@@ -39,18 +40,23 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * Checks to see if a user is signed in.
      *
      * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     * @param account (Optional) Provide to check if a user is signed in to a specific account.
      *
      * @returns True if the user is signed in, false otherwise.
+     *
+     * If no tenant or account is provided, then
+     * checks all accounts for a session.
      */
-    isSignedIn(tenantId?: string): Promise<boolean>;
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * Asks the user to sign in or pick an account to use.
      *
      * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     * @param account (Optional) Provide to sign in to a specific account.
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    signIn(tenantId?: string): Promise<boolean>;
+    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
     /**
      * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
      */

package/out/src/VSCodeAzureSubscriptionProvider.js

@@ -85,26 +85,29 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                     _g = false;
                     try {
                         account = _c;
-                        const { client } = yield this.getSubscriptionClient(account, undefined, undefined);
-                        try {
-                            for (var _k = true, _l = (e_2 = void 0, __asyncValues(client.tenants.list())), _m; _m = yield _l.next(), _d = _m.done, !_d;) {
-                                _f = _m.value;
-                                _k = false;
-                                try {
-                                    const tenant = _f;
-                                    results.push(tenant);
-                                }
-                                finally {
-                                    _k = true;
+                        // Added check. Without this the getSubscriptionClient function throws the NotSignedInError
+                        if (yield this.isSignedIn(undefined, account)) {
+                            const { client } = yield this.getSubscriptionClient(account, undefined, undefined);
+                            try {
+                                for (var _k = true, _l = (e_2 = void 0, __asyncValues(client.tenants.list())), _m; _m = yield _l.next(), _d = _m.done, !_d;) {
+                                    _f = _m.value;
+                                    _k = false;
+                                    try {
+                                        const tenant = _f;
+                                        results.push(tenant);
+                                    }
+                                    finally {
+                                        _k = true;
+                                    }
                                 }
                             }
-                        }
-                        catch (e_2_1) { e_2 = { error: e_2_1 }; }
-                        finally {
-                            try {
-                                if (!_k && !_d && (_e = _l.return)) yield _e.call(_l);
+                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                            finally {
+                                try {
+                                    if (!_k && !_d && (_e = _l.return)) yield _e.call(_l);
+                                }
+                                finally { if (e_2) throw e_2.error; }
                             }
-                            finally { if (e_2) throw e_2.error; }
                         }
                     }
                     finally {
@@ -128,7 +131,8 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * @param filter - Whether to filter the list returned, according to the list returned
      * by `getTenantFilters()` and `getSubscriptionFilters()`. Optional, default true.
      *
-     * @returns A list of Azure subscriptions.
+     * @returns A list of Azure subscriptions. The list is sorted by subscription name.
+     * The list can contain duplicate subscriptions if they come from different accounts.
      *
      * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
      * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
@@ -138,7 +142,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
         return __awaiter(this, void 0, void 0, function* () {
             const tenantIds = yield this.getTenantFilters();
             const shouldFilterTenants = filter && !!tenantIds.length; // If the list is empty it is treated as "no filter"
-            const results = [];
+            const allSubscriptions = [];
             try {
                 this.suppressSignInEvents = true;
                 // Get the list of tenants from each account
@@ -151,36 +155,55 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                         if (shouldFilterTenants && !tenantIds.includes(tenantId)) {
                             continue;
                         }
-                        // If the user is not signed in to this tenant, then skip it
-                        if (!(yield this.isSignedIn(tenantId))) {
-                            continue;
-                        }
                         // For each tenant, get the list of subscriptions
-                        results.push(...yield this.getSubscriptionsForTenant(tenantId, account));
+                        allSubscriptions.push(...yield this.getSubscriptionsForTenant(account, tenantId));
                     }
+                    // list subscriptions for the home tenant
+                    allSubscriptions.push(...yield this.getSubscriptionsForTenant(account));
                 }
             }
             finally {
                 this.suppressSignInEvents = false;
             }
+            // It's possible that by listing subscriptions in all tenants and the "home" tenant there could be duplicate subscriptions
+            // Thus, we remove duplicate subscriptions. However, if multiple accounts have the same subscription, we keep them.
+            const subscriptionMap = new Map();
+            allSubscriptions.forEach(sub => subscriptionMap.set(`${sub.account.id}/${sub.subscriptionId}`, sub));
+            const uniqueSubscriptions = Array.from(subscriptionMap.values());
             const sortSubscriptions = (subscriptions) => subscriptions.sort((a, b) => a.name.localeCompare(b.name));
             const subscriptionIds = yield this.getSubscriptionFilters();
             if (filter && !!subscriptionIds.length) { // If the list is empty it is treated as "no filter"
-                return sortSubscriptions(results.filter(sub => subscriptionIds.includes(sub.subscriptionId)));
+                return sortSubscriptions(uniqueSubscriptions.filter(sub => subscriptionIds.includes(sub.subscriptionId)));
             }
-            return sortSubscriptions(results);
+            return sortSubscriptions(uniqueSubscriptions);
         });
     }
     /**
      * Checks to see if a user is signed in.
      *
      * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     * @param account (Optional) Provide to check if a user is signed in to a specific account.
      *
      * @returns True if the user is signed in, false otherwise.
+     *
+     * If no tenant or account is provided, then
+     * checks all accounts for a session.
      */
-    isSignedIn(tenantId) {
+    isSignedIn(tenantId, account) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true });
+            // If no tenant or account is provided, then check all accounts for a session
+            if (!account && !tenantId) {
+                const accounts = yield vscode.authentication.getAccounts((0, configuredAzureEnv_1.getConfiguredAuthProviderId)());
+                if (accounts.length === 0) {
+                    return false;
+                }
+                for (const account of accounts) {
+                    if (yield this.isSignedIn(undefined, account)) {
+                        return true;
+                    }
+                }
+            }
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true, account });
             return !!session;
         });
     }
@@ -188,12 +211,18 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * Asks the user to sign in or pick an account to use.
      *
      * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     * @param account (Optional) Provide to sign in to a specific account.
      *
      * @returns True if the user is signed in, false otherwise.
      */
-    signIn(tenantId) {
+    signIn(tenantId, account) {
         return __awaiter(this, void 0, void 0, function* () {
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: true, clearSessionPreference: true });
+            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, {
+                createIfNone: true,
+                // If no account is provided, then clear the session preference which tells VS Code to show the account picker
+                clearSessionPreference: !account,
+                account,
+            });
             return !!session;
         });
     }
@@ -245,9 +274,14 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      *
      * @returns The list of subscriptions for the tenant.
      */
-    getSubscriptionsForTenant(tenantId, account) {
+    getSubscriptionsForTenant(account, tenantId) {
         var _a, e_3, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
+            // If the user is not signed in to this tenant or account, then return an empty list
+            // This is to prevent the NotSignedInError from being thrown in getSubscriptionClient
+            if (!(yield this.isSignedIn(tenantId, account))) {
+                return [];
+            }
             const { client, credential, authentication } = yield this.getSubscriptionClient(account, tenantId, undefined);
             const environment = (0, configuredAzureEnv_1.getConfiguredAzureEnv)();
             const subscriptions = [];
@@ -265,8 +299,8 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                             /* eslint-disable @typescript-eslint/no-non-null-assertion */
                             name: subscription.displayName,
                             subscriptionId: subscription.subscriptionId,
+                            tenantId: tenantId !== null && tenantId !== void 0 ? tenantId : subscription.tenantId,
                             /* eslint-enable @typescript-eslint/no-non-null-assertion */
-                            tenantId: tenantId,
                             account: account
                         });
                     }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "3.0.0",
+    "version": "3.1.0",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",