@atlaskit/insm 0.4.54 → 0.4.55

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/insm
 
+## 0.4.55
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.4.54
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/insm",
-	"version": "0.4.54",
+	"version": "0.4.55",
 	"description": "INSM tooling measures user-perceived interactivity of a page",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,7 +27,7 @@
 	"dependencies": {
 		"@atlaskit/analytics-listeners": "^10.1.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^102.0.0",
+		"@atlaskit/tmp-editor-statsig": "^103.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bowser-ultralight": "^1.0.6"
 	},

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

@@ -1,13 +0,0 @@
-import type { INSMOptions } from './types';
-import type { INSMSession } from './insm-session';
-import { INSM } from './insm';
-/**
- * Initializes the INSM (Interactivity Session Measurement) tooling
- */
-export declare function init(options: INSMOptions): void;
-/**
- * **In**teractivity **s**ession **m**onitoring
- */
-export declare const insm: Pick<INSM, 'start' | 'stopEarly' | 'startHeavyTask' | 'endHeavyTask' | 'overrideExperienceKey'> & {
-    session: Pick<INSMSession, 'details' | 'startFeature' | 'endFeature' | 'addProperties' | 'setProperty'> | undefined;
-};

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

@@ -1,37 +0,0 @@
-import type { Measure, PeriodMeasurer } from '../types';
-type Interaction = 'pointerdown' | 'pointerup' | 'click' | 'keydown' | 'keyup';
-type INPTrackerOptions = {
-    /**
-     * The interactions that should be included in the INP calculation.
-     * If none provided then 'pointerdown', 'pointerup', 'click', 'keydown', and 'keyup' are used.
-     */
-    includedInteractions?: Interaction[];
-};
-export declare class INPTracker implements PeriodMeasurer {
-    /**
-     * INP stands for Interaction to Next Paint
-     */
-    name: string;
-    monitor: InteractionTracker;
-    includedInteractions: Interaction[];
-    constructor(options?: INPTrackerOptions);
-    start(paused: boolean): Measure;
-    end(): Measure;
-    pause(): void;
-    resume(): void;
-}
-declare class InteractionTracker {
-    paused: boolean;
-    private performanceObserver;
-    private interactionResult;
-    private includedInteractions;
-    constructor(includedInteractions: Interaction[]);
-    private stopTracking;
-    private startTracking;
-    private reset;
-    start(paused: boolean): Measure;
-    end(): Measure;
-    pause(): void;
-    resume(): void;
-}
-export {};

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

@@ -1,91 +0,0 @@
-import type { INSMSession } from './insm-session';
-import type { Measure } from './types';
-export declare class PeriodTracking {
-    private periodMeasurements;
-    /**
-     * On creation - this is set to the currently running sessions features,
-     * and is updated throughout the period for any additional features triggered.
-     * It is reset when starting a new period.
-     */
-    private latestPeriodFeatures;
-    private latestHeavyTasks;
-    state: 'inactive' | 'active';
-    pauses: Set<string>;
-    /**
-     * Warning: this can be reset mid period when pausing/resuming.
-     * It's intended use is to build the `periodMeasurements` duration.
-     */
-    private currentPeriodStart;
-    private session;
-    constructor(session: INSMSession);
-    startFeature(featureName: string): void;
-    startHeavyTask(heavyTaskName: string): void;
-    endHeavyTask(heavyTaskName: string): void;
-    /**
-     * Sets a pause based on a key.  If this is the first pause, then it will also halt
-     * running interactivity measures, and update the current measurements duration.
-     */
-    pause(pauseName: string): void;
-    /**
-     * Releases a pause for a key.
-     *
-     * **NOTE**: The session will only resume if this was the only
-     * currently tracked pause key.
-     */
-    resume(pauseName: string): void;
-    get endResults(): {
-        active: {
-            count: number;
-            duration: number;
-            features: Set<string>;
-            heavyTasks: Set<string>;
-            measurements: {
-                [key: string]: Measure;
-            };
-        };
-        inactive: {
-            count: number;
-            duration: number;
-            features: Set<string>;
-            heavyTasks: Set<string>;
-            measurements: {
-                [key: string]: Measure;
-            };
-        };
-    } | {
-        active: {
-            features: string[];
-            heavyTasks: string[];
-            measurements: {
-                [key: string]: Measure;
-            };
-            duration: number;
-            count: number;
-        };
-        inactive: {
-            features: string[];
-            heavyTasks: string[];
-            measurements: {
-                [key: string]: Measure;
-            };
-            duration: number;
-            count: number;
-        };
-    };
-    private activeStartListeners;
-    private setupActiveStartInteractionListeners;
-    private activeEndListeners;
-    /**
-     * This works by;
-     * On setup
-     * - starts activity listeners
-     *   - on activity received
-     *     - possible end active count down started.
-     *       3 animation frames or 3 seconds of inactivity - whichever comes first
-     *     - any existing end count down ended
-     */
-    private activeEndCountDownAbortController;
-    private activeEndCountDownVisibilityListener;
-    private setupEndActiveInteractionListeners;
-    private changePeriodAndTrackLast;
-}

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

@@ -1,115 +0,0 @@
-import type { INSM } from './insm';
-import type { AddedProperties, ExperienceProperties } from './types';
-import { PeriodTracking } from './insm-period';
-import { LongAnimationFrameMeasurer } from './session-measurers/LongAnimationFrameMeasurer';
-/**
- * Only intended for internal use.
- *
- * Exported for consumers who may require the type.
- *
- * Note: Events are not reliably fired from mobile browsers (ie. when a browser is closed when not in use)
- */
-export declare class INSMSession {
-    private experienceKey;
-    private experienceProperties;
-    private startedAt;
-    private pageLoadTime;
-    insm: INSM;
-    private running;
-    private addedProperties;
-    private staticProperties;
-    runningFeatures: Set<string>;
-    periodTracking: PeriodTracking;
-    longAnimationFrameMeasurer: LongAnimationFrameMeasurer;
-    constructor(experienceKey: string, experienceProperties: ExperienceProperties, insm: INSM);
-    /**
-     * Completes the page load timing. This is called automatically when ending a heavy task
-     * with the key 'PageLoad'.
-     */
-    completePageLoad(): void;
-    updateExperienceKey(experienceKey: string): void;
-    /**
-     * Adds a feature to the currently running session
-     */
-    startFeature(featureName: string): void;
-    /**
-     * Ends a features usage in the currently running session
-     */
-    endFeature(featureName: string): void;
-    /**
-     * Returns details on the current session.
-     */
-    get details(): {
-        experienceKey: string;
-        experienceProperties: ExperienceProperties;
-        paused: boolean;
-        periodState: 'inactive' | 'active';
-        /**
-         * The only scenario where this value should return false is when
-         * the experience has been stopped early.
-         */
-        running: boolean;
-    };
-    /**
-     * This api is an alternative to addProperties for scenarios
-     * such as where you have a hot path that will repeatedly fire
-     * throughout a session.
-     * The last value for a given key will be used, and if there is a
-     * matching key from addProperties, the addProperties value will be used.
-     *
-     * ```ts
-     * insm.session.addProperties('custom:lcm', true)
-     * ```
-     */
-    setProperty(key: string, value: number | string | boolean): void;
-    /**
-     * This api takes either a static single-level key-value object, or callbacks which return the same and
-     * will be evaluated on session end.
-     *
-     * When ending a session, all properties received via this api are merged, in order, into the resulting
-     * insm event’s properties; last write wins.
-     *
-     * Callback values are evaluated at session end.
-     *
-     * For example, for the following
-     *
-     * ```ts
-     * insm.experience.addProperties({ one: 1, two: 2 });
-     * insm.experience.addProperties(() => ({ one: 'one' }));
-     * insm.experience.addProperties({ three: 3 });
-     * ```
-     *
-     * The resulting added properties will be
-     *
-     * ```ts
-     * { one: 'one', two: 2, three: 3 }
-     * ```
-     */
-    addProperties(propertiesToAdd: AddedProperties): void;
-    /**
-     * In some scenarios (ie. when a page error boundary is hit), you will want to exit early.
-     * This is api supports these scenarios
-     *
-     * ```ts
-     * insm.stopEarly(reasonKey: string, description: string);
-     * ```
-     *
-     * Sessions closed early are identifiable by their end details
-     * `"endDetails": { stoppedBy: "early-stop", reasonKey, description }`.
-     *
-     * **Note**: The session is ended as soon as this is called, and any `addProperties` handlers will
-     * called immediately.
-     */
-    earlyStop(reason: string, description?: string): void;
-    end(endDetails: {
-        contentId?: string | null;
-        experienceKey: string;
-        stoppedBy: 'new-experience';
-    } | {
-        stoppedBy: 'beforeunload';
-    } | {
-        description?: string;
-        reason: string;
-        stoppedBy: 'early-stop';
-    }): void;
-}

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

@@ -1,70 +0,0 @@
-import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-import { INSMSession } from './insm-session';
-import type { ExperienceProperties, INSMOptions } from './types';
-import { AnimationFPSIM } from './period-measurers/afps';
-import { INPTracker } from './inp-measurers/inp';
-export declare class INSM {
-    analyticsWebClient?: AnalyticsWebClient;
-    runningSession?: INSMSession;
-    options: INSMOptions;
-    periodMeasurers: [
-        AnimationFPSIM,
-        INPTracker
-    ];
-    /**
-     * Heavy tasks are tracked at the insm layer as heavy tasks
-     * are expected at times to be unrelated to the current
-     * page session.
-     */
-    runningHeavyTasks: Set<string>;
-    constructor(options: INSMOptions);
-    /**
-     * 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;
-    /**
-     * Ends a heavy task in the currently running session
-     */
-    endHeavyTask(heavyTaskName: string): void;
-    /**
-     * 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('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('PageLoad')
-     * // ... heavy initialisation work
-     * 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.
-     */
-    stopEarly(reasonKey: string, description: string): void;
-    /**
-     * Gets the current running session details
-     */
-    get session(): INSMSession | undefined;
-}

package/dist/types-ts4.5/period-measurers/afps.d.ts

@@ -1,57 +0,0 @@
-import type { PeriodMeasurer } from '../types';
-export declare class AnimationFPSIM implements PeriodMeasurer {
-    /**
-     * AFPS stands for Animation Frames Per Second
-     */
-    name: string;
-    monitor: AnimationFPSMonitor;
-    start(paused: boolean): {
-        numerator: number;
-        denominator: number;
-        max: number;
-        min: number;
-        average: number;
-    };
-    end(): {
-        numerator: number;
-        denominator: number;
-        max: number;
-        min: number;
-        average: number;
-    };
-    pause(): void;
-    resume(): void;
-}
-declare class AnimationFPSMonitor {
-    paused: boolean;
-    private currentState;
-    private windowFrameCount;
-    private windowTotalTime;
-    private currentFrameStart;
-    animationFrame?: ReturnType<typeof requestAnimationFrame>;
-    private measureWindowFPS;
-    /**
-     * If there is running tracking - it will be reset
-     */
-    private startWindowTracking;
-    startNewWindow(paused: boolean): {
-        numerator: number;
-        denominator: number;
-        max: number;
-        min: number;
-        average: number;
-    };
-    private resetWindow;
-    private endWindowTracking;
-    private resetOverallTracking;
-    end(): {
-        numerator: number;
-        denominator: number;
-        max: number;
-        min: number;
-        average: number;
-    };
-    pause(): void;
-    resume(): void;
-}
-export {};

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

@@ -1,63 +0,0 @@
-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,90 +0,0 @@
-import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
-export type INSMOptions = {
-    /**
-     * If an experience is missing or not enabled - no session event will be fired
-     */
-    experiences: {
-        [key: string]: {
-            enabled: boolean;
-        } | undefined;
-    };
-    getAnalyticsWebClient: Promise<AnalyticsWebClient>;
-    /**
-     * The Event Population is intended for segmenting traffic based on
-     * overrides/segments used in Statsig for targeting.
-     * ie. "customer-test", "internal-test", "release-tracks", "experiment-population"
-     *
-     * See https://console.statsig.com/LqivKg6ADZZaGczRfBKfX/dynamic_configs/cc_ufo_group
-     * for an example dynamic config powering the Confluence population.
-     */
-    population?: string;
-};
-export type ExperienceProperties = {
-    /**
-     * An optional content id (ie. for a Confluence page - the page id)
-     *
-     * Leaf experiences such as the Confluence Space Overview are
-     * 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 | undefined;
-} | (() => {
-    [key: string]: string | number | boolean | undefined;
-});
-export type Measure = {
-    average: number;
-    denominator: number;
-    max: number;
-    min: 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.
-     *
-     * Implementers should take care to handle if measurements can be received after
-     * an animation frame.  In this scenario, on resetting - the consumer needs to
-     * discard any measurements started before the reset.
-     *
-     * The possibility of data loss due to this is mitigated by the inactive period logic
-     * where a session can not be marked as inactive until
-     * - at least 3 seconds of no user activity
-     * - and 2 animation frames since the last user activity.
-     *
-     * **Important** consumers need to handle starting up both initial tracking and also
-     * when tracking is restarted after an end.
-     *
-     * @returns The interactivity measurements for the current period (or undefined for the initial start)
-     */
-    start: (
-    /**
-     * When started with paused = true. it indicates a heavy task is running at startup time.
-     */
-    paused: boolean) => Measure | undefined;
-}