Add Basic and Advanced flow for Deploy Workspace Project (#961)

Author: MicroFish91

package-lock.json

@@ -862,9 +862,9 @@
         "@azure/storage-blob": "^12.4.1",
         "@fluentui/react-components": "^9.56.2",
         "@fluentui/react-icons": "^2.0.265",
-        "@microsoft/vscode-azext-azureutils": "^3.3.3",
+        "@microsoft/vscode-azext-azureutils": "^3.5.0",
         "@microsoft/vscode-azext-github": "^1.0.4",
-        "@microsoft/vscode-azext-utils": "^3.3.3",
+        "@microsoft/vscode-azext-utils": "^3.4.0",
         "@microsoft/vscode-azureresources-api": "^2.0.2",
         "@vscode/codicons": "0.0.38",
         "buffer": "^6.0.3",

package.json

@@ -11,3 +11,8 @@ export interface ManagedEnvironmentRequiredContext extends ISubscriptionActionCo
     subscription: AzureSubscription;
     managedEnvironment: ManagedEnvironment;
 }
+
+export interface ManagedEnvironmentContext extends ISubscriptionActionContext {
+    subscription: AzureSubscription;
+    managedEnvironment?: ManagedEnvironment;
+}

src/commands/ManagedEnvironmentContext.ts

@@ -4,17 +4,18 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { type ContainerApp, type ManagedEnvironment } from "@azure/arm-appcontainers";
+import { type Registry } from "@azure/arm-containerregistry";
 import { type ResourceGroup } from "@azure/arm-resources";
 import { LocationListStep, type ILocationWizardContext } from "@microsoft/vscode-azext-azureutils";
-import { ActivityChildItem, ActivityChildType, activityInfoIcon, AzureWizardPromptStep, createContextValue, type ExecuteActivityContext, type IActionContext } from "@microsoft/vscode-azext-utils";
+import { ActivityChildItem, ActivityChildType, activityInfoIcon, AzureWizardPromptStep, createContextValue, prependOrInsertAfterLastInfoChild, type ActivityInfoChild, type ExecuteActivityContext, type IActionContext } from "@microsoft/vscode-azext-utils";
 import { activityInfoContext } from "../constants";
 import { ext } from "../extensionVariables";
-import { prependOrInsertAfterLastInfoChild } from "../utils/activityUtils";
 import { localize } from "../utils/localize";
 
 type StartingResourcesLogContext = IActionContext & Partial<ExecuteActivityContext> & ILocationWizardContext & {
     resourceGroup?: ResourceGroup,
     managedEnvironment?: ManagedEnvironment,
+    registry?: Registry;
     containerApp?: ContainerApp
 };
 
@@ -26,17 +27,13 @@ const startingResourcesContext: string = 'startingResourcesLogStepItem';
  */
 export class StartingResourcesLogStep<T extends StartingResourcesLogContext> extends AzureWizardPromptStep<T> {
     public hideStepCount: boolean = true;
-    protected hasLogged: boolean = false;
 
     /**
      * Implement if you require additional context loading before resource logging
      */
     protected configureStartingResources?(context: T): void | Promise<void>;
 
     public async configureBeforePrompt(context: T): Promise<void> {
-        if (this.hasLogged) {
-            return;
-        }
         await this.configureStartingResources?.(context);
         await this.logStartingResources(context);
     }
@@ -50,47 +47,71 @@ export class StartingResourcesLogStep<T extends StartingResourcesLogContext> ext
     }
 
     protected async logStartingResources(context: T): Promise<void> {
+        // Resource group
         if (context.resourceGroup) {
             prependOrInsertAfterLastInfoChild(context,
                 new ActivityChildItem({
                     contextValue: createContextValue([startingResourcesContext, activityInfoContext]),
                     label: localize('useResourceGroup', 'Use resource group "{0}"', context.resourceGroup.name),
                     activityType: ActivityChildType.Info,
-                    iconPath: activityInfoIcon
-                })
+                    iconPath: activityInfoIcon,
+                    stepId: this.id,
+                }) as ActivityInfoChild,
             );
             ext.outputChannel.appendLog(localize('usingResourceGroup', 'Using resource group "{0}".', context.resourceGroup.name));
         }
+        context.telemetry.properties.existingResourceGroup = String(!!context.resourceGroup);
 
+        // Managed environment
         if (context.managedEnvironment) {
             prependOrInsertAfterLastInfoChild(context,
                 new ActivityChildItem({
                     label: localize('useManagedEnvironment', 'Use managed environment "{0}"', context.managedEnvironment.name),
                     contextValue: createContextValue([startingResourcesContext, activityInfoContext]),
                     activityType: ActivityChildType.Info,
-                    iconPath: activityInfoIcon
-                }),
+                    iconPath: activityInfoIcon,
+                    stepId: this.id,
+                }) as ActivityInfoChild,
             );
             ext.outputChannel.appendLog(localize('usingManagedEnvironment', 'Using managed environment "{0}".', context.managedEnvironment.name));
         }
+        context.telemetry.properties.existingEnvironment = String(!!context.managedEnvironment);
+
+        // Container registry
+        if (context.registry) {
+            prependOrInsertAfterLastInfoChild(context,
+                new ActivityChildItem({
+                    label: localize('useAcr', 'Use container registry "{0}"', context.registry.name),
+                    contextValue: createContextValue([startingResourcesContext, activityInfoContext]),
+                    activityType: ActivityChildType.Info,
+                    iconPath: activityInfoIcon,
+                    stepId: this.id,
+                }) as ActivityInfoChild,
+            );
+            ext.outputChannel.appendLog(localize('usingAcr', 'Using Azure Container Registry "{0}".', context.registry.name));
+        }
+        context.telemetry.properties.existingRegistry = String(!!context.registry);
 
+        // Container app
         if (context.containerApp) {
             prependOrInsertAfterLastInfoChild(context,
                 new ActivityChildItem({
                     label: localize('useContainerApp', 'Use container app "{0}"', context.containerApp.name),
                     contextValue: createContextValue([startingResourcesContext, activityInfoContext]),
                     activityType: ActivityChildType.Info,
                     iconPath: activityInfoIcon,
-                }),
+                    stepId: this.id,
+                }) as ActivityInfoChild,
             );
             ext.outputChannel.appendLog(localize('usingContainerApp', 'Using container app "{0}".', context.containerApp.name));
         }
+        context.telemetry.properties.existingContainerApp = String(!!context.containerApp);
 
+        // Location
         if (LocationListStep.hasLocation(context)) {
             const location: string = (await LocationListStep.getLocation(context)).name;
             ext.outputChannel.appendLog(localize('usingLocation', 'Using location: "{0}".', location));
         }
-
-        this.hasLogged = true;
+        context.telemetry.properties.existingLocation = String(!!LocationListStep.hasLocation(context));
     }
 }

src/commands/StartingResourcesLogStep.ts

@@ -1,20 +1,21 @@
 # Change Log
 
-### 0.0.3
+## 1.0.0
+### Changed
+* [[961](https://github.com/microsoft/vscode-azurecontainerapps/pull/961)] Add a new resource location parameter to the `deployWorkspaceProjectApi` definition.  If no location is provided, try to infer location via other provided resources.
+* [[961](https://github.com/microsoft/vscode-azurecontainerapps/pull/961)] Suppress registry prompting by default and remove associated flag (`suppressRegistryPrompt`)
 
+## 0.0.3
 ### Added
 * [[817]](https://github.com/microsoft/vscode-azurecontainerapps/pull/817) Added an API entry-point and compat wrapper for existing `deployImageApi` command
 
 ### Changed
 * [[816]](https://github.com/microsoft/vscode-azurecontainerapps/pull/816) Added backward compatibility to ensure existing functionality remains unaffected by new managed identity features.
 
-### 0.0.2
-
+## 0.0.2
 ### Changed
 * [[615]](https://github.com/microsoft/vscode-azurecontainerapps/pull/615) Removed ability to set option `ignoreExistingDeploySettings`. This will now happen automatically by default.
 
 ## 0.0.1
-* Initial release
-
 ### Added
 * [[578]](https://github.com/microsoft/vscode-azurecontainerapps/pull/578) Added an API entry-point to the `deployWorkspaceProject` command

src/commands/api/CHANGELOG.md

@@ -4,8 +4,8 @@
 *--------------------------------------------------------------------------------------------*/
 
 import { type ResourceGroup } from "@azure/arm-resources";
-import { ResourceGroupListStep, parseAzureResourceGroupId } from "@microsoft/vscode-azext-azureutils";
-import { callWithTelemetryAndErrorHandling, createSubscriptionContext, subscriptionExperience, type IActionContext, type ISubscriptionActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { LocationListStep, ResourceGroupListStep, parseAzureResourceGroupId } from "@microsoft/vscode-azext-azureutils";
+import { callWithTelemetryAndErrorHandling, createSubscriptionContext, nonNullValueAndProp, subscriptionExperience, type IActionContext, type ISubscriptionActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { type AzureSubscription } from "@microsoft/vscode-azureresources-api";
 import { Uri, type WorkspaceFolder } from "vscode";
 import { ext } from "../../extensionVariables";
@@ -22,10 +22,10 @@ export async function deployWorkspaceProjectApi(deployWorkspaceProjectOptions: a
     return await callWithTelemetryAndErrorHandling('containerApps.api.deployWorkspaceProject', async (context: IActionContext): Promise<DeployWorkspaceProjectResults> => {
         const {
             resourceGroupId,
+            location,
             rootPath,
             dockerfilePath,
             srcPath,
-            suppressRegistryPrompt,
             suppressConfirmation,
             suppressContainerAppCreation,
             shouldSaveDeploySettings
@@ -52,10 +52,15 @@ export async function deployWorkspaceProjectApi(deployWorkspaceProjectOptions: a
             shouldSaveDeploySettings: !!shouldSaveDeploySettings,
         });
 
+        if (location || deployWorkspaceProjectInternalContext.resourceGroup) {
+            const autoSelectLocation = location ?? nonNullValueAndProp(deployWorkspaceProjectInternalContext.resourceGroup, 'location');
+            await LocationListStep.setAutoSelectLocation(deployWorkspaceProjectInternalContext, autoSelectLocation);
+        }
+
         const deployWorkspaceProjectContext: DeployWorkspaceProjectContext = await deployWorkspaceProjectInternal(deployWorkspaceProjectInternalContext, {
+            advancedCreate: false,
             suppressActivity: true,
             suppressConfirmation,
-            suppressRegistryPrompt: suppressRegistryPrompt ?? true,
             suppressContainerAppCreation,
             suppressProgress: true,
             suppressWizardTitle: true,

src/commands/api/deployWorkspaceProjectApi.ts

@@ -10,9 +10,7 @@ import type * as api from "./vscode-azurecontainerapps.api";
 
 export function getAzureContainerAppsApiProvider(): apiUtils.AzureExtensionApiProvider {
     return createApiProvider([<api.AzureContainerAppsExtensionApi>{
-        // Todo: Change this to 0.0.3 later.  0.0.3 is backwards compatible anyway so this change should be fine either way.
-        // For some reason it's causing a block on Function side, so just keep it at 0.0.1 until we figure out why
-        apiVersion: '0.0.1',
+        apiVersion: '1.0.0',
         deployImage: deployImageApi,
         deployWorkspaceProject: deployWorkspaceProjectApi,
     }]);

src/commands/api/getAzureContainerAppsApiProvider.ts

@@ -22,14 +22,14 @@ export interface DeployWorkspaceProjectOptionsContract {
     // Existing resources
     subscriptionId?: string;
     resourceGroupId?: string;
+    location?: string;
 
     // Workspace deployment paths (absolute fs path)
     rootPath?: string;
     srcPath?: string;
     dockerfilePath?: string;
 
     // Options
-    suppressRegistryPrompt?: boolean;
     suppressConfirmation?: boolean;  // Suppress any [resource] confirmation prompts
     suppressContainerAppCreation?: boolean;
     shouldSaveDeploySettings?: boolean;

src/commands/api/vscode-azurecontainerapps.api.d.ts

@@ -7,7 +7,7 @@ import { KnownActiveRevisionsMode, type ContainerAppsAPIClient, type Ingress } f
 import { LocationListStep } from "@microsoft/vscode-azext-azureutils";
 import { AzureWizardExecuteStepWithActivityOutput, nonNullProp, nonNullValueAndProp, type AzureWizardExecuteStep } from "@microsoft/vscode-azext-utils";
 import { type Progress } from "vscode";
-import { containerAppsWebProvider, ImageSource } from "../../constants";
+import { ImageSource } from "../../constants";
 import { ContainerAppItem } from "../../tree/ContainerAppItem";
 import { createContainerAppsAPIClient } from "../../utils/azureClients";
 import { localize } from "../../utils/localize";
@@ -37,7 +37,7 @@ export class ContainerAppCreateStep<T extends ContainerAppCreateContext> extends
         } : undefined;
 
         context.containerApp = ContainerAppItem.CreateContainerAppModel(await appClient.containerApps.beginCreateOrUpdateAndWait(resourceGroupName, containerAppName, {
-            location: (await LocationListStep.getLocation(context, containerAppsWebProvider)).name,
+            location: (await LocationListStep.getLocation(context)).name,
             managedEnvironmentId: context.managedEnvironment?.id,
             configuration: {
                 ingress,