Add Local and Remote Settings conversion #4387
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.md in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { type StringDictionary } from "@azure/arm-appservice"; | ||
| import { isSettingConvertible } from "@microsoft/vscode-azext-azureappsettings"; | ||
| import { AzExtFsExtra, AzureWizardPromptStep, nonNullValue, type IAzureQuickPickItem } from "@microsoft/vscode-azext-utils"; | ||
| import * as vscode from 'vscode'; | ||
| import { type ILocalSettingsJson } from "../../funcConfig/local.settings"; | ||
| import { localize } from "../../localize"; | ||
| import { decryptLocalSettings } from "../appSettings/localSettings/decryptLocalSettings"; | ||
| import { encryptLocalSettings } from "../appSettings/localSettings/encryptLocalSettings"; | ||
| import { getLocalSettingsFile } from "../appSettings/localSettings/getLocalSettingsFile"; | ||
| import { type IAddMIConnectionsContext } from "./IAddMIConnectionsContext"; | ||
|
|
||
| export interface Connection { | ||
| name: string; | ||
| value: string; | ||
| } | ||
|
|
||
| export class ConnectionsListStep extends AzureWizardPromptStep<IAddMIConnectionsContext> { | ||
| public async prompt(context: IAddMIConnectionsContext): Promise<void> { | ||
| const picks = await this.getPicks(context); | ||
|
|
||
| if (picks.length === 0) { | ||
| const noItemFoundMessage: string = localize('noConnectionsFound', 'No connections found in local settings'); | ||
| (await context.ui.showQuickPick(picks, { | ||
| placeHolder: localize('selectConnections', 'Select the connections you want to add managed identity support for'), | ||
| suppressPersistence: true, | ||
| noPicksMessage: noItemFoundMessage | ||
| })); | ||
| } else { | ||
| context.connections = (await context.ui.showQuickPick(picks, { | ||
| placeHolder: localize('selectConnections', 'Select the connections you want to add managed identity support for'), | ||
| suppressPersistence: true, | ||
| canPickMany: true, | ||
| })).map(item => item.data); | ||
| } | ||
| } | ||
|
|
||
| public shouldPrompt(context: IAddMIConnectionsContext): boolean { | ||
| return !context.connections || context.connections.length === 0; | ||
| } | ||
|
|
||
| private async getPicks(context: IAddMIConnectionsContext): Promise<IAzureQuickPickItem<Connection>[]> { | ||
| if (context.functionapp) { | ||
|
Member
There was a problem hiding this comment. nit: |
||
| return this.getRemoteQuickPicks(context); | ||
| } else { | ||
| return this.getLocalQuickPicks(context); | ||
| } | ||
| } | ||
|
|
||
| private async getLocalQuickPicks(context: IAddMIConnectionsContext, workspaceFolder?: vscode.WorkspaceFolder): Promise<IAzureQuickPickItem<Connection>[]> { | ||
| const picks: IAzureQuickPickItem<Connection>[] = []; | ||
| const message: string = localize('selectLocalSettings', 'Select the local settings to add identity settings for.'); | ||
| const localSettingsPath: string = await getLocalSettingsFile(context, message, workspaceFolder); | ||
| const localSettingsUri: vscode.Uri = vscode.Uri.file(localSettingsPath); | ||
| context.localSettingsPath = localSettingsPath; | ||
|
|
||
| if (await AzExtFsExtra.pathExists(localSettingsPath)) { | ||
|
Member
There was a problem hiding this comment. Now that you're using this function, I think you can get rid of the if statement above. |
||
| let localSettings: ILocalSettingsJson = <ILocalSettingsJson>await AzExtFsExtra.readJSON(localSettingsPath); | ||
| if (localSettings.IsEncrypted) { | ||
| await decryptLocalSettings(context, localSettingsUri); | ||
| try { | ||
| localSettings = await AzExtFsExtra.readJSON<ILocalSettingsJson>(localSettingsPath); | ||
| } finally { | ||
| await encryptLocalSettings(context, localSettingsUri); | ||
| } | ||
| } | ||
|
|
||
| if (localSettings.Values) { | ||
| for (const [key, value] of Object.entries(localSettings.Values)) { | ||
| if (!isSettingConvertible(key, value)) { | ||
| continue; | ||
| } | ||
|
|
||
| picks.push({ | ||
| label: key, | ||
| data: { | ||
| name: key, | ||
| value: value | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return picks; | ||
| } | ||
|
|
||
| private async getRemoteQuickPicks(context: IAddMIConnectionsContext): Promise<IAzureQuickPickItem<Connection>[]> { | ||
| const picks: IAzureQuickPickItem<Connection>[] = []; | ||
|
|
||
| const client = await nonNullValue(context.functionapp?.site.createClient(context)); | ||
| const appSettings: StringDictionary = await client.listApplicationSettings(); | ||
| if (appSettings.properties) { | ||
| for (const [key, value] of Object.entries(appSettings.properties)) { | ||
| if (!isSettingConvertible(key, value)) { | ||
| continue; | ||
| } | ||
|
|
||
| picks.push({ | ||
| label: key, | ||
| data: { | ||
| name: key, | ||
| value: value | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| return picks; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.md in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { type IResourceGroupWizardContext, type Role } from "@microsoft/vscode-azext-azureutils"; | ||
| import { type ExecuteActivityContext, type ISubscriptionActionContext } from "@microsoft/vscode-azext-utils"; | ||
| import { type SlotTreeItem } from "../../tree/SlotTreeItem"; | ||
| import { type Connection } from "./ConnectionsListStep"; | ||
|
|
||
| export interface IAddMIConnectionsContext extends ExecuteActivityContext, IResourceGroupWizardContext, ISubscriptionActionContext { | ||
|
Member
There was a problem hiding this comment. nit: No "👁️" needed here................................. |
||
| functionapp?: SlotTreeItem; | ||
| connections?: Connection[]; | ||
| connectionsToAdd?: Connection[]; | ||
| roles?: Role[]; | ||
| localSettingsPath?: string; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.md in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { activitySuccessContext, activitySuccessIcon, AzExtFsExtra, AzureWizardExecuteStep, createUniversallyUniqueContextValue, GenericTreeItem, nonNullProp } from "@microsoft/vscode-azext-utils"; | ||
| import { ext } from "../../extensionVariables"; | ||
| import { type ILocalSettingsJson } from "../../funcConfig/local.settings"; | ||
| import { localize } from "../../localize"; | ||
| import { getLocalSettingsFile } from "../appSettings/localSettings/getLocalSettingsFile"; | ||
| import { type IAddMIConnectionsContext } from "./IAddMIConnectionsContext"; | ||
|
|
||
| export class LocalSettingsAddStep extends AzureWizardExecuteStep<IAddMIConnectionsContext> { | ||
| public priority: number = 125; | ||
|
|
||
| public async execute(context: IAddMIConnectionsContext): Promise<void> { | ||
| // If right clicking on a connection we will have the connections to convert but not the local settings path | ||
| if (!context.localSettingsPath) { | ||
| const message: string = localize('selectLocalSettings', 'Select the local settings file to add connections to.'); | ||
| context.localSettingsPath = await getLocalSettingsFile(context, message); | ||
| } | ||
|
|
||
| const localSettings = await AzExtFsExtra.readJSON<ILocalSettingsJson>(nonNullProp(context, 'localSettingsPath')); | ||
|
Member
There was a problem hiding this comment. I feel like we should just make getting the settings from the |
||
| if (localSettings.Values) { | ||
| for (const connection of nonNullProp(context, 'connectionsToAdd')) { | ||
| localSettings.Values[connection.name] = connection.value; | ||
| context.activityChildren?.push( | ||
| new GenericTreeItem(undefined, { | ||
| contextValue: createUniversallyUniqueContextValue(['useExistingResourceGroupInfoItem', activitySuccessContext]), | ||
| label: localize('addedLocalSetting', 'Add Local setting "{0}"', connection.name), | ||
| iconPath: activitySuccessIcon | ||
| }) | ||
| ); | ||
| } | ||
| await AzExtFsExtra.writeJSON(nonNullProp(context, 'localSettingsPath'), localSettings); | ||
| await ext.rgApi.workspaceResourceTree.refresh(context); | ||
| } | ||
| } | ||
| public shouldExecute(context: IAddMIConnectionsContext): boolean { | ||
| return !context.functionapp && !!context.connections | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.md in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { activitySuccessContext, activitySuccessIcon, AzureWizardExecuteStep, createUniversallyUniqueContextValue, GenericTreeItem, nonNullProp } from "@microsoft/vscode-azext-utils"; | ||
| import { ext } from "../../extensionVariables"; | ||
| import { localize } from "../../localize"; | ||
| import { type IAddMIConnectionsContext } from "./IAddMIConnectionsContext"; | ||
|
|
||
| export class RemoteSettingsAddStep extends AzureWizardExecuteStep<IAddMIConnectionsContext> { | ||
| public priority: number = 110; | ||
|
|
||
| public async execute(context: IAddMIConnectionsContext): Promise<void> { | ||
| if (!context.functionapp) { | ||
|
Member
There was a problem hiding this comment. nit: Why not just use |
||
| throw new Error(localize('functionAppNotFound', 'Function app not found.')); | ||
| } | ||
|
|
||
| const client = await context.functionapp?.site.createClient(context); | ||
| const remoteSettings = await client.listApplicationSettings(); | ||
| for (const connection of nonNullProp(context, 'connectionsToAdd')) { | ||
|
nturinski marked this conversation as resolved.
|
||
| if (remoteSettings.properties) { | ||
| remoteSettings.properties[connection.name] = connection.value; | ||
| } else { | ||
| await client.updateApplicationSettings({ properties: { [connection.name]: connection.value } }); | ||
| } | ||
| context.activityChildren?.push( | ||
| new GenericTreeItem(undefined, { | ||
|
nturinski marked this conversation as resolved.
|
||
| contextValue: createUniversallyUniqueContextValue(['useExistingResourceGroupInfoItem', activitySuccessContext]), | ||
| label: localize('addedAppSetting', 'Add app setting "{0}"', connection.name), | ||
| iconPath: activitySuccessIcon | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| await client.updateApplicationSettings({ properties: remoteSettings.properties }); | ||
| await ext.rgApi.tree.refresh(context); | ||
| } | ||
|
|
||
| public shouldExecute(context: IAddMIConnectionsContext): boolean { | ||
| return !!context.functionapp && !!context.connections; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.