[BUG] Application Insights reports 'not_specified' to Azure when trac…

…king unhandled browser exception #1940 (#1980)
microsoft · Feb 1, 2023 · 9141ebf · 9141ebf
1 parent 0562a7b
commit 9141ebf
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 5 deletions.
diff --git a/AISKU/samples/HelloWorld/index-snippet.html b/AISKU/samples/HelloWorld/index-snippet.html
@@ -6,15 +6,24 @@
     <!-- import Application Insights JS SDK from CDN -->
     <script type="text/javascript">!function(T,l,y){var S=T.location,k="script",D="instrumentationKey",C="ingestionendpoint",I="disableExceptionTracking",E="ai.device.",b="toLowerCase",w="crossOrigin",N="POST",e="appInsightsSDK",t=y.name||"appInsights";(y.name||T[e])&&(T[e]=t);var n=T[t]||function(d){var g=!1,f=!1,m={initialize:!0,queue:[],sv:"5",version:2,config:d};function v(e,t){var n={},a="Browser";return n[E+"id"]=a[b](),n[E+"type"]=a,n["ai.operation.name"]=S&&S.pathname||"_unknown_",n["ai.internal.sdkVersion"]="javascript:snippet_"+(m.sv||m.version),{time:function(){var e=new Date;function t(e){var t=""+e;return 1===t.length&&(t="0"+t),t}return e.getUTCFullYear()+"-"+t(1+e.getUTCMonth())+"-"+t(e.getUTCDate())+"T"+t(e.getUTCHours())+":"+t(e.getUTCMinutes())+":"+t(e.getUTCSeconds())+"."+((e.getUTCMilliseconds()/1e3).toFixed(3)+"").slice(2,5)+"Z"}(),iKey:e,name:"Microsoft.ApplicationInsights."+e.replace(/-/g,"")+"."+t,sampleRate:100,tags:n,data:{baseData:{ver:2}}}}var h=d.url||y.src;if(h){function a(e){var t,n,a,i,r,o,s,c,u,p,l;g=!0,m.queue=[],f||(f=!0,t=h,s=function(){var e={},t=d.connectionString;if(t)for(var n=t.split(";"),a=0;a<n.length;a++){var i=n[a].split("=");2===i.length&&(e[i[0][b]()]=i[1])}if(!e[C]){var r=e.endpointsuffix,o=r?e.location:null;e[C]="https://"+(o?o+".":"")+"dc."+(r||"services.visualstudio.com")}return e}(),c=s[D]||d[D]||"",u=s[C],p=u?u+"/v2/track":d.endpointUrl,(l=[]).push((n="SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details)",a=t,i=p,(o=(r=v(c,"Exception")).data).baseType="ExceptionData",o.baseData.exceptions=[{typeName:"SDKLoadFailed",message:n.replace(/\./g,"-"),hasFullStack:!1,stack:n+"\nSnippet failed to load ["+a+"] -- Telemetry is disabled\nHelp Link: https://go.microsoft.com/fwlink/?linkid=2128109\nHost: "+(S&&S.pathname||"_unknown_")+"\nEndpoint: "+i,parsedStack:[]}],r)),l.push(function(e,t,n,a){var i=v(c,"Message"),r=i.data;r.baseType="MessageData";var o=r.baseData;return o.message='AI (Internal): 99 message:"'+("SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details) ("+n+")").replace(/\"/g,"")+'"',o.properties={endpoint:a},i}(0,0,t,p)),function(e,t){if(JSON){var n=T.fetch;if(n&&!y.useXhr)n(t,{method:N,body:JSON.stringify(e),mode:"cors"});else if(XMLHttpRequest){var a=new XMLHttpRequest;a.open(N,t),a.setRequestHeader("Content-type","application/json"),a.send(JSON.stringify(e))}}}(l,p))}function i(e,t){f||setTimeout(function(){!t&&m.core||a()},500)}var e=function(){var n=l.createElement(k);n.src=h;var e=y[w];return!e&&""!==e||"undefined"==n[w]||(n[w]=e),n.onload=i,n.onerror=a,n.onreadystatechange=function(e,t){"loaded"!==n.readyState&&"complete"!==n.readyState||i(0,t)},n}();y.ld<0?l.getElementsByTagName("head")[0].appendChild(e):setTimeout(function(){l.getElementsByTagName(k)[0].parentNode.appendChild(e)},y.ld||0)}try{m.cookie=l.cookie}catch(p){}function t(e){for(;e.length;)!function(t){m[t]=function(){var e=arguments;g||m.queue.push(function(){m[t].apply(m,e)})}}(e.pop())}var n="track",r="TrackPage",o="TrackEvent";t([n+"Event",n+"PageView",n+"Exception",n+"Trace",n+"DependencyData",n+"Metric",n+"PageViewPerformance","start"+r,"stop"+r,"start"+o,"stop"+o,"addTelemetryInitializer","setAuthenticatedUserContext","clearAuthenticatedUserContext","flush"]),m.SeverityLevel={Verbose:0,Information:1,Warning:2,Error:3,Critical:4};var s=(d.extensionConfig||{}).ApplicationInsightsAnalytics||{};if(!0!==d[I]&&!0!==s[I]){var c="onerror";t(["_"+c]);var u=T[c];T[c]=function(e,t,n,a,i){var r=u&&u(e,t,n,a,i);return!0!==r&&m["_"+c]({message:e,url:t,lineNumber:n,columnNumber:a,error:i}),r},d.autoExceptionInstrumented=!0}return m}(y.cfg);function a(){y.onInit&&y.onInit(n)}(T[t]=n).queue&&0===n.queue.length?(n.queue.push(a),n.trackPageView({})):a()}(window,document,{
         src: "https://js.monitor.azure.com/scripts/b/ai.2.min.js", // The SDK URL Source for the CDN
-        //src: "../../browser/ai.2.min.js", // The URL Source for the local build
+        //src: "http://localhost:9001/AISKU/browser/ai.2.min.js", // The URL Source for the local build
         crossOrigin: "anonymous", // When supplied this will add the provided value as the cross origin attribute on the script tag
         cfg: { // Application Insights Configuration
-            instrumentationKey: "INSTRUMENTATION_KEY"
+            instrumentationKey: "INSTRUMENTATION_KEY",
+            disableIKeyValidation: true
         }});
     </script>
 
   </head>
   <body>
     <h1>Hello World!</h1>
+    <!-- trackException manual tests
+    <button onclick="javascript: throw 'String Error'">Throw String Exception</button>
+    <button onclick="javascript: appInsights.trackException({ exception: 'String Error' })">trackException with String as the exception</button>
+    <button onclick="javascript: try { throw 'String Error'; } catch(e) { appInsights.trackException({exception: e})}">trackException with try / catch</button>
+
+    <button onclick="javascript: appInsights.trackException('String Error')">trackException with String</button>
+    <button onclick="javascript: try { throw 'String Error'; } catch(e) { appInsights.trackException(null)}">trackException with null</button>
+    -->
   </body>
 </html>
diff --git a/extensions/applicationinsights-analytics-js/Tests/Unit/src/AnalyticsPlugin.tests.ts b/extensions/applicationinsights-analytics-js/Tests/Unit/src/AnalyticsPlugin.tests.ts
@@ -467,10 +467,12 @@ export class AnalyticsPluginTests extends AITestClass {
                 // Act
                 appInsights.trackException({exception: new Error(), severityLevel: SeverityLevel.Critical});
                 appInsights.trackException({error: new Error(), severityLevel: SeverityLevel.Critical});
+                appInsights.trackException({exception: "Critical Exception" as any, severityLevel: SeverityLevel.Critical});
+                appInsights.trackException("Critical Exception" as any);
                 this.clock.tick(1);
 
                 // Test
-                Assert.ok(senderStub.calledTwice, "Telemetry is sent when master switch is on");
+                Assert.equal(4, senderStub.callCount, "Telemetry is sent when master switch is on");
             }
         });
     }
@@ -537,6 +539,58 @@ export class AnalyticsPluginTests extends AITestClass {
                 Assert.equal(SeverityLevel.Error, trackStub.firstCall.args[0].baseData.severityLevel);
             }
         });
+
+        this.testCase({
+            name: "TrackExceptionTests: trackException with a string as the exception",
+            test: () => {
+                // setup
+                const plugin = new ChannelPlugin();
+                const core = new AppInsightsCore();
+
+                this.onDone(() => {
+                    core.unload(false);
+                });
+
+                core.initialize(
+                    {instrumentationKey: "ikey"},
+                    [plugin]
+                );
+                const appInsights = new AnalyticsPlugin();
+                core.addPlugin(appInsights);
+                const trackStub = this.sandbox.stub(appInsights.core, "track");
+
+                // Test
+                appInsights.trackException({exception: new Error("Critical Exception"), severityLevel: SeverityLevel.Critical});
+                Assert.ok(trackStub.calledOnce, "single exception is tracked");
+                Assert.equal(SeverityLevel.Critical, trackStub.firstCall.args[0].baseData.severityLevel);
+                Assert.equal("Critical Exception", trackStub.firstCall.args[0].baseData.exceptions[0].message);
+
+                trackStub.reset();
+
+                appInsights.trackException({exception: "String Exception" as any, severityLevel: SeverityLevel.Error});
+                Assert.ok(trackStub.calledOnce, "single exception is tracked");
+                Assert.equal(SeverityLevel.Error, trackStub.firstCall.args[0].baseData.severityLevel);
+                Assert.equal("String Exception", trackStub.firstCall.args[0].baseData.exceptions[0].message);
+
+                trackStub.reset();
+
+                appInsights.trackException("Direct String Exception" as any);
+                Assert.ok(trackStub.calledOnce, "single exception is tracked");
+                Assert.equal("string: Direct String Exception", trackStub.firstCall.args[0].baseData.exceptions[0].message);
+
+                trackStub.reset();
+
+                appInsights.trackException(new Error("Wrapped String Exception") as any);
+                Assert.ok(trackStub.calledOnce, "single exception is tracked");
+                Assert.equal("Wrapped String Exception", trackStub.firstCall.args[0].baseData.exceptions[0].message);
+
+                trackStub.reset();
+
+                appInsights.trackException(null as any);
+                Assert.ok(trackStub.calledOnce, "single exception is tracked");
+                Assert.equal("not_specified", trackStub.firstCall.args[0].baseData.exceptions[0].message, JSON.stringify(trackStub.firstCall.args[0].baseData.exceptions[0]));
+            }
+        });
     }
 
     private addOnErrorTests(): void {

diff --git a/extensions/applicationinsights-analytics-js/src/JavaScriptSDK/AnalyticsPlugin.ts b/extensions/applicationinsights-analytics-js/src/JavaScriptSDK/AnalyticsPlugin.ts
@@ -17,7 +17,7 @@ import {
     IPlugin, IProcessTelemetryContext, IProcessTelemetryUnloadContext, ITelemetryInitializerHandler, ITelemetryItem, ITelemetryPluginChain,
     ITelemetryUnloadState, InstrumentEvent, TelemetryInitializerFunction, _eInternalMessageId, arrForEach, createProcessTelemetryContext,
     createUniqueNamespace, dumpObj, eLoggingSeverity, eventOff, eventOn, generateW3CId, getDocument, getExceptionName, getHistory,
-    getLocation, getWindow, hasHistory, hasWindow, isFunction, isNullOrUndefined, isString, isUndefined, mergeEvtNamespace,
+    getLocation, getWindow, hasHistory, hasWindow, isError, isFunction, isNullOrUndefined, isString, isUndefined, mergeEvtNamespace,
     objDefineAccessors, objForEachKey, safeGetCookieMgr, strUndefined, throwError
 } from "@microsoft/applicationinsights-core-js";
 import { PropertiesPlugin } from "@microsoft/applicationinsights-properties-js";
@@ -406,7 +406,17 @@ export class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights
             * @param systemProperties
             */
             _self.sendExceptionInternal = (exception: IExceptionTelemetry, customProperties?: { [key: string]: any }, systemProperties?: { [key: string]: any }) => {
-                const theError = exception.exception || exception.error || new Error(strNotSpecified);
+                // Adding additional edge cases to handle
+                // - Not passing anything (null / undefined)
+                const theError = (exception && (exception.exception || exception.error)) ||
+                    // - Handle someone calling trackException based of v1 API where the exception was the Error
+                    isError(exception) && exception ||
+                    // - Handles no error being defined and instead of creating a new Error() instance attempt to map so any stacktrace
+                    //   is preserved and does not list ApplicationInsights code as the source
+                    { name: (exception && typeof exception) as string, message: exception as any || strNotSpecified };
+
+                // If no exception object was passed assign to an empty object to avoid internal exceptions
+                exception = exception || {};
                 let exceptionPartB = new Exception(
                     _self.diagLog(),
                     theError,