Impl

MicroFish91 · MicroFish91 · commit f1c4700c2a26 · 2023-10-08T11:24:47.000-07:00
diff --git a/package.json b/package.json
@@ -75,6 +75,11 @@
                 "title": "%containerApps.editContainerApp%",
                 "category": "Azure Container Apps"
             },
+            {
+                "command": "containerApps.updateImage",
+                "title": "%containerApps.updateImage%",
+                "category": "Azure Container Apps"
+            },
             {
                 "command": "containerApps.deployImageApi",
                 "title": "%containerApps.deployImageApi%",
@@ -328,6 +333,11 @@
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /containerAppItem/i",
                     "group": "5@1"
                 },
+                {
+                    "command": "containerApps.updateImage",
+                    "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /containerAppItem(.*)revisionMode:single/i",
+                    "group": "6@1"
+                },
                 {
                     "command": "containerApps.startStreamingLogs",
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /containerAppItem/i",
@@ -368,6 +378,11 @@
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /revisionItem(.*)revisionState:active/i",
                     "group": "2@4"
                 },
+                {
+                    "command": "containerApps.updateImage",
+                    "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /revisionDraft:false(.*)revisionItem/i",
+                    "group": "3@1"
+                },
                 {
                     "command": "containerApps.deployRevisionDraft",
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /revisionDraftItem(.*)unsavedChanges:true/i",
@@ -389,10 +404,15 @@
                     "group": "1@2"
                 },
                 {
-                    "command": "containerApps.editRevisionDraft",
+                    "command": "containerApps.updateImage",
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /revisionDraftItem/i",
                     "group": "2@1"
                 },
+                {
+                    "command": "containerApps.editRevisionDraft",
+                    "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /revisionDraftItem/i",
+                    "group": "3@1"
+                },
                 {
                     "command": "containerApps.editScaleRange",
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /scaleItem/i",
diff --git a/package.nls.json b/package.nls.json
@@ -7,6 +7,7 @@
     "containerApps.browse": "Browse",
     "containerApps.createContainerApp": "Create Container App...",
     "containerApps.editContainerApp": "Edit Container App (Advanced)...",
+    "containerApps.updateImage": "Update Container Image...",
     "containerApps.deployImageApi": "Deploy Image to Container App (API)...",
     "containerApps.deployWorkspaceProject": "Deploy Project from Workspace...",
     "containerApps.deleteContainerApp": "Delete Container App...",
diff --git a/src/commands/createContainerApp/ContainerAppCreateStep.ts b/src/commands/createContainerApp/ContainerAppCreateStep.ts
@@ -17,7 +17,7 @@ import { getContainerNameForImage } from "../image/imageSource/containerRegistry
 import type { ICreateContainerAppContext } from "./ICreateContainerAppContext";
 
 export class ContainerAppCreateStep extends ExecuteActivityOutputStepBase<ICreateContainerAppContext> {
-    public priority: number = 750;
+    public priority: number = 620;
 
     protected async executeCore(context: ICreateContainerAppContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const appClient: ContainerAppsAPIClient = await createContainerAppsAPIClient(context);
diff --git a/src/commands/image/README.md b/src/commands/image/README.md
@@ -2,5 +2,4 @@
 
 - `deployImageApi` - A command shared with the `vscode-docker` extension.  It uses our old `deployImage` command flow which immediately tries to deploy the image to a container app without creating a draft.  This command cannot be used to bundle template changes.
 
-<!-- Todo: Add this back in when update image command is added in follow-up PR -->
-<!-- - `updateContainerImage` - An ACA exclusive command that updates the container app or revision's container image through updates to a revision draft.  The draft must be deployed for the changes to take effect and can be used to bundle together `Template` changes. -->
+- `updateImage` - An ACA exclusive command that updates the container app or revision's container image via revision draft.  The draft must be deployed for the changes to take effect and can be used to bundle together `Template` changes.
diff --git a/src/commands/image/updateImage/UpdateImageStep.ts b/src/commands/image/updateImage/UpdateImageStep.ts
@@ -0,0 +1,45 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { Revision } from "@azure/arm-appcontainers";
+import { nonNullProp, randomUtils } from "@microsoft/vscode-azext-utils";
+import { Progress } from "vscode";
+import { ext } from "../../../extensionVariables";
+import { ContainerAppItem, ContainerAppModel } from "../../../tree/ContainerAppItem";
+import { RevisionsItemModel } from "../../../tree/revisionManagement/RevisionItem";
+import { localize } from "../../../utils/localize";
+import { getParentResourceFromItem } from "../../../utils/revisionDraftUtils";
+import { RevisionDraftUpdateBaseStep } from "../../revisionDraft/RevisionDraftUpdateBaseStep";
+import { getContainerNameForImage } from "../imageSource/containerRegistry/getContainerNameForImage";
+import { UpdateImageContext } from "./updateImage";
+
+export class UpdateImageStep<T extends UpdateImageContext> extends RevisionDraftUpdateBaseStep<T> {
+    public priority: number = 490;
+
+    constructor(baseItem: ContainerAppItem | RevisionsItemModel) {
+        super(baseItem);
+    }
+
+    public async execute(context: UpdateImageContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+        progress.report({ message: localize('updatingImage', 'Updating image (draft)...') });
+
+        this.revisionDraftTemplate.containers = [];
+        this.revisionDraftTemplate.containers.push({
+            env: context.environmentVariables,
+            image: context.image,
+            // We need the revision draft to always show up as having unsaved changes, we can ensure this by adding a unique ID at end of the container name
+            name: getContainerNameForImage(nonNullProp(context, 'image')) + `-${randomUtils.getRandomHexString(5)}`,
+        });
+
+        this.updateRevisionDraftWithTemplate();
+
+        const parentResource: ContainerAppModel | Revision = getParentResourceFromItem(this.baseItem);
+        ext.outputChannel.appendLog(localize('updatedImage', 'Updated container app "{0}" with image "{1}" (draft).', parentResource.name, context.image));
+    }
+
+    public shouldExecute(context: UpdateImageContext): boolean {
+        return !!context.containerApp && !!context.image;
+    }
+}
diff --git a/src/commands/image/updateImage/UpdateRegistryAndSecretsStep.ts b/src/commands/image/updateImage/UpdateRegistryAndSecretsStep.ts
@@ -0,0 +1,34 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardExecuteStep, nonNullProp } from "@microsoft/vscode-azext-utils";
+import type { Progress } from "vscode";
+import { ext } from "../../../extensionVariables";
+import { ContainerAppModel, getContainerEnvelopeWithSecrets } from "../../../tree/ContainerAppItem";
+import { localize } from "../../../utils/localize";
+import { updateContainerApp } from "../../../utils/updateContainerApp/updateContainerApp";
+import { UpdateImageContext } from "./updateImage";
+
+export class UpdateRegistryAndSecretsStep extends AzureWizardExecuteStep<UpdateImageContext> {
+    public priority: number = 480;
+
+    public async execute(context: UpdateImageContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+        progress.report({ message: localize('configuringSecrets', 'Configuring registry secrets...') });
+
+        const containerApp: ContainerAppModel = nonNullProp(context, 'containerApp');
+        const containerAppEnvelope = await getContainerEnvelopeWithSecrets(context, context.subscription, containerApp);
+
+        containerAppEnvelope.configuration.secrets = context.secrets;
+        containerAppEnvelope.configuration.registries = context.registries;
+
+        await updateContainerApp(context, context.subscription, containerAppEnvelope);
+
+        ext.outputChannel.appendLog(localize('updatedSecrets', 'Updated container app "{0}" with new registry secrets.', containerApp.name));
+    }
+
+    public shouldExecute(context: UpdateImageContext): boolean {
+        return !!context.registries && !!context.secrets;
+    }
+}
diff --git a/src/commands/image/updateImage/updateImage.ts b/src/commands/image/updateImage/updateImage.ts
@@ -0,0 +1,73 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { KnownActiveRevisionsMode, Revision } from "@azure/arm-appcontainers";
+import { VerifyProvidersStep } from "@microsoft/vscode-azext-azureutils";
+import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, ExecuteActivityContext, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { webProvider } from "../../../constants";
+import { ext } from "../../../extensionVariables";
+import { ContainerAppItem, ContainerAppModel } from "../../../tree/ContainerAppItem";
+import { RevisionDraftItem } from "../../../tree/revisionManagement/RevisionDraftItem";
+import { RevisionItem } from "../../../tree/revisionManagement/RevisionItem";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
+import { localize } from "../../../utils/localize";
+import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
+import { pickRevision, pickRevisionDraft } from "../../../utils/pickItem/pickRevision";
+import { getParentResourceFromItem } from "../../../utils/revisionDraftUtils";
+import type { ImageSourceBaseContext } from "../imageSource/ImageSourceBaseContext";
+import { ImageSourceListStep } from "../imageSource/ImageSourceListStep";
+import { UpdateImageStep } from "./UpdateImageStep";
+import { UpdateRegistryAndSecretsStep } from "./UpdateRegistryAndSecretsStep";
+
+export type UpdateImageContext = ImageSourceBaseContext & ExecuteActivityContext;
+
+export async function updateImage(context: IActionContext, node?: ContainerAppItem | RevisionItem): Promise<void> {
+    let item: ContainerAppItem | RevisionItem | RevisionDraftItem | undefined = node;
+    if (!item) {
+        const containerAppItem: ContainerAppItem = await pickContainerApp(context);
+
+        if (containerAppItem.containerApp.revisionsMode === KnownActiveRevisionsMode.Single) {
+            item = containerAppItem;
+        } else {
+            if (ext.revisionDraftFileSystem.doesContainerAppsItemHaveRevisionDraft(containerAppItem)) {
+                item = await pickRevisionDraft(context, containerAppItem);
+            } else {
+                item = await pickRevision(context, containerAppItem);
+            }
+        }
+    }
+
+    const { subscription, containerApp } = item;
+
+    const wizardContext: UpdateImageContext = {
+        ...context,
+        ...createSubscriptionContext(subscription),
+        ...await createActivityContext(),
+        subscription,
+        containerApp
+    };
+
+    const promptSteps: AzureWizardPromptStep<UpdateImageContext>[] = [
+        new ImageSourceListStep(),
+    ];
+
+    const executeSteps: AzureWizardExecuteStep<UpdateImageContext>[] = [
+        new VerifyProvidersStep([webProvider]),
+        new UpdateRegistryAndSecretsStep(),
+        new UpdateImageStep(item)
+    ];
+
+    const parentResource: ContainerAppModel | Revision = getParentResourceFromItem(item);
+
+    const wizard: AzureWizard<UpdateImageContext> = new AzureWizard(wizardContext, {
+        title: localize('updateImage', 'Update container image for "{0}" (draft)', parentResource.name),
+        promptSteps,
+        executeSteps,
+        showLoadingPrompt: true
+    });
+
+    await wizard.prompt();
+    await wizard.execute();
+}
diff --git a/src/commands/ingress/disableIngress/DisableIngressStep.ts b/src/commands/ingress/disableIngress/DisableIngressStep.ts
@@ -11,7 +11,7 @@ import { IngressUpdateStepBase } from "../IngressUpdateStepBase";
 import { isIngressEnabled } from "../isIngressEnabled";
 
 export class DisableIngressStep extends IngressUpdateStepBase<IngressContext> {
-    public priority: number = 650;
+    public priority: number = 750;
 
     public async execute(context: IngressContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const containerApp = nonNullProp(context, 'containerApp');
diff --git a/src/commands/ingress/enableIngress/EnableIngressStep.ts b/src/commands/ingress/enableIngress/EnableIngressStep.ts
@@ -14,7 +14,7 @@ import { updateContainerApp } from "../../../utils/updateContainerApp/updateCont
 import type { IngressContext } from "../IngressContext";
 
 export class EnableIngressStep extends ExecuteActivityOutputStepBase<IngressContext> {
-    public priority: number = 650;
+    public priority: number = 750;
 
     protected async executeCore(context: IngressContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         progress.report({ message: localize('enablingIngress', 'Enabling ingress...') });
diff --git a/src/commands/ingress/toggleIngressVisibility/ToggleIngressVisibilityStep.ts b/src/commands/ingress/toggleIngressVisibility/ToggleIngressVisibilityStep.ts
@@ -11,7 +11,7 @@ import type { IngressContext } from "../IngressContext";
 import { IngressUpdateStepBase } from "../IngressUpdateStepBase";
 
 export class ToggleIngressVisibilityStep extends IngressUpdateStepBase<IngressContext> {
-    public priority: number = 650;
+    public priority: number = 750;
 
     public async execute(context: IngressContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const containerApp = nonNullProp(context, 'containerApp');
diff --git a/src/commands/registerCommands.ts b/src/commands/registerCommands.ts
@@ -16,6 +16,7 @@ import { disconnectRepo } from './gitHub/disconnectRepo/disconnectRepo';
 import { openGitHubRepo } from './gitHub/openGitHubRepo';
 import { deployImageApi } from './image/deployImageApi/deployImageApi';
 import { createAcr } from './image/imageSource/containerRegistry/acr/createAcr/createAcr';
+import { updateImage } from './image/updateImage/updateImage';
 import { disableIngress } from './ingress/disableIngress/disableIngress';
 import { editTargetPort } from './ingress/editTargetPort/editTargetPort';
 import { enableIngress } from './ingress/enableIngress/enableIngress';
@@ -45,11 +46,12 @@ export function registerCommands(): void {
     registerCommandWithTreeNodeUnwrapping('containerApps.deleteManagedEnvironment', deleteManagedEnvironment);
 
     // container apps
+    registerCommandWithTreeNodeUnwrapping('containerApps.browse', browseContainerAppNode);
     registerCommandWithTreeNodeUnwrapping('containerApps.createContainerApp', createContainerApp);
-    registerCommandWithTreeNodeUnwrapping('containerApps.editContainerApp', editContainerApp);
     registerCommandWithTreeNodeUnwrapping('containerApps.deleteContainerApp', deleteContainerApp);
+    registerCommandWithTreeNodeUnwrapping('containerApps.editContainerApp', editContainerApp);
     registerCommandWithTreeNodeUnwrapping('containerApps.openConsoleInPortal', openConsoleInPortal);
-    registerCommandWithTreeNodeUnwrapping('containerApps.browse', browseContainerAppNode);
+    registerCommandWithTreeNodeUnwrapping('containerApps.updateImage', updateImage);
 
     // deploy
     registerCommandWithTreeNodeUnwrapping('containerApps.deployImageApi', deployImageApi);
diff --git a/src/commands/revisionDraft/RevisionDraftFileSystem.ts b/src/commands/revisionDraft/RevisionDraftFileSystem.ts
@@ -136,7 +136,7 @@ export class RevisionDraftFileSystem implements FileSystemProvider {
         ext.state.notifyChildrenChanged(file.containerAppId);
     }
 
-    updateRevisionDraftWithTemplate(item: RevisionsItemModel, template: Template): void {
+    updateRevisionDraftWithTemplate(item: ContainerAppItem | RevisionsItemModel, template: Template): void {
         const uri: Uri = this.buildUriFromItem(item);
         if (!this.draftStore.has(uri.path)) {
             this.createRevisionDraft(item);
diff --git a/src/commands/revisionDraft/RevisionDraftUpdateBaseStep.ts b/src/commands/revisionDraft/RevisionDraftUpdateBaseStep.ts
@@ -3,10 +3,11 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import type { Template } from "@azure/arm-appcontainers";
+import { KnownActiveRevisionsMode, type Template } from "@azure/arm-appcontainers";
 import { AzureWizardExecuteStep, nonNullValueAndProp } from "@microsoft/vscode-azext-utils";
 import type { Progress } from "vscode";
 import { ext } from "../../extensionVariables";
+import { ContainerAppItem } from "../../tree/ContainerAppItem";
 import type { RevisionsItemModel } from "../../tree/revisionManagement/RevisionItem";
 import type { IContainerAppContext } from "../IContainerAppContext";
 
@@ -16,7 +17,7 @@ export abstract class RevisionDraftUpdateBaseStep<T extends IContainerAppContext
      */
     protected revisionDraftTemplate: Template;
 
-    constructor(readonly baseItem: RevisionsItemModel) {
+    constructor(readonly baseItem: ContainerAppItem | RevisionsItemModel) {
         super();
         this.revisionDraftTemplate = this.initRevisionDraftTemplate();
     }
@@ -34,7 +35,13 @@ export abstract class RevisionDraftUpdateBaseStep<T extends IContainerAppContext
     private initRevisionDraftTemplate(): Template {
         let template: Template | undefined = ext.revisionDraftFileSystem.parseRevisionDraft(this.baseItem);
         if (!template) {
-            template = nonNullValueAndProp(this.baseItem.revision, 'template');
+            // Branching path reasoning: https://github.com/microsoft/vscode-azurecontainerapps/blob/main/src/commands/revisionDraft/README.md
+            // Make deep copies so we don't accidentally modify the cached values
+            if (ContainerAppItem.isContainerAppItem(this.baseItem) || this.baseItem.containerApp.revisionsMode === KnownActiveRevisionsMode.Single) {
+                template = JSON.parse(JSON.stringify(nonNullValueAndProp(this.baseItem.containerApp, 'template'))) as Template;
+            } else {
+                template = JSON.parse(JSON.stringify(nonNullValueAndProp(this.baseItem.revision, 'template'))) as Template;
+            }
         }
         return template;
     }
diff --git a/src/commands/scaling/scaleRule/addScaleRule/AddScaleRuleStep.ts b/src/commands/scaling/scaleRule/addScaleRule/AddScaleRuleStep.ts
@@ -9,7 +9,7 @@ import { ScaleRuleTypes } from "../../../../constants";
 import { ext } from "../../../../extensionVariables";
 import type { RevisionsItemModel } from "../../../../tree/revisionManagement/RevisionItem";
 import { localize } from "../../../../utils/localize";
-import { getParentResource } from "../../../../utils/revisionDraftUtils";
+import { getParentResourceFromItem } from "../../../../utils/revisionDraftUtils";
 import { RevisionDraftUpdateBaseStep } from "../../../revisionDraft/RevisionDraftUpdateBaseStep";
 import type { IAddScaleRuleContext } from "./IAddScaleRuleContext";
 
@@ -28,7 +28,7 @@ export class AddScaleRuleStep<T extends IAddScaleRuleContext> extends RevisionDr
         this.integrateRule(context, this.revisionDraftTemplate.scale.rules, context.scaleRule);
         this.updateRevisionDraftWithTemplate();
 
-        const resourceName = getParentResource(context.containerApp, this.baseItem.revision).name;
+        const resourceName = getParentResourceFromItem(this.baseItem).name;
         ext.outputChannel.appendLog(localize('addedScaleRule', 'Added {0} rule "{1}" to "{2}" (draft)', context.newRuleType, context.newRuleName, resourceName));
     }
 
diff --git a/src/commands/scaling/scaleRule/deleteScaleRule/DeleteScaleRuleStep.ts b/src/commands/scaling/scaleRule/deleteScaleRule/DeleteScaleRuleStep.ts
diff --git a/src/constants.ts b/src/constants.ts
diff --git a/src/tree/revisionManagement/RevisionItem.ts b/src/tree/revisionManagement/RevisionItem.ts
diff --git a/src/tree/revisionManagement/RevisionsItem.ts b/src/tree/revisionManagement/RevisionsItem.ts
