Merge remote-tracking branch 'origin/main' into dynamic-refresh

Author: Eskibear

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -400,6 +400,7 @@ FodyWeavers.xsd
 # bundled folder
 dist/
 dist-esm/
+out/
 types/
 
 # dotenv
@@ -409,4 +410,4 @@ types/
 *.tgz
 
 # examples
-examples/package-lock.json
+examples/package-lock.json

azure-pipelines.yml

@@ -12,7 +12,7 @@ pool:
 steps:
 - task: NodeTool@0
   inputs:
-    versionSpec: '16.x'
+    versionSpec: '18.x'
   displayName: 'Install Node.js'
 
 - script: |

package-lock.json

@@ -17,14 +17,15 @@
     "README.md"
   ],
   "scripts": {
-    "build": "npm run clean && npm run build-cjs && npm run build-esm",
+    "build": "npm run clean && npm run build-cjs && npm run build-esm && npm run build-test",
     "build-cjs": "rollup --config",
-    "build-esm": "tsc -p ./",
-    "clean": "rimraf dist dist-esm types",
+    "build-esm": "tsc -p ./tsconfig.json",
+    "build-test": "tsc -p ./tsconfig.test.json",
+    "clean": "rimraf dist dist-esm out types",
     "dev": "rollup --config --watch",
     "lint": "eslint src/ test/",
     "fix-lint": "eslint src/ test/ --fix",
-    "test": "mocha --timeout 10000"
+    "test": "mocha out/test/*.test.{js,cjs,mjs} --timeout 10000"
   },
   "repository": {
     "type": "git",
@@ -33,7 +34,10 @@
   "license": "MIT",
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.2",
+    "@types/mocha": "^10.0.4",
     "@types/node": "^20.5.7",
+    "@types/sinon": "^17.0.1",
+    "@types/uuid": "^9.0.7",
     "@typescript-eslint/eslint-plugin": "^6.6.0",
     "@typescript-eslint/parser": "^6.6.0",
     "chai": "^4.3.7",

package.json

@@ -1,15 +1,18 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-const chai = require("chai");
-const chaiAsPromised = require("chai-as-promised");
+import * as chai from "chai";
+import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-const { load } = require("../dist/index");
-const { createMockedConnectionString } = require("./utils/testHelper");
-const nock = require("nock");
+import { load } from "./exportedApi";
+import { createMockedConnectionString } from "./utils/testHelper";
+import * as nock from "nock";
 
 class HttpRequestCountPolicy {
+    count: number;
+    name: string;
+
     constructor() {
         this.count = 0;
         this.name = "HttpRequestCountPolicy";
@@ -25,12 +28,12 @@ class HttpRequestCountPolicy {
 
 describe("custom client options", function () {
     const fakeEndpoint = "https://azure.azconfig.io";
-    before(() => {
+    beforeEach(() => {
         // Thus here mock it to reply 500, in which case the retry mechanism works.
         nock(fakeEndpoint).persist().get(() => true).reply(500);
     });
 
-    after(() => {
+    afterEach(() => {
         nock.restore();
     })
 
@@ -58,7 +61,7 @@ describe("custom client options", function () {
 
     it("should override default retry options", async () => {
         const countPolicy = new HttpRequestCountPolicy();
-        const loadWithMaxRetries = (maxRetries) => {
+        const loadWithMaxRetries = (maxRetries: number) => {
             return load(createMockedConnectionString(fakeEndpoint), {
                 clientOptions: {
                     additionalPolicies: [{
@@ -93,9 +96,26 @@ describe("custom client options", function () {
         expect(countPolicy.count).eq(2);
     });
 
-    // Note:
-    // core-rest-pipeline skips the retry throwing `RestError: getaddrinfo ENOTFOUND azure.azconfig.io`
-    // Probably would be fixed in upstream libs.
-    // See https://github.com/Azure/azure-sdk-for-js/issues/27037
-    it("should retry on DNS failure");
+    it("should retry on DNS failure", async () => {
+        nock.restore(); // stop mocking with 500 error but sending real requests which will fail with ENOTFOUND
+        const countPolicy = new HttpRequestCountPolicy();
+        const loadPromise = () => {
+            return load(createMockedConnectionString(fakeEndpoint), {
+                clientOptions: {
+                    additionalPolicies: [{
+                        policy: countPolicy,
+                        position: "perRetry"
+                    }]
+                }
+            })
+        };
+        let error;
+        try {
+            await loadPromise();
+        } catch (e) {
+            error = e;
+        }
+        expect(error).not.undefined;
+        expect(countPolicy.count).eq(3);
+    });
 })

test/.eslintrc

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export { load } from "../src";

test/clientOptions.test.js renamed to test/clientOptions.test.ts

@@ -1,18 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-const chai = require("chai");
-const chaiAsPromised = require("chai-as-promised");
+import * as chai from "chai";
+import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-const { load } = require("../dist/index");
-const {
-    mockAppConfigurationClientListConfigurationSettings,
-    restoreMocks,
-    createMockedConnectionString,
-    createMockedKeyVaultReference,
-    createMockedJsonKeyValue
-} = require("./utils/testHelper");
+import { load } from "./exportedApi";
+import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedKeyVaultReference, createMockedJsonKeyValue } from "./utils/testHelper";
 
 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");

test/exportedApi.ts

@@ -1,16 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-const chai = require("chai");
-const chaiAsPromised = require("chai-as-promised");
+import * as chai from "chai";
+import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
-const { load } = require("../dist/index");
-const { sinon,
-    createMockedConnectionString,
-    createMockedTokenCredential,
-    mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } = require("./utils/testHelper");
-const { SecretClient } = require("@azure/keyvault-secrets");
+import { load } from "./exportedApi";
+import { sinon, createMockedConnectionString, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } from "./utils/testHelper";
+import { KeyVaultSecret, SecretClient } from "@azure/keyvault-secrets";
 
 const mockedData = [
     // key, secretUri, value
@@ -72,9 +69,9 @@ describe("key vault reference", function () {
 
         // mock specific behavior per secret client
         const client1 = new SecretClient("https://fake-vault-name.vault.azure.net", createMockedTokenCredential());
-        sinon.stub(client1, "getSecret").returns({ value: "SecretValueViaClient1" });
+        sinon.stub(client1, "getSecret").returns(Promise.resolve({value: "SecretValueViaClient1" } as KeyVaultSecret));
         const client2 = new SecretClient("https://fake-vault-name2.vault.azure.net", createMockedTokenCredential());
-        sinon.stub(client2, "getSecret").returns({ value: "SecretValueViaClient2" });
+        sinon.stub(client2, "getSecret").returns(Promise.resolve({value: "SecretValueViaClient2" } as KeyVaultSecret));
         const settings = await load(createMockedConnectionString(), {
             keyVaultOptions: {
                 secretClients: [