@atlaskit/insm 0.1.2 → 0.2.0

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

@@ -22,6 +22,9 @@ export declare class INSM {
      * Starts a heavy task in the currently running session.
      *
      * This also pauses measurement.
+     *
+     * For PageLoads using the key 'PageLoad' will mean the heavy task duration
+     * is added to the insm session event as pageLoadTime.
      */
     startHeavyTask(heavyTaskName: string): void;
     /**
@@ -32,18 +35,29 @@ export declare class INSM {
      * Call this when starting a new experience.  This is expected to be wired to the product
      * routing solution.
      *
-     * It's expected this call will be paired with a `insm.session.startHeavyTask('page-load')` and subsequent `insm.session.endHeavyTask('page-load')`
-     * so that performance degradations linked to the page initialisation are excluded from the active interactivity monitoring.
+     * It's expected this call will be paired with a `insm.session.startHeavyTask('PageLoad')` and
+     * subsequent `insm.session.endHeavyTask('PageLoad')` so that performance degradations linked
+     * to the page initialisation are excluded from the active interactivity monitoring.
+     *
+     * Using the key 'PageLoad' is special and will result in the heavy task duration being added to the
+     * insm session event as pageLoadTime.
      *
      *
      * ```ts
      * insm.start('edit-page', { initial: true, contentId: '9001' })
-     * insm.session.startHeavyTask(''page-load')
+     * insm.session.startHeavyTask('PageLoad')
      * // ... heavy initialisation work
-     * insm.session.endHeavyTask(''page-load')
+     * insm.session.endHeavyTask('PageLoad')
      * ```
      */
     start(experienceKey: string, experienceProperties: ExperienceProperties): void;
+    private lastStartedExperienceProperties;
+    /**
+     * Call this to update the name of the running session after it's started
+     * In the case it's been started with an unregistered name, and there is not running
+     * session. This will also trigger the session being started.
+     */
+    overrideExperienceKey(experienceKey: string): void;
     /**
      * This prematurely halts any running experience measurement. It's expected to be used in
      * scenarios such as when error boundaries are hit.

package/dist/types-ts4.5/session-measurers/LongAnimationFrameMeasurer.d.ts

@@ -0,0 +1,63 @@
+import type { INSMSession } from '../insm-session';
+type LongAnimationFrameMeasurerOptions = {
+    initial: boolean;
+    insmSession: INSMSession;
+    limit: number;
+    reportingThreshold: number;
+};
+interface TrackedScriptTiming {
+    afDuration: number;
+    duration: number;
+    features: string[];
+    forcedStyleAndLayoutDuration: number;
+    invoker: string;
+    invokerType: string;
+    sourceCharPosition: number;
+    sourceFunctionName: string;
+    sourceURL: string;
+}
+export declare class LongAnimationFrameMeasurer {
+    private observer?;
+    private longestScriptTimings;
+    private options;
+    private paused;
+    private minimumIndex;
+    private minimumDuration;
+    constructor(options: LongAnimationFrameMeasurerOptions);
+    private handleBatch;
+    private createScriptTiming;
+    private processScript;
+    /**
+     * Pauses tracking
+     */
+    pause(): void;
+    /**
+     * Resumes tracking
+     */
+    resume(): void;
+    /**
+     * Returns the current tracked longest script timings sorted by duration
+     */
+    get current(): TrackedScriptTiming[];
+    /**
+     * Cleans up the performance tracking (tracking cannot be resumed following this).
+     */
+    cleanup(): void;
+}
+export interface _PerformanceScriptTiming extends PerformanceEntry {
+    readonly duration: DOMHighResTimeStamp;
+    readonly entryType: string;
+    readonly executionStart: DOMHighResTimeStamp;
+    readonly forcedStyleAndLayoutDuration: DOMHighResTimeStamp;
+    readonly invoker: string;
+    readonly invokerType: 'classic-script' | 'module-script' | 'event-listener' | 'user-callback' | 'resolve-promise' | 'reject-promise';
+    readonly name: string;
+    readonly pauseDuration: DOMHighResTimeStamp;
+    readonly sourceCharPosition: number;
+    readonly sourceFunctionName: string;
+    readonly sourceURL: string;
+    readonly startTime: DOMHighResTimeStamp;
+    readonly window?: Window;
+    readonly windowAttribution: 'self' | 'descendant' | 'ancestor' | 'same-page' | 'other';
+}
+export {};

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

@@ -1,6 +1,5 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 export type INSMOptions = {
-    getAnalyticsWebClient: Promise<AnalyticsWebClient>;
     /**
      * If an experience is missing or not enabled - no session event will be fired
      */
@@ -9,12 +8,9 @@ export type INSMOptions = {
             enabled: boolean;
         } | undefined;
     };
+    getAnalyticsWebClient: Promise<AnalyticsWebClient>;
 };
 export type ExperienceProperties = {
-    /**
-     * Whether this represents the initial page the user is visiting
-     */
-    initial: boolean;
     /**
      * An optional content id (ie. for a Confluence page - the page id)
      *
@@ -22,24 +18,44 @@ export type ExperienceProperties = {
      * not expected to provide this property.
      */
     contentId?: string | null;
+    /**
+     * Whether this represents the initial page the user is visiting
+     */
+    initial: boolean;
 };
 export type AddedProperties = {
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | undefined;
 } | (() => {
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | undefined;
 });
 export type Measure = {
-    numerator: number;
+    average: number;
     denominator: number;
     max: number;
     min: number;
-    average: number;
+    numerator: number;
 };
 export interface PeriodMeasurer {
+    /**
+     * Run any cleanup, and report the last periods interactivity.
+     *
+     * Important note: A new period can start after the end has been reached
+     * in cases where the measurement was ended due to a scenario such as an
+     * error boundary being hit (via `insm.stopEarly`).
+     */
+    end: () => Measure;
     /**
      * Name of the interactivity measurement (measures in the resulting insm event will be under this key)
      */
     name: string;
+    /**
+     * Pauses measurement (ie. when heavy work is triggered)
+     */
+    pause: () => void;
+    /**
+     * Pauses measurement (ie. when heavy work completes)
+     */
+    resume: () => void;
     /**
      * Called when an the state changes, and/or a new experience session starts.
      *
@@ -62,20 +78,4 @@ export interface PeriodMeasurer {
      * When started with paused = true. it indicates a heavy task is running at startup time.
      */
     paused: boolean) => Measure | undefined;
-    /**
-     * Run any cleanup, and report the last periods interactivity.
-     *
-     * Important note: A new period can start after the end has been reached
-     * in cases where the measurement was ended due to a scenario such as an
-     * error boundary being hit (via `insm.stopEarly`).
-     */
-    end: () => Measure;
-    /**
-     * Pauses measurement (ie. when heavy work is triggered)
-     */
-    pause: () => void;
-    /**
-     * Pauses measurement (ie. when heavy work completes)
-     */
-    resume: () => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/insm",
-	"version": "0.1.2",
+	"version": "0.2.0",
 	"description": "INSM tooling measures user-perceived interactivity of a page",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -25,12 +25,18 @@
 	},
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/analytics-listeners": "^9.0.0",
-		"@atlaskit/tmp-editor-statsig": "^12.5.0",
-		"@babel/runtime": "^7.0.0"
+		"@atlaskit/analytics-listeners": "^9.1.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/tmp-editor-statsig": "^13.23.0",
+		"@babel/runtime": "^7.0.0",
+		"bowser-ultralight": "^1.0.6"
 	},
 	"peerDependencies": {
 		"react": "^18.2.0"
 	},
-	"platform-feature-flags": {}
+	"platform-feature-flags": {
+		"cc_editor_insm_fix_attributes": {
+			"type": "boolean"
+		}
+	}
 }