Merge with main

Author: MicroFish91

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.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.newDTSConnectionSetting && 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/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.newDTSConnectionSetting = `Endpoint=${emulator.schedulerEndpoint};Authentication=None`;
+        context.newDTSHubNameConnectionSetting = 'default';
+    }
+
+    public shouldExecute(context: T): boolean {
+        return !context.newDTSConnectionSetting && 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.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.newDTSHubNameConnectionSetting && 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];
+}

src/debug/durable/validateDTSConnectionPreDebug.ts

@@ -56,6 +56,6 @@ export async function isAliveConnection(context: IActionContext, dtsConnection:
     } catch (e) {
         // Even if we get back an error, if we can read a status code, the connection provided a response and is still alive
         const statusCode = (e as { statusCode?: number })?.statusCode;
-        return statusCode ? true : false;
+        return !!statusCode;
     }
 }