Add custom ActivityAttributes for deployWorkspaceProject (#894)

Author: MicroFish91

package-lock.json

@@ -850,7 +850,7 @@
         "@azure/storage-blob": "^12.4.1",
         "@microsoft/vscode-azext-azureutils": "^3.3.3",
         "@microsoft/vscode-azext-github": "^1.0.2",
-        "@microsoft/vscode-azext-utils": "^3.1.1",
+        "@microsoft/vscode-azext-utils": "^3.2.1",
         "@microsoft/vscode-azureresources-api": "^2.0.2",
         "buffer": "^6.0.3",
         "dayjs": "^1.11.3",

package.json

@@ -94,7 +94,19 @@ export async function deployWorkspaceProjectInternal(
     const wizardContext: DeployWorkspaceProjectInternalContext = {
         ...context,
         ...activityContext,
-        ...startingConfiguration
+        ...startingConfiguration,
+        activityAttributes: {
+            description: `Takes a workspace project with a Dockerfile and deploys it to an Azure Container App.
+                Automatically creates any required resources (resource group, managed environment, container registry, container app, log analytics workspace).
+                Supports single repo and monorepo, with deployment settings saved and reused via local VS Code settings (.vscode/settings.json).
+                Deployment settings are saved under "containerApps.deploymentConfigurations".
+                Deployment is agnostic to project runtime and language.`,
+            troubleshooting: [
+                `When ACR build errors are present, try to inspect the Dockerfile and ACR build logs.
+                When an error is related to the Dockerfile, offer to make direct fixes for the user.
+                If the Dockerfile and project dependencies don't match, focus on updating the Dockerfile to reflect the project, not the other way around.`
+            ],
+        },
     };
 
     const promptSteps: AzureWizardPromptStep<DeployWorkspaceProjectInternalContext>[] = [

src/commands/deployWorkspaceProject/internal/deployWorkspaceProjectInternal.ts

@@ -4,7 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 
 import { sendRequestWithTimeout, type AzExtPipelineResponse } from "@microsoft/vscode-azext-azureutils";
-import { ActivityChildItem, ActivityChildType, AzureWizardExecuteStep, activityFailContext, activityFailIcon, activityProgressContext, activityProgressIcon, activitySuccessContext, activitySuccessIcon, createContextValue, nonNullProp, nonNullValue, nonNullValueAndProp, type ActivityChildItemOptions, type ExecuteActivityOutput } from "@microsoft/vscode-azext-utils";
+import { ActivityChildItem, ActivityChildType, AzureWizardExecuteStep, activityFailContext, activityFailIcon, activityProgressContext, activityProgressIcon, activitySuccessContext, activitySuccessIcon, createContextValue, nonNullProp, nonNullValue, nonNullValueAndProp, type ActivityChildItemOptions, type ExecuteActivityOutput, type LogActivityAttributes } from "@microsoft/vscode-azext-utils";
 import { ThemeColor, ThemeIcon, TreeItemCollapsibleState, window, type MessageItem } from "vscode";
 import { acrDomain } from "../../../../constants";
 import { localize } from "../../../../utils/localize";
@@ -107,6 +107,16 @@ export class BuildImageStep<T extends BuildImageInAzureImageSourceContext> exten
                 });
                 return Promise.resolve([buildImageLogsItem]);
             };
+
+            const logs: LogActivityAttributes = {
+                name: `ACR Build Logs - ${this.acrBuildError.name}`,
+                description: 'Build logs are provided by Azure Container Registry (ACR) after a failed build. The build was attempted on an uploaded project using a Dockerfile, which ACR followed to try and build the image.',
+                content: this.acrBuildError.content,
+            };
+
+            context.activityAttributes ??= {};
+            context.activityAttributes.logs ??= [];
+            context.activityAttributes.logs.push(logs);
         }
 
         return {

src/commands/image/imageSource/buildImageInAzure/BuildImageStep.ts

@@ -3,17 +3,54 @@
 *  Licensed under the MIT License. See License.md in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
 
-import { AzureWizardPromptStep, nonNullValue } from '@microsoft/vscode-azext-utils';
+import { AzExtFsExtra, AzureWizardPromptStep, nonNullValue, type FileActivityAttributes } from '@microsoft/vscode-azext-utils';
 import { dockerFilePick, dockerfileGlobPattern } from "../../../../constants";
 import { selectWorkspaceFile } from "../../../../utils/workspaceUtils";
 import { type BuildImageInAzureImageSourceContext } from './BuildImageInAzureImageSourceContext';
 
-export class DockerfileItemStep extends AzureWizardPromptStep<BuildImageInAzureImageSourceContext> {
-    public async prompt(context: BuildImageInAzureImageSourceContext): Promise<void> {
+const dockerfileAttributeName: string = 'Dockerfile';
+
+export class DockerfileItemStep<T extends BuildImageInAzureImageSourceContext> extends AzureWizardPromptStep<T> {
+    public async configureBeforePrompt(context: T): Promise<void> {
+        if (context.dockerfilePath) {
+            await this.addDockerfileAttributes(context, context.dockerfilePath);
+        }
+    }
+
+    public async prompt(context: T): Promise<void> {
         context.dockerfilePath = nonNullValue(await selectWorkspaceFile(context, dockerFilePick, { filters: {}, autoSelectIfOne: true }, `**/${dockerfileGlobPattern}`));
+        await this.addDockerfileAttributes(context, context.dockerfilePath);
     }
 
-    public shouldPrompt(context: BuildImageInAzureImageSourceContext): boolean {
+    public shouldPrompt(context: T): boolean {
         return !context.dockerfilePath;
     }
+
+    private async addDockerfileAttributes(context: T, dockerfilePath: string): Promise<void> {
+        if (context.activityAttributes?.files?.some(f => f.path === dockerfilePath)) {
+            // If this dockerfile already exists in activity attributes, don't add it again
+            return;
+        }
+
+        const dockerfile: FileActivityAttributes = {
+            name: dockerfileAttributeName,
+            description: 'A Dockerfile from the user\'s VS Code workspace that was used to build the project.',
+            path: dockerfilePath,
+            content: await AzExtFsExtra.readFile(dockerfilePath),
+        };
+
+        context.activityAttributes ??= {};
+        context.activityAttributes.files ??= [];
+        context.activityAttributes.files.push(dockerfile);
+    }
+
+    public undo(context: T): void {
+        const files: FileActivityAttributes[] = context.activityAttributes?.files ?? [];
+        if (files[files.length - 1]) {
+            const lastFile = files[files.length - 1];
+            if (lastFile.name === dockerfileAttributeName) {
+                context.activityAttributes?.files?.pop();
+            }
+        }
+    }
 }