Return configuration changes to caller #21
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,7 +11,7 @@ | |
| import { ImportMode } from "./enums"; | ||
| import { OperationTimeoutError, ArgumentError } from "./errors"; | ||
| import { AdaptiveTaskManager } from "./internal/adaptiveTaskManager"; | ||
| import { ImportProgress, KeyLabelLookup, ConfigurationChanges } from "./models"; | ||
| import { isConfigSettingEqual } from "./internal/utils"; | ||
| import { v4 as uuidv4 } from "uuid"; | ||
| import { Constants } from "./internal/constants"; | ||
|
|
@@ -43,27 +43,78 @@ | |
| * @param timeout - Seconds of entire import progress timeout | ||
| * @param progressCallback - Callback for report the progress of import | ||
| * @param importMode - Determines the behavior when importing key-values. The default value, 'All' will import all key-values in the input file to App Configuration. 'Ignore-Match' will only import settings that have no matching key-value in App Configuration. | ||
| * @returns Promise<void> | ||
| */ | ||
| public async Import( | ||
| configSettingsSource: ConfigurationSettingsSource, | ||
| timeout: number, | ||
| strict = false, | ||
| progressCallback?: (progress: ImportProgress) => unknown, | ||
| importMode = ImportMode.IgnoreMatch | ||
| ): Promise<void> { | ||
| this.validateImportMode(importMode); | ||
MaryanneNjeri marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| // Generate correlation ID for operations | ||
|
||
| const customCorrelationRequestId: string = uuidv4(); | ||
| const customHeadersOption: OperationOptions = { | ||
| requestOptions: { | ||
| customHeaders: { | ||
| [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const configurationChanges: ConfigurationChanges = await this.GetConfigurationChanges(configSettingsSource, strict, importMode, customHeadersOption); | ||
|
||
|
|
||
| await this.applyUpdatesToServer([...configurationChanges.Added, ...configurationChanges.Modified], configurationChanges.Deleted, timeout, customHeadersOption, progressCallback); | ||
| } | ||
|
|
||
| /** | ||
| * Get configuration changes between source settings and Azure App Configuration service without any applying changes | ||
|
||
| * | ||
| * Example usage: | ||
| * ```ts | ||
| * const fileData = fs.readFileSync("mylocalPath").toString(); | ||
| * const configurationChanges = await client.getConfigurationChanges( | ||
ChristineWanjau marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * new StringConfigurationSettingsSource({data:fileData, format: ConfigurationFormat.Json}), | ||
| * false, | ||
| * ImportMode.All, | ||
| * options | ||
| * ); | ||
| * ``` | ||
| * @param configSettingsSource - A ConfigurationSettingsSource instance. | ||
| * @param strict - Use strict mode to delete settings not in source. | ||
| * @param importMode - Determines the behavior when analyzing key-values. | ||
| * 'All' will include all key-values. | ||
| * 'Ignore-Match' will exclude settings that have matching key-values in App Configuration. | ||
| * @param customHeadersOption - Custom headers for the operation. | ||
| * @returns ConfigurationChanges object containing Added, Modified, and Deleted settings | ||
| */ | ||
| public async GetConfigurationChanges( | ||
| configSettingsSource: ConfigurationSettingsSource, | ||
| strict = false, | ||
| importMode = ImportMode.IgnoreMatch, | ||
| customHeadersOption?: OperationOptions | ||
|
Member
There was a problem hiding this comment. How is this used in this function?
Contributor
Author
There was a problem hiding this comment. The customHeadersOptions?
Member
There was a problem hiding this comment. Right. It does look like needed for this function.
Contributor
Author
There was a problem hiding this comment. We use customHeadersOption to pass the correlationRequestId to link requests involved in the Import process. When the Import API calls the GetConfigurationChanges API, we pass the same correlationRequestId to associate both the read and write operations.
Contributor
Author
There was a problem hiding this comment. Discussed offline. Updated to generate |
||
| ): Promise<ConfigurationChanges> { | ||
| this.validateImportMode(importMode); | ||
|
|
||
| // Generate correlation ID | ||
| if (!customHeadersOption) { | ||
| const customCorrelationRequestId: string = uuidv4(); | ||
| customHeadersOption = { | ||
| requestOptions: { | ||
| customHeaders: { | ||
| [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| const configSettings = await configSettingsSource.GetConfigurationSettings(); | ||
|
|
||
| const configurationSettingToDelete: ConfigurationSetting<string>[] = []; | ||
| const configurationSettingToModify: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[] = []; | ||
| const configurationSettingToAdd: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[] = []; | ||
| const srcKeyLabelLookUp: KeyLabelLookup = {}; | ||
|
|
||
| configSettings.forEach((config: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>) => { | ||
|
|
@@ -73,59 +124,43 @@ | |
| srcKeyLabelLookUp[config.key][config.label || ""] = true; | ||
| }); | ||
|
|
||
| configurationSettingToAdd.push(...configSettings); | ||
|
|
||
| for await (const existing of this.configurationClient.listConfigurationSettings({...configSettingsSource.FilterOptions, ...customHeadersOption})) { | ||
| const isKeyLabelPresent: boolean = srcKeyLabelLookUp[existing.key] && srcKeyLabelLookUp[existing.key][existing.label || ""]; | ||
| if (strict && !isKeyLabelPresent) { | ||
| configurationSettingToDelete.push(existing); | ||
| } | ||
|
|
||
| const incoming = configSettings.find(configSetting => configSetting.key == existing.key && | ||
|
||
| configSetting.label === existing.label); | ||
|
|
||
| if (incoming) { | ||
| const settingsAreEqual: boolean = isConfigSettingEqual(incoming, existing); | ||
|
|
||
| if (!settingsAreEqual) { | ||
| configurationSettingToModify.push(incoming); | ||
| // Remove from add list since it's a modification, not an addition | ||
| const addIndex = configurationSettingToAdd.indexOf(incoming); | ||
|
||
| if (addIndex !== -1) { | ||
| configurationSettingToAdd.splice(addIndex, 1); | ||
| } | ||
| } | ||
| else if (importMode === ImportMode.IgnoreMatch) { | ||
| // Remove unchanged settings from add list | ||
| const addIndex = configurationSettingToAdd.indexOf(incoming); | ||
| if (addIndex !== -1) { | ||
| configurationSettingToAdd.splice(addIndex, 1); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return { | ||
| Added: configurationSettingToAdd, | ||
| Modified: configurationSettingToModify, | ||
| Deleted: configurationSettingToDelete | ||
| }; | ||
| } | ||
|
|
||
| private async applyUpdatesToServer( | ||
|
Member
There was a problem hiding this comment. How about changing the argument name |
||
|
|
@@ -146,7 +181,7 @@ | |
| await this.executeTasksWithTimeout(importTaskManager, timeout, progressCallback); | ||
| } | ||
|
|
||
| private newAdaptiveTaskManager<T>(task: (setting: T) => Promise<any>, configurationSettings: Array<T>) { | ||
| let index = 0; | ||
| return new AdaptiveTaskManager(() => { | ||
| if (index == configurationSettings.length) { | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.