add integration test

Author: zhiyuanliang-ms

.gitignore

@@ -411,3 +411,7 @@ types/
 
 # examples
 examples/package-lock.json
+
+# cert
+*.cert
+*.key

package-lock.json

@@ -52,7 +52,8 @@
     "sinon": "^15.2.0",
     "tslib": "^2.6.0",
     "typescript": "^5.1.6",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.1",
+    "selfsigned": "^2.4.1"
   },
   "dependencies": {
     "@azure/app-configuration": "^1.6.1",

package.json

@@ -258,7 +258,6 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     }
 
     async #loadFeatureFlags() {
-        this.#featureFlagTracing.resetFeatureFlagTracing();
         const featureFlagSettings: ConfigurationSetting[] = [];
         for (const selector of this.#featureFlagSelectors) {
             const listOptions: ListConfigurationSettingsOptions = {
@@ -283,6 +282,8 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
             selector.pageEtags = pageEtags;
         }
 
+        this.#featureFlagTracing.resetFeatureFlagTracing();
+
         // parse feature flags
         const featureFlags = await Promise.all(
             featureFlagSettings.map(setting => this.#parseFeatureFlag(setting))

src/AzureAppConfigurationImpl.ts

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import * as chai from "chai";
+import * as chaiAsPromised from "chai-as-promised";
+chai.use(chaiAsPromised);
+const expect = chai.expect;
+import { createMockedConnectionString, createMockedFeatureFlag, HttpRequestHeadersPolicy, sleepInMs } from "./utils/testHelper";
+import { mockServerEndpoint, startMockServer, closeMockServer } from "./utils/integrationTestHelper";
+import { load } from "./exportedApi";
+
+describe("integration test", function () {
+    this.timeout(15000);
+
+    const headerPolicy = new HttpRequestHeadersPolicy();
+    const position: "perCall" | "perRetry" = "perCall";
+    const clientOptions = {
+        retryOptions: {
+            maxRetries: 0 // save time
+        },
+        allowInsecureConnection: true,
+        additionalPolicies: [{
+            policy: headerPolicy,
+            position
+        }]
+    };
+
+    it("should have request type in correlation-context header if feature flags use feature filters", async () => {
+        // We are using self-signed certificate
+        process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+
+        startMockServer([
+            createMockedFeatureFlag("Alpha_1", { conditions: { client_filters: [ { name: "Microsoft.TimeWindow" } ] } }),
+            createMockedFeatureFlag("Alpha_2", { conditions: { client_filters: [ { name: "Microsoft.Targeting" } ] } }),
+            createMockedFeatureFlag("Alpha_3", { conditions: { client_filters: [ { name: "CustomFilter" } ] } })
+        ]);
+
+        const settings = await load(createMockedConnectionString(mockServerEndpoint), {
+            clientOptions,
+            featureFlagOptions: {
+                enabled: true,
+                selectors: [ {keyFilter: "*"} ],
+                refresh: {
+                    enabled: true,
+                    refreshIntervalInMs: 1000
+                }
+            }
+        });
+        await sleepInMs(1000 + 1);
+        try {
+            await settings.refresh();
+        } catch (e) { /* empty */ }
+        expect(headerPolicy.headers).not.undefined;
+        const correlationContext = headerPolicy.headers.get("Correlation-Context");
+        expect(correlationContext).not.undefined;
+        expect(correlationContext.includes("RequestType=Watch")).eq(true);
+        expect(correlationContext.includes("Filter=CSTM+TIME+TRGT")).eq(true);
+
+        closeMockServer();
+    });
+});

test/integration.test.ts

@@ -5,23 +5,9 @@ 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 { createMockedConnectionString, createMockedKeyValue, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, restoreMocks, HttpRequestHeadersPolicy, sleepInMs } from "./utils/testHelper";
 import { load } from "./exportedApi";
 
-class HttpRequestHeadersPolicy {
-    headers: any;
-    name: string;
-
-    constructor() {
-        this.headers = {};
-        this.name = "HttpRequestHeadersPolicy";
-    }
-    sendRequest(req, next) {
-        this.headers = req.headers;
-        return next(req).then(resp => resp);
-    }
-}
-
 describe("request tracing", function () {
     this.timeout(15000);
 

test/requestTracing.test.ts

@@ -0,0 +1,46 @@
+import { ConfigurationSetting } from "@azure/app-configuration";
+import * as https from "https";
+import * as selfsigned from "selfsigned";
+import * as fs from "fs";
+
+let server;
+
+const domain = "localhost";
+const port = 443
+
+function startMockServer(settings: ConfigurationSetting[]) {
+    const attrs = [{ name: "commonName", value: domain }];
+    const certOptions = { keySize: 2048, selfSigned: true };
+    const pems = selfsigned.generate(attrs, certOptions);
+
+    fs.writeFileSync("server.key", pems.private);
+    fs.writeFileSync("server.cert", pems.cert);
+
+    const options = {
+        key: fs.readFileSync("server.key"),
+        cert: fs.readFileSync("server.cert")
+    };
+      
+    const responseBody = {
+        items: [...settings]
+    };
+
+    server = https.createServer(options, (req, res) => {
+        res.writeHead(200, { "Content-Type": "application/json" });
+        res.end(JSON.stringify(responseBody));  
+    });
+      
+    server.listen(port);
+}
+
+function closeMockServer() {
+    server.close();
+}
+
+const mockServerEndpoint = "https://localhost:443";
+
+export {
+    startMockServer,
+    closeMockServer,
+    mockServerEndpoint
+}

test/utils/integrationTestHelper.ts

@@ -194,6 +194,20 @@ const createMockedFeatureFlag = (name: string, flagProps?: any, props?: any) =>
     isReadOnly: false
 }, props));
 
+class HttpRequestHeadersPolicy {
+    headers: any;
+    name: string;
+
+    constructor() {
+        this.headers = {};
+        this.name = "HttpRequestHeadersPolicy";
+    }
+    sendRequest(req, next) {
+        this.headers = req.headers;
+        return next(req).then(resp => resp);
+    }
+}
+
 export {
     sinon,
     mockAppConfigurationClientListConfigurationSettings,
@@ -209,5 +223,7 @@ export {
     createMockedKeyValue,
     createMockedFeatureFlag,
 
+    HttpRequestHeadersPolicy,
+
     sleepInMs
-};
+};