Add Azure deployment support for DTS projects (#4566)

Author: MicroFish91

package-lock.json

@@ -1483,7 +1483,7 @@
         "@azure/storage-blob": "^12.5.0",
         "@microsoft/vscode-azext-azureappservice": "^3.6.4",
         "@microsoft/vscode-azext-azureappsettings": "^0.2.8",
-        "@microsoft/vscode-azext-azureutils": "^3.3.3",
+        "@microsoft/vscode-azext-azureutils": "^3.4.0",
         "@microsoft/vscode-azext-utils": "^3.1.1",
         "@microsoft/vscode-azureresources-api": "^2.0.4",
         "@microsoft/vscode-container-client": "^0.1.2",

package.json

@@ -4,15 +4,17 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { type IActionContext } from "@microsoft/vscode-azext-utils";
-import { type CodeActionValues, type ConnectionKey } from "../../../constants";
+import { type CodeAction, type ConnectionKey } from "../../../constants";
 import { type IConnectionTypesContext } from "./IConnectionTypesContext";
 
 export interface ISetConnectionSettingContext extends IActionContext, IConnectionTypesContext {
-    action: CodeActionValues;
+    action: CodeAction;
     projectPath: string;
 
     // Remote connections for deploy
     [ConnectionKey.Storage]?: string;
     [ConnectionKey.EventHubs]?: string;
+    [ConnectionKey.DTS]?: string;
+    [ConnectionKey.DTSHub]?: string;
     [ConnectionKey.SQL]?: string;
 }

src/commands/appSettings/connectionSettings/ISetConnectionSettingContext.ts

@@ -4,12 +4,12 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { AzureWizardExecuteStep } from "@microsoft/vscode-azext-utils";
-import { CodeAction, type ConnectionKeyValues } from "../../../constants";
+import { CodeAction, type ConnectionKey } from "../../../constants";
 import { MismatchBehavior, setLocalAppSetting } from "../../../funcConfig/local.settings";
 import { type ISetConnectionSettingContext } from "./ISetConnectionSettingContext";
 
 export abstract class SetConnectionSettingStepBase<T extends ISetConnectionSettingContext> extends AzureWizardExecuteStep<T> {
-    public abstract readonly debugDeploySetting: ConnectionKeyValues;
+    public abstract readonly debugDeploySetting: ConnectionKey;
 
     protected async setConnectionSetting(context: T, value: string): Promise<void> {
         if (context.action === CodeAction.Deploy) {

src/commands/appSettings/connectionSettings/SetConnectionSettingStepBase.ts

@@ -4,14 +4,14 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { type IStorageAccountWizardContext } from '@microsoft/vscode-azext-azureutils';
-import { ConnectionKey, ConnectionType, localStorageEmulatorConnectionString, type ConnectionKeyValues } from '../../../../constants';
+import { ConnectionKey, ConnectionType, localStorageEmulatorConnectionString } from '../../../../constants';
 import { SetConnectionSettingStepBase } from '../SetConnectionSettingStepBase';
 import { getStorageConnectionString } from '../getLocalConnectionSetting';
 import { type IAzureWebJobsStorageWizardContext } from './IAzureWebJobsStorageWizardContext';
 
 export class AzureWebJobsStorageExecuteStep<T extends IAzureWebJobsStorageWizardContext> extends SetConnectionSettingStepBase<T> {
     public priority: number = 230;
-    public debugDeploySetting: ConnectionKeyValues = ConnectionKey.Storage;
+    public debugDeploySetting: ConnectionKey = ConnectionKey.Storage;
 
     public async execute(context: T): Promise<void> {
         let value: string;

src/commands/appSettings/connectionSettings/azureWebJobsStorage/AzureWebJobsStorageExecuteStep.ts

@@ -10,14 +10,14 @@ import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext'
 
 export class DTSConnectionCustomPromptStep<T extends IDTSConnectionWizardContext> extends AzureWizardPromptStep<T> {
     public async prompt(context: T): Promise<void> {
-        context.newDTSConnection = (await context.ui.showInputBox({
+        context.newDTSConnectionSetting = (await context.ui.showInputBox({
             prompt: localize('customDTSConnectionPrompt', 'Provide a custom DTS connection string.'),
             validateInput: (value: string | undefined) => this.validateInput(value)
         })).trim();
     }
 
     public shouldPrompt(context: T): boolean {
-        return !context.newDTSConnection && context.dtsConnectionType === ConnectionType.Custom;
+        return !context.newDTSConnectionSetting && context.dtsConnectionType === ConnectionType.Custom;
     }
 
     private validateInput(name: string | undefined): string | undefined {

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

@@ -0,0 +1,83 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { VerifyProvidersStep } from '@microsoft/vscode-azext-azureutils';
+import { AzureWizardPromptStep, type AzureWizardExecuteStep, type IWizardOptions } from '@microsoft/vscode-azext-utils';
+import { type MessageItem } from 'vscode';
+import { ConnectionType, DurableTaskProvider } from '../../../../constants';
+import { useEmulator } from '../../../../constants-nls';
+import { localize } from '../../../../localize';
+import { DurableTaskSchedulerListStep } from './azure/DurableTaskSchedulerListStep';
+import { DTSConnectionCustomPromptStep } from './custom/DTSConnectionCustomPromptStep';
+import { DTSHubNameCustomPromptStep } from './custom/DTSHubNameCustomPromptStep';
+import { DTSConnectionSetSettingStep } from './DTSConnectionSetSettingStep';
+import { DTSHubNameSetSettingStep } from './DTSHubNameSetSettingStep';
+import { DTSEmulatorStartStep } from './emulator/DTSEmulatorStartStep';
+import { type IDTSAzureConnectionWizardContext, type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
+
+export class DTSConnectionListStep<T extends IDTSConnectionWizardContext> extends AzureWizardPromptStep<T> {
+    constructor(readonly connectionTypes: Set<ConnectionType>) {
+        super();
+    }
+
+    public async prompt(context: T): Promise<void> {
+        const connectAzureButton = { title: localize('connectAzureTaskScheduler', 'Connect Azure Task Scheduler'), data: ConnectionType.Azure };
+        const connectEmulatorButton = { title: useEmulator, data: ConnectionType.Emulator };
+        const connectCustomDTSButton = { title: localize('connectCustomTaskScheduler', 'Manually Set a Connection String'), data: ConnectionType.Custom };
+
+        const buttons: MessageItem[] = [];
+        if (this.connectionTypes.has(ConnectionType.Azure)) {
+            buttons.push(connectAzureButton);
+        }
+        if (this.connectionTypes.has(ConnectionType.Emulator)) {
+            buttons.push(connectEmulatorButton);
+        }
+        if (this.connectionTypes.has(ConnectionType.Custom)) {
+            buttons.push(connectCustomDTSButton);
+        }
+
+        const message: string = localize('selectDTSConnection', 'Durable Functions needs to be configured to use a Durable Task Scheduler.');
+        context.dtsConnectionType = (await context.ui.showWarningMessage(message, { modal: true }, ...buttons) as {
+            title: string;
+            data: ConnectionType;
+        }).data;
+
+        context.telemetry.properties.dtsConnectionType = context.dtsConnectionType;
+    }
+
+    public shouldPrompt(context: T): boolean {
+        return !context.dtsConnectionType;
+    }
+
+    public async getSubWizard(context: T): Promise<IWizardOptions<T> | undefined> {
+        const promptSteps: AzureWizardPromptStep<T | IDTSAzureConnectionWizardContext>[] = [];
+        const executeSteps: AzureWizardExecuteStep<T | IDTSAzureConnectionWizardContext>[] = [];
+
+        switch (context.dtsConnectionType) {
+            case ConnectionType.Azure:
+                promptSteps.push(new DurableTaskSchedulerListStep());
+                executeSteps.push(new VerifyProvidersStep<IDTSAzureConnectionWizardContext>([DurableTaskProvider]));
+                break;
+            case ConnectionType.Emulator:
+                executeSteps.push(new DTSEmulatorStartStep());
+                break;
+            case ConnectionType.Custom:
+                promptSteps.push(
+                    new DTSConnectionCustomPromptStep(),
+                    new DTSHubNameCustomPromptStep(),
+                );
+                break;
+            default:
+                throw new Error(localize('unexpectedConnectionType', 'Internal error: Unexpected DTS connection type encountered: "{0}".', context.dtsConnectionType));
+        }
+
+        executeSteps.push(
+            new DTSConnectionSetSettingStep(),
+            new DTSHubNameSetSettingStep(),
+        );
+
+        return { promptSteps, executeSteps };
+    }
+}

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

@@ -5,18 +5,23 @@
 
 import { nonNullProp } from '@microsoft/vscode-azext-utils';
 import { ConnectionKey } from '../../../../constants';
+import { clientIdKey } from '../../../durableTaskScheduler/copySchedulerConnectionString';
 import { SetConnectionSettingStepBase } from '../SetConnectionSettingStepBase';
-import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
+import { type IDTSAzureConnectionWizardContext, type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
 
-export class DTSConnectionSetSettingStep<T extends IDTSConnectionWizardContext> extends SetConnectionSettingStepBase<T> {
+export class DTSConnectionSetSettingStep<T extends IDTSConnectionWizardContext | IDTSAzureConnectionWizardContext> extends SetConnectionSettingStepBase<T> {
     public priority: number = 240;
     public debugDeploySetting: ConnectionKey = ConnectionKey.DTS;
 
     public async execute(context: T): Promise<void> {
-        await this.setConnectionSetting(context, nonNullProp(context, 'newDTSConnection'));
+        let newDTSConnectionSetting = nonNullProp(context, 'newDTSConnectionSetting');
+        if ((context as IDTSAzureConnectionWizardContext).managedIdentity) {
+            newDTSConnectionSetting = newDTSConnectionSetting.replace(clientIdKey, (context as IDTSAzureConnectionWizardContext).managedIdentity?.clientId ?? clientIdKey);
+        }
+        await this.setConnectionSetting(context, newDTSConnectionSetting);
     }
 
     public shouldExecute(context: T): boolean {
-        return !!context.newDTSConnection;
+        return !!context.newDTSConnectionSetting;
     }
 }

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

@@ -36,11 +36,11 @@ export class DTSEmulatorStartStep<T extends IDTSConnectionWizardContext> extends
         void window.showInformationMessage(message);
         ext.outputChannel.appendLog(message);
 
-        context.newDTSConnection = `Endpoint=${emulator.schedulerEndpoint};Authentication=None`;
-        context.newDTSHubName = 'default';
+        context.newDTSConnectionSetting = `Endpoint=${emulator.schedulerEndpoint};Authentication=None`;
+        context.newDTSHubNameConnectionSetting = 'default';
     }
 
     public shouldExecute(context: T): boolean {
-        return !context.newDTSConnection && context.dtsConnectionType === ConnectionType.Emulator;
+        return !context.newDTSConnectionSetting && context.dtsConnectionType === ConnectionType.Emulator;
     }
 }

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

@@ -12,15 +12,15 @@ import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext'
 
 export class DTSHubNameCustomPromptStep<T extends IDTSConnectionWizardContext> extends AzureWizardPromptStep<T> {
     public async prompt(context: T): Promise<void> {
-        context.newDTSHubName = (await context.ui.showInputBox({
+        context.newDTSHubNameConnectionSetting = (await context.ui.showInputBox({
             prompt: localize('customDTSConnectionPrompt', 'Provide the custom DTS hub name.'),
             value: await getDTSHubName(context, context.projectPath),
             validateInput: (value: string) => this.validateInput(value)
         })).trim();
     }
 
     public shouldPrompt(context: T): boolean {
-        return !context.newDTSHubName && context.dtsConnectionType === ConnectionType.Custom;
+        return !context.newDTSHubNameConnectionSetting && context.dtsConnectionType === ConnectionType.Custom;
     }
 
     private validateInput(name: string): string | undefined {