Add deleteEnvironmentVariable command (#798)

Author: MicroFish91

package.json

@@ -225,6 +225,12 @@
                 "title": "%containerApps.editEnvironmentVariables%",
                 "category": "Azure Container Apps"
             },
+            {
+                "command": "containerApps.deleteEnvironmentVariable",
+                "title": "%containerApps.deleteEnvironmentVariable.title%",
+                "shortTitle": "%containerApps.deleteEnvironmentVariable.shortTitle%",
+                "category": "Azure Container Apps"
+            },
             {
                 "command": "containerApps.editScaleRange",
                 "title": "%containerApps.editScaleRange%",
@@ -505,6 +511,11 @@
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /environmentVariableItem/i",
                     "group": "1@1"
                 },
+                {
+                    "command": "containerApps.deleteEnvironmentVariable",
+                    "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /environmentVariableItem/i",
+                    "group": "1@2"
+                },
                 {
                     "command": "containerApps.editScaleRange",
                     "when": "view =~ /(azureResourceGroups|azureFocusView)/ && viewItem =~ /scaleItem/i",

package.nls.json

@@ -16,6 +16,8 @@
     "containerApps.editEnvironmentVariableName.title": "Edit Environment Variable Name...",
     "containerApps.editEnvironmentVariableName.shortTitle": "Edit Name...",
     "containerApps.editEnvironmentVariables": "Edit Environment Variables (.env)...",
+    "containerApps.deleteEnvironmentVariable.title": "Delete Environment Variable...",
+    "containerApps.deleteEnvironmentVariable.shortTitle": "Delete...",
     "containerApps.deployImageApi": "Deploy Image to Container App (API)...",
     "containerApps.deployWorkspaceProject": "Deploy Project from Workspace...",
     "containerApps.deployWorkspaceProjectApi": "Deploy Project from Workspace (API)...",

src/commands/environmentVariables/deleteEnvironmentVariable/EnvironmentVariableDeleteContext.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type EnvironmentVar } from "@azure/arm-appcontainers";
+import { type SetTelemetryProps } from "../../../telemetry/SetTelemetryProps";
+import { type ContainerUpdateTelemetryProps as TelemetryProps } from "../../../telemetry/commandTelemetryProps";
+import { type EnvironmentVariablesBaseContext } from "../EnvironmentVariablesContext";
+
+export interface EnvironmentVariableDeleteBaseContext extends EnvironmentVariablesBaseContext {
+    // Require the environment variable upfront so we can delete
+    environmentVariable: EnvironmentVar;
+}
+
+export type EnvironmentVariableDeleteContext = EnvironmentVariableDeleteBaseContext & SetTelemetryProps<TelemetryProps>;

src/commands/environmentVariables/deleteEnvironmentVariable/EnvironmentVariableDeleteDraftStep.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 { type Container } from "@azure/arm-appcontainers";
+import { type Progress } from "vscode";
+import { type ContainerAppItem } from "../../../tree/ContainerAppItem";
+import { type RevisionsItemModel } from "../../../tree/revisionManagement/RevisionItem";
+import { localize } from "../../../utils/localize";
+import { RevisionDraftUpdateBaseStep } from "../../revisionDraft/RevisionDraftUpdateBaseStep";
+import { type EnvironmentVariableDeleteContext } from "./EnvironmentVariableDeleteContext";
+
+export class EnvironmentVariableDeleteDraftStep<T extends EnvironmentVariableDeleteContext> extends RevisionDraftUpdateBaseStep<T> {
+    public priority: number = 590;
+
+    constructor(baseItem: ContainerAppItem | RevisionsItemModel) {
+        super(baseItem);
+    }
+
+    public async execute(context: T, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+        progress.report({ message: localize('deletingEnv', 'Deleting environment variable (draft)...') });
+        this.revisionDraftTemplate.containers ??= [];
+
+        const container: Container = this.revisionDraftTemplate.containers[context.containersIdx] ?? {};
+        container.env = container.env?.filter(env => env.name !== context.environmentVariable.name) ?? [];
+
+        await this.updateRevisionDraftWithTemplate(context);
+    }
+
+    public shouldExecute(context: T): boolean {
+        return !!context.environmentVariable;
+    }
+}

src/commands/environmentVariables/deleteEnvironmentVariable/deleteEnvironmentVariable.ts

@@ -0,0 +1,58 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the MIT License. See License.md in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { type Revision } from "@azure/arm-appcontainers";
+import { AzureWizard, createSubscriptionContext, DeleteConfirmationStep, type IActionContext, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
+import { type ContainerAppModel } from "../../../tree/ContainerAppItem";
+import { type EnvironmentVariableItem } from "../../../tree/containers/EnvironmentVariableItem";
+import { createActivityContext } from "../../../utils/activityUtils";
+import { getManagedEnvironmentFromContainerApp } from "../../../utils/getResourceUtils";
+import { getVerifyProvidersStep } from "../../../utils/getVerifyProvidersStep";
+import { localize } from "../../../utils/localize";
+import { pickEnvironmentVariable } from "../../../utils/pickItem/pickEnvironmentVariables";
+import { getParentResourceFromItem, isTemplateItemEditable, TemplateItemNotEditableError } from "../../../utils/revisionDraftUtils";
+import { RevisionDraftDeployPromptStep } from "../../revisionDraft/RevisionDraftDeployPromptStep";
+import { type EnvironmentVariableDeleteContext } from "./EnvironmentVariableDeleteContext";
+import { EnvironmentVariableDeleteDraftStep } from "./EnvironmentVariableDeleteDraftStep";
+
+export async function deleteEnvironmentVariable(context: IActionContext, node?: EnvironmentVariableItem): Promise<void> {
+    const item: EnvironmentVariableItem = node ?? await pickEnvironmentVariable(context, { autoSelectDraft: true });
+    const { subscription, containerApp } = item;
+
+    if (!isTemplateItemEditable(item)) {
+        throw new TemplateItemNotEditableError(item);
+    }
+
+    const subscriptionContext: ISubscriptionContext = createSubscriptionContext(subscription);
+    const parentResource: ContainerAppModel | Revision = getParentResourceFromItem(item);
+
+    const wizardContext: EnvironmentVariableDeleteContext = {
+        ...context,
+        ...subscriptionContext,
+        ...await createActivityContext(),
+        subscription,
+        managedEnvironment: await getManagedEnvironmentFromContainerApp({ ...context, ...subscriptionContext }, containerApp),
+        containerApp,
+        containersIdx: item.containersIdx,
+        environmentVariable: item.envVariable,
+    };
+    wizardContext.telemetry.properties.revisionMode = containerApp.revisionsMode;
+
+    const confirmMessage: string = localize('confirmDeleteEnv', 'Are you sure you want to delete environment variable "{0}" locally?\n\nThis change will not be reflected in your container app until you deploy changes.', item.envVariable.name);
+    const wizard: AzureWizard<EnvironmentVariableDeleteContext> = new AzureWizard(wizardContext, {
+        title: localize('deleteEnvironmentVariable', 'Delete environment variable "{0}" from "{1}" (draft)', item.envVariable.name, parentResource.name),
+        promptSteps: [
+            new DeleteConfirmationStep(confirmMessage),
+            new RevisionDraftDeployPromptStep(),
+        ],
+        executeSteps: [
+            getVerifyProvidersStep<EnvironmentVariableDeleteContext>(),
+            new EnvironmentVariableDeleteDraftStep(item),
+        ],
+    });
+
+    await wizard.prompt();
+    await wizard.execute();
+}

src/commands/environmentVariables/editEnvironmentVariable/editEnvironmentVariableName.ts

@@ -13,6 +13,7 @@ import { getVerifyProvidersStep } from "../../../utils/getVerifyProvidersStep";
 import { localize } from "../../../utils/localize";
 import { pickEnvironmentVariable } from "../../../utils/pickItem/pickEnvironmentVariables";
 import { getParentResourceFromItem, isTemplateItemEditable, TemplateItemNotEditableError } from "../../../utils/revisionDraftUtils";
+import { RevisionDraftDeployPromptStep } from "../../revisionDraft/RevisionDraftDeployPromptStep";
 import { EnvironmentVariableNameStep } from "../addEnvironmentVariable/EnvironmentVariableNameStep";
 import { type EnvironmentVariableEditContext } from "./EnvironmentVariableEditContext";
 import { EnvironmentVariableEditDraftStep } from "./EnvironmentVariableEditDraftStep";
@@ -44,6 +45,7 @@ export async function editEnvironmentVariableName(context: IActionContext, node?
         title: localize('editEnvironmentVariableTitle', 'Edit environment variable name in "{0}" (draft)', parentResource.name),
         promptSteps: [
             new EnvironmentVariableNameStep(item),
+            new RevisionDraftDeployPromptStep(),
         ],
         executeSteps: [
             getVerifyProvidersStep<EnvironmentVariableEditContext>(),

src/commands/environmentVariables/editEnvironmentVariables/editEnvironmentVariables.ts

@@ -14,6 +14,7 @@ import { localize } from "../../../utils/localize";
 import { pickEnvironmentVariables } from "../../../utils/pickItem/pickEnvironmentVariables";
 import { getParentResourceFromItem, isTemplateItemEditable, TemplateItemNotEditableError } from "../../../utils/revisionDraftUtils";
 import { EnvFileListStep } from "../../image/imageSource/EnvFileListStep";
+import { RevisionDraftDeployPromptStep } from "../../revisionDraft/RevisionDraftDeployPromptStep";
 import { type EnvironmentVariablesEditContext } from "./EnvironmentVariablesEditContext";
 import { EnvironmentVariablesEditDraftStep } from "./EnvironmentVariablesEditDraftStep";
 
@@ -43,6 +44,7 @@ export async function editEnvironmentVariables(context: IActionContext, node?: E
         title: localize('editEnvironmentVariables', 'Edit environment variables for "{0}" (draft)', parentResource.name),
         promptSteps: [
             new EnvFileListStep({ suppressSkipPick: true }),
+            new RevisionDraftDeployPromptStep(),
         ],
         executeSteps: [
             getVerifyProvidersStep<EnvironmentVariablesEditContext>(),

src/commands/image/imageSource/EnvironmentVariablesListStep.ts

@@ -15,6 +15,7 @@ import { editContainer } from './editContainer/editContainer';
 import { editContainerImage } from './editContainer/editContainerImage/editContainerImage';
 import { editContainerApp } from './editContainerApp';
 import { addEnvironmentVariable } from './environmentVariables/addEnvironmentVariable/addEnvironmentVariable';
+import { deleteEnvironmentVariable } from './environmentVariables/deleteEnvironmentVariable/deleteEnvironmentVariable';
 import { editEnvironmentVariableName } from './environmentVariables/editEnvironmentVariable/editEnvironmentVariableName';
 import { editEnvironmentVariables } from './environmentVariables/editEnvironmentVariables/editEnvironmentVariables';
 import { connectToGitHub } from './gitHub/connectToGitHub/connectToGitHub';
@@ -75,6 +76,7 @@ export function registerCommands(): void {
     registerCommandWithTreeNodeUnwrapping('containerApps.addEnvironmentVariable', addEnvironmentVariable);
     registerCommandWithTreeNodeUnwrapping('containerApps.editEnvironmentVariableName', editEnvironmentVariableName);
     registerCommandWithTreeNodeUnwrapping('containerApps.editEnvironmentVariables', editEnvironmentVariables);
+    registerCommandWithTreeNodeUnwrapping('containerApps.deleteEnvironmentVariable', deleteEnvironmentVariable);
 
     // deploy
     registerCommandWithTreeNodeUnwrapping('containerApps.deployImageApi', deployImageApi);