Improve local settings when creating templates

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "editor.codeActionsOnSave": {
-        "source.fixAll.eslint": true,
-        "source.organizeImports": true
+        "source.fixAll.eslint": "explicit",
+        "source.organizeImports": "explicit"
     },
     "editor.detectIndentation": false,
     "editor.formatOnSave": true,

package.json

@@ -276,11 +276,6 @@
                 "title": "%azureFunctions.restartFunctionApp%",
                 "category": "Azure Functions"
             },
-            {
-                "command": "azureFunctions.setAzureWebJobsStorage",
-                "title": "%azureFunctions.setAzureWebJobsStorage%",
-                "category": "Azure Functions"
-            },
             {
                 "command": "azureFunctions.startFunctionApp",
                 "title": "%azureFunctions.startFunctionApp%",

package.nls.json

@@ -71,7 +71,6 @@
     "azureFunctions.requestTimeout": "The timeout (in seconds) to be used when making requests, for example getting the latest templates.",
     "azureFunctions.restartFunctionApp": "Restart",
     "azureFunctions.scmDoBuildDuringDeployment": "Set to true to build your project on the server. Currently only applicable for Linux Function Apps.",
-    "azureFunctions.setAzureWebJobsStorage": "Set AzureWebJobsStorage...",
     "azureFunctions.show64BitWarning": "Show a warning to install a 64-bit version of the Azure Functions Core Tools when you create a .NET Framework project.",
     "azureFunctions.showCoreToolsWarning": "Show a warning if your installed version of Azure Functions Core Tools is out-of-date.",
     "azureFunctions.showDeployConfirmation": "Ask for confirmation before deploying to a Function App in Azure (deploying will overwrite any previous deployment and cannot be undone).",

src/commands/addBinding/IBindingWizardContext.ts

@@ -17,4 +17,5 @@ export interface IBindingWizardContext extends IFunctionWizardContext {
     bindingTemplate?: IBindingTemplate;
     binding?: IFunctionBinding;
     bindingName?: string;
+    useStorageEmulator?: boolean;
 }

src/commands/addBinding/settingSteps/AzureConnectionCreateStepBase.ts

@@ -33,7 +33,10 @@ export abstract class AzureConnectionCreateStepBase<T extends IBindingWizardCont
         progress.report({ message: localize('retrieving', 'Retrieving connection string...') });
 
         const result: IConnection = await this.getConnection(context);
-        let appSettingKey: string = `${result.name}_${nonNullProp(this._setting, 'resourceType').toUpperCase()}`;
+        let appSettingKey: string = context.useStorageEmulator ?
+            // if using the storage emulator, don't append the resource type to the app setting key
+            result.name :
+            `${result.name}_${nonNullProp(this._setting, 'resourceType').toUpperCase()}`;
         appSettingKey = appSettingKey.replace(/[^a-z0-9_\.]/gi, ''); // remove invalid chars
         setBindingSetting(context, this._setting, appSettingKey);
         await setLocalAppSetting(context, context.projectPath, appSettingKey, result.connectionString);

src/commands/addBinding/settingSteps/LocalAppSettingListStep.ts

@@ -3,7 +3,6 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { StorageAccountKind, StorageAccountListStep, StorageAccountPerformance, StorageAccountReplication } from '@microsoft/vscode-azext-azureutils';
 import { type AzureWizardExecuteStep, type AzureWizardPromptStep, type IAzureQuickPickItem, type ISubscriptionActionContext, type IWizardOptions } from '@microsoft/vscode-azext-utils';
 import * as path from 'path';
 import { localSettingsFileName } from '../../../constants';
@@ -20,7 +19,7 @@ import { BindingSettingStepBase } from './BindingSettingStepBase';
 import { LocalAppSettingCreateStep } from './LocalAppSettingCreateStep';
 import { LocalAppSettingNameStep } from './LocalAppSettingNameStep';
 import { LocalAppSettingValueStep } from './LocalAppSettingValueStep';
-import { StorageConnectionCreateStep } from './StorageConnectionCreateStep';
+import { StorageTypePromptStep } from './StorageTypePromptStep';
 import { CosmosDBConnectionCreateStep } from './cosmosDB/CosmosDBConnectionCreateStep';
 import { CosmosDBListStep } from './cosmosDB/CosmosDBListStep';
 import { EventHubAuthRuleListStep } from './eventHub/EventHubAuthRuleListStep';
@@ -33,10 +32,11 @@ export class LocalAppSettingListStep extends BindingSettingStepBase {
     public async promptCore(context: IBindingWizardContext): Promise<BindingSettingValue> {
         const localSettingsPath: string = path.join(context.projectPath, localSettingsFileName);
         const settings: ILocalSettingsJson = await getLocalSettingsJson(context, localSettingsPath);
-        const existingSettings: string[] = settings.Values ? Object.keys(settings.Values) : [];
+        const existingSettings: [string, string][] = settings.Values ? Object.entries(settings.Values) : [];
+
         let picks: IAzureQuickPickItem<string | undefined>[] = [{ label: localize('newAppSetting', '$(plus) Create new local app setting'), data: undefined }];
-        picks = picks.concat(existingSettings.map((s: string) => { return { data: s, label: s }; }));
-        const placeHolder: string = localize('selectAppSetting', 'Select setting from "{0}"', localSettingsFileName);
+        picks = picks.concat(existingSettings.map((s: [string, string]) => { return { data: s[0], label: s[0], description: s[1] }; }));
+        const placeHolder: string = localize('selectAppSetting', 'Select the app setting with your {1} string from "{0}"', localSettingsFileName, this._setting.label);
         return (await context.ui.showQuickPick(picks, { placeHolder })).data;
     }
 
@@ -50,11 +50,7 @@ export class LocalAppSettingListStep extends BindingSettingStepBase {
                     azureExecuteSteps.push(new CosmosDBConnectionCreateStep(this._setting));
                     break;
                 case ResourceType.Storage:
-                    azurePromptSteps.push(new StorageAccountListStep(
-                        { kind: StorageAccountKind.Storage, performance: StorageAccountPerformance.Standard, replication: StorageAccountReplication.LRS },
-                        { kind: [StorageAccountKind.BlobStorage], learnMoreLink: 'https://aka.ms/T5o0nf' }
-                    ));
-                    azureExecuteSteps.push(new StorageConnectionCreateStep(this._setting));
+                    azurePromptSteps.push(new StorageTypePromptStep(this._setting));
                     break;
                 case ResourceType.ServiceBus:
                     azurePromptSteps.push(new ServiceBusListStep());

src/commands/addBinding/settingSteps/StorageConnectionCreateStep.ts

@@ -9,11 +9,11 @@ import { type IBindingWizardContext } from '../IBindingWizardContext';
 import { AzureConnectionCreateStepBase, type IConnection } from './AzureConnectionCreateStepBase';
 
 export class StorageConnectionCreateStep extends AzureConnectionCreateStepBase<IStorageAccountWizardContext & IBindingWizardContext> {
-    public async getConnection(context: IStorageAccountWizardContext): Promise<IConnection> {
+    public async getConnection(context: IStorageAccountWizardContext & Partial<IBindingWizardContext>): Promise<IConnection> {
         return await getStorageConnectionString(context);
     }
 
-    public shouldExecute(context: IStorageAccountWizardContext): boolean {
-        return !!context.storageAccount;
+    public shouldExecute(context: IStorageAccountWizardContext & Partial<IBindingWizardContext>): boolean {
+        return !!context.storageAccount || !!context.useStorageEmulator;
     }
 }

src/commands/addBinding/settingSteps/StorageTypePromptStep.ts

@@ -0,0 +1,54 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { StorageAccountKind, StorageAccountListStep, StorageAccountPerformance, StorageAccountReplication } from "@microsoft/vscode-azext-azureutils";
+import { AzureWizardPromptStep, type AzureWizardExecuteStep, type IAzureQuickPickItem, type ISubscriptionActionContext, type IWizardOptions } from "@microsoft/vscode-azext-utils";
+import { localize } from "../../../localize";
+import { type IBindingSetting } from "../../../templates/IBindingTemplate";
+import { type IEventHubsConnectionWizardContext } from "../../appSettings/connectionSettings/eventHubs/IEventHubsConnectionWizardContext";
+import { type IBindingWizardContext } from "../IBindingWizardContext";
+import { StorageConnectionCreateStep } from "./StorageConnectionCreateStep";
+
+export class StorageTypePromptStep extends AzureWizardPromptStep<IBindingWizardContext> {
+    private readonly _setting: IBindingSetting;
+
+    constructor(setting: IBindingSetting) {
+        super();
+        this._setting = setting;
+    }
+
+    public async prompt(context: IBindingWizardContext): Promise<void> {
+        const picks: IAzureQuickPickItem<boolean>[] = [
+            { label: localize('useAzurite', 'Use Azurite emulator for local storage'), data: true },
+            { label: localize('useAzureStorage', 'Use Azure Storage for remote storage'), data: false }
+        ];
+
+        context.useStorageEmulator = (await context.ui.showQuickPick(picks, { placeHolder: localize('selectStorage', 'Select a storage account type for development') })).data;
+        return;
+    }
+
+    public shouldPrompt(context: IBindingWizardContext): boolean {
+        return context.useStorageEmulator === undefined;
+    }
+
+    public async getSubWizard(context: IBindingWizardContext): Promise<IWizardOptions<IBindingWizardContext> | undefined> {
+        const promptSteps: AzureWizardPromptStep<IBindingWizardContext & ISubscriptionActionContext & IEventHubsConnectionWizardContext>[] = [];
+        const executeSteps: AzureWizardExecuteStep<IBindingWizardContext & ISubscriptionActionContext & IEventHubsConnectionWizardContext>[] = [];
+
+        if (!context.useStorageEmulator) {
+            promptSteps.push(new StorageAccountListStep(
+                { kind: StorageAccountKind.Storage, performance: StorageAccountPerformance.Standard, replication: StorageAccountReplication.LRS },
+                { kind: [StorageAccountKind.BlobStorage], learnMoreLink: 'https://aka.ms/T5o0nf' }
+            ));
+        }
+
+        executeSteps.push(new StorageConnectionCreateStep(this._setting));
+
+        return {
+            promptSteps,
+            executeSteps
+        };
+    }
+}

src/commands/appSettings/connectionSettings/getLocalConnectionSetting.ts

@@ -7,7 +7,7 @@ import { KnownAccessRights, type AccessKeys, type AuthorizationRule, type EventH
 import { type StorageAccount, type StorageAccountListKeysResult, type StorageManagementClient } from "@azure/arm-storage";
 import { getResourceGroupFromId, uiUtils, type IStorageAccountWizardContext } from "@microsoft/vscode-azext-azureutils";
 import { nonNullProp, nonNullValue, type ISubscriptionContext } from "@microsoft/vscode-azext-utils";
-import { localSettingsFileName } from "../../../constants";
+import { ConnectionKey, localSettingsFileName, localStorageEmulatorConnectionString } from "../../../constants";
 import { defaultDescription } from "../../../constants-nls";
 import { ext } from "../../../extensionVariables";
 import { localize } from "../../../localize";
@@ -21,11 +21,17 @@ export interface IResourceResult {
     connectionString: string;
 }
 
-export async function getStorageConnectionString(context: IStorageAccountWizardContext): Promise<IResourceResult> {
+export async function getStorageConnectionString(context: IStorageAccountWizardContext & { useStorageEmulator?: boolean }): Promise<IResourceResult> {
+    if (context.useStorageEmulator) {
+        return {
+            name: ConnectionKey.Storage,
+            connectionString: localStorageEmulatorConnectionString
+        }
+    }
+
     const client: StorageManagementClient = await createStorageClient(context);
     const storageAccount: StorageAccount = nonNullProp(context, 'storageAccount');
     const name: string = nonNullProp(storageAccount, 'name');
-
     const resourceGroup: string = getResourceGroupFromId(nonNullProp(storageAccount, 'id'));
     const result: StorageAccountListKeysResult = await client.storageAccounts.listKeys(resourceGroup, name);
     const key: string = nonNullProp(nonNullValue(nonNullProp(result, 'keys')[0], 'keys[0]'), 'value');

src/commands/registerCommands.ts

@@ -15,7 +15,6 @@ import { deleteServiceConnector } from '../serviceConnector/deleteServiceConnect
 import { validateServiceConnector } from '../serviceConnector/validateServiceConnector';
 import { ResolvedFunctionAppResource } from '../tree/ResolvedFunctionAppResource';
 import { addBinding } from './addBinding/addBinding';
-import { setAzureWebJobsStorage } from './appSettings/connectionSettings/azureWebJobsStorage/setAzureWebJobsStorage';
 import { downloadAppSettings } from './appSettings/downloadAppSettings';
 import { decryptLocalSettings } from './appSettings/localSettings/decryptLocalSettings';
 import { encryptLocalSettings } from './appSettings/localSettings/encryptLocalSettings';
@@ -93,7 +92,6 @@ export function registerCommands(): void {
     registerCommandWithTreeNodeUnwrapping('azureFunctions.pickProcess', pickFuncProcess);
     registerCommandWithTreeNodeUnwrapping('azureFunctions.redeploy', redeployDeployment);
     registerCommandWithTreeNodeUnwrapping('azureFunctions.restartFunctionApp', restartFunctionApp);
-    registerCommandWithTreeNodeUnwrapping('azureFunctions.setAzureWebJobsStorage', setAzureWebJobsStorage);
     registerCommandWithTreeNodeUnwrapping('azureFunctions.startFunctionApp', startFunctionApp);
     registerCommandWithTreeNodeUnwrapping('azureFunctions.startJavaRemoteDebug', remoteDebugJavaFunctionApp);
     registerCommandWithTreeNodeUnwrapping('azureFunctions.startRemoteDebug', startRemoteDebug);