feat: add dynamic Azurite connection string generation using workspace settings

src/constants.ts

@@ -146,6 +146,8 @@ export const localhost: string = '127.0.0.1';
 export const tsDefaultOutDir: string = 'dist';
 export const tsConfigFileName: string = 'tsconfig.json';
 
+// standard Azurite emulator account key
+export const azuriteAccountKey: string = 'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq';
 export const localStorageEmulatorConnectionString: string = 'UseDevelopmentStorage=true';
 export const localEventHubsEmulatorConnectionString: string = 'SingleHost';
 export const localEventHubsEmulatorConnectionRegExp: RegExp = new RegExp(`${localEventHubsEmulatorConnectionString}|MemoryF|Memory`);

src/debug/storageProviders/validateStorageConnectionPreDebug.ts

@@ -14,7 +14,7 @@ export async function validateStorageConnectionPreDebug(context: IActionContext,
     const projectPathContext = Object.assign(context, { projectPath });
     const storageConnectionKey: string = ConnectionKey.Storage;
     const storageConnection: string | undefined = await getStorageLocalSettingsValue(projectPathContext, storageConnectionKey);
-    const storageIdentityConnection: string | undefined = await getLocalSettingsConnectionString(context, ConnectionKey.StorageIdentity, projectPath);
+    const storageIdentityConnection: string | undefined = (await getLocalSettingsConnectionString(context, ConnectionKey.StorageIdentity, projectPath))[0];
 
     if (storageConnection || storageIdentityConnection) {
         return;

src/debug/validatePreDebug.ts

@@ -10,7 +10,7 @@ import * as semver from 'semver';
 import * as vscode from 'vscode';
 import { type ISetConnectionSettingContext } from '../commands/appSettings/connectionSettings/ISetConnectionSettingContext';
 import { tryGetFunctionProjectRoot } from '../commands/createNewProject/verifyIsProject';
-import { CodeAction, ConnectionKey, DurableBackend, ProjectLanguage, functionJsonFileName, localSettingsFileName, localStorageEmulatorConnectionString, projectLanguageModelSetting, projectLanguageSetting, workerRuntimeKey } from "../constants";
+import { CodeAction, ConnectionKey, DurableBackend, ProjectLanguage, functionJsonFileName, localSettingsFileName, projectLanguageModelSetting, projectLanguageSetting, workerRuntimeKey } from "../constants";
 import { ParsedFunctionJson } from "../funcConfig/function";
 import { MismatchBehavior, getLocalSettingsConnectionString, setLocalAppSetting } from "../funcConfig/local.settings";
 import { getLocalFuncCoreToolsVersion } from '../funcCoreTools/getLocalFuncCoreToolsVersion';
@@ -196,8 +196,8 @@ async function validateAzureWebJobsStorage(context: IPreDebugContext, projectLan
  * If AzureWebJobsStorage is set, pings the emulator to make sure it's actually running
  */
 async function validateEmulatorIsRunning(context: IActionContext, projectPath: string): Promise<boolean> {
-    const azureWebJobsStorage: string | undefined = await getLocalSettingsConnectionString(context, ConnectionKey.Storage, projectPath);
-    if (azureWebJobsStorage && azureWebJobsStorage.toLowerCase() === localStorageEmulatorConnectionString.toLowerCase()) {
+    const [azureWebJobsStorage, isEmulator] = await getLocalSettingsConnectionString(context, ConnectionKey.Storage, projectPath);
+    if (azureWebJobsStorage && isEmulator) {
         try {
             const client = BlobServiceClient.fromConnectionString(azureWebJobsStorage, { retryOptions: { maxTries: 1 } });
             await client.getProperties();

src/funcConfig/local.settings.ts

@@ -8,9 +8,10 @@ import * as path from 'path';
 import * as vscode from 'vscode';
 import { decryptLocalSettings } from '../commands/appSettings/localSettings/decryptLocalSettings';
 import { encryptLocalSettings } from '../commands/appSettings/localSettings/encryptLocalSettings';
-import { localSettingsFileName, type ConnectionKey } from '../constants';
+import { azuriteAccountKey, localSettingsFileName, localStorageEmulatorConnectionString, type ConnectionKey } from '../constants';
 import { localize } from '../localize';
 import { parseJson } from '../utils/parseJson';
+import { getWorkspaceSetting } from '../vsCodeConfig/settings';
 
 export interface ILocalSettingsJson {
     IsEncrypted?: boolean;
@@ -19,14 +20,48 @@ export interface ILocalSettingsJson {
     ConnectionStrings?: { [key: string]: string };
 }
 
-export async function getLocalSettingsConnectionString(context: IActionContext, connectionKey: ConnectionKey, projectPath: string): Promise<string | undefined> {
+export async function getLocalSettingsConnectionString(context: IActionContext, connectionKey: ConnectionKey, projectPath: string): Promise<[string | undefined, boolean]> {
     // func cli uses environment variable if it's defined on the machine, so no need to prompt
     if (process.env[connectionKey]) {
-        return process.env[connectionKey];
+        return [process.env[connectionKey], isConnectionStringEmulator(process.env[connectionKey])];
     }
 
     const settings: ILocalSettingsJson = await getLocalSettingsJson(context, path.join(projectPath, localSettingsFileName));
-    return settings.Values && settings.Values[connectionKey];
+    let connectionString = settings.Values && settings.Values[connectionKey];
+    if (connectionString === localStorageEmulatorConnectionString) {
+        // check for azurite settings and build the connection string if it's an emulator
+        connectionString = getLocalSettingsEmulatorConnectionString();
+    }
+    const isEmulator = isConnectionStringEmulator(connectionString);
+    return [connectionString, isEmulator];
+}
+
+function getLocalSettingsEmulatorConnectionString(): string {
+    const blobHost = getWorkspaceSetting('blobHost', undefined, 'azurite') || '127.0.0.1';
+    const blobPort = getWorkspaceSetting('blobPort', undefined, 'azurite') || '10000';
+    const queueHost = getWorkspaceSetting('queueHost', undefined, 'azurite') || '127.0.0.1';
+    const queuePort = getWorkspaceSetting('queuePort', undefined, 'azurite') || '10001';
+    const tableHost = getWorkspaceSetting('tableHost', undefined, 'azurite') || '127.0.0.1';
+    const tablePort = getWorkspaceSetting('tablePort', undefined, 'azurite') || '10002';
+
+    const protocol = getTransferProtocol();
+    return `DefaultEndpointsProtocol=${protocol};AccountName=devstoreaccount1;AccountKey=${azuriteAccountKey}/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=${protocol}://${blobHost}:${blobPort}/devstoreaccount1;QueueEndpoint=${protocol}://${queueHost}:${queuePort}/devstoreaccount1;TableEndpoint=${protocol}://${tableHost}:${tablePort}/devstoreaccount1;`;
+}
+
+function isConnectionStringEmulator(connectionString: string | undefined): boolean {
+    const blobHost: string = getWorkspaceSetting('blobHost', undefined, 'azurite') || '127.0.0.1';
+    const queueHost: string = getWorkspaceSetting('queueHost', undefined, 'azurite') || '127.0.0.1';
+    const tableHost: string = getWorkspaceSetting('tableHost', undefined, 'azurite') || '127.0.0.1';
+
+    return !!connectionString &&
+        (connectionString.includes(blobHost) ||
+            connectionString.includes(queueHost) ||
+            connectionString.includes(tableHost)
+        );
+}
+
+function getTransferProtocol(): string {
+    return getWorkspaceSetting('cert', undefined, 'azurite') && getWorkspaceSetting('key', undefined, 'azurite') ? 'https' : 'http';
 }
 
 export enum MismatchBehavior {