CoreUtils - Tree-Shaking ennhancements #1469

MSNev · 2021-02-08T18:14:01Z

extract and export each CoreUtils function as first class
stop using CoreUtils class within core, using the new direct functions

MSNev · 2021-02-08T18:15:24Z

AISKU/src/applicationinsights-web.ts

@@ -35,7 +35,8 @@ export {
    INotificationManager,
    IProcessTelemetryContext,
    Tags,
-    BaseCore
+    BaseCore,
+    CoreUtils


Wasn't directly exported but was indirectly available because of the internal usages, so to avoid breaking anyone how had taken a dependency explicitly exporting.

MSNev · 2021-02-08T18:16:03Z

channels/applicationinsights-channel-js/api-extractor.json

+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+ {
+    "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",


Adding more Api Extractor generations -- VERY useful for spotting the missed exports

MSNev · 2021-02-08T18:19:07Z

shared/AppInsightsCore/Tests/Selenium/ApplicationInsightsCore.Tests.ts


-                // Using manual spies as sinon spy is failing to correctly restore the function
-                let orgMwcRandom = CoreUtils.mwcRandom32;
-                CoreUtils.mwcRandom32 = function() {


Generally, I tried to not change any of the Tests so that they continue to use the CoreUtils versions (to help ensure no-one is broken). However, in this case because it mocks the values but the internal code no longer uses these references these tests had to change to continue passing.

The minor side effect is that it's actually testing more of the production level execution path, by following the same rules for IE detection etc.

MSNev · 2021-02-08T18:21:20Z

shared/AppInsightsCore/Tests/Selenium/ApplicationInsightsCore.Tests.ts

-                let randCalled = 0;
+                // Check that mwcRandom is bing called (relies on the mwc implementation from the default seed)
+                mwcRandomSeed(1);
+                Assert.notEqual(722346555, random32(), "Make sure that the mwcRandom was not being called - step 1");


Now also using "magic" numbers as mwc is psuedo random, so using the same seed always gives the same result (or should). So the test is also confirming that it really is using mwc.

MSNev · 2021-02-08T18:34:15Z

shared/AppInsightsCore/src/JavaScriptSDK/AppInsightsCore.ts

@@ -32,7 +32,7 @@ export class AppInsightsCore extends BaseCore implements IAppInsightsCore {
                    if (telemetryItem === null) {
                        _notifyInvalidEvent(telemetryItem);
                        // throw error
-                        throw Error("Invalid telemetry item");
+                        throwError("Invalid telemetry item");


Simply minification help as "throw" is a reserved word and "Error" is a class, so neither could be minified

MSNev · 2021-02-08T18:35:20Z

shared/AppInsightsCore/src/JavaScriptSDK/CoreUtils.ts

+    arrForEach, arrIndexOf, arrMap, arrReduce, attachEvent, dateNow, detachEvent, hasOwnProperty, 
+    isArray, isBoolean, isDate, isError, isFunction, isNullOrUndefined, isNumber, isObject, isString, isTypeof, 
+    isUndefined, objDefineAccessors, objKeys, strTrim, toISOString
+} from "./HelperFuncs";


Splitting these out to their own file to "fix" the cyclic dependencies build issues

MSNev · 2021-02-08T19:14:30Z

shared/AppInsightsCore/src/JavaScriptSDK/CoreUtils.ts

-            }
-        }
-    }
+export interface ICoreUtils {


Defining an interface for the old "exported" CoreUtils class, so that CoreUtils can become an exported constant that follows the previously exposed class values that just reference the extracted functions -- i.e. CoreUtils should not have any locally defined functions.

There is 1 current exception to this and its the CoreUtils._canUseCookies property -- because it's a property. This is used by the community so it need to stay as a working change -- even when I add my CookieManager changes on top of this.

So the changes in this file include

moving functions from CoreUtils.xxx => first class function (defined and exported directly)

moving the functions from CoreUtils.xxx => first class function that are now in HelperFuncs.ts and RandomHelper.ts etc

Defining ICoreUtils interface to match and document the previous CoreUtils

export a constant CoreUtils: ICoreUtils implementation (start @ line 365)

Same for EventHelper class

MSNev · 2021-02-08T19:18:35Z

shared/AppInsightsCore/src/JavaScriptSDK/CoreUtils.ts

-    public static _canUseCookies: boolean;
+    /**
+     * Internal - Do not use directly.
+     * @deprecated Direct usage of this property is not recommend


More details will be added around this when the CookieManager changes are merged (plan is before next release)

MSNev · 2021-02-08T19:19:34Z

shared/AppInsightsCore/src/JavaScriptSDK/EnvUtils.ts

+/**
+ * Identifies whether the current environment appears to be IE
+ */
+export function isIE() {


Moved from CoreUtils.ts

MSNev · 2021-02-08T19:20:18Z

shared/AppInsightsCore/src/JavaScriptSDK/HelperFuncs.ts

+const strDetachEvent = "detachEvent";
+const strRemoveEventListener = "removeEventListener";
+
+export function objToString(obj: any) {


Moved from CoreUtils.ts -- to avoid cyclic dependencies -- we have had these build warnings for a while, but this fixes that.

MSNev · 2021-02-08T19:30:40Z

shared/AppInsightsCore/src/JavaScriptSDK/InstrumentHooks.ts

@@ -172,7 +172,7 @@ function _getObjProto(target:any) {
 function _getOwner(target:any, name:string, checkPrototype:boolean): any {
    let owner = null;
    if (target) {
-        if (CoreUtils.hasOwnProperty(target, name)) {
+        if (hasOwnProperty(target, name)) {


These changes are just a case of stopping direct usage of CoreUtils and use the functions directly

- extract and export each CoreUtils function as first class - stop using CoreUtils class within core, using the new direct functions - create TestFramework and change core to use it (so it restores the navigator / user agent properly)

hectorhdzg

LGTM

MSNev requested review from trask, ramthi, lzchen, xiao-lix, hectorhdzg, heyams and kryalama February 8, 2021 18:14

MSNev commented Feb 8, 2021

View reviewed changes

MSNev force-pushed the MSNev/TreeShaking branch 12 times, most recently from c54c314 to 26b6689 Compare February 11, 2021 19:04

MSNev mentioned this pull request Feb 12, 2021

Stamp Specific endpoint changes #1474

Merged

MSNev force-pushed the MSNev/TreeShaking branch from 26b6689 to 034254c Compare February 17, 2021 04:54

CoreUtils - Tree-Shaking ennhancements

d4d27d7

- extract and export each CoreUtils function as first class - stop using CoreUtils class within core, using the new direct functions - create TestFramework and change core to use it (so it restores the navigator / user agent properly)

MSNev force-pushed the MSNev/TreeShaking branch from 034254c to d4d27d7 Compare February 17, 2021 20:29

hectorhdzg approved these changes Feb 19, 2021

View reviewed changes

MSNev merged commit 7dcc2e6 into master Feb 19, 2021

MSNev deleted the MSNev/TreeShaking branch March 1, 2021 20:16

snyk-bot mentioned this pull request Sep 2, 2021

[Snyk] Security upgrade ts-jest from 24.3.0 to 25.3.0 MaxMood96/ApplicationInsights-JS#14

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CoreUtils - Tree-Shaking ennhancements #1469

CoreUtils - Tree-Shaking ennhancements #1469

MSNev commented Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021 •

edited

Loading

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

MSNev Feb 8, 2021

hectorhdzg left a comment

CoreUtils - Tree-Shaking ennhancements #1469

CoreUtils - Tree-Shaking ennhancements #1469

Conversation

MSNev commented Feb 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MSNev Feb 8, 2021 • 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

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

hectorhdzg left a comment

Choose a reason for hiding this comment

MSNev Feb 8, 2021 •

edited

Loading