Add support for domain name label scopes

package.json

@@ -773,15 +773,15 @@
         "webpack-cli": "^4.6.0"
     },
     "dependencies": {
-        "@azure/arm-appservice": "^13.0.2",
+        "@azure/arm-appservice": "^15.0.0",
         "@azure/arm-resources": "^5.0.0",
         "@azure/core-client": "^1.7.3",
         "@azure/core-rest-pipeline": "^1.11.0",
-        "@microsoft/vscode-azext-azureappservice": "^3.1.0",
+        "@microsoft/vscode-azext-azureappservice": "file:../vscode-azuretools/appservice/microsoft-vscode-azext-azureappservice-3.3.1.tgz",
         "@microsoft/vscode-azext-azureappsettings": "^0.2.0",
         "@microsoft/vscode-azext-azureutils": "^3.1.1",
-        "@microsoft/vscode-azext-utils": "^2.5.7",
-        "@microsoft/vscode-azureresources-api": "^2.1.0",
+        "@microsoft/vscode-azext-utils": "file:../vscode-azuretools/utils/microsoft-vscode-azext-utils-2.5.13.tgz",
+        "@microsoft/vscode-azureresources-api": "^2.3.2",
         "dotenv": "^6.2.0",
         "fast-xml-parser": "^4.4.1",
         "fs-extra": "^8.0.0",

src/WebAppResolver.ts

@@ -1,6 +1,6 @@
 import { type Site } from "@azure/arm-appservice";
 import { uiUtils } from "@microsoft/vscode-azext-azureutils";
-import { callWithTelemetryAndErrorHandling, nonNullProp, nonNullValue, type IActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { callWithTelemetryAndErrorHandling, nonNullProp, nonNullValue, nonNullValueAndProp, type IActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { type AppResource, type AppResourceResolver } from "@microsoft/vscode-azext-utils/hostapi";
 import { ResolvedWebAppResource } from "./tree/ResolvedWebAppResource";
 import { createWebSiteClient } from "./utils/azureClients";
@@ -9,6 +9,7 @@ export class WebAppResolver implements AppResourceResolver {
 
     private siteCacheLastUpdated = 0;
     private siteCache: Map<string, Site> = new Map<string, Site>();
+    private siteNameCounter: Map<string, number> = new Map<string, number>();
     private listWebAppsTask: Promise<void> | undefined;
 
     public async resolveResource(subContext: ISubscriptionContext, resource: AppResource): Promise<ResolvedWebAppResource | undefined> {
@@ -17,10 +18,17 @@ export class WebAppResolver implements AppResourceResolver {
 
             if (this.siteCacheLastUpdated < Date.now() - 1000 * 3) {
                 this.siteCacheLastUpdated = Date.now();
+
                 this.listWebAppsTask = new Promise((resolve, reject) => {
                     this.siteCache.clear();
+                    this.siteNameCounter.clear();
+
                     uiUtils.listAllIterator(client.webApps.list()).then((sites) => {
                         for (const site of sites) {
+                            const siteName: string = nonNullProp(site, 'name');
+                            const count: number = (this.siteNameCounter.get(siteName) ?? 0) + 1;
+
+                            this.siteNameCounter.set(siteName, count);
                             this.siteCache.set(nonNullProp(site, 'id').toLowerCase(), site);
                         }
                         resolve();
@@ -33,7 +41,12 @@ export class WebAppResolver implements AppResourceResolver {
 
             await this.listWebAppsTask;
             const site = this.siteCache.get(nonNullProp(resource, 'id').toLowerCase());
-            return new ResolvedWebAppResource(subContext, nonNullValue(site));
+
+            return new ResolvedWebAppResource(subContext, nonNullValue(site), {
+                // Multiple sites with the same name could be displayed as long as they are in different locations
+                // To help distinguish these apps for our users, lookahead and determine if the location should be provided for duplicated site names
+                showLocationAsTreeItemDescription: (this.siteNameCounter.get(nonNullValueAndProp(site, 'name')) ?? 1) > 1,
+            });
         });
     }
 

src/commands/createWebApp/IWebAppWizardContext.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { type IAppServiceWizardContext } from '@microsoft/vscode-azext-azureappservice';
-import { type ExecuteActivityContext } from '@microsoft/vscode-azext-utils';
+import { type ExecuteActivityContext, type ISubscriptionActionContext } from '@microsoft/vscode-azext-utils';
 import { type AppStackMajorVersion, type AppStackMinorVersion } from './stacks/models/AppStackModel';
 import { type JavaContainers, type WebAppRuntimes, type WebAppStack, type WebAppStackValue } from './stacks/models/WebAppStackModel';
 
@@ -20,7 +20,7 @@ export type FullJavaStack = {
     minorVersion: AppStackMinorVersion<JavaContainers>;
 };
 
-export interface IWebAppWizardContext extends IAppServiceWizardContext, ExecuteActivityContext {
+export interface IWebAppWizardContext extends ISubscriptionActionContext, IAppServiceWizardContext, ExecuteActivityContext {
     newSiteRuntime?: string;
 
     usingBackupStacks?: boolean;

src/commands/createWebApp/createWebApp.ts

@@ -3,14 +3,15 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { AppInsightsCreateStep, AppInsightsListStep, AppKind, AppServicePlanCreateStep, AppServicePlanListStep, AppServicePlanSkuStep, CustomLocationListStep, LogAnalyticsCreateStep, ParsedSite, setLocationsTask, SiteNameStep } from "@microsoft/vscode-azext-azureappservice";
+import { AppInsightsCreateStep, AppInsightsListStep, AppKind, AppServicePlanCreateStep, AppServicePlanListStep, AppServicePlanSkuStep, CustomLocationListStep, DomainNameLabelScope, LogAnalyticsCreateStep, ParsedSite, setLocationsTask, SiteDomainNameLabelScopeStep, SiteNameStep } from "@microsoft/vscode-azext-azureappservice";
 import { LocationListStep, ResourceGroupCreateStep, ResourceGroupListStep, SubscriptionTreeItemBase, VerifyProvidersStep } from "@microsoft/vscode-azext-azureutils";
 import { AzureWizard, maskUserInfo, nonNullProp, parseError, type AzExtParentTreeItem, type AzureWizardExecuteStep, type AzureWizardPromptStep, type IActionContext, type ICreateChildImplContext } from "@microsoft/vscode-azext-utils";
 import { webProvider } from "../../constants";
 import { ext } from "../../extensionVariables";
 import { localize } from "../../localize";
 import { SiteTreeItem } from "../../tree/SiteTreeItem";
 import { createActivityContext } from "../../utils/activityUtils";
+import { WebAppWithDomainLabelScopeCreateStep } from "./domainLabelScope/WebAppWithDomainLabelScopeCreateStep";
 import { type IWebAppWizardContext } from "./IWebAppWizardContext";
 import { SetPostPromptDefaultsStep } from "./SetPostPromptDefaultsStep";
 import { setPrePromptDefaults } from "./setPrePromptDefaults";
@@ -43,19 +44,25 @@ export async function createWebApp(context: IActionContext & Partial<ICreateChil
 
     const promptSteps: AzureWizardPromptStep<IWebAppWizardContext>[] = [];
     const executeSteps: AzureWizardExecuteStep<IWebAppWizardContext>[] = [];
+
+    // Add these steps to the front because we need this information for checking site name availability
+    LocationListStep.addStep(wizardContext, promptSteps);
+    promptSteps.push(new SiteDomainNameLabelScopeStep());
+    if (context.advancedCreation) {
+        promptSteps.push(new ResourceGroupListStep());
+    }
+
     const siteStep: SiteNameStep = new SiteNameStep();
     promptSteps.push(siteStep);
 
     if (context.advancedCreation) {
-        promptSteps.push(new ResourceGroupListStep());
         promptSteps.push(new WebAppStackStep());
         CustomLocationListStep.addStep(wizardContext, promptSteps);
         promptSteps.push(new AppServicePlanListStep());
         promptSteps.push(new AppInsightsListStep());
     } else {
         promptSteps.push(new WebAppStackStep());
         promptSteps.push(new AppServicePlanSkuStep());
-        LocationListStep.addStep(wizardContext, promptSteps);
         executeSteps.push(new ResourceGroupCreateStep());
         executeSteps.push(new AppServicePlanCreateStep());
         executeSteps.push(new AppInsightsCreateStep());
@@ -64,7 +71,6 @@ export async function createWebApp(context: IActionContext & Partial<ICreateChil
 
     executeSteps.push(new VerifyProvidersStep([webProvider, 'Microsoft.Insights']));
     executeSteps.push(new LogAnalyticsCreateStep());
-    executeSteps.push(new WebAppCreateStep());
 
     if (wizardContext.newSiteOS !== undefined) {
         await setLocationsTask(wizardContext);
@@ -76,14 +82,18 @@ export async function createWebApp(context: IActionContext & Partial<ICreateChil
     await wizard.prompt();
 
     const newSiteName = nonNullProp(wizardContext, 'newSiteName');
-
     wizardContext.activityTitle = localize('createWebApp', 'Create Web App "{0}"', newSiteName);
 
+    if (wizardContext.newSiteDomainNameLabelScope === DomainNameLabelScope.Global) {
+        executeSteps.push(new WebAppCreateStep());
+    } else {
+        executeSteps.push(new WebAppWithDomainLabelScopeCreateStep());
+    }
+
     await wizard.execute();
     await ext.rgApi.appResourceTree.refresh(context);
 
     const rawSite = nonNullProp(wizardContext, 'site');
-    // site is set as a result of SiteCreateStep.execute()
     const site = new ParsedSite(rawSite, wizardContext);
     ext.outputChannel.appendLog(getCreatedWebAppMessage(site));
 

src/commands/createWebApp/domainLabelScope/README.md

@@ -0,0 +1,4 @@
+## Domain Label Scope
+
+The files in this folder are intended to be temporary because the App Service SDK does not currently support the required API version we need. Consequently, we needed to implement a custom call with custom types. In the future, we expect to be able to remove this folder and consolidate everything into a single web app creation file.
+