[beta] Merge [main] (3.3.7) to beta branch

.aiAutoMinify.json

@@ -13,6 +13,7 @@
                 "_eInternalMessageId",
                 "SendRequestReason",
                 "TransportType",
+                "eStatsType",
                 "TelemetryUnloadReason",
                 "TelemetryUpdateReason"
             ]

.github/workflows/stale-assigned.yml

@@ -19,7 +19,7 @@ jobs:
           stale-issue-message: 'This Issue will be closed in 30 days. Please remove the "Stale" label or comment to avoid closure with no action.'
           stale-pr-message: 'This PR will be closed in 30 days. Please remove the "Stale" label or comment to avoid closure with no action.'
           operations-per-run: 200
-          days-before-stale: 360
+          days-before-stale: 300
           days-before-close: 30
           stale-issue-label: 'stale'
           stale-pr-label: 'stale'

.github/workflows/stale.yml

@@ -19,7 +19,7 @@ jobs:
           stale-issue-message: 'This Issue will be closed in 30 days. Please remove the "Stale" label or comment to avoid closure with no action.'
           stale-pr-message: 'This PR will be closed in 30 days. Please remove the "Stale" label or comment to avoid closure with no action.'
           operations-per-run: 200
-          days-before-stale: 300
+          days-before-stale: 240
           days-before-close: 30
           stale-issue-label: 'stale'
           stale-pr-label: 'stale'

AISKU/README.md

@@ -34,6 +34,7 @@ See [Breaking Changes](https://microsoft.github.io/ApplicationInsights-JS/upgrad
 | Version | Full Size | Raw Minified | GZip Size
 |---------|-----------|--------------|-------------
 | [<nightly3>](https://github.com/microsoft/ApplicationInsights-JS/tree/main/AISKU)  | [![full size size](https://js.monitor.azure.com/nightly/ai.3-nightly3.js.svg)](https://js.monitor.azure.com/nightly/ai.3-nightly3.js.svg)| ![minified size size](https://js.monitor.azure.com/nightly/ai.3-nightly3.min.js.svg) | ![gzip size](https://js.monitor.azure.com/nightly/ai.3-nightly3.min.js.gzip.svg)
+| 3.3.7:  | [![full size size](https://js.monitor.azure.com/scripts/b/ai.3.3.7.js.svg)](https://js.monitor.azure.com/scripts/b/ai.3.3.7.js.svg)| ![minified size size](https://js.monitor.azure.com/scripts/b/ai.3.3.7.min.js.svg) | ![gzip size](https://js.monitor.azure.com/scripts/b/ai.3.3.7.min.js.gzip.svg)
 | 3.3.6:  | [![full size size](https://js.monitor.azure.com/scripts/b/ai.3.3.6.js.svg)](https://js.monitor.azure.com/scripts/b/ai.3.3.6.js.svg)| ![minified size size](https://js.monitor.azure.com/scripts/b/ai.3.3.6.min.js.svg) | ![gzip size](https://js.monitor.azure.com/scripts/b/ai.3.3.6.min.js.gzip.svg)
 | 3.3.5:  | [![full size size](https://js.monitor.azure.com/scripts/b/ai.3.3.5.js.svg)](https://js.monitor.azure.com/scripts/b/ai.3.3.5.js.svg)| ![minified size size](https://js.monitor.azure.com/scripts/b/ai.3.3.5.min.js.svg) | ![gzip size](https://js.monitor.azure.com/scripts/b/ai.3.3.5.min.js.gzip.svg)
 | 3.3.4:  | [![full size size](https://js.monitor.azure.com/scripts/b/ai.3.3.4.js.svg)](https://js.monitor.azure.com/scripts/b/ai.3.3.4.js.svg)| ![minified size size](https://js.monitor.azure.com/scripts/b/ai.3.3.4.min.js.svg) | ![gzip size](https://js.monitor.azure.com/scripts/b/ai.3.3.4.min.js.gzip.svg)

AISKU/Tests/Perf/src/AISKUPerf.ts

@@ -19,7 +19,7 @@ export class AppInsightsInitPerfTestClass {
          * should update version after new release
          * version with doperf(): after 2.5.6
          * */
-        var defaultVer = "3.3.6";
+        var defaultVer = "3.3.7";
         this.version = ver? ver:this._getQueryParameterVersion(defaultVer); 
         this.perfEventsBuffer = [];
         this.perfEventWaitBuffer = [];

AISKU/Tests/Unit/src/AISKUSize.Tests.ts

@@ -54,13 +54,13 @@ function _checkSize(checkType: string, maxSize: number, size: number, isNightly:
 }    
 
 export class AISKUSizeCheck extends AITestClass {
-    private readonly MAX_RAW_SIZE = 146;
-    private readonly MAX_BUNDLE_SIZE = 146;
-    private readonly MAX_RAW_DEFLATE_SIZE = 58;
-    private readonly MAX_BUNDLE_DEFLATE_SIZE = 58;
+    private readonly MAX_RAW_SIZE = 147;
+    private readonly MAX_BUNDLE_SIZE = 147;
+    private readonly MAX_RAW_DEFLATE_SIZE = 59;
+    private readonly MAX_BUNDLE_DEFLATE_SIZE = 59;
     private readonly rawFilePath = "../dist/es5/applicationinsights-web.min.js";
     // Automatically updated by version scripts
-    private readonly currentVer = "3.3.6";
+    private readonly currentVer = "3.3.7";
     private readonly prodFilePath = `../browser/es5/ai.${this.currentVer[0]}.min.js`;
 
     public testInitialize() {

AISKU/Tests/Unit/src/CdnPackaging.tests.ts

@@ -16,7 +16,7 @@ const enum CdnFormat {
 
 export class CdnPackagingChecks extends AITestClass {
     // Automatically updated by version scripts
-    private readonly currentVer = "3.3.6";
+    private readonly currentVer = "3.3.7";
 
     public testInitialize() {
     }

AISKU/Tests/Unit/src/CdnThrottle.tests.ts

@@ -135,11 +135,14 @@ export class CdnThrottle extends AITestClass {
                     offCfg: {
                         "throttleMgrCfg.106.disabled":true,
                         "throttleMgrCfg.109.disabled":true,
-                    }
-                }},
+                    }},
+                    ["zipPayload"]: {
+                        mode: CdnFeatureMode.enable},
+                },
                 config: {
                     maxMessageLimit: 10,
-                    throttleMgrCfg: throttleCfgDisable
+                    throttleMgrCfg: throttleCfgDisable,
+
                 }
             } as ICfgSyncConfig;
             doc["res"] = new (doc as any).Response(JSON.stringify(cdnCfg), {
@@ -245,6 +248,42 @@ export class CdnThrottle extends AITestClass {
             }, "response received", 60, 1000) as any)
         });
 
+        this.testCaseAsync({
+            name: "CfgSyncPlugin: customer didn't set feature opt in, successfully get aisku default and fetch from config url, get disable zip config to be true",
+            stepDelay: 10,
+            useFakeTimers: true,
+            steps: [ () => {
+                let doc = getGlobal();
+                hookFetch((resolve) => { // global instance cannot access test private instance
+                    AITestClass.orgSetTimeout(function() {
+                        resolve( doc["res2"]);
+                    }, 0);
+                });
+
+                let noSetconfig = {
+                    instrumentationKey: TestInstrumentationKey,
+                    extensionConfig : {["AppInsightsCfgSyncPlugin"] :  {
+                        syncMode: ICfgSyncMode.Receive,
+                        cfgUrl: "testurl"
+                    }}
+                };
+
+                this.fetchStub = this.sandbox.spy((doc as any), "fetch");
+                this.init = new ApplicationInsights({
+                    config: noSetconfig,
+                });
+                this.init.loadAppInsights();
+                this._ai = this.init;
+            }].concat(PollingAssert.createPollingAssert(() => {
+                if (this.fetchStub.called){
+                    let newCfg = this._ai.config;
+                    Assert.equal(newCfg.featureOptIn["zipPayload"]["mode"], FeatureOptInMode.enable); // aisku default is none, overwrite to true by cdn config
+                    return true;
+                }
+                return false;
+            }, "response received", 60, 1000) as any)
+        });
+
         this.testCaseAsync({
             name: "CfgSyncPlugin: customer set throttle config, new config fetch from config url could overwrite original one",
             stepDelay: 10,

AISKU/Tests/es6-module-type-check/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@microsoft/applicationinsights-test-module-type-check",
     "author": "Microsoft Application Insights Team and Contributors",
-    "version": "3.3.6",
+    "version": "3.3.7",
     "description": "Microsoft Application Insights ES6 Module and Type check Example",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "keywords": [
@@ -32,7 +32,7 @@
         "tslib": ">= 1.0.0"
     },
     "dependencies": {
-        "@microsoft/applicationinsights-common": "3.3.6",
-        "@microsoft/applicationinsights-web": "3.3.6"
+        "@microsoft/applicationinsights-common": "3.3.7",
+        "@microsoft/applicationinsights-web": "3.3.7"
     }
 }

AISKU/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-web",
-    "version": "3.3.6",
+    "version": "3.3.7",
     "description": "Microsoft Application Insights JavaScript SDK - Web",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -32,7 +32,7 @@
     },
     "devDependencies": {
         "@microsoft/ai-test-framework": "0.0.1",
-        "@microsoft/applicationinsights-offlinechannel-js": "0.3.6",
+        "@microsoft/applicationinsights-offlinechannel-js": "0.3.7",
         "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
         "@microsoft/applicationinsights-rollup-es5": "1.0.2",
         "sinon": "^7.3.1",
@@ -57,21 +57,21 @@
         "typedoc": "^0.26.6",
         "typescript": "^4.9.3",
         "tslib": "^2.0.0",
-        "puppeteer": "19.2.0"
+        "puppeteer": "22.12.1"
     },
     "peerDependencies": {
         "tslib": ">= 1.0.0"
     },
     "dependencies": {
         "@microsoft/dynamicproto-js": "^2.0.3",
         "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-analytics-js": "3.3.6",
-        "@microsoft/applicationinsights-channel-js": "3.3.6",
-        "@microsoft/applicationinsights-cfgsync-js": "3.3.6",
-        "@microsoft/applicationinsights-common": "3.3.6",
-        "@microsoft/applicationinsights-core-js": "3.3.6",
-        "@microsoft/applicationinsights-dependencies-js": "3.3.6",
-        "@microsoft/applicationinsights-properties-js": "3.3.6",
+        "@microsoft/applicationinsights-analytics-js": "3.3.7",
+        "@microsoft/applicationinsights-channel-js": "3.3.7",
+        "@microsoft/applicationinsights-cfgsync-js": "3.3.7",
+        "@microsoft/applicationinsights-common": "3.3.7",
+        "@microsoft/applicationinsights-core-js": "3.3.7",
+        "@microsoft/applicationinsights-dependencies-js": "3.3.7",
+        "@microsoft/applicationinsights-properties-js": "3.3.7",
         "@nevware21/ts-utils": ">= 0.11.8 < 2.x",
         "@nevware21/ts-async": ">= 0.5.4 < 2.x"
     },

AISKU/src/AISku.ts

@@ -50,6 +50,7 @@ const _ignoreUpdateSnippetProperties = [
 const IKEY_USAGE = "iKeyUsage";
 const CDN_USAGE = "CdnUsage";
 const SDK_LOADER_VER = "SdkLoaderVer";
+const ZIP_PAYLOAD = "zipPayload";
 
 const UNDEFINED_VALUE: undefined = undefined;
 
@@ -80,7 +81,8 @@ const defaultConfigValues: IConfigDefaults<IConfiguration & IConfig> = {
     featureOptIn:{
         [IKEY_USAGE]: {mode: FeatureOptInMode.enable}, //for versions after 3.1.2 (>= 3.2.0)
         [CDN_USAGE]: {mode: FeatureOptInMode.disable},
-        [SDK_LOADER_VER]: {mode: FeatureOptInMode.disable}
+        [SDK_LOADER_VER]: {mode: FeatureOptInMode.disable},
+        [ZIP_PAYLOAD]: {mode: FeatureOptInMode.none}
     },
     throttleMgrCfg: cfgDfMerge<{[key:number]: IThrottleMgrConfig}>(
         {
@@ -375,17 +377,17 @@ export class AppInsightsSku implements IApplicationInsights {
                             _throttleMgr.onReadyState(true);
                         }
 
-                        if (!_iKeySentMessage && !_config.connectionString && isFeatureEnabled(IKEY_USAGE, _config)) {
+                        if (!_iKeySentMessage && !_config.connectionString && isFeatureEnabled(IKEY_USAGE, _config, true)) {
                             _throttleMgr.sendMessage( _eInternalMessageId.InstrumentationKeyDeprecation, "See Instrumentation key support at aka.ms/IkeyMigrate");
                             _iKeySentMessage = true;
                         }
 
-                        if (!_cdnSentMessage && _self.context.internal.sdkSrc && _self.context.internal.sdkSrc.indexOf("az416426") != -1 && isFeatureEnabled(CDN_USAGE, _config)) {
+                        if (!_cdnSentMessage && _self.context.internal.sdkSrc && _self.context.internal.sdkSrc.indexOf("az416426") != -1 && isFeatureEnabled(CDN_USAGE, _config, true)) {
                             _throttleMgr.sendMessage( _eInternalMessageId.CdnDeprecation, "See Cdn support notice at aka.ms/JsActiveCdn");
                             _cdnSentMessage = true;
                         }
 
-                        if (!_sdkVerSentMessage && parseInt(_snippetVersion) < 6 && isFeatureEnabled(SDK_LOADER_VER, _config)) {
+                        if (!_sdkVerSentMessage && parseInt(_snippetVersion) < 6 && isFeatureEnabled(SDK_LOADER_VER, _config, true)) {
                             _throttleMgr.sendMessage( _eInternalMessageId.SdkLdrUpdate, "An updated Sdk Loader is available, see aka.ms/SnippetVer");
                             _sdkVerSentMessage = true;
                         }

AISKULight/Tests/Unit/src/AISKULightSize.Tests.ts

@@ -51,12 +51,12 @@ function _checkSize(checkType: string, maxSize: number, size: number, isNightly:
 }    
 
 export class AISKULightSizeCheck extends AITestClass {
-    private readonly MAX_RAW_SIZE = 92;
-    private readonly MAX_BUNDLE_SIZE = 92;
+    private readonly MAX_RAW_SIZE = 93;
+    private readonly MAX_BUNDLE_SIZE = 93;
     private readonly MAX_RAW_DEFLATE_SIZE = 38;
     private readonly MAX_BUNDLE_DEFLATE_SIZE = 38;
     private readonly rawFilePath = "../dist/es5/applicationinsights-web-basic.min.js";
-    private readonly currentVer = "3.3.6";
+    private readonly currentVer = "3.3.7";
     private readonly prodFilePath = `../browser/es5/aib.${this.currentVer[0]}.min.js`;
 
     public testInitialize() {

AISKULight/Tests/Unit/src/dynamicconfig.tests.ts

@@ -1,18 +1,19 @@
 import { AITestClass, Assert, PollingAssert } from "@microsoft/ai-test-framework";
 import { IConfig } from "@microsoft/applicationinsights-common";
-import { IConfiguration, isString, newId } from "@microsoft/applicationinsights-core-js";
+import { IConfiguration, IPayloadData, isString, ITelemetryItem, IXHROverride, newId } from "@microsoft/applicationinsights-core-js";
 import { ApplicationInsights, ISenderConfig } from "../../../src/index";
 import { createAsyncResolvedPromise } from "@nevware21/ts-async";
-
+import { SinonSpy } from 'sinon';
 export class ApplicationInsightsDynamicConfigTests extends AITestClass {
     private static readonly _instrumentationKey = "b7170927-2d1c-44f1-acec-59f4e1751c11";
     private static readonly _connectionString = `InstrumentationKey=${ApplicationInsightsDynamicConfigTests._instrumentationKey}`;
     private _ai: ApplicationInsights;
     private _sessionPrefix: string = newId();
     private _config: IConfiguration & IConfig;
     static registerTests: any;
+    private genericSpy: SinonSpy;
     private _ctx: any;
-
+    private xhrOverride: IXHROverride;
     constructor(testName?: string) {
         super(testName || "AISKU Dynamic Config");
     }
@@ -30,6 +31,7 @@ export class ApplicationInsightsDynamicConfigTests extends AITestClass {
 
             this._ai = new ApplicationInsights(this._config);
             this._ctx = {};
+            this.xhrOverride = new AutoCompleteXhrOverride();
         } catch (e) {
             console.error("Failed to initialize", e);
         }
@@ -137,6 +139,80 @@ export class ApplicationInsightsDynamicConfigTests extends AITestClass {
                 return false;
             }, "Wait for promise response" + new Date().toISOString(), 60, 1000) as any)
         });
+
+        this.testCaseAsync({
+            name: "zip test: gzip encode is working and content-encode header is set (feature opt-in)",
+            stepDelay: 10,
+            useFakeTimers: true,
+            useFakeServer: true,
+            steps: [
+                () => {
+                    this.genericSpy = this.sandbox.spy(this.xhrOverride, 'sendPOST');
+                    this._ai.config.featureOptIn["zipPayload"] = { mode: 3 };
+                    this._ai.config.extensionConfig["AppInsightsChannelPlugin"] = {
+                        httpXHROverride: this.xhrOverride,
+                                alwaysUseXhrOverride: true
+                    }
+                    this.clock.tick(10);
+                    const telemetryItem: ITelemetryItem = {
+                        name: 'fake item with some really long name to take up space quickly',
+                        iKey: 'iKey',
+                        baseType: 'some type',
+                        baseData: {}
+                    };
+
+                    this._ai.track(telemetryItem);
+                    this._ai.flush();
+                    this.clock.tick(10);
+                }].concat(PollingAssert.createPollingAssert(() => {
+                    if (this.genericSpy.called){
+                        let request = this.genericSpy.getCall(0).args[0];
+                        let gzipData = request.data;
+                        QUnit.assert.ok(gzipData, "data should be set");
+                        QUnit.assert.equal(true, gzipData[0] === 0x1F && gzipData[1] === 0x8B, "telemetry should be gzip encoded");
+                        QUnit.assert.equal(request.headers["Content-Encoding"], "gzip", "telemetry should be gzip encoded");
+                        return true;
+                    }
+                    return false;
+                }, "Wait for promise response" + new Date().toISOString(), 60, 1000) as any)
+            });
+
+            this.testCaseAsync({
+                name: "zip test: gzip encode will not working (feature opt-in is not set)",
+                stepDelay: 10,
+                useFakeTimers: true,
+                useFakeServer: true,
+                steps: [
+                    () => {
+                        this.genericSpy = this.sandbox.spy(this.xhrOverride, 'sendPOST');
+                        this._ai.config.extensionConfig["AppInsightsChannelPlugin"] = {
+                            httpXHROverride: this.xhrOverride,
+                                    alwaysUseXhrOverride: true
+                        }
+                        this.clock.tick(10);
+                        const telemetryItem: ITelemetryItem = {
+                            name: 'fake item with some really long name to take up space quickly',
+                            iKey: 'iKey',
+                            baseType: 'some type',
+                            baseData: {}
+                        };
+
+                        this._ai.track(telemetryItem);
+                        this._ai.flush();
+                        this.clock.tick(10);
+                    }].concat(PollingAssert.createPollingAssert(() => {
+                        if (this.genericSpy.called){
+                            let request = this.genericSpy.getCall(0).args[0];
+                            let gzipData = request.data;
+                            QUnit.assert.ok(gzipData, "data should be set");
+                            QUnit.assert.equal(false, gzipData[0] === 0x1F && gzipData[1] === 0x8B, "telemetry should not be gzip encoded");
+                            QUnit.assert.equal(request.headers["Content-Encoding"], undefined, "telemetry should not be gzip encoded");
+                            return true;
+                        }
+                        return false;
+                    }, "Wait for promise response" + new Date().toISOString(), 60, 1000) as any)
+                });
+
     }
 
     public addApiTests(): void {
@@ -153,4 +229,12 @@ export class ApplicationInsightsDynamicConfigTests extends AITestClass {
         });
     }
 
+}
+
+class AutoCompleteXhrOverride {
+
+    public sendPOST(payload: IPayloadData, oncomplete: (status: number, headers: { [headerName: string]: string }) => void, sync?: boolean) {
+        console.log("AutoCompleteXhrOverride.sendPOST called with payload: ", payload);
+        oncomplete(200, null);
+    }
 }