Merge branch 'zhiyuanliang/select-snapshot' of https://github.com/Azure/AppConfiguration-JavaScriptProvider into zhiyuanliang/select-snapshot

Author: zhiyuanliang-ms

src/types.ts

@@ -17,7 +17,7 @@ export type SettingSelector = {
      * For all other cases the characters: asterisk `*`, comma `,`, and backslash `\` are reserved. Reserved characters must be escaped using a backslash (\).
      * e.g. the key filter `a\\b\,\*c*` returns all key-values whose key starts with `a\b,*c`.
      */
-    keyFilter: string,
+    keyFilter?: string,
 
     /**
      * The label filter to apply when querying Azure App Configuration for key-values.

test/load.test.ts

@@ -6,7 +6,7 @@ import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 import { load } from "./exportedApi.js";
-import { MAX_TIME_OUT, mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedEndpoint, createMockedTokenCredential, createMockedKeyValue } from "./utils/testHelper.js";
+import { MAX_TIME_OUT, mockAppConfigurationClientListConfigurationSettings, mockAppConfigurationClientGetSnapshot, mockAppConfigurationClientListConfigurationSettingsForSnapshot, restoreMocks, createMockedConnectionString, createMockedEndpoint, createMockedTokenCredential, createMockedKeyValue } from "./utils/testHelper.js";
 
 const mockedKVs = [{
     key: "app.settings.fontColor",
@@ -418,4 +418,32 @@ describe("load", function () {
             settings.constructConfigurationObject({ separator: "%" });
         }).to.throw("Invalid separator '%'. Supported values: '.', ',', ';', '-', '_', '__', '/', ':'.");
     });
+
+    it("should load from snapshot", async () => {
+        const snapshotName = "Test";
+        mockAppConfigurationClientGetSnapshot(snapshotName, {compositionType: "key"});
+        mockAppConfigurationClientListConfigurationSettingsForSnapshot(snapshotName, [[{key: "TestKey", value: "TestValue"}].map(createMockedKeyValue)]);
+        const connectionString = createMockedConnectionString();
+        const settings = await load(connectionString, {
+            selectors: [{
+                snapshotName: snapshotName
+            }]
+        });
+        expect(settings).not.undefined;
+        expect(settings).not.undefined;
+        expect(settings.get("TestKey")).eq("TestValue");
+        restoreMocks();
+    });
+
+    it("should throw error when snapshot composition type is not key", async () => {
+        const snapshotName = "Test";
+        mockAppConfigurationClientGetSnapshot(snapshotName, {compositionType: "key_label"});
+        const connectionString = createMockedConnectionString();
+        expect(load(connectionString, {
+            selectors: [{
+                snapshotName: snapshotName
+            }]
+        })).eventually.rejectedWith(`Composition type for the selected snapshot with name ${snapshotName} must be 'key'.`);
+        restoreMocks();
+    });
 });

test/utils/testHelper.ts

@@ -162,6 +162,35 @@ function mockAppConfigurationClientGetConfigurationSetting(kvList, customCallbac
     });
 }
 
+function mockAppConfigurationClientGetSnapshot(snapshotName: string, mockedResponse: any, customCallback?: (options) => any) {
+    sinon.stub(AppConfigurationClient.prototype, "getSnapshot").callsFake((name, options) => {
+        if (customCallback) {
+            customCallback(options);
+        }
+
+        if (name === snapshotName) {
+            return mockedResponse;
+        } else {
+            throw new RestError("", { statusCode: 404 });
+        }
+    });
+}
+
+function mockAppConfigurationClientListConfigurationSettingsForSnapshot(snapshotName: string, pages: ConfigurationSetting[][], customCallback?: (options) => any) {
+    sinon.stub(AppConfigurationClient.prototype, "listConfigurationSettingsForSnapshot").callsFake((name, listOptions) => {
+        if (customCallback) {
+            customCallback(listOptions);
+        }
+
+        if (name === snapshotName) {
+            const kvs = _filterKVs(pages.flat(), listOptions);
+            return getMockedIterator(pages, kvs, listOptions);
+        } else {
+            throw new RestError("", { statusCode: 404 });
+        }
+    });
+}
+
 // uriValueList: [["<secretUri>", "value"], ...]
 function mockSecretClientGetSecret(uriValueList: [string, string][]) {
     const dict = new Map();
@@ -265,6 +294,8 @@ export {
     sinon,
     mockAppConfigurationClientListConfigurationSettings,
     mockAppConfigurationClientGetConfigurationSetting,
+    mockAppConfigurationClientGetSnapshot,
+    mockAppConfigurationClientListConfigurationSettingsForSnapshot,
     mockAppConfigurationClientLoadBalanceMode,
     mockConfigurationManagerGetClients,
     mockSecretClientGetSecret,