New activity output wrapper utils and execute step base (#467)

MicroFish91 · web-flow · commit b4d8d0a3eced · 2023-10-07T21:50:04.000-07:00
diff --git a/src/commands/createContainerApp/createContainerApp.ts b/src/commands/createContainerApp/createContainerApp.ts
@@ -10,7 +10,7 @@ import { webProvider } from "../../constants";
 import { ext } from "../../extensionVariables";
 import { ContainerAppItem } from "../../tree/ContainerAppItem";
 import type { ManagedEnvironmentItem } from "../../tree/ManagedEnvironmentItem";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { pickEnvironment } from "../../utils/pickItem/pickEnvironment";
 import { ImageSourceListStep } from "../deployImage/imageSource/ImageSourceListStep";
diff --git a/src/commands/createManagedEnvironment/LogAnalyticsCreateStep.ts b/src/commands/createManagedEnvironment/LogAnalyticsCreateStep.ts
@@ -4,32 +4,54 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { LocationListStep } from "@microsoft/vscode-azext-azureutils";
-import { AzureWizardExecuteStep } from "@microsoft/vscode-azext-utils";
+import { GenericTreeItem } from "@microsoft/vscode-azext-utils";
 import { Progress } from "vscode";
-import { ext } from "../../extensionVariables";
+import { activityFailContext, activityFailIcon, activitySuccessContext, activitySuccessIcon } from "../../constants";
+import { ExecuteActivityOutput, ExecuteActivityOutputStepBase } from "../../utils/activity/ExecuteActivityOutputStepBase";
+import { createActivityChildContext } from "../../utils/activity/activityUtils";
 import { createOperationalInsightsManagementClient } from "../../utils/azureClients";
 import { localize } from "../../utils/localize";
-import { nonNullProp, nonNullValue } from "../../utils/nonNull";
+import { nonNullProp } from "../../utils/nonNull";
 import { IManagedEnvironmentContext } from "./IManagedEnvironmentContext";
 
-export class LogAnalyticsCreateStep extends AzureWizardExecuteStep<IManagedEnvironmentContext> {
+export class LogAnalyticsCreateStep extends ExecuteActivityOutputStepBase<IManagedEnvironmentContext> {
     public priority: number = 220;
 
-    public async execute(context: IManagedEnvironmentContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
+    protected async executeCore(context: IManagedEnvironmentContext, progress: Progress<{ message?: string | undefined; increment?: number | undefined }>): Promise<void> {
         const opClient = await createOperationalInsightsManagementClient(context);
-        const rg = nonNullValue(context.resourceGroup);
-        const creatingLaw: string = localize('creatingLogAnalyticsWorkspace', 'Creating new Log Analytics workspace...');
-        progress.report({ message: creatingLaw });
-        ext.outputChannel.appendLog(creatingLaw);
-        context.logAnalyticsWorkspace = await opClient.workspaces.beginCreateOrUpdateAndWait(
-            nonNullProp(rg, 'name'), nonNullProp(context, 'newManagedEnvironmentName'), { location: (await LocationListStep.getLocation(context)).name });
+        const resourceGroup = nonNullProp(context, 'resourceGroup');
+        const workspaceName = nonNullProp(context, 'newManagedEnvironmentName');
+
+        const creating: string = localize('creatingLogAnalyticsWorkspace', 'Creating log analytics workspace...');
+        progress.report({ message: creating });
 
-        const createdLaw: string = localize('createdLogAnalyticWorkspace', 'Successfully created new log analytic workspace.');
-        ext.outputChannel.appendLog(createdLaw);
-        void progress.report({ message: createdLaw });
+        context.logAnalyticsWorkspace = await opClient.workspaces.beginCreateOrUpdateAndWait(
+            nonNullProp(resourceGroup, 'name'), workspaceName, { location: (await LocationListStep.getLocation(context)).name });
     }
 
     public shouldExecute(context: IManagedEnvironmentContext): boolean {
         return !context.logAnalyticsWorkspace;
     }
+
+    protected createSuccessOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+        return {
+            item: new GenericTreeItem(undefined, {
+                contextValue: createActivityChildContext(['logAnalyticsCreateStep', activitySuccessContext]),
+                label: localize('createWorkspace', 'Create log analytics workspace "{0}"', context.newManagedEnvironmentName),
+                iconPath: activitySuccessIcon
+            }),
+            message: localize('createLogAnalyticsWorkspaceSuccess', 'Created log analytics workspace "{0}".', context.newManagedEnvironmentName)
+        };
+    }
+
+    protected createFailOutput(context: IManagedEnvironmentContext): ExecuteActivityOutput {
+        return {
+            item: new GenericTreeItem(undefined, {
+                contextValue: createActivityChildContext(['logAnalyticsCreateStep', activityFailContext]),
+                label: localize('createWorkspace', 'Create log analytics workspace "{0}"', context.newManagedEnvironmentName),
+                iconPath: activityFailIcon
+            }),
+            message: localize('createLogAnalyticsWorkspaceFail', 'Failed to create log analytics workspace "{0}".', context.newManagedEnvironmentName)
+        };
+    }
 }
diff --git a/src/commands/createManagedEnvironment/createManagedEnvironment.ts b/src/commands/createManagedEnvironment/createManagedEnvironment.ts
@@ -8,7 +8,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionCont
 import { AzureSubscription } from "@microsoft/vscode-azureresources-api";
 import { appProvider, managedEnvironmentsId, operationalInsightsProvider } from "../../constants";
 import { ext } from "../../extensionVariables";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { IManagedEnvironmentContext } from "./IManagedEnvironmentContext";
 import { LogAnalyticsCreateStep } from "./LogAnalyticsCreateStep";
diff --git a/src/commands/deleteManagedEnvironment/deleteManagedEnvironment.ts b/src/commands/deleteManagedEnvironment/deleteManagedEnvironment.ts
@@ -8,7 +8,7 @@ import { AzureWizard, createSubscriptionContext, IActionContext } from "@microso
 import { ext } from "../../extensionVariables";
 import { ContainerAppItem } from "../../tree/ContainerAppItem";
 import type { ManagedEnvironmentItem } from "../../tree/ManagedEnvironmentItem";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { pickEnvironment } from "../../utils/pickItem/pickEnvironment";
 import { DeleteAllContainerAppsStep } from "../deleteContainerApp/DeleteAllContainerAppsStep";
diff --git a/src/commands/deployImage/imageSource/containerRegistry/acr/createAcr/createAcr.ts b/src/commands/deployImage/imageSource/containerRegistry/acr/createAcr/createAcr.ts
@@ -7,7 +7,7 @@ import { LocationListStep, ResourceGroupCreateStep } from "@microsoft/vscode-aze
 import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, createSubscriptionContext, nonNullValue, subscriptionExperience } from "@microsoft/vscode-azext-utils";
 import { AzureSubscription } from "@microsoft/vscode-azureresources-api";
 import { ext } from "../../../../../../extensionVariables";
-import { createActivityContext } from "../../../../../../utils/activityUtils";
+import { createActivityContext } from "../../../../../../utils/activity/activityUtils";
 import { localize } from "../../../../../../utils/localize";
 import { CreateAcrContext } from "./CreateAcrContext";
 import { RegistryCreateStep } from "./RegistryCreateStep";
diff --git a/src/commands/deployWorkspaceProject/deployWorkspaceProject.ts b/src/commands/deployWorkspaceProject/deployWorkspaceProject.ts
@@ -10,7 +10,7 @@ import { ProgressLocation, window } from "vscode";
 import { appProvider, managedEnvironmentsId, operationalInsightsProvider, webProvider } from "../../constants";
 import { ext } from "../../extensionVariables";
 import { ContainerAppModel, isIngressEnabled } from "../../tree/ContainerAppItem";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { browseContainerApp } from "../browseContainerApp";
 import { ContainerAppCreateStep } from "../createContainerApp/ContainerAppCreateStep";
@@ -48,7 +48,7 @@ export async function deployWorkspaceProject(context: IActionContext): Promise<v
         ...subscriptionContext,
         ...await createActivityContext(),
         ...defaultContextValues,
-        // activityChildren: [],
+        activityChildren: [],
         subscription,
     };
 
diff --git a/src/commands/gitHub/disconnectRepo/disconnectRepo.ts b/src/commands/gitHub/disconnectRepo/disconnectRepo.ts
@@ -7,7 +7,7 @@ import { getGitHubAccessToken } from "@microsoft/vscode-azext-github";
 import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, ITreeItemPickerContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { ContainerAppsItem } from "../../../tree/ContainerAppsBranchDataProvider";
 import { ActionsItem } from "../../../tree/configurations/ActionsItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import { getContainerAppSourceControl } from "../connectToGitHub/getContainerAppSourceControl";
diff --git a/src/commands/ingress/disableIngress/disableIngress.ts b/src/commands/ingress/disableIngress/disableIngress.ts
@@ -6,7 +6,7 @@
 import { AzureWizard, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from '@microsoft/vscode-azext-utils';
 import { ext } from '../../../extensionVariables';
 import type { ContainerAppsItem } from "../../../tree/ContainerAppsBranchDataProvider";
-import { createActivityContext } from '../../../utils/activityUtils';
+import { createActivityContext } from '../../../utils/activity/activityUtils';
 import { localize } from '../../../utils/localize';
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import type { IngressContext } from '../IngressContext';
diff --git a/src/commands/ingress/editTargetPort/editTargetPort.ts b/src/commands/ingress/editTargetPort/editTargetPort.ts
@@ -7,7 +7,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, createSubsc
 import { ext } from "../../../extensionVariables";
 import { IngressEnabledItem } from "../../../tree/configurations/IngressItem";
 import type { ContainerAppItem } from "../../../tree/ContainerAppItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import type { IngressContext } from "../IngressContext";
diff --git a/src/commands/ingress/enableIngress/enableIngress.ts b/src/commands/ingress/enableIngress/enableIngress.ts
@@ -6,7 +6,7 @@
 import { AzureWizard, AzureWizardPromptStep, createSubscriptionContext, IActionContext } from '@microsoft/vscode-azext-utils';
 import { ext } from '../../../extensionVariables';
 import type { ContainerAppsItem } from "../../../tree/ContainerAppsBranchDataProvider";
-import { createActivityContext } from '../../../utils/activityUtils';
+import { createActivityContext } from '../../../utils/activity/activityUtils';
 import { localize } from '../../../utils/localize';
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import type { IngressContext } from "../IngressContext";
diff --git a/src/commands/ingress/toggleIngressVisibility/toggleIngressVisibility.ts b/src/commands/ingress/toggleIngressVisibility/toggleIngressVisibility.ts
@@ -4,7 +4,7 @@ import { IngressConstants } from "../../../constants";
 import { ext } from "../../../extensionVariables";
 import type { ContainerAppItem } from "../../../tree/ContainerAppItem";
 import type { IngressEnabledItem } from "../../../tree/configurations/IngressItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import type { IngressContext } from "../IngressContext";
diff --git a/src/commands/logStream/startStreamingLogs.ts b/src/commands/logStream/startStreamingLogs.ts
@@ -5,7 +5,7 @@
 
 import { AzureWizard, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { ContainerAppItem } from "../../tree/ContainerAppItem";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { pickContainerApp } from "../../utils/pickItem/pickContainerApp";
 import { ContainerListStep } from "./ContainerListStep";
diff --git a/src/commands/logStream/stopStreamingLogs.ts b/src/commands/logStream/stopStreamingLogs.ts
@@ -5,7 +5,7 @@
 
 import { AzureWizard, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import type { ContainerAppItem } from "../../tree/ContainerAppItem";
-import { createActivityContext } from "../../utils/activityUtils";
+import { createActivityContext } from "../../utils/activity/activityUtils";
 import { localize } from "../../utils/localize";
 import { pickContainerApp } from "../../utils/pickItem/pickContainerApp";
 import { IStreamLogsContext } from "./IStreamLogsContext";
diff --git a/src/commands/revision/chooseRevisionMode/chooseRevisionMode.ts b/src/commands/revision/chooseRevisionMode/chooseRevisionMode.ts
@@ -7,7 +7,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, createSubsc
 import { ext } from "../../../extensionVariables";
 import { ContainerAppItem } from "../../../tree/ContainerAppItem";
 import type { RevisionsItem } from "../../../tree/revisionManagement/RevisionsItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import { ChangeRevisionModeStep } from "./ChangeRevisionModeStep";
diff --git a/src/commands/revisionDraft/deployRevisionDraft/deployRevisionDraft.ts b/src/commands/revisionDraft/deployRevisionDraft/deployRevisionDraft.ts
@@ -8,7 +8,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionCont
 import { ext } from "../../../extensionVariables";
 import type { ContainerAppItem } from "../../../tree/ContainerAppItem";
 import { RevisionDraftItem } from "../../../tree/revisionManagement/RevisionDraftItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { delay } from "../../../utils/delay";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
diff --git a/src/commands/scaling/scaleRange/editScaleRange.ts b/src/commands/scaling/scaleRange/editScaleRange.ts
@@ -7,7 +7,7 @@ import type { Revision, Scale } from "@azure/arm-appcontainers";
 import { AzureWizard, IActionContext, createSubscriptionContext, nonNullValueAndProp } from "@microsoft/vscode-azext-utils";
 import type { ContainerAppModel } from "../../../tree/ContainerAppItem";
 import type { ScaleItem } from "../../../tree/scaling/ScaleItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickScale } from "../../../utils/pickItem/pickScale";
 import { getParentResource } from "../../../utils/revisionDraftUtils";
diff --git a/src/commands/scaling/scaleRule/addScaleRule/addScaleRule.ts b/src/commands/scaling/scaleRule/addScaleRule/addScaleRule.ts
@@ -7,7 +7,7 @@ import { Revision } from "@azure/arm-appcontainers";
 import { AzureWizard, IActionContext, createSubscriptionContext, nonNullProp } from "@microsoft/vscode-azext-utils";
 import type { ContainerAppModel } from "../../../../tree/ContainerAppItem";
 import type { ScaleRuleGroupItem } from "../../../../tree/scaling/ScaleRuleGroupItem";
-import { createActivityContext } from "../../../../utils/activityUtils";
+import { createActivityContext } from "../../../../utils/activity/activityUtils";
 import { localize } from "../../../../utils/localize";
 import { pickScaleRuleGroup } from "../../../../utils/pickItem/pickScale";
 import { getParentResource } from "../../../../utils/revisionDraftUtils";
diff --git a/src/commands/scaling/scaleRule/deleteScaleRule/deleteScaleRule.ts b/src/commands/scaling/scaleRule/deleteScaleRule/deleteScaleRule.ts
@@ -7,7 +7,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, DeleteConfi
 import type { ContainerAppModel } from "../../../../tree/ContainerAppItem";
 import type { ScaleRuleGroupItem } from "../../../../tree/scaling/ScaleRuleGroupItem";
 import type { ScaleRuleItem } from "../../../../tree/scaling/ScaleRuleItem";
-import { createActivityContext } from "../../../../utils/activityUtils";
+import { createActivityContext } from "../../../../utils/activity/activityUtils";
 import { localize } from "../../../../utils/localize";
 import { pickScaleRuleGroup } from "../../../../utils/pickItem/pickScale";
 import { getParentResource } from "../../../../utils/revisionDraftUtils";
diff --git a/src/commands/secret/addSecret/addSecret.ts b/src/commands/secret/addSecret/addSecret.ts
@@ -6,7 +6,7 @@
 import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { ext } from "../../../extensionVariables";
 import { SecretsItem } from "../../../tree/configurations/secrets/SecretsItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickContainerApp } from "../../../utils/pickItem/pickContainerApp";
 import type { ISecretContext } from "../ISecretContext";
diff --git a/src/commands/secret/deleteSecret/deleteSecret.ts b/src/commands/secret/deleteSecret/deleteSecret.ts
@@ -7,7 +7,7 @@ import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionCont
 import { ext } from "../../../extensionVariables";
 import type { SecretItem } from "../../../tree/configurations/secrets/SecretItem";
 import { SecretsItem } from "../../../tree/configurations/secrets/SecretsItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickSecret } from "../../../utils/pickItem/pickSecret";
 import type { ISecretContext } from "../ISecretContext";
diff --git a/src/commands/secret/editSecret/editSecretName.ts b/src/commands/secret/editSecret/editSecretName.ts
@@ -6,7 +6,7 @@
 import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { ext } from "../../../extensionVariables";
 import type { SecretItem } from "../../../tree/configurations/secrets/SecretItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickSecret } from "../../../utils/pickItem/pickSecret";
 import type { ISecretContext } from "../ISecretContext";
diff --git a/src/commands/secret/editSecret/editSecretValue.ts b/src/commands/secret/editSecret/editSecretValue.ts
@@ -6,7 +6,7 @@
 import { AzureWizard, AzureWizardExecuteStep, AzureWizardPromptStep, IActionContext, createSubscriptionContext } from "@microsoft/vscode-azext-utils";
 import { ext } from "../../../extensionVariables";
 import type { SecretItem } from "../../../tree/configurations/secrets/SecretItem";
-import { createActivityContext } from "../../../utils/activityUtils";
+import { createActivityContext } from "../../../utils/activity/activityUtils";
 import { localize } from "../../../utils/localize";
 import { pickSecret } from "../../../utils/pickItem/pickSecret";
 import type { ISecretContext } from "../ISecretContext";
diff --git a/src/constants.ts b/src/constants.ts
@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { IAzureQuickPickItem } from "@microsoft/vscode-azext-utils";
-import { QuickPickItem } from "vscode";
+import { QuickPickItem, ThemeColor, ThemeIcon } from "vscode";
 import { localize } from "./utils/localize";
 
 export const managedEnvironmentsId = 'managedEnvironments';
@@ -86,6 +86,12 @@ export const relativeSettingsFilePath: string = `${vscodeFolder}/${settingsFile}
 // Originally from the Docker extension: https://github.com/microsoft/vscode-docker/blob/main/src/constants.ts
 export const DOCKERFILE_GLOB_PATTERN = '**/{*.[dD][oO][cC][kK][eE][rR][fF][iI][lL][eE],[dD][oO][cC][kK][eE][rR][fF][iI][lL][eE],[dD][oO][cC][kK][eE][rR][fF][iI][lL][eE].*}';
 
+export const activitySuccessIcon: ThemeIcon = new ThemeIcon('pass', new ThemeColor('testing.iconPassed'));
+export const activityFailIcon: ThemeIcon = new ThemeIcon('error', new ThemeColor('testing.iconFailed'));
+
+export const activitySuccessContext: string = 'activity:success';
+export const activityFailContext: string = 'activity:fail';
+
 export const revisionModeSingleContextValue: string = 'revisionMode:single';
 export const revisionModeMultipleContextValue: string = 'revisionMode:multiple';
 
diff --git a/src/tree/ContainerAppItem.ts b/src/tree/ContainerAppItem.ts
diff --git a/src/utils/activity/ExecuteActivityOutputStepBase.ts b/src/utils/activity/ExecuteActivityOutputStepBase.ts
diff --git a/src/utils/activity/activityUtils.ts b/src/utils/activity/activityUtils.ts
