@atlaskit/insm 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/insm
 
+## 0.1.2
+
+### Patch Changes
+
+- [`cf1cfd5a04c5c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cf1cfd5a04c5c) -
+  Remove INSM circular dependency
+- [`78573b5014067`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/78573b5014067) -
+  Update numerator calculation in INP Measurers
+
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/cjs/inp-measurers/inp.js

@@ -60,7 +60,7 @@ var InteractionResult = /*#__PURE__*/function () {
       if (duration < this.min) {
         this.min = duration;
       }
-      this.numerator += this.average * (this.count - 1) + duration;
+      this.numerator += duration;
       this.count += 1;
       this.average = this.numerator / this.count;
     }

package/dist/cjs/insm-session.js

@@ -174,8 +174,9 @@ var INSMSession = exports.INSMSession = /*#__PURE__*/function () {
           periods: periodResults,
           endDetails: endDetails
         }),
-        tags: ['insm'],
-        source: 'insm'
+        highPriority: true,
+        tags: ['editor'],
+        source: 'unknown'
       };
       (_this$insm$analyticsW = this.insm.analyticsWebClient) === null || _this$insm$analyticsW === void 0 || _this$insm$analyticsW.sendOperationalEvent(operationalEvent);
     }

package/dist/cjs/insm.js

@@ -21,17 +21,7 @@ var INSM = exports.INSM = /*#__PURE__*/function () {
      * page session.
      */
     (0, _defineProperty2.default)(this, "runningHeavyTasks", new Set());
-    this.periodMeasurers = [new _afps.AnimationFPSIM(), new _inp.INPTracker(), new _inp.INPTracker({
-      includedInteractions: ['pointerup']
-    }), new _inp.INPTracker({
-      includedInteractions: ['pointerdown']
-    }), new _inp.INPTracker({
-      includedInteractions: ['click']
-    }), new _inp.INPTracker({
-      includedInteractions: ['keydown']
-    }), new _inp.INPTracker({
-      includedInteractions: ['keyup']
-    })];
+    this.periodMeasurers = [new _afps.AnimationFPSIM(), new _inp.INPTracker()];
     this.options = options;
 
     // If this does throw -- we do want an unhandledRejection rejection to be passed to the window
@@ -40,14 +30,23 @@ var INSM = exports.INSM = /*#__PURE__*/function () {
       return _this.analyticsWebClient = analyticsWebClient;
     });
 
-    // No cleanup needs to be performed -- as this is intended to run until the tab is closed
-    // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-    window.addEventListener('pagehide', function () {
-      var _this$runningSession;
-      (_this$runningSession = _this.runningSession) === null || _this$runningSession === void 0 || _this$runningSession.end({
-        stoppedBy: 'pagehide'
+    // No cleanup needs to be performed -- as this tooling is intended to run until the tab is closed
+    // The use of beforeunload here is because using pagehide does not reliably result in the analytics
+    // being fired by the analytics web client.
+    // The use of this means we will miss events from mobile safari which does not reliably call this api
+    // however mobile browsers do not call when a browser closes - so we expect limited mobile data from
+    // this tooling in its current form.
+
+    // window will not be defined in server envs - in these envs -- there can never be a session end
+    if (typeof window !== 'undefined') {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      window.addEventListener('beforeunload', function () {
+        var _this$runningSession;
+        (_this$runningSession = _this.runningSession) === null || _this$runningSession === void 0 || _this$runningSession.end({
+          stoppedBy: 'beforeunload'
+        });
       });
-    });
+    }
   }
 
   /**

package/dist/es2019/inp-measurers/inp.js

@@ -38,7 +38,7 @@ class InteractionResult {
     if (duration < this.min) {
       this.min = duration;
     }
-    this.numerator += this.average * (this.count - 1) + duration;
+    this.numerator += duration;
     this.count += 1;
     this.average = this.numerator / this.count;
   }

package/dist/es2019/insm-session.js

@@ -141,8 +141,9 @@ export class INSMSession {
         periods: periodResults,
         endDetails: endDetails
       },
-      tags: ['insm'],
-      source: 'insm'
+      highPriority: true,
+      tags: ['editor'],
+      source: 'unknown'
     };
     (_this$insm$analyticsW = this.insm.analyticsWebClient) === null || _this$insm$analyticsW === void 0 ? void 0 : _this$insm$analyticsW.sendOperationalEvent(operationalEvent);
   }

package/dist/es2019/insm.js

@@ -10,31 +10,30 @@ export class INSM {
      * page session.
      */
     _defineProperty(this, "runningHeavyTasks", new Set());
-    this.periodMeasurers = [new AnimationFPSIM(), new INPTracker(), new INPTracker({
-      includedInteractions: ['pointerup']
-    }), new INPTracker({
-      includedInteractions: ['pointerdown']
-    }), new INPTracker({
-      includedInteractions: ['click']
-    }), new INPTracker({
-      includedInteractions: ['keydown']
-    }), new INPTracker({
-      includedInteractions: ['keyup']
-    })];
+    this.periodMeasurers = [new AnimationFPSIM(), new INPTracker()];
     this.options = options;
 
     // If this does throw -- we do want an unhandledRejection rejection to be passed to the window
     // this is to ease debugging.
     options.getAnalyticsWebClient.then(analyticsWebClient => this.analyticsWebClient = analyticsWebClient);
 
-    // No cleanup needs to be performed -- as this is intended to run until the tab is closed
-    // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-    window.addEventListener('pagehide', () => {
-      var _this$runningSession;
-      (_this$runningSession = this.runningSession) === null || _this$runningSession === void 0 ? void 0 : _this$runningSession.end({
-        stoppedBy: 'pagehide'
+    // No cleanup needs to be performed -- as this tooling is intended to run until the tab is closed
+    // The use of beforeunload here is because using pagehide does not reliably result in the analytics
+    // being fired by the analytics web client.
+    // The use of this means we will miss events from mobile safari which does not reliably call this api
+    // however mobile browsers do not call when a browser closes - so we expect limited mobile data from
+    // this tooling in its current form.
+
+    // window will not be defined in server envs - in these envs -- there can never be a session end
+    if (typeof window !== 'undefined') {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      window.addEventListener('beforeunload', () => {
+        var _this$runningSession;
+        (_this$runningSession = this.runningSession) === null || _this$runningSession === void 0 ? void 0 : _this$runningSession.end({
+          stoppedBy: 'beforeunload'
+        });
       });
-    });
+    }
   }
 
   /**

package/dist/esm/inp-measurers/inp.js

@@ -53,7 +53,7 @@ var InteractionResult = /*#__PURE__*/function () {
       if (duration < this.min) {
         this.min = duration;
       }
-      this.numerator += this.average * (this.count - 1) + duration;
+      this.numerator += duration;
       this.count += 1;
       this.average = this.numerator / this.count;
     }

package/dist/esm/insm-session.js

@@ -168,8 +168,9 @@ export var INSMSession = /*#__PURE__*/function () {
           periods: periodResults,
           endDetails: endDetails
         }),
-        tags: ['insm'],
-        source: 'insm'
+        highPriority: true,
+        tags: ['editor'],
+        source: 'unknown'
       };
       (_this$insm$analyticsW = this.insm.analyticsWebClient) === null || _this$insm$analyticsW === void 0 || _this$insm$analyticsW.sendOperationalEvent(operationalEvent);
     }

package/dist/esm/insm.js

@@ -14,17 +14,7 @@ export var INSM = /*#__PURE__*/function () {
      * page session.
      */
     _defineProperty(this, "runningHeavyTasks", new Set());
-    this.periodMeasurers = [new AnimationFPSIM(), new INPTracker(), new INPTracker({
-      includedInteractions: ['pointerup']
-    }), new INPTracker({
-      includedInteractions: ['pointerdown']
-    }), new INPTracker({
-      includedInteractions: ['click']
-    }), new INPTracker({
-      includedInteractions: ['keydown']
-    }), new INPTracker({
-      includedInteractions: ['keyup']
-    })];
+    this.periodMeasurers = [new AnimationFPSIM(), new INPTracker()];
     this.options = options;
 
     // If this does throw -- we do want an unhandledRejection rejection to be passed to the window
@@ -33,14 +23,23 @@ export var INSM = /*#__PURE__*/function () {
       return _this.analyticsWebClient = analyticsWebClient;
     });
 
-    // No cleanup needs to be performed -- as this is intended to run until the tab is closed
-    // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
-    window.addEventListener('pagehide', function () {
-      var _this$runningSession;
-      (_this$runningSession = _this.runningSession) === null || _this$runningSession === void 0 || _this$runningSession.end({
-        stoppedBy: 'pagehide'
+    // No cleanup needs to be performed -- as this tooling is intended to run until the tab is closed
+    // The use of beforeunload here is because using pagehide does not reliably result in the analytics
+    // being fired by the analytics web client.
+    // The use of this means we will miss events from mobile safari which does not reliably call this api
+    // however mobile browsers do not call when a browser closes - so we expect limited mobile data from
+    // this tooling in its current form.
+
+    // window will not be defined in server envs - in these envs -- there can never be a session end
+    if (typeof window !== 'undefined') {
+      // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
+      window.addEventListener('beforeunload', function () {
+        var _this$runningSession;
+        (_this$runningSession = _this.runningSession) === null || _this$runningSession === void 0 || _this$runningSession.end({
+          stoppedBy: 'beforeunload'
+        });
       });
-    });
+    }
   }
 
   /**

package/dist/types/insm-session.d.ts

@@ -78,11 +78,11 @@ export declare class INSMSession {
      */
     earlyStop(reason: string, description?: string): void;
     end(endDetails: {
-        stoppedBy: 'new-experience';
-        experienceKey: string;
         contentId?: string | null;
+        experienceKey: string;
+        stoppedBy: 'new-experience';
     } | {
-        stoppedBy: 'pagehide';
+        stoppedBy: 'beforeunload';
     } | {
         stoppedBy: 'early-stop';
         reason: string;

package/dist/types/insm.d.ts

@@ -7,15 +7,7 @@ export declare class INSM {
     analyticsWebClient?: AnalyticsWebClient;
     runningSession?: INSMSession;
     options: INSMOptions;
-    periodMeasurers: [
-        AnimationFPSIM,
-        INPTracker,
-        INPTracker,
-        INPTracker,
-        INPTracker,
-        INPTracker,
-        INPTracker
-    ];
+    periodMeasurers: [AnimationFPSIM, INPTracker];
     /**
      * Heavy tasks are tracked at the insm layer as heavy tasks
      * are expected at times to be unrelated to the current

package/dist/types-ts4.5/insm-session.d.ts

@@ -78,11 +78,11 @@ export declare class INSMSession {
      */
     earlyStop(reason: string, description?: string): void;
     end(endDetails: {
-        stoppedBy: 'new-experience';
-        experienceKey: string;
         contentId?: string | null;
+        experienceKey: string;
+        stoppedBy: 'new-experience';
     } | {
-        stoppedBy: 'pagehide';
+        stoppedBy: 'beforeunload';
     } | {
         stoppedBy: 'early-stop';
         reason: string;

package/dist/types-ts4.5/insm.d.ts

@@ -9,11 +9,6 @@ export declare class INSM {
     options: INSMOptions;
     periodMeasurers: [
         AnimationFPSIM,
-        INPTracker,
-        INPTracker,
-        INPTracker,
-        INPTracker,
-        INPTracker,
         INPTracker
     ];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/insm",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "INSM tooling measures user-perceived interactivity of a page",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -26,12 +26,9 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/analytics-listeners": "^9.0.0",
-		"@atlaskit/tmp-editor-statsig": "^11.9.0",
+		"@atlaskit/tmp-editor-statsig": "^12.5.0",
 		"@babel/runtime": "^7.0.0"
 	},
-	"devDependencies": {
-		"@atlaskit/editor-test-helpers": "workspace:^"
-	},
 	"peerDependencies": {
 		"react": "^18.2.0"
 	},