Add deployImage as part of API export, add additional activity children, and allow more flexible deployment targets (#817)

Author: MicroFish91

src/commands/api/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### 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.
 

src/commands/api/deployImageApi.ts

@@ -0,0 +1,55 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { callWithMaskHandling, callWithTelemetryAndErrorHandling, createSubscriptionContext, type ExecuteActivityContext, type IActionContext, type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils";
+import { ImageSource, acrDomain } from "../../constants";
+import { type DeployImageApiTelemetryProps as TelemetryProps } from "../../telemetry/commandTelemetryProps";
+import { type SetTelemetryProps } from "../../telemetry/SetTelemetryProps";
+import { getDomainFromRegistryName, getRegistryFromAcrName } from "../../utils/imageNameUtils";
+import { pickContainer } from "../../utils/pickItem/pickContainer";
+import { deployImage } from "../deployImage/deployImage";
+import { type ContainerRegistryImageSourceContext } from "../image/imageSource/containerRegistry/ContainerRegistryImageSourceContext";
+import { type ImageSourceBaseContext } from "../image/imageSource/ImageSourceContext";
+import { type DeployImageToAcaOptionsContract } from "./vscode-azurecontainerapps.api";
+
+export type DeployImageApiContext = ImageSourceBaseContext & ExecuteActivityContext & SetTelemetryProps<TelemetryProps>;
+
+export async function deployImageApi(deployImageOptions: DeployImageToAcaOptionsContract): Promise<void> {
+    return await callWithTelemetryAndErrorHandling('containerApps.api.deployImage', async (context: IActionContext & Partial<ContainerRegistryImageSourceContext>) => {
+        const node = await pickContainer(context);
+        const { subscription } = node;
+
+        Object.assign(context, { ...createSubscriptionContext(subscription), imageSource: ImageSource.ContainerRegistry }, deployImageOptions);
+
+        context.registryDomain = getDomainFromRegistryName(deployImageOptions.registryName);
+        if (context.registryDomain === acrDomain) {
+            context.registry = await getRegistryFromAcrName(<ISubscriptionActionContext>context, deployImageOptions.registryName);
+        }
+
+        // Mask sensitive data
+        if (deployImageOptions.secret) {
+            context.valuesToMask.push(deployImageOptions.secret);
+        }
+        if (deployImageOptions.username) {
+            context.valuesToMask.push(deployImageOptions.username);
+        }
+        context.valuesToMask.push(deployImageOptions.image);
+
+        if (deployImageOptions.secret) {
+            context.telemetry.properties.hasRegistrySecrets = 'true';
+            return callWithMaskHandling<void>(() => deployImage(context, node), deployImageOptions.secret);
+        } else {
+            context.telemetry.properties.hasRegistrySecrets = 'false';
+            return deployImage(context, node);
+        }
+    });
+}
+
+/**
+ * A compatibility wrapper for the legacy entrypoint utilizing `deployImageApi`
+ */
+export async function deployImageApiCompat(_: IActionContext & Partial<ContainerRegistryImageSourceContext>, deployImageOptions: DeployImageToAcaOptionsContract): Promise<void> {
+    return await deployImageApi(deployImageOptions);
+}

src/commands/api/getAzureContainerAppsApiProvider.ts

@@ -4,6 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 
 import { createApiProvider, type apiUtils } from "@microsoft/vscode-azext-utils";
+import { deployImageApi } from "./deployImageApi";
 import { deployWorkspaceProjectApi } from "./deployWorkspaceProjectApi";
 import type * as api from "./vscode-azurecontainerapps.api";
 
@@ -12,6 +13,7 @@ export function getAzureContainerAppsApiProvider(): apiUtils.AzureExtensionApiPr
         // 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',
-        deployWorkspaceProject: deployWorkspaceProjectApi
+        deployImage: deployImageApi,
+        deployWorkspaceProject: deployWorkspaceProjectApi,
     }]);
 }

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

@@ -8,6 +8,15 @@ export interface AzureContainerAppsExtensionApi {
     deployWorkspaceProject(options: DeployWorkspaceProjectOptionsContract): Promise<DeployWorkspaceProjectResults>;
 }
 
+// The interface of the command options passed to the Azure Container Apps extension's deployImageToAca command
+// This interface is shared with the Docker extension (https://github.com/microsoft/vscode-docker)
+export interface DeployImageToAcaOptionsContract {
+    image: string;
+    registryName: string;
+    username?: string;
+    secret?: string;
+}
+
 export interface DeployWorkspaceProjectOptionsContract {
     // Existing resources
     subscriptionId?: string;

src/commands/deployImage/DeployImageContext.ts

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type Template } from "@azure/arm-appcontainers";
+import { type DeployImageApiContext } from "../api/deployImageApi";
+
+export interface DeployImageContext extends DeployImageApiContext {
+    containersIdx: number;
+    template: Template;
+}

src/commands/deployImage/deployImage.ts

@@ -0,0 +1,91 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type ResourceGroup } from "@azure/arm-resources";
+import { LocationListStep, ResourceGroupListStep } from "@microsoft/vscode-azext-azureutils";
+import { activityInfoIcon, activitySuccessContext, AzureWizard, createSubscriptionContext, createUniversallyUniqueContextValue, GenericTreeItem, nonNullValue, nonNullValueAndProp, type IActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { ext } from "../../extensionVariables";
+import { type ContainerItem } from "../../tree/containers/ContainerItem";
+import { createActivityContext } from "../../utils/activityUtils";
+import { isAzdExtensionInstalled } from "../../utils/azdUtils";
+import { getManagedEnvironmentFromContainerApp } from "../../utils/getResourceUtils";
+import { getVerifyProvidersStep } from "../../utils/getVerifyProvidersStep";
+import { localize } from "../../utils/localize";
+import { getParentResource } from "../../utils/revisionDraftUtils";
+import { ContainerAppOverwriteConfirmStep } from "../ContainerAppOverwriteConfirmStep";
+import { showContainerAppNotification } from "../createContainerApp/showContainerAppNotification";
+import { ContainerAppUpdateStep } from "../image/imageSource/ContainerAppUpdateStep";
+import { ImageSourceListStep } from "../image/imageSource/ImageSourceListStep";
+import { type ContainerRegistryImageSourceContext } from "../image/imageSource/containerRegistry/ContainerRegistryImageSourceContext";
+import { type DeployImageContext } from "./DeployImageContext";
+
+export async function deployImage(context: IActionContext & Partial<ContainerRegistryImageSourceContext>, node: ContainerItem): Promise<void> {
+    const { subscription, containerApp } = node;
+    const subscriptionContext: ISubscriptionContext = createSubscriptionContext(subscription);
+
+    const wizardContext: DeployImageContext = {
+        ...context,
+        ...subscriptionContext,
+        ...await createActivityContext(true),
+        subscription,
+        managedEnvironment: await getManagedEnvironmentFromContainerApp({ ...context, ...subscriptionContext }, containerApp),
+        containerApp,
+        containersIdx: node.containersIdx,
+        template: nonNullValueAndProp(getParentResource(containerApp, node.revision), 'template'),
+    };
+
+    if (isAzdExtensionInstalled()) {
+        wizardContext.telemetry.properties.isAzdExtensionInstalled = 'true';
+    }
+
+    const resourceGroups: ResourceGroup[] = await ResourceGroupListStep.getResourceGroups(wizardContext);
+    wizardContext.resourceGroup = nonNullValue(
+        resourceGroups.find(rg => rg.name === containerApp.resourceGroup),
+        localize('containerAppResourceGroup', 'Expected to find the container app\'s resource group.'),
+    );
+
+    // Log resource group
+    wizardContext.activityChildren?.push(
+        new GenericTreeItem(undefined, {
+            contextValue: createUniversallyUniqueContextValue(['useExistingResourceGroupInfoItem', activitySuccessContext]),
+            label: localize('useResourceGroup', 'Using resource group "{0}"', wizardContext.resourceGroup.name),
+            iconPath: activityInfoIcon
+        })
+    );
+    ext.outputChannel.appendLog(localize('usingResourceGroup', 'Using resource group "{0}".', wizardContext.resourceGroup.name));
+
+    // Log container app
+    wizardContext.activityChildren?.push(
+        new GenericTreeItem(undefined, {
+            contextValue: createUniversallyUniqueContextValue(['useExistingContainerAppInfoItem', activitySuccessContext]),
+            label: localize('useContainerApp', 'Using container app "{0}"', wizardContext.containerApp?.name),
+            iconPath: activityInfoIcon
+        })
+    );
+    ext.outputChannel.appendLog(localize('usingContainerApp', 'Using container app "{0}".', wizardContext.containerApp?.name));
+
+    await LocationListStep.setLocation(wizardContext, containerApp.location);
+
+    const parentResourceName: string = getParentResource(containerApp, node.revision).name ?? containerApp.name;
+    const wizard: AzureWizard<DeployImageContext> = new AzureWizard(wizardContext, {
+        title: localize('deployImageTitle', 'Deploy image to "{0}"', parentResourceName),
+        promptSteps: [
+            new ImageSourceListStep(),
+            new ContainerAppOverwriteConfirmStep(),
+        ],
+        executeSteps: [
+            getVerifyProvidersStep<DeployImageContext>(),
+            new ContainerAppUpdateStep(),
+        ],
+        showLoadingPrompt: true
+    });
+
+    await wizard.prompt();
+    await wizard.execute();
+
+    if (!wizardContext.suppressNotification) {
+        void showContainerAppNotification(containerApp, true /** isUpdate */);
+    }
+}

src/commands/image/deployImageApi/deployImage.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { type Ingress } from "@azure/arm-appcontainers";
+import { type Container, type Ingress } from "@azure/arm-appcontainers";
 import { activityFailContext, activityFailIcon, activitySuccessContext, activitySuccessIcon, AzureWizardExecuteStep, createUniversallyUniqueContextValue, GenericParentTreeItem, GenericTreeItem, nonNullProp, type ExecuteActivityOutput } from "@microsoft/vscode-azext-utils";
 import * as retry from "p-retry";
 import { type Progress } from "vscode";
@@ -57,15 +57,19 @@ export class ContainerAppUpdateStep<T extends ImageSourceContext & IngressContex
         containerAppEnvelope.configuration.secrets = context.secrets;
         containerAppEnvelope.configuration.registries = context.registryCredentials;
 
-        // We want to replace the old image
-        containerAppEnvelope.template ||= {};
-        containerAppEnvelope.template.containers = [];
+        containerAppEnvelope.template = context.template ?? containerAppEnvelope.template ?? {};
+        containerAppEnvelope.template.containers ||= [];
 
-        containerAppEnvelope.template.containers.push({
+        const newContainer: Container = {
             env: context.environmentVariables,
             image: context.image,
             name: getContainerNameForImage(nonNullProp(context, 'image')),
-        });
+        };
+        if (context.containersIdx) {
+            containerAppEnvelope.template.containers[context.containersIdx] = newContainer;
+        } else {
+            containerAppEnvelope.template.containers = [newContainer];
+        }
 
         // Related: https://github.com/microsoft/vscode-azurecontainerapps/pull/805
         const retries = 4;

src/commands/image/deployImageApi/deployImageApi.ts

@@ -38,7 +38,7 @@ export class EnvFileListStep<T extends EnvFileListContext> extends AzureWizardPr
     }
 
     public async prompt(context: T): Promise<void> {
-        const existingData = context.containerApp?.template?.containers?.[context.containersIdx ?? 0].env;
+        const existingData = context.template?.containers?.[context.containersIdx ?? 0].env ?? context.containerApp?.template?.containers?.[context.containersIdx ?? 0].env;
         context.envPath ??= await this.promptForEnvPath(context, !!existingData /** showHasExistingData */);
 
         if (!context.envPath && existingData) {