Return configuration changes to caller

libraries/azure-app-configuration-importer-file-source/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/app-configuration-importer-file-source",
   "author": "Microsoft Corporation",
   "description": "A client library for importing/exporting key-values between configuration file sources and Azure App Configuration service",
-  "version": "1.1.3-preview",
+  "version": "2.1.3-preview",
   "sdk-type": "client",
   "keywords": [
     "node",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@azure/app-configuration": "^1.9.0",
-    "@azure/app-configuration-importer": "1.1.3-preview"
+    "@azure/app-configuration-importer": "2.1.3-preview"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.22.2",

libraries/azure-app-configuration-importer/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/app-configuration-importer",
   "author": "Microsoft Corporation",
   "description": "A client library for importing/exporting key-values between configuration sources and Azure App Configuration service",
-  "version": "1.1.3-preview",
+  "version": "2.1.3-preview",
   "sdk-type": "client",
   "keywords": [
     "node",

libraries/azure-app-configuration-importer/src/appConfigurationImporter.ts

@@ -11,7 +11,7 @@
 import { ImportMode } from "./enums";
 import { OperationTimeoutError, ArgumentError } from "./errors";
 import { AdaptiveTaskManager } from "./internal/adaptiveTaskManager";
-import { ImportProgress, KeyLabelLookup } from "./models";
+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,74 @@
    * @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.
-   * @param dryRun - When dry run is enabled, no updates  will be performed to App Configuration. Instead, any updates that would have been performed in a normal run will be printed to the console for review
+   * @returns Promise<void>
    */
   public async Import(
     configSettingsSource: ConfigurationSettingsSource,
     timeout: number,
     strict = false,
     progressCallback?: (progress: ImportProgress) => unknown,
+    importMode?: ImportMode
+  ): Promise<void> {
+    if (importMode === undefined) {
+      importMode = ImportMode.IgnoreMatch;
+    }
+
+    this.validateImportMode(importMode);
+
+    // 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(
+   *   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,
-    dryRun?: boolean
-  ) {
+    customHeadersOption?: OperationOptions
+  ): Promise<ConfigurationChanges> {
     if (importMode == undefined) {
       importMode = ImportMode.IgnoreMatch;
     }
-    if (dryRun == undefined) {
-      dryRun = false;
-    }
+
     this.validateImportMode(importMode);
 
     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 +120,43 @@
       srcKeyLabelLookUp[config.key][config.label || ""] = true;
     });
 
-    // generate correlationRequestId for operations in the same activity
-    const customCorrelationRequestId: string = uuidv4();
-    const customHeadersOption: OperationOptions = {
-      requestOptions: {
-        customHeaders: {
-          [Constants.CorrelationRequestIdHeader]: customCorrelationRequestId
-        }
-      }
-    };
+    configurationSettingToAdd.push(...configSettings);
 
-    if (strict || importMode == ImportMode.IgnoreMatch) {
-      for await (const existing of this.configurationClient.listConfigurationSettings({...configSettingsSource.FilterOptions, ...customHeadersOption})) {
-
-        const isKeyLabelPresent: boolean = srcKeyLabelLookUp[existing.key] && srcKeyLabelLookUp[existing.key][existing.label || ""];
+    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 (strict && !isKeyLabelPresent) {
-          configurationSettingToDelete.push(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);
+          }
         }
-
-        if (importMode == ImportMode.IgnoreMatch) {
-          const incoming = configSettings.find(configSetting => configSetting.key == existing.key && 
-            configSetting.label == existing.label);
-
-          if (incoming && isConfigSettingEqual(incoming, existing)) {
-            configSettings.splice(configSettings.indexOf(incoming), 1);
+        else if (importMode === ImportMode.IgnoreMatch) {
+          // Remove unchanged settings from add list
+          const addIndex = configurationSettingToAdd.indexOf(incoming);
+          if (addIndex !== -1) {
+            configurationSettingToAdd.splice(addIndex, 1);
           }
         }
       }
     }
-
-    if (dryRun) {
-      this.printUpdatesToConsole(configSettings, configurationSettingToDelete);
-    }
-    else {
-      await this.applyUpdatesToServer(configSettings, configurationSettingToDelete, timeout, customHeadersOption, progressCallback);
-    }
-  }
 
-  private printUpdatesToConsole(
-    settingsToAdd: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[], 
-    settingsToDelete: ConfigurationSetting<string>[]
-  ): void {
-    console.log("The following settings will be removed from App Configuration:");
-    for (const setting of settingsToDelete) {
-
-      console.log(JSON.stringify({key: setting.key, label: setting.label, contentType: setting.contentType, tags: setting.tags}));
-    } 
-
-    console.log("\nThe following settings will be written to App Configuration:");
-    for (const setting of settingsToAdd) {
-
-      console.log(JSON.stringify({key: setting.key, label: setting.label, contentType: setting.contentType, tags: setting.tags}));
-    }
+    return {
+      Added: configurationSettingToAdd,
+      Modified: configurationSettingToModify,
+      Deleted: configurationSettingToDelete
+    };
   }
 
   private async applyUpdatesToServer(
@@ -146,7 +177,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) {

libraries/azure-app-configuration-importer/src/index.ts

@@ -9,7 +9,7 @@ export {
 } from "./importOptions";
 export * from "./enums";
 export * from "./errors";
-export { ImportProgress as ImportResult } from "./models";
+export { ImportProgress as ImportResult, ConfigurationChanges } from "./models";
 export { StringConfigurationSettingsSource } from "./settingsImport/stringConfigurationSettingsSource";
 export { ConfigurationSettingsSource } from "./settingsImport/configurationSettingsSource";
 export { IterableConfigurationSettingsSource } from "./settingsImport/iterableConfigurationSettingsSource";

libraries/azure-app-configuration-importer/src/models.ts

@@ -1,6 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+import { 
+  SecretReferenceValue,
+  ConfigurationSetting,
+  SetConfigurationSettingParam,
+  FeatureFlagValue
+} from "@azure/app-configuration";
+
 /**
  * @internal
  */
@@ -42,4 +49,10 @@ export interface KeyLabelLookup {
   [key: string]: {
     [label: string] : boolean
   }
+}
+
+export interface ConfigurationChanges {
+  Deleted: ConfigurationSetting<string>[];
+  Modified: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[];
+  Added: SetConfigurationSettingParam<string | FeatureFlagValue | SecretReferenceValue>[];
 }