@microsoft/vscode-azext-azureauth 1.4.0 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 1.4.0 - 2023-11-03
+* [#1619](https://github.com/microsoft/vscode-azuretools/pull/1619) Make `getSession` synchronous to fix an issue that broke app service deployments
+
 ## 1.3.0 - 2023-10-23
 
 * [#1610](https://github.com/microsoft/vscode-azuretools/pull/1610) Add `signInToTenant` command which facilitates signing in to a specific tenant.

package/out/src/AzureSubscriptionProvider.d.ts

@@ -1,6 +1,6 @@
 import type * as vscode from 'vscode';
 import type { AzureSubscription } from './AzureSubscription';
-import { TenantIdDescription } from '@azure/arm-subscriptions';
+import type { TenantIdDescription } from '@azure/arm-resources-subscriptions';
 /**
  * An interface for obtaining Azure subscription information
  */

package/out/src/Tenant.d.ts

@@ -0,0 +1,4 @@
+import type { TenantIdDescription } from '@azure/arm-subscriptions';
+export interface Tenant extends TenantIdDescription {
+    isAuthenticated: boolean;
+}

package/out/src/Tenant.js

@@ -0,0 +1,7 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Tenant.js.map

package/out/src/VSCodeAzureSubscriptionProvider.d.ts

@@ -1,4 +1,4 @@
-import type { TenantIdDescription } from '@azure/arm-subscriptions';
+import type { TenantIdDescription } from '@azure/arm-resources-subscriptions';
 import * as vscode from 'vscode';
 import type { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscription';
 import type { AzureSubscriptionProvider } from './AzureSubscriptionProvider';
@@ -99,5 +99,4 @@ export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable i
      * @returns A client, the credential used by the client, and the authentication function
      */
     private getSubscriptionClient;
-    private getToken;
 }

package/out/src/VSCodeAzureSubscriptionProvider.js

@@ -74,13 +74,31 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * @returns A list of tenants.
      */
     getTenants() {
+        var _a, e_1, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
-            const listTenantsResponse = yield fetch('https://management.azure.com/tenants?api-version=2022-12-01', {
-                headers: {
-                    Authorization: `Bearer ${yield this.getToken()}`,
+            const { client } = yield this.getSubscriptionClient();
+            const results = [];
+            try {
+                for (var _d = true, _e = __asyncValues(client.tenants.list()), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
+                    _c = _f.value;
+                    _d = false;
+                    try {
+                        const tenant = _c;
+                        results.push(tenant);
+                    }
+                    finally {
+                        _d = true;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
                 }
-            });
-            return (yield listTenantsResponse.json()).value;
+                finally { if (e_1) throw e_1.error; }
+            }
+            return results;
         });
     }
     /**
@@ -99,8 +117,6 @@ 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 subscriptionIds = yield this.getSubscriptionFilters();
-            const shouldFilterSubscriptions = filter && !!subscriptionIds.length; // If the list is empty it is treated as "no filter"
             const results = [];
             try {
                 this.suppressSignInEvents = true;
@@ -117,19 +133,18 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                         continue;
                     }
                     // For each tenant, get the list of subscriptions
-                    for (const subscription of yield this.getSubscriptionsForTenant(tenantId)) {
-                        // If filtering is enabled, and the current subscription is not in that list, then skip it
-                        if (shouldFilterSubscriptions && !subscriptionIds.includes(subscription.subscriptionId)) {
-                            continue;
-                        }
-                        results.push(subscription);
-                    }
+                    results.push(...yield this.getSubscriptionsForTenant(tenantId));
                 }
             }
             finally {
                 this.suppressSignInEvents = false;
             }
-            return results.sort((a, b) => a.name.localeCompare(b.name));
+            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(results);
         });
     }
     /**
@@ -206,7 +221,7 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      * @returns The list of subscriptions for the tenant.
      */
     getSubscriptionsForTenant(tenantId) {
-        var _a, e_1, _b, _c;
+        var _a, e_2, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             const { client, credential, authentication } = yield this.getSubscriptionClient(tenantId);
             const environment = (0, configuredAzureEnv_1.getConfiguredAzureEnv)();
@@ -234,12 +249,12 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
                     }
                 }
             }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
             finally {
                 try {
                     if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
                 }
-                finally { if (e_1) throw e_1.error; }
+                finally { if (e_2) throw e_2.error; }
             }
             return subscriptions;
         });
@@ -251,39 +266,40 @@ class VSCodeAzureSubscriptionProvider extends vscode.Disposable {
      *
      * @returns A client, the credential used by the client, and the authentication function
      */
-    getSubscriptionClient(tenantId, scopes) {
+    getSubscriptionClient(tenantId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const armSubs = yield Promise.resolve().then(() => require('@azure/arm-subscriptions'));
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
-            if (!session) {
+            const initialSession = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(undefined, tenantId, { createIfNone: false, silent: true });
+            if (!initialSession) {
                 throw new NotSignedInError_1.NotSignedInError();
             }
             const credential = {
-                getToken: () => __awaiter(this, void 0, void 0, function* () {
-                    return {
-                        token: session.accessToken,
-                        expiresOnTimestamp: 0
-                    };
+                getToken: (scopes, _options) => __awaiter(this, void 0, void 0, function* () {
+                    const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
+                    if (session === null || session === void 0 ? void 0 : session.accessToken) {
+                        return {
+                            token: session.accessToken,
+                            expiresOnTimestamp: 0
+                        };
+                    }
+                    else {
+                        return null;
+                    }
                 })
             };
+            const configuredAzureEnv = (0, configuredAzureEnv_1.getConfiguredAzureEnv)();
+            const endpoint = configuredAzureEnv.resourceManagerEndpointUrl;
+            const armSubs = yield Promise.resolve().then(() => require('@azure/arm-resources-subscriptions'));
             return {
-                client: new armSubs.SubscriptionClient(credential),
+                client: new armSubs.SubscriptionClient(credential, { endpoint }),
                 credential: credential,
                 authentication: {
-                    getSession: () => session
+                    getSession: (scopes) => __awaiter(this, void 0, void 0, function* () {
+                        return yield (0, getSessionFromVSCode_1.getSessionFromVSCode)(scopes, tenantId, { createIfNone: false, silent: true });
+                    })
                 }
             };
         });
     }
-    getToken(tenantId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const session = yield (0, getSessionFromVSCode_1.getSessionFromVSCode)([], tenantId, { createIfNone: false, silent: true });
-            if (!session) {
-                throw new NotSignedInError_1.NotSignedInError();
-            }
-            return session.accessToken;
-        });
-    }
 }
 exports.VSCodeAzureSubscriptionProvider = VSCodeAzureSubscriptionProvider;
 //# sourceMappingURL=VSCodeAzureSubscriptionProvider.js.map

package/out/src/getSessionFromVSCode.js

@@ -16,9 +16,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSessionFromVSCode = void 0;
 const configuredAzureEnv_1 = require("./utils/configuredAzureEnv");
 const vscode = require("vscode");
+function ensureEndingSlash(value) {
+    return value.endsWith('/') ? value : `${value}/`;
+}
 function getResourceScopes(scopes) {
     if (scopes === undefined || scopes === "" || scopes.length === 0) {
-        scopes = `${(0, configuredAzureEnv_1.getConfiguredAzureEnv)().resourceManagerEndpointUrl}.default`;
+        scopes = ensureEndingSlash((0, configuredAzureEnv_1.getConfiguredAzureEnv)().resourceManagerEndpointUrl);
     }
     const arrScopes = (Array.isArray(scopes) ? scopes : [scopes])
         .map((scope) => {

package/out/src/utils/configuredAzureEnv.js

@@ -35,10 +35,10 @@ function getConfiguredAzureEnv() {
     const authProviderConfig = vscode.workspace.getConfiguration(CustomCloudConfigurationSection);
     const environmentSettingValue = authProviderConfig.get(CloudEnvironmentSettingName);
     if (environmentSettingValue === CloudEnvironmentSettingValue.ChinaCloud) {
-        return Object.assign(Object.assign({}, azureEnv.Environment.get(azureEnv.Environment.ChinaCloud.name)), { isCustomCloud: false });
+        return Object.assign(Object.assign({}, azureEnv.Environment.ChinaCloud), { isCustomCloud: false });
     }
     else if (environmentSettingValue === CloudEnvironmentSettingValue.USGovernment) {
-        return Object.assign(Object.assign({}, azureEnv.Environment.get(azureEnv.Environment.USGovernment.name)), { isCustomCloud: false });
+        return Object.assign(Object.assign({}, azureEnv.Environment.USGovernment), { isCustomCloud: false });
     }
     else if (environmentSettingValue === CloudEnvironmentSettingValue.Custom) {
         const customCloud = authProviderConfig.get(CustomEnvironmentSettingName);

package/out/src/utils/getUnauthenticatedTenants.d.ts

@@ -1,4 +1,4 @@
-import type { TenantIdDescription } from "@azure/arm-subscriptions";
+import type { TenantIdDescription } from "@azure/arm-resources-subscriptions";
 import type { AzureSubscriptionProvider } from "../AzureSubscriptionProvider";
 /**
  * @returns list of tenants that VS Code doesn't have sessions for

package/out/src/utils/signInToTenant.d.ts

@@ -0,0 +1,2 @@
+import type { AzureSubscriptionProvider } from "../AzureSubscriptionProvider";
+export declare function signInToTenant(subscriptionProvider: AzureSubscriptionProvider): Promise<void>;

package/out/src/utils/signInToTenant.js

@@ -0,0 +1,89 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signInToTenant = void 0;
+const vscode = require("vscode");
+function signInToTenant(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tenantId = yield pickTenant(subscriptionProvider);
+        if (tenantId) {
+            yield subscriptionProvider.signIn(tenantId);
+        }
+    });
+}
+exports.signInToTenant = signInToTenant;
+function pickTenant(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const pick = yield vscode.window.showQuickPick(getPicks(subscriptionProvider), {
+            placeHolder: 'Select Directory to Sign In To',
+            matchOnDescription: true,
+            ignoreFocusOut: true,
+        });
+        return pick === null || pick === void 0 ? void 0 : pick.tenant.tenantId;
+    });
+}
+function getPicks(subscriptionProvider) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const unauthenticatedTenants = yield getUnauthenticatedTenants(subscriptionProvider);
+        const picks = unauthenticatedTenants.map(tenant => {
+            var _a, _b, _c;
+            return ({
+                label: (_a = tenant.displayName) !== null && _a !== void 0 ? _a : '',
+                description: (_b = tenant.tenantId) !== null && _b !== void 0 ? _b : '',
+                detail: (_c = tenant.defaultDomain) !== null && _c !== void 0 ? _c : '',
+                tenant,
+            });
+        });
+        return picks;
+    });
+}
+function getUnauthenticatedTenants(subscriptionProvider) {
+    var _a, e_1, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        const tenants = yield subscriptionProvider.getTenants();
+        const unauthenticatedTenants = [];
+        try {
+            for (var _d = true, tenants_1 = __asyncValues(tenants), tenants_1_1; tenants_1_1 = yield tenants_1.next(), _a = tenants_1_1.done, !_a;) {
+                _c = tenants_1_1.value;
+                _d = false;
+                try {
+                    const tenant = _c;
+                    if (!(yield subscriptionProvider.isSignedIn(tenant.tenantId))) {
+                        unauthenticatedTenants.push(tenant);
+                    }
+                }
+                finally {
+                    _d = true;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = tenants_1.return)) yield _b.call(tenants_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return unauthenticatedTenants;
+    });
+}
+//# sourceMappingURL=signInToTenant.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/vscode-azext-azureauth",
     "author": "Microsoft Corporation",
-    "version": "1.4.0",
+    "version": "2.1.0",
     "description": "Azure authentication helpers for Visual Studio Code",
     "tags": [
         "azure",
@@ -52,7 +52,7 @@
         "typescript": "^4.9.4"
     },
     "dependencies": {
-        "@azure/arm-subscriptions": "^5.1.0",
+        "@azure/arm-resources-subscriptions": "^2.1.0",
         "@azure/ms-rest-azure-env": "^2.0.0"
     }
 }