Beta Part 4: Part of Mega Dynamic Load/Unload support #1781

MSNev · 2022-03-12T00:02:04Z

Fix function typing issues
Update Analytics Extension to start supporting teardown / unload (more tests required)
Adds namespace option to instrumentation hooks (for debugging teardown issues)
Update AITest Class to log and optionally assert events and hooks that have not been removed
Add Update callback when plugins are added / removed (will be extended for config updates)
Some minor minification improvements

- Fix function typing issues - Update Analytics Extension to start supporting teardown / unload (more tests required) - Adds namespace option to instrumentation hooks (for debugging teardown issues) - Update AITest Class to log and optionally assert events and hooks that have not been removed - Add Update callback when plugins are added / removed (will be extended for config updates) - Some minor minification improvements

MSNev · 2022-03-12T00:06:22Z

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

@@ -2,7 +2,7 @@ import { AITestClass, Assert } from "@microsoft/ai-test-framework";
 import * as pako from "pako";

 export class AISKUSizeCheck extends AITestClass {
-    private readonly MAX_DEFLATE_SIZE = 43;
+    private readonly MAX_DEFLATE_SIZE = 44;


I'm going to have to spend some additional time once all of the code is merged, I already have some changes to help with the size but they are quite significant in the number of changes for a review -- so delaying for now and just incrementing the current minimum.

MSNev · 2022-03-12T00:08:14Z

channels/applicationinsights-channel-js/src/Offline.ts

-import { getWindow, getDocument, getNavigator, isUndefined, isNullOrUndefined, attachEvent } from "@microsoft/applicationinsights-core-js";
-import dynamicProto from "@microsoft/dynamicproto-js";
+import { getWindow, getDocument, getNavigator, isUndefined, isNullOrUndefined, createUniqueNamespace, mergeEvtNamespace, eventOn, eventOff } from "@microsoft/applicationinsights-core-js";
+


The refactoring here is mostly just removing the internal Offline class (for minufication purposes), the functionality does not change.

MSNev · 2022-03-12T00:09:24Z

channels/applicationinsights-channel-js/src/Sender.ts

@@ -204,7 +172,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                    try {
                        _self.triggerSend(isAsync, null, sendReason || SendRequestReason.ManualFlush);
                    } catch (e) {
-                        _self.diagLog().throwInternal(LoggingSeverity.CRITICAL,
+                        _throwInternal(_self.diagLog(),LoggingSeverity.CRITICAL,


Using a new helper (introduced for minification purposes)

MSNev · 2022-03-12T00:10:37Z

channels/applicationinsights-channel-js/src/Offline.ts

-
-                    }
-                }
+export function createOfflineListener(parentEvtNamespace?: string | string[]): IOfflineListener {


The event namespace is part of the changes for unload support, so the events are tagged with the current instance.

MSNev · 2022-03-12T00:11:32Z

channels/applicationinsights-channel-js/src/Offline.ts

+}
+
+function _disableEvents(target: any, evtNamespace: string | string[]) {
+    eventOff(target, null, null, evtNamespace);


This will remove ALL of the events on the target object that match the provided namespace.
So both the online and offline will be removed by this single call.

MSNev · 2022-03-12T00:12:52Z

channels/applicationinsights-channel-js/src/Sender.ts

@@ -467,11 +435,17 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                }
            };

+            _self._doTeardown = (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => {


This should be the full teardown support for the Sender -- more testing required though as I haven't updated the sender tests yet to check and fail for unremoved events, hooks etc.

MSNev · 2022-03-12T00:13:40Z

channels/applicationinsights-channel-js/src/Sender.ts

@@ -1051,6 +1025,25 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                return regexp.test(config.instrumentationKey);
            }

+            function _initDefaults() {


Called during construction and teardown.

MSNev · 2022-03-12T00:14:37Z

common/Tests/Framework/src/AITestClass.ts

@@ -24,6 +24,37 @@ function _getObjName(target:any, unknownValue?:string) {
    return (((target || {})["constructor"]) || {}).name || unknownValue || "";
 }

+function _getAllAiDataKeys<T = any>(target: T, callbackfn: (name: string, value: T[keyof T]) => void) {


Base test class updates which will be used validate and remove any registered events, hooks etc.

MSNev · 2022-03-12T00:15:51Z

common/Tests/Framework/src/AITestClass.ts

@@ -162,6 +193,14 @@ export class AITestClass {
                let stepIndex = 0;

                const testDone = () => {
+                    if (testInfo.assertNoEvents) {


New switches (currently false by default) which will automatically fail any test (when true) if any event, hook has not been removed after the test completes.

MSNev · 2022-03-12T00:16:41Z

common/Tests/Framework/src/AITestClass.ts

+        }
+    }
+
+    protected _assertHooksRemoved() {


This is the current set of objects that will be validated -- these will grow as we find plugins that are adding hooks.

MSNev · 2022-03-12T00:16:57Z

common/Tests/Framework/src/AITestClass.ts

@@ -683,6 +731,32 @@ export class AITestClass {
        }
    }

+    protected _assertEventsRemoved() {


This is the current set of objects that will be validated -- these will grow as we find plugins that are adding events.

MSNev · 2022-03-12T00:19:08Z