Provide an option to hook up DTS emulator when locally debugging DTS projects (#4538)

Author: MicroFish91

src/commands/appSettings/connectionSettings/IConnectionPromptOptions.ts

@@ -3,9 +3,10 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { type EventHubsConnectionTypeValues, type SqlDbConnectionTypeValues, type StorageConnectionTypeValues } from "../../../constants";
+import { type EventHubsConnectionType, type SqlDbConnectionType, type StorageConnectionType } from "./IConnectionTypesContext";
+
 
 export interface IConnectionPromptOptions {
-    preselectedConnectionType?: StorageConnectionTypeValues | EventHubsConnectionTypeValues | SqlDbConnectionTypeValues;
+    preselectedConnectionType?: StorageConnectionType | EventHubsConnectionType | SqlDbConnectionType;
 }
 

src/commands/appSettings/connectionSettings/IConnectionTypesContext.ts

@@ -0,0 +1,19 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { type ConnectionType } from "../../../constants";
+
+export type StorageConnectionType = ConnectionType.Azure | ConnectionType.Emulator;
+export type DTSConnectionType = ConnectionType;
+export type EventHubsConnectionType = ConnectionType.Azure | ConnectionType.Emulator;
+export type SqlDbConnectionType = ConnectionType.Azure | ConnectionType.Custom;
+
+export interface IConnectionTypesContext {
+    azureWebJobsStorageType?: StorageConnectionType;
+    dtsConnectionType?: DTSConnectionType;
+    eventHubsConnectionType?: EventHubsConnectionType;
+    sqlDbConnectionType?: SqlDbConnectionType;
+}
+

src/commands/appSettings/connectionSettings/ISetConnectionSettingContext.ts

@@ -5,8 +5,9 @@
 
 import { type IActionContext } from "@microsoft/vscode-azext-utils";
 import { type CodeActionValues, type ConnectionKey } from "../../../constants";
+import { type IConnectionTypesContext } from "./IConnectionTypesContext";
 
-export interface ISetConnectionSettingContext extends IActionContext {
+export interface ISetConnectionSettingContext extends IActionContext, IConnectionTypesContext {
     action: CodeActionValues;
     projectPath: string;
 

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

@@ -6,11 +6,12 @@
 import { StorageAccountKind, StorageAccountListStep, StorageAccountPerformance, StorageAccountReplication } from '@microsoft/vscode-azext-azureutils';
 import { AzureWizardPromptStep, type ISubscriptionActionContext, type IWizardOptions } from '@microsoft/vscode-azext-utils';
 import { type MessageItem } from 'vscode';
-import { ConnectionType, type EventHubsConnectionTypeValues, type SqlDbConnectionTypeValues } from '../../../../constants';
+import { ConnectionType } from '../../../../constants';
 import { useEmulator } from '../../../../constants-nls';
 import { ext } from '../../../../extensionVariables';
 import { localize } from '../../../../localize';
 import { type IConnectionPromptOptions } from '../IConnectionPromptOptions';
+import { type StorageConnectionType } from '../IConnectionTypesContext';
 import { type IAzureWebJobsStorageWizardContext } from './IAzureWebJobsStorageWizardContext';
 
 export class AzureWebJobsStoragePromptStep<T extends IAzureWebJobsStorageWizardContext> extends AzureWizardPromptStep<T> {
@@ -36,17 +37,16 @@ export class AzureWebJobsStoragePromptStep<T extends IAzureWebJobsStorageWizardC
         context.telemetry.properties.azureWebJobsStorageType = context.azureWebJobsStorageType;
     }
 
-    public async configureBeforePrompt(context: T & { eventHubsConnectionType?: EventHubsConnectionTypeValues, sqlDbConnectionType?: SqlDbConnectionTypeValues }): Promise<void> {
+    public async configureBeforePrompt(context: T): Promise<void> {
+        const matchingConnectionType: StorageConnectionType | undefined = tryFindMatchingConnectionType([context.dtsConnectionType, context.eventHubsConnectionType, context.sqlDbConnectionType]);
+
         if (this.options?.preselectedConnectionType === ConnectionType.Azure || this.options?.preselectedConnectionType === ConnectionType.Emulator) {
             context.azureWebJobsStorageType = this.options.preselectedConnectionType;
         } else if (!!context.storageAccount || !!context.newStorageAccountName) {
             // Only should prompt if no storage account was selected
             context.azureWebJobsStorageType = ConnectionType.Azure;
-        } else if (context.eventHubsConnectionType) {
-            context.azureWebJobsStorageType = context.eventHubsConnectionType;
-        } else if (context.sqlDbConnectionType === ConnectionType.Azure) {
-            // No official support for an `Emulator` scenario yet
-            context.azureWebJobsStorageType = context.sqlDbConnectionType;
+        } else if (matchingConnectionType) {
+            context.azureWebJobsStorageType = matchingConnectionType;
         }
 
         // Even if we end up skipping the prompt, we should still record the flow in telemetry
@@ -88,3 +88,18 @@ export class AzureWebJobsStoragePromptStep<T extends IAzureWebJobsStorageWizardC
         return { promptSteps };
     }
 }
+
+const availableStorageConnections: Set<ConnectionType> = new Set([ConnectionType.Azure, ConnectionType.Emulator]);
+
+function tryFindMatchingConnectionType(connections: (ConnectionType | undefined)[]): StorageConnectionType | undefined {
+    for (const c of connections) {
+        if (!c) {
+            continue;
+        }
+
+        if (availableStorageConnections.has(c)) {
+            return c as StorageConnectionType;
+        }
+    }
+    return undefined;
+}

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

@@ -5,12 +5,12 @@
 
 import { type StorageAccount } from "@azure/arm-storage";
 import { type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
-import { type StorageConnectionTypeValues } from "../../../../constants";
+import { type StorageConnectionType } from "../IConnectionTypesContext";
 import { type ISetConnectionSettingContext } from "../ISetConnectionSettingContext";
 
 export interface IAzureWebJobsStorageWizardContext extends ISetConnectionSettingContext, Partial<ISubscriptionContext> {
     storageAccount?: StorageAccount;
     newStorageAccountName?: string;
 
-    azureWebJobsStorageType?: StorageConnectionTypeValues;
+    azureWebJobsStorageType?: StorageConnectionType;
 }

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

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep, validationUtils } from '@microsoft/vscode-azext-utils';
+import { ConnectionType } from '../../../../constants';
+import { localize } from '../../../../localize';
+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({
+            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;
+    }
+
+    private validateInput(name: string | undefined): string | undefined {
+        name = name ? name.trim() : '';
+        if (!validationUtils.hasValidCharLength(name)) {
+            return validationUtils.getInvalidCharLengthMessage();
+        }
+        return undefined;
+    }
+}

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

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { nonNullProp } from '@microsoft/vscode-azext-utils';
+import { ConnectionKey } from '../../../../constants';
+import { SetConnectionSettingStepBase } from '../SetConnectionSettingStepBase';
+import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
+
+export class DTSConnectionSetSettingStep<T extends IDTSConnectionWizardContext> 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'));
+    }
+
+    public shouldExecute(context: T): boolean {
+        return !!context.newDTSConnection;
+    }
+}

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

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep, type AzureWizardExecuteStep, type IWizardOptions } from '@microsoft/vscode-azext-utils';
+import { type MessageItem } from 'vscode';
+import { ConnectionType } from '../../../../constants';
+import { useEmulator } from '../../../../constants-nls';
+import { localize } from '../../../../localize';
+import { DTSConnectionCustomPromptStep } from './DTSConnectionCustomPromptStep';
+import { DTSConnectionSetSettingStep } from './DTSConnectionSetSettingStep';
+import { DTSEmulatorStartStep } from './DTSEmulatorStartStep';
+import { DTSHubNameCustomPromptStep } from './DTSHubNameCustomPromptStep';
+import { DTSHubNameSetSettingStep } from './DTSHubNameSetSettingStep';
+import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
+
+export class DTSConnectionTypeListStep<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>[] = [];
+        const executeSteps: AzureWizardExecuteStep<T>[] = [];
+
+        switch (context.dtsConnectionType) {
+            case ConnectionType.Azure:
+                throw new Error('Needs implementation.');
+            case ConnectionType.Emulator:
+                executeSteps.push(new DTSEmulatorStartStep());
+                break;
+            case ConnectionType.Custom:
+                promptSteps.push(
+                    new DTSConnectionCustomPromptStep(),
+                    new DTSHubNameCustomPromptStep(),
+                );
+                break;
+        }
+
+        executeSteps.push(
+            new DTSConnectionSetSettingStep(),
+            new DTSHubNameSetSettingStep(),
+        );
+
+        return { promptSteps, executeSteps };
+    }
+}

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

@@ -0,0 +1,46 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardExecuteStep, nonNullValue } from '@microsoft/vscode-azext-utils';
+import { commands, window } from 'vscode';
+import { ConnectionType } from '../../../../constants';
+import { ext } from '../../../../extensionVariables';
+import { localize } from '../../../../localize';
+import { type DurableTaskSchedulerEmulator } from '../../../../tree/durableTaskScheduler/DurableTaskSchedulerEmulatorClient';
+import { type IDTSConnectionWizardContext } from './IDTSConnectionWizardContext';
+
+export class DTSEmulatorStartStep<T extends IDTSConnectionWizardContext> extends AzureWizardExecuteStep<T> {
+    public priority: number = 200;
+
+    public async execute(context: T): Promise<void> {
+        const emulatorId: string = nonNullValue(
+            await commands.executeCommand('azureFunctions.durableTaskScheduler.startEmulator'),
+            localize('failedToStartEmulator', 'Internal error: Failed to start DTS emulator.'),
+        );
+
+        const emulators: DurableTaskSchedulerEmulator[] = nonNullValue(
+            await commands.executeCommand('azureFunctions.durableTaskScheduler.getEmulators'),
+            localize('failedToGetEmulators', 'Internal error: Failed to retrieve the list of DTS emulators.'),
+        );
+
+        const emulator: DurableTaskSchedulerEmulator = nonNullValue(
+            emulators.find(e => e.id === emulatorId),
+            localize('couldNotFindEmulator', 'Internal error: Failed to retrieve info on the started DTS emulator.'),
+        );
+
+        const { schedulerEndpoint, dashboardEndpoint } = emulator;
+
+        const message: string = localize('emulatorStartedMessage', `Durable Task Scheduler (DTS) emulator has been started by your container client at "{0}".  Its dashboard is available at "{1}".`, schedulerEndpoint.toString(), dashboardEndpoint.toString());
+        void window.showInformationMessage(message);
+        ext.outputChannel.appendLog(message);
+
+        context.newDTSConnection = `Endpoint=${emulator.schedulerEndpoint};Authentication=None`;
+        context.newDTSHubName = 'default';
+    }
+
+    public shouldExecute(context: T): boolean {
+        return !context.newDTSConnection && context.dtsConnectionType === ConnectionType.Emulator;
+    }
+}

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

@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { AzureWizardPromptStep, validationUtils, type IActionContext } from '@microsoft/vscode-azext-utils';
+import * as path from 'path';
+import { ConnectionKey, ConnectionType, localSettingsFileName } from '../../../../constants';
+import { getLocalSettingsJson } from '../../../../funcConfig/local.settings';
+import { localize } from '../../../../localize';
+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({
+            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;
+    }
+
+    private validateInput(name: string): string | undefined {
+        name = name.trim();
+
+        if (!validationUtils.hasValidCharLength(name)) {
+            return validationUtils.getInvalidCharLengthMessage();
+        }
+        return undefined;
+    }
+}
+
+async function getDTSHubName(context: IActionContext, projectPath: string): Promise<string | undefined> {
+    const localSettingsJson = await getLocalSettingsJson(context, path.join(projectPath, localSettingsFileName));
+    return localSettingsJson.Values?.[ConnectionKey.DTSHub];
+}