resolve merge conflict

zhiyuanliang-ms · zhiyuanliang-ms · commit 197f4b810922 · 2024-11-01T00:47:12.000+08:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@azure/app-configuration-provider",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "The JavaScript configuration provider for Azure App Configuration",
   "main": "dist/index.js",
   "module": "./dist-esm/index.js",
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.2",
     "@types/mocha": "^10.0.4",
-    "@types/node": "^20.5.7",
+    "@types/node": "^22.7.7",
     "@types/sinon": "^17.0.1",
     "@types/uuid": "^9.0.7",
     "@typescript-eslint/eslint-plugin": "^6.6.0",
@@ -47,11 +47,11 @@
     "mocha": "^10.2.0",
     "nock": "^13.3.3",
     "rimraf": "^5.0.1",
-    "rollup": "^3.26.3",
+    "rollup": "^3.29.5",
     "rollup-plugin-dts": "^5.3.0",
     "sinon": "^15.2.0",
     "tslib": "^2.6.0",
-    "typescript": "^5.1.6",
+    "typescript": "^5.6.3",
     "uuid": "^9.0.1"
   },
   "dependencies": {
diff --git a/src/AzureAppConfiguration.ts b/src/AzureAppConfiguration.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { Disposable } from "./common/disposable";
+import { Disposable } from "./common/disposable.js";
 
 export type AzureAppConfiguration = {
     /**
diff --git a/src/AzureAppConfigurationImpl.ts b/src/AzureAppConfigurationImpl.ts
@@ -3,13 +3,13 @@
 
 import { AppConfigurationClient, ConfigurationSetting, ConfigurationSettingId, GetConfigurationSettingOptions, GetConfigurationSettingResponse, ListConfigurationSettingsOptions, featureFlagPrefix, isFeatureFlag } from "@azure/app-configuration";
 import { isRestError } from "@azure/core-rest-pipeline";
-import { AzureAppConfiguration, ConfigurationObjectConstructionOptions } from "./AzureAppConfiguration";
-import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions";
-import { IKeyValueAdapter } from "./IKeyValueAdapter";
-import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter";
-import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./RefreshOptions";
-import { Disposable } from "./common/disposable";
-import { base64Helper, jsonSorter } from "./common/utils";
+import { AzureAppConfiguration, ConfigurationObjectConstructionOptions } from "./AzureAppConfiguration.js";
+import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js";
+import { IKeyValueAdapter } from "./IKeyValueAdapter.js";
+import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter.js";
+import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./RefreshOptions.js";
+import { Disposable } from "./common/disposable.js";
+import { base64Helper, jsonSorter } from "./common/utils.js";
 import {
     FEATURE_FLAGS_KEY_NAME,
     FEATURE_MANAGEMENT_KEY_NAME,
@@ -30,11 +30,11 @@ import {
     VARIANT_KEY_NAME,
     VARIANTS_KEY_NAME,
     CONFIGURATION_VALUE_KEY_NAME
-} from "./featureManagement/constants";
-import { AzureKeyVaultKeyValueAdapter } from "./keyvault/AzureKeyVaultKeyValueAdapter";
-import { RefreshTimer } from "./refresh/RefreshTimer";
-import { getConfigurationSettingWithTrace, listConfigurationSettingsWithTrace, requestTracingEnabled } from "./requestTracing/utils";
-import { KeyFilter, LabelFilter, SettingSelector } from "./types";
+} from "./featureManagement/constants.js";
+import { AzureKeyVaultKeyValueAdapter } from "./keyvault/AzureKeyVaultKeyValueAdapter.js";
+import { RefreshTimer } from "./refresh/RefreshTimer.js";
+import { getConfigurationSettingWithTrace, listConfigurationSettingsWithTrace, requestTracingEnabled } from "./requestTracing/utils.js";
+import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 
 type PagedSettingSelector = SettingSelector & {
     /**
@@ -87,7 +87,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         this.#options = options;
 
         // Enable request tracing if not opt-out
-        this.#requestTracingEnabled = requestTracingEnabled();
+        this.#requestTracingEnabled = options?.requestTracingOptions?.enabled ?? requestTracingEnabled();
 
         if (options?.trimKeyPrefixes) {
             this.#sortedTrimKeyPrefixes = [...options.trimKeyPrefixes].sort((a, b) => b.localeCompare(a));
@@ -164,19 +164,19 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         return this.#configMap.size;
     }
 
-    entries(): IterableIterator<[string, any]> {
+    entries(): MapIterator<[string, any]> {
         return this.#configMap.entries();
     }
 
-    keys(): IterableIterator<string> {
+    keys(): MapIterator<string> {
         return this.#configMap.keys();
     }
 
-    values(): IterableIterator<any> {
+    values(): MapIterator<any> {
         return this.#configMap.values();
     }
 
-    [Symbol.iterator](): IterableIterator<[string, any]> {
+    [Symbol.iterator](): MapIterator<[string, any]> {
         return this.#configMap[Symbol.iterator]();
     }
     // #endregion
diff --git a/src/AzureAppConfigurationOptions.ts b/src/AzureAppConfigurationOptions.ts
@@ -2,10 +2,11 @@
 // Licensed under the MIT license.
 
 import { AppConfigurationClientOptions } from "@azure/app-configuration";
-import { KeyVaultOptions } from "./keyvault/KeyVaultOptions";
-import { RefreshOptions } from "./RefreshOptions";
-import { SettingSelector } from "./types";
-import { FeatureFlagOptions } from "./featureManagement/FeatureFlagOptions";
+import { KeyVaultOptions } from "./keyvault/KeyVaultOptions.js";
+import { RefreshOptions } from "./RefreshOptions.js";
+import { SettingSelector } from "./types.js";
+import { FeatureFlagOptions } from "./featureManagement/FeatureFlagOptions.js";
+import { RequestTracingOptions } from "./requestTracing/RequestTracingOptions.js";
 
 export const MaxRetries = 2;
 export const MaxRetryDelayInMs = 60000;
@@ -47,4 +48,9 @@ export interface AzureAppConfigurationOptions {
      * Specifies options used to configure feature flags.
      */
     featureFlagOptions?: FeatureFlagOptions;
-}
+
+    /**
+     * Specifies options used to configure request tracing.
+     */
+    requestTracingOptions?: RequestTracingOptions;
+}
diff --git a/src/JsonKeyValueAdapter.ts b/src/JsonKeyValueAdapter.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { ConfigurationSetting, featureFlagContentType, secretReferenceContentType } from "@azure/app-configuration";
-import { IKeyValueAdapter } from "./IKeyValueAdapter";
+import { IKeyValueAdapter } from "./IKeyValueAdapter.js";
 
 export class JsonKeyValueAdapter implements IKeyValueAdapter {
     static readonly #ExcludedJsonContentTypes: string[] = [
diff --git a/src/RefreshOptions.ts b/src/RefreshOptions.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { WatchedSetting } from "./WatchedSetting";
+import { WatchedSetting } from "./WatchedSetting.js";
 
 export const DEFAULT_REFRESH_INTERVAL_IN_MS = 30 * 1000;
 export const MIN_REFRESH_INTERVAL_IN_MS = 1 * 1000;
diff --git a/src/featureManagement/FeatureFlagOptions.ts b/src/featureManagement/FeatureFlagOptions.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { FeatureFlagRefreshOptions } from "../RefreshOptions";
-import { SettingSelector } from "../types";
+import { FeatureFlagRefreshOptions } from "../RefreshOptions.js";
+import { SettingSelector } from "../types.js";
 
 /**
  * Options used to configure feature flags.
@@ -27,4 +27,4 @@ export interface FeatureFlagOptions {
      * Specifies how feature flag refresh is configured. All selected feature flags will be watched for changes.
      */
     refresh?: FeatureFlagRefreshOptions;
-}
+}
diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export { AzureAppConfiguration } from "./AzureAppConfiguration";
-export { Disposable } from "./common/disposable";
-export { load } from "./load";
-export { KeyFilter, LabelFilter } from "./types";
+export { AzureAppConfiguration } from "./AzureAppConfiguration.js";
+export { Disposable } from "./common/disposable.js";
+export { load, loadFromCdn } from "./load.js";
+export { KeyFilter, LabelFilter } from "./types.js";
+export { VERSION } from "./version.js";
diff --git a/src/keyvault/AzureKeyVaultKeyValueAdapter.ts b/src/keyvault/AzureKeyVaultKeyValueAdapter.ts
@@ -2,8 +2,8 @@
 // Licensed under the MIT license.
 
 import { ConfigurationSetting, isSecretReference, parseSecretReference } from "@azure/app-configuration";
-import { IKeyValueAdapter } from "../IKeyValueAdapter";
-import { KeyVaultOptions } from "./KeyVaultOptions";
+import { IKeyValueAdapter } from "../IKeyValueAdapter.js";
+import { KeyVaultOptions } from "./KeyVaultOptions.js";
 import { SecretClient, parseKeyVaultSecretIdentifier } from "@azure/keyvault-secrets";
 
 export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
@@ -72,4 +72,4 @@ export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
 
 function getHost(url: string) {
     return new URL(url).host;
-}
+}
diff --git a/src/load.ts b/src/load.ts
@@ -3,10 +3,10 @@
 
 import { AppConfigurationClient, AppConfigurationClientOptions } from "@azure/app-configuration";
 import { TokenCredential } from "@azure/identity";
-import { AzureAppConfiguration } from "./AzureAppConfiguration";
-import { AzureAppConfigurationImpl } from "./AzureAppConfigurationImpl";
-import { AzureAppConfigurationOptions, MaxRetries, MaxRetryDelayInMs } from "./AzureAppConfigurationOptions";
-import * as RequestTracing from "./requestTracing/constants";
+import { AzureAppConfiguration } from "./AzureAppConfiguration.js";
+import { AzureAppConfigurationImpl } from "./AzureAppConfigurationImpl.js";
+import { AzureAppConfigurationOptions, MaxRetries, MaxRetryDelayInMs } from "./AzureAppConfigurationOptions.js";
+import * as RequestTracing from "./requestTracing/constants.js";
 
 const MIN_DELAY_FOR_UNHANDLED_ERROR: number = 5000; // 5 seconds
 
@@ -82,6 +82,23 @@ export async function load(
     }
 }
 
+/**
+ * Loads the data from a CDN and returns an instance of AzureAppConfiguration.
+ * @param cdnEndpoint  The URL to the CDN.
+ * @param appConfigOptions  Optional parameters.
+ */
+export async function loadFromCdn(cdnEndpoint: URL | string, options?: AzureAppConfigurationOptions): Promise<AzureAppConfiguration>;
+
+export async function loadFromCdn(
+    cdnEndpoint: string | URL,
+    appConfigOptions?: AzureAppConfigurationOptions
+): Promise<AzureAppConfiguration> {
+    const emptyTokenCredential: TokenCredential = {
+        getToken: async () => ({ token: "", expiresOnTimestamp: 0 })
+    };
+    return await load(cdnEndpoint, emptyTokenCredential, appConfigOptions);
+}
+
 function instanceOfTokenCredential(obj: unknown) {
     return obj && typeof obj === "object" && "getToken" in obj && typeof obj.getToken === "function";
 }
diff --git a/src/requestTracing/RequestTracingOptions.ts b/src/requestTracing/RequestTracingOptions.ts
@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * Options used to configure request tracing.
+ */
+export interface RequestTracingOptions {
+    /**
+     * Specifies whether request tracing is enabled.
+     */
+    enabled: boolean;
+}
diff --git a/src/requestTracing/constants.ts b/src/requestTracing/constants.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { VERSION } from "../version";
+import { VERSION } from "../version.js";
 
 export const ENV_AZURE_APP_CONFIGURATION_TRACING_DISABLED = "AZURE_APP_CONFIGURATION_TRACING_DISABLED";
 
diff --git a/src/requestTracing/utils.ts b/src/requestTracing/utils.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { AppConfigurationClient, ConfigurationSettingId, GetConfigurationSettingOptions, ListConfigurationSettingsOptions } from "@azure/app-configuration";
-import { AzureAppConfigurationOptions } from "../AzureAppConfigurationOptions";
+import { AzureAppConfigurationOptions } from "../AzureAppConfigurationOptions.js";
 import {
     AZURE_FUNCTION_ENV_VAR,
     AZURE_WEB_APP_ENV_VAR,
@@ -111,7 +111,7 @@ export function requestTracingEnabled(): boolean {
 
 function getEnvironmentVariable(name: string) {
     // Make it compatible with non-Node.js runtime
-    if (typeof process?.env === "object") {
+    if (typeof process !== "undefined" && typeof process?.env === "object") {
         return process.env[name];
     } else {
         return undefined;
diff --git a/src/version.ts b/src/version.ts
@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export const VERSION = "1.1.0";
+export const VERSION = "1.1.1";
diff --git a/test/clientOptions.test.ts b/test/clientOptions.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { load } from "./exportedApi";
-import { createMockedConnectionString } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { createMockedConnectionString } from "./utils/testHelper.js";
 import * as nock from "nock";
 
 class HttpRequestCountPolicy {
diff --git a/test/featureFlag.test.ts b/test/featureFlag.test.ts
@@ -3,8 +3,8 @@
 
 import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
-import { load } from "./exportedApi";
-import { createMockedConnectionString, createMockedEndpoint, createMockedFeatureFlag, createMockedKeyValue, mockAppConfigurationClientListConfigurationSettings, restoreMocks } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { createMockedConnectionString, createMockedEndpoint, createMockedFeatureFlag, createMockedKeyValue, mockAppConfigurationClientListConfigurationSettings, restoreMocks } from "./utils/testHelper.js";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 
diff --git a/test/json.test.ts b/test/json.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { load } from "./exportedApi";
-import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedKeyVaultReference, createMockedJsonKeyValue } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedKeyVaultReference, createMockedJsonKeyValue } from "./utils/testHelper.js";
 
 const jsonKeyValue = createMockedJsonKeyValue("json.settings.logging", '{"Test":{"Level":"Debug"},"Prod":{"Level":"Warning"}}');
 const keyVaultKeyValue = createMockedKeyVaultReference("TestKey", "https://fake-vault-name.vault.azure.net/secrets/fakeSecretName");
diff --git a/test/keyvault.test.ts b/test/keyvault.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { load } from "./exportedApi";
-import { sinon, createMockedConnectionString, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { sinon, createMockedConnectionString, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } from "./utils/testHelper.js";
 import { KeyVaultSecret, SecretClient } from "@azure/keyvault-secrets";
 
 const mockedData = [
@@ -111,4 +111,4 @@ describe("key vault reference", function () {
         expect(settings.get("TestKey")).eq("SecretValue");
         expect(settings.get("TestKey2")).eq("SecretValue2");
     });
-});
+});
diff --git a/test/load.test.ts b/test/load.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { load } from "./exportedApi";
-import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedEndpoint, createMockedTokenCredential, createMockedKeyValue } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedEndpoint, createMockedTokenCredential, createMockedKeyValue } from "./utils/testHelper.js";
 
 const mockedKVs = [{
     key: "app.settings.fontColor",
diff --git a/test/refresh.test.ts b/test/refresh.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { load } from "./exportedApi";
-import { mockAppConfigurationClientListConfigurationSettings, mockAppConfigurationClientGetConfigurationSetting, restoreMocks, createMockedConnectionString, createMockedKeyValue, sleepInMs, createMockedFeatureFlag } from "./utils/testHelper";
+import { load } from "./exportedApi.js";
+import { mockAppConfigurationClientListConfigurationSettings, mockAppConfigurationClientGetConfigurationSetting, restoreMocks, createMockedConnectionString, createMockedKeyValue, sleepInMs, createMockedFeatureFlag } from "./utils/testHelper.js";
 import * as uuid from "uuid";
 
 let mockedKVs: any[] = [];
@@ -423,4 +423,4 @@ describe("dynamic refresh feature flags", function () {
         await settings.refresh();
         expect(refreshSuccessfulCount).eq(1); // change in feature flags, because page etags are different.
     });
-});
+});
diff --git a/test/requestTracing.test.ts b/test/requestTracing.test.ts
@@ -5,8 +5,8 @@ import * as chai from "chai";
 import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-import { createMockedConnectionString, createMockedKeyValue, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, restoreMocks, sleepInMs } from "./utils/testHelper";
-import { load } from "./exportedApi";
+import { createMockedConnectionString, createMockedKeyValue, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, restoreMocks, sleepInMs } from "./utils/testHelper.js";
+import { load } from "./exportedApi.js";
 
 class HttpRequestHeadersPolicy {
     headers: any;
@@ -122,6 +122,20 @@ describe("request tracing", function () {
         delete process.env.AZURE_APP_CONFIGURATION_TRACING_DISABLED;
     });
 
+    it("should disable request tracing by RequestTracingOptions", async () => {
+        try {
+            await load(createMockedConnectionString(fakeEndpoint), {
+                clientOptions,
+                requestTracingOptions: {
+                    enabled: false
+                }
+            });
+        } catch (e) { /* empty */ }
+        expect(headerPolicy.headers).not.undefined;
+        const correlationContext = headerPolicy.headers.get("Correlation-Context");
+        expect(correlationContext).undefined;
+    });
+
     it("should have request type in correlation-context header when refresh is enabled", async () => {
         mockAppConfigurationClientListConfigurationSettings([{
             key: "app.settings.fontColor",
