Enable support for reusing plugins in multiple instances of AppInsights #1132 #1133

MSNev · 2019-12-06T22:04:39Z

Latest version only address linting failures

MSNev · 2019-12-06T22:52:16Z

AISKU/Tests/ApplicationInsightsDeprecatedTests.ts

@@ -150,7 +150,12 @@ export class ApplicationInsightsDeprecatedTests extends TestClass {
        if(this.successSpy.called) {
            let currentCount: number = 0;
            this.successSpy.args.forEach(call => {
-                currentCount += call[1];
+                call[0].forEach(message => {
+                    // Ignore the internal SendBrowserInfoOnUserInit message (Only occurs when running tests in a browser)


As comment says, these tests where failing when running in a browser but passed fine from the command line -- this fixes that issue.

MSNev · 2019-12-06T22:54:39Z

channels/applicationinsights-channel-js/Tests/Sender.tests.ts

@@ -60,7 +60,7 @@ export class SenderTests extends TestClass {
                    baseData: {}
                };
                try {
-                    this._sender.processTelemetry(telemetryItem);
+                    this._sender.processTelemetry(telemetryItem, null);


The context is optional as existing plugin implementation may not pass it, so null is a valid value.
And it's really only required once we have a plugin that uses this value (i.e. a Singleton/shared plugin implementation)

is including the , null necessary?

MSNev · 2019-12-06T22:56:49Z

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

@@ -150,12 +150,8 @@ export class Sender implements IChannelControlsAI {
     */
    private _timeoutHandle: any;

-    private _nextPlugin: ITelemetryPlugin;


These will now be hidden, so any plugin which was relying on these internal fields WILL be broken.
I've added an accessor for the _logger -> log(), but the only real usage of the _nextPlugin should have been to check and call processTelemetry() which now has a helper processNext()

extensions/applicationinsights-react-js/test/ReactAI.test.ts

MSNev · 2019-12-13T01:18:50Z

shared/AppInsightsCore/src/JavaScriptSDK/TelemetryPluginProxy.ts

+
+                // The underlying plugin is either not defined or does not have a processTelemetry implementation
+                // so we still want the next plugin to be executed.
+                _nextPlugin.processTelemetry(env, itemCtx);


This case actually fixes an existing issue where if you added a new IPlugin which didn't implement the processTelemetry() between (based on the priority) 2 other ITelemetryPlugin instances the trailing chain would not get called and it would actually caused an exception (in the ChannelsController), this exception will no longer occur because the execution is now wrapped with this proxy.

MSNev · 2019-12-13T01:22:35Z

shared/AppInsightsCore/src/JavaScriptSDK/TelemetryPluginProxy.ts

+                    if (!_nextPlugin || !_nextPlugin.hasRun()) {
+                        // Either we have no next plugin or the current one did not attempt to call the next plugin
+                        // Which means the current one is the root of the failure so log/report this failure
+                        itemCtx.log().throwInternal(


Try and log details about the actual plugin that is causing the issue

MSNev · 2019-12-13T01:23:44Z

shared/AppInsightsCore/src/JavaScriptSDK/TelemetryPluginProxy.ts

+                    if (_nextPlugin && !_nextPlugin.hasRun()) {
+                        // As part of the failure the current plugin did not attempt to call the next plugin in the cahin
+                        // So rather than leave the pipeline dead in the water we call the next plugin
+                        _nextPlugin.processTelemetry(env, itemCtx);


Calling the next plugin (if present) so that the pipeline isn't dead and therefore the throwInternal() can still succeed.

MSNev · 2019-12-13T18:57:18Z

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts

+            _self._getTelCtx(itemCtx).processNext(env);
+        };
+
+        _self._getTelCtx = (overrideCtx:ITelemetryItemContext = null) => {


This needs work :-(
For proper backward compatibility I need to record and process the instance level nextPlugin chain when no telemetryItemContext is available.

This state can also occur when a plugin gets executed (that wasn't wrapped by the TelemetryPluginProxy) and doesn't pass the existing telemetry context (i.e. existing plugins)

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts

MSNev · 2019-12-13T19:47:56Z

shared/AppInsightsCore/src/JavaScriptSDK/TelemetryItemContext.ts

+        _self.processNext = (env: ITelemetryItem) => {
+            let nextPlugin = _nextProxy;
+
+            // Avoid double executing the same plugin


Due to backward compatibility, we can't add this double execution check :-(

shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ITelemetryItemContext.ts

markwolff · 2019-12-19T00:53:11Z

extensions/applicationinsights-angular-js/src/AngularPlugin.ts

-        this._logger = core.logger;
+    initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?:ITelemetryPluginChain) {
+        super.initialize(config, core, extensions, pluginChain);
+        let ctx = this._getTelCtx();


Even though it's private, is there another name we can use other than "context"? This word already has meaning through the SDK. Maybe "chain" or "origin"? Not a blocker, since it can be changed in a different version

markwolff · 2019-12-19T00:56:41Z

channels/applicationinsights-channel-js/Tests/Sender.tests.ts

@@ -60,7 +60,7 @@ export class SenderTests extends TestClass {
                    baseData: {}
                };
                try {
-                    this._sender.processTelemetry(telemetryItem);
+                    this._sender.processTelemetry(telemetryItem, null);


is including the , null necessary?

#1132

MSNev · 2019-12-19T22:00:51Z

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts

+    /**
+     * Internal helper to allow setting of the internal initialized setting for inherited instances and unit testing
+     */
+    protected setInitialized: (isInitialized: boolean) => void;


Latest version changes order of these 2 methods to pass linting failure

MSNev · 2019-12-19T22:01:21Z

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts

+            let itemCtx:IProcessTelemetryContext = currentCtx;
+            if (!itemCtx) {
+                let rootCtx = _rootCtx || new ProcessTelemetryContext(null, {}, _self.core);
+                // tslint:disable-next-line: prefer-conditional-expression


Ignoring this rule in this case as I think it's clearer this way.

MSNev force-pushed the MSNev/SupportSharedPlugins branch from cdb970e to 082905a Compare December 6, 2019 22:37

MSNev commented Dec 6, 2019

View reviewed changes

xiao-lix reviewed Dec 10, 2019

View reviewed changes

extensions/applicationinsights-react-js/test/ReactAI.test.ts Show resolved Hide resolved

MSNev force-pushed the MSNev/SupportSharedPlugins branch from 082905a to 4f3a249 Compare December 10, 2019 22:27

markwolff requested review from hectorhdzg and markwolff December 11, 2019 01:44

MSNev force-pushed the MSNev/SupportSharedPlugins branch from 4f3a249 to 2a9705c Compare December 13, 2019 01:12

MSNev commented Dec 13, 2019

View reviewed changes

shared/AppInsightsCore/src/JavaScriptSDK/BaseTelemetryPlugin.ts Outdated Show resolved Hide resolved

MSNev commented Dec 13, 2019

View reviewed changes

shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ITelemetryItemContext.ts Outdated Show resolved Hide resolved

MSNev force-pushed the MSNev/SupportSharedPlugins branch from 2a9705c to 8e14af8 Compare December 13, 2019 21:17

markwolff approved these changes Dec 13, 2019

View reviewed changes

MSNev force-pushed the MSNev/SupportSharedPlugins branch 2 times, most recently from 2b1d723 to 16b04e3 Compare December 17, 2019 06:41

MSNev requested review from markwolff and xiao-lix December 17, 2019 18:26

MSNev force-pushed the MSNev/SupportSharedPlugins branch from 16b04e3 to 7a24b79 Compare December 18, 2019 19:59

markwolff approved these changes Dec 19, 2019

View reviewed changes

Enable support for reusing plugins in multiple instances of AppInsights

db7bf82

#1132

MSNev force-pushed the MSNev/SupportSharedPlugins branch from 7a24b79 to db7bf82 Compare December 19, 2019 21:59

MSNev commented Dec 19, 2019

View reviewed changes

MSNev merged commit 91f08a1 into master Dec 19, 2019

MSNev deleted the MSNev/SupportSharedPlugins branch January 30, 2020 19:12

snyk-bot mentioned this pull request Feb 22, 2020

[Snyk] Upgrade @microsoft/applicationinsights-web from 2.4.0 to 2.4.1 emilbolet/bolet.io-OLD#1

Merged

snyk-bot mentioned this pull request Mar 7, 2020

[Snyk] Upgrade @microsoft/applicationinsights-web from 2.4.1 to 2.4.4 emilbolet/bolet.io-OLD#7

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable support for reusing plugins in multiple instances of AppInsights #1132 #1133

Enable support for reusing plugins in multiple instances of AppInsights #1132 #1133

MSNev commented Dec 6, 2019 •

edited

Loading

MSNev Dec 6, 2019

MSNev Dec 6, 2019

markwolff Dec 19, 2019

MSNev Dec 6, 2019

MSNev Dec 13, 2019 •

edited

Loading

MSNev Dec 13, 2019

MSNev Dec 13, 2019

MSNev Dec 13, 2019 •

edited

Loading

MSNev Dec 13, 2019

markwolff Dec 19, 2019

markwolff Dec 19, 2019

MSNev Dec 19, 2019

MSNev Dec 19, 2019

Enable support for reusing plugins in multiple instances of AppInsights #1132 #1133

Enable support for reusing plugins in multiple instances of AppInsights #1132 #1133

Conversation

MSNev commented Dec 6, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MSNev Dec 13, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MSNev Dec 13, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MSNev commented Dec 6, 2019 •

edited

Loading

MSNev Dec 13, 2019 •

edited

Loading

MSNev Dec 13, 2019 •

edited

Loading