Create a centralized CommandAttributes and add attributes for DTS setup (#4649)

Author: MicroFish91

src/commands/CommandAttributes.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 ActivityAttributes } from "@microsoft/vscode-azext-utils";
+
+export class CommandAttributes {
+
+    static readonly Deploy: ActivityAttributes = {
+        description: "Deploys application code to an Azure Functions app using deployment methods such as zip deployment, Azure CLI, or GitHub Actions. This action publishes the app to the specified Function App resource, making it live in the target environment.",
+        troubleshooting: [
+            "Deployment succeeds but the app fails to start — check Application Insights or log stream for runtime errors.",
+            "Deployment fails due to '403 Forbidden' or '401 Unauthorized' — verify the publishing profile, service principal, or deployment credentials have appropriate permissions.",
+            "Code changes are not reflected — ensure you're not deploying to a staging slot or that deployment caching isn't interfering.",
+            "Missing or invalid host.json or function.json — validate your app's structure and configuration files.",
+            "Dependencies not installed — make sure your build step restores packages before deployment (e.g., npm install, pip install).",
+            "Cold start latency after deployment — this is normal for Consumption Plan apps and usually resolves after the first few executions.",
+            "Function runtime version mismatch — verify the target runtime version in Azure matches your local dev/runtime settings.",
+            "Zip deployment fails with 'conflicting changes' — ensure no simultaneous deployments or file locks are interfering.",
+            "Continuous deployment stuck or outdated — check your deployment center logs for GitHub/DevOps pipeline issues.",
+            "App Service Plan quota exceeded — check if the Function App’s resource usage has hit limits for memory, CPU, or file system.",
+        ],
+    };
+
+    static readonly DeployDTSSetup: ActivityAttributes = {
+        description: "A preflight operation that ensures that a new Durable Task Scheduler (DTS) resource and hub is created, configured, and ready for connection to the function app.",
+        troubleshooting: [
+            "DTS resource creation takes a long time (25+ minutes) and then fails - possible temporary service issue; you should recommend that the user try again a short time later and delete any unused resources that were created.",
+            "Task hub creation fails — if an existing parent DTS resource was selected, check that the scheduler is not stuck in a provisioning state.",
+        ],
+    };
+
+}

src/commands/appSettings/connectionSettings/durableTaskScheduler/getDTSConnection.ts

@@ -13,6 +13,7 @@ import { ext } from "../../../../extensionVariables";
 import { localize } from "../../../../localize";
 import { HttpDurableTaskSchedulerClient, type DurableTaskSchedulerResource } from "../../../../tree/durableTaskScheduler/DurableTaskSchedulerClient";
 import { createActivityContext } from "../../../../utils/activityUtils";
+import { CommandAttributes } from "../../../CommandAttributes";
 import { type IFuncDeployContext } from "../../../deploy/deploy";
 import { type IDTSConnectionSetSettingsContext } from "../ISetConnectionSettingContext";
 import { DTSConnectionListStep } from "./DTSConnectionListStep";
@@ -47,6 +48,8 @@ export async function getDTSConnectionIfNeeded(context: DTSConnectionContext, ap
     const wizardContext: IDTSAzureConnectionWizardContext = {
         ...context,
         ...await createActivityContext({ withChildren: true }),
+        activityAttributes: CommandAttributes.DeployDTSSetup,
+        callbackId: `${context.callbackId}.dtsSetup`,
         site,
         projectPath,
         action: CodeAction.Deploy,

src/commands/deploy/deploy.ts

@@ -24,6 +24,7 @@ import { isPathEqual } from '../../utils/fs';
 import { treeUtils } from '../../utils/treeUtils';
 import { getWorkspaceSetting } from '../../vsCodeConfig/settings';
 import { verifyInitForVSCode } from '../../vsCodeConfig/verifyInitForVSCode';
+import { CommandAttributes } from '../CommandAttributes';
 import { type ISetConnectionSettingContext } from '../appSettings/connectionSettings/ISetConnectionSettingContext';
 import { getStorageConnectionIfNeeded } from '../appSettings/connectionSettings/azureWebJobsStorage/getStorageConnection';
 import { getDTSConnectionIfNeeded } from '../appSettings/connectionSettings/durableTaskScheduler/getDTSConnection';
@@ -68,25 +69,11 @@ async function deploy(actionContext: IActionContext, arg1: vscode.Uri | string |
     }
 
     const context: IFuncDeployContext = Object.assign(actionContext, deployPaths, {
+        ...await createActivityContext(),
+        activityAttributes: CommandAttributes.Deploy,
         action: CodeAction.Deploy,
         defaultAppSetting: 'defaultFunctionAppToDeploy',
         projectPath,
-        activityAttributes: {
-            "description": "Deploys application code to an Azure Functions app using deployment methods such as zip deployment, Azure CLI, or GitHub Actions. This action publishes the app to the specified Function App resource, making it live in the target environment.",
-            "troubleshooting": [
-                "Deployment succeeds but the app fails to start — check Application Insights or log stream for runtime errors.",
-                "Deployment fails due to '403 Forbidden' or '401 Unauthorized' — verify the publishing profile, service principal, or deployment credentials have appropriate permissions.",
-                "Code changes are not reflected — ensure you're not deploying to a staging slot or that deployment caching isn't interfering.",
-                "Missing or invalid host.json or function.json — validate your app's structure and configuration files.",
-                "Dependencies not installed — make sure your build step restores packages before deployment (e.g., npm install, pip install).",
-                "Cold start latency after deployment — this is normal for Consumption Plan apps and usually resolves after the first few executions.",
-                "Function runtime version mismatch — verify the target runtime version in Azure matches your local dev/runtime settings.",
-                "Zip deployment fails with 'conflicting changes' — ensure no simultaneous deployments or file locks are interfering.",
-                "Continuous deployment stuck or outdated — check your deployment center logs for GitHub/DevOps pipeline issues.",
-                "App Service Plan quota exceeded — check if the Function App’s resource usage has hit limits for memory, CPU, or file system."
-            ]
-        },
-        ...(await createActivityContext())
     });
 
     if (treeUtils.isAzExtTreeItem(arg1)) {