[App Config] updateSyncToken method

sdk/appconfiguration/app-configuration/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+## 1.2.0-beta.1 (Unreleased)
+
+- Added `updateSyncToken` method to `AppConfigurationClient` to be able to provide external synchronization tokens.
+  [PR #14507](https://github.com/Azure/azure-sdk-for-js/pull/14507)
+
 ## 1.1.1 (Unreleased)
 
 - Fix issues with `select`ing fields to be returned from `listConfigurationSettings`, `listConfigurationRevisions`
@@ -13,7 +18,7 @@
 ## 1.0.1 (2020-02-19)
 
 - The underlying filter behavior has changed for `listConfigurationSettings` and `listRevisions`.
-  Inline documentation has been revised to accomodate it.
+  Inline documentation has been revised to accommodate it.
 
 ## 1.0.0 (2020-01-06)
 

sdk/appconfiguration/app-configuration/src/appConfigurationClient.ts

@@ -115,6 +115,7 @@ export interface InternalAppConfigurationClientOptions extends AppConfigurationC
  */
 export class AppConfigurationClient {
   private client: AppConfiguration;
+  private _syncTokens: SyncTokens;
   // (for tests)
   private _trace = traceFromTracingHelpers;
 
@@ -164,13 +165,13 @@ export class AppConfigurationClient {
       }
     }
 
-    const syncTokens = appConfigOptions.syncTokens || new SyncTokens();
+    this._syncTokens = appConfigOptions.syncTokens || new SyncTokens();
 
     this.client = new AppConfiguration(
       appConfigCredential,
       appConfigEndpoint,
       apiVersion,
-      getGeneratedClientOptions(appConfigEndpoint, syncTokens, appConfigOptions)
+      getGeneratedClientOptions(appConfigEndpoint, this._syncTokens, appConfigOptions)
     );
   }
 
@@ -496,8 +497,11 @@ export class AppConfigurationClient {
       }
     });
   }
-}
 
+  updateSyncToken(syncToken: string): void {
+    this._syncTokens.addSyncTokenFromHeaderValue(syncToken);
+  }
+}
 /**
  * Gets the options for the generated AppConfigurationClient
  * @internal

sdk/appconfiguration/app-configuration/test/internal/http.spec.ts

@@ -291,6 +291,38 @@ describe("http request related tests", function() {
       assert.equal(syncTokens.getSyncTokenHeaderValue(), "clearReadOnly=value");
     });
   });
+
+  describe("syncToken", async () => {
+    it("update sync token", async () => {
+      const syncTokens = new SyncTokens();
+      syncTokens.addSyncTokenFromHeaderValue("a=value;sn=0");
+      const client = new AppConfigurationClient(
+        "Endpoint=https://endpoint.azconfig.io;Id=abc;Secret=123",
+        { syncTokens } as InternalAppConfigurationClientOptions
+      );
+      assert.equal(
+        client["_syncTokens"]["_currentSyncTokens"].size,
+        1,
+        "Unexpected number of syncTokens before the `update` call"
+      );
+      client.updateSyncToken("b=value;sn=3");
+      assert.equal(
+        client["_syncTokens"]["_currentSyncTokens"].size,
+        2,
+        "Unexpected number of syncTokens after the `update` call"
+      );
+      assert.deepEqual(
+        client["_syncTokens"]["_currentSyncTokens"].get("a"),
+        { id: "a", value: "value", sequenceNumber: 0 },
+        "Unexpected object present for key `a`"
+      );
+      assert.deepEqual(
+        client["_syncTokens"]["_currentSyncTokens"].get("b"),
+        { id: "b", value: "value", sequenceNumber: 3 },
+        "Unexpected object present for key `b`"
+      );
+    });
+  });
 });
 
 function splitAndSort(syncTokens: string | undefined): string {

sdk/appconfiguration/app-configuration/test/public/index.spec.ts

@@ -1139,4 +1139,37 @@ describe("AppConfigurationClient", () => {
       });
     });
   });
+
+  describe("syncToken", async () => {
+    it("update sync token with eventgrid example", async () => {
+      // Supposed to be a live test
+      // TODO:
+      // - Import eventgrid
+      // - get sync token from eventgrid event
+      // - call updateSyncToken
+      // - call getConfigurationSetting
+      // - assertion/check the retrieved setting
+
+      // get sync token from EventGrid event (example event shown, based on .net sample)
+      const eventGridEvent = {
+        key: "key for setting",
+        label: "label for setting",
+        syncToken: "opaque sync token"
+      };
+
+      // user treats token as an opaque value (note - this _does_ mutate the appconfigclient)
+      // however, this mutations happens regardless since the system can and does return
+      // sync token headers during normal operation.
+      client.updateSyncToken(eventGridEvent.syncToken);
+
+      // and now retrieving the value should be consistent with what happened
+      // in EventGrid.
+      const retrievedSetting = await client.getConfigurationSetting({
+        key: eventGridEvent.key,
+        label: eventGridEvent.label
+      });
+
+      console.log(retrievedSetting);
+    });
+  });
 });