update

Author: zhiyuanliang-ms

eslint.config.mjs

@@ -53,7 +53,6 @@ export default defineConfig([globalIgnores([
         }],
 
         "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-require-imports": "off",
         "eol-last": ["error", "always"],
         "no-trailing-spaces": "error",
         "space-before-blocks": ["error", "always"],

package-lock.json

@@ -66,7 +66,7 @@
     "playwright": "^1.55.0"
   },
   "dependencies": {
-    "@azure/app-configuration": "^1.9.0",
+    "@azure/app-configuration": "^1.10.0",
     "@azure/core-rest-pipeline": "^1.6.0",
     "@azure/identity": "^4.2.1",
     "@azure/keyvault-secrets": "^4.7.0",

package.json

@@ -11,6 +11,9 @@ import {
     featureFlagPrefix,
     isFeatureFlag,
     isSecretReference,
+    isSnapshotReference,
+    parseSnapshotReference,
+    SnapshotReferenceValue,
     GetSnapshotOptions,
     ListConfigurationSettingsForSnapshotOptions,
     GetSnapshotResponse,
@@ -57,7 +60,7 @@ import { AIConfigurationTracingOptions } from "./requestTracing/aiConfigurationT
 import { KeyFilter, LabelFilter, SettingWatcher, SettingSelector, PagedSettingsWatcher, WatchedSetting } from "./types.js";
 import { ConfigurationClientManager } from "./configurationClientManager.js";
 import { getFixedBackoffDuration, getExponentialBackoffDuration } from "./common/backoffUtils.js";
-import { InvalidOperationError, ArgumentError, isFailoverableError, isInputError } from "./common/errors.js";
+import { InvalidOperationError, ArgumentError, isFailoverableError, isInputError, SnapshotReferenceError } from "./common/errors.js";
 import { ErrorMessages } from "./common/errorMessages.js";
 
 const MIN_DELAY_FOR_UNHANDLED_FAILURE = 5_000; // 5 seconds
@@ -513,8 +516,11 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                 if (isSnapshotReference(setting) && !loadFeatureFlag) {
                     this.#useSnapshotReference = true;
 
-                    // TODO: When SDK supports snapshot reference, use the helper method from SDK.
-                    const snapshotName = parseSnapshotReference(setting).value.snapshotName;
+                    const snapshotRef: ConfigurationSetting<SnapshotReferenceValue> = parseSnapshotReference(setting);
+                    const snapshotName = snapshotRef.value.snapshotName;
+                    if (!snapshotName) {
+                        throw new SnapshotReferenceError(`Invalid format for Snapshot reference setting '${setting.key}'.`);
+                    }
                     const settingsFromSnapshot = await this.#loadConfigurationSettingsFromSnapshot(snapshotName);
 
                     for (const snapshotSetting of settingsFromSnapshot) {
@@ -589,7 +595,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     async #loadConfigurationSettingsFromSnapshot(snapshotName: string): Promise<ConfigurationSetting[]> {
         const snapshot = await this.#getSnapshot(snapshotName);
         if (snapshot === undefined) {
-            throw new InvalidOperationError(`Could not find snapshot with name ${snapshotName}.`);
+            return []; // treat non-existing snapshot as empty
         }
         if (snapshot.compositionType != KnownSnapshotComposition.Key) {
             throw new InvalidOperationError(`Composition type for the selected snapshot with name ${snapshotName} must be 'key'.`);
@@ -1094,28 +1100,3 @@ function validateTagFilters(tagFilters: string[]): void {
         }
     }
 }
-
-// TODO: Temporary workaround until SDK supports snapshot reference
-const snapshotReferenceContentType = "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8";
-
-interface JsonSnapshotReferenceValue {
-  snapshot_name: string;
-}
-
-function isSnapshotReference(setting: ConfigurationSetting):
-    setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">> {
-    return (setting && setting.contentType === snapshotReferenceContentType && typeof setting.value === "string");
-}
-
-function parseSnapshotReference(setting: ConfigurationSetting) {
-    if (!isSnapshotReference(setting)) {
-        throw new Error(`Invalid snapshot reference: ${setting}`);
-    }
-    const jsonSnapshotReferenceValue = JSON.parse(setting.value) as JsonSnapshotReferenceValue;
-
-    const snapshotReference = {
-        ...setting,
-        value: { snapshotName: jsonSnapshotReferenceValue.snapshot_name },
-    };
-    return snapshotReference;
-}

src/appConfigurationImpl.ts

@@ -33,6 +33,13 @@ export class KeyVaultReferenceError extends Error {
     }
 }
 
+export class SnapshotReferenceError extends Error {
+    constructor(message: string, options?: ErrorOptions) {
+        super(message, options);
+        this.name = "SnapshotReferenceError";
+    }
+}
+
 export function isFailoverableError(error: any): boolean {
     if (!isRestError(error)) {
         return false;