@statsig/cli-session-replay-node 3.20.0

package/LICENSE

@@ -0,0 +1,14 @@
+ISC License (ISC)
+Copyright (c) 2021, Statsig, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+Statsig helps you move faster with feature gates (feature flags), and/or dynamic configs. It also allows you to run A/B/n tests to validate your new features and understand their impact on your KPIs. If you're new to Statsig, check out our product and create an account at [statsig.com](https://www.statsig.com/?ref=gh_jsm).
+
+<h1 align="center">
+	<a href="https://statsig.com/?ref=gh_jsm">
+		<img src="https://github.com/statsig-io/js-client-monorepo/assets/95646168/ae5499ed-20ff-4584-bf21-8857f800d485" />
+	</a>
+    <div />
+	<a href="https://statsig.com/?ref=gh_jsm">Statsig</a>
+</h1>
+
+<p align="center">
+	<a href="https://github.com/statsig-io/js-client-monorepo/blob/main/LICENSE">
+        	<img src="https://img.shields.io/badge/license-ISC-blue.svg?colorA=1b2528&colorB=ccfbc7&style=for-the-badge">
+    	</a>
+	<a href="https://www.npmjs.com/package/@statsig/js-client">
+        	<img src="https://img.shields.io/npm/v/@statsig/js-client.svg?colorA=1b2528&colorB=b2d3ff&style=for-the-badge">
+    	</a>
+	<a href="https://statsig.com/community?ref=gh_jsm">
+        	<img src="https://img.shields.io/badge/slack-statsig-brightgreen.svg?logo=slack&colorA=1b2528&colorB=FFF8BA&style=for-the-badge">
+    	</a>
+</p>
+
+## Getting Started
+
+Read through the [Documentation](https://docs.statsig.com/client/javascript-sdk?ref=gh_jsm) or check out the [Samples](samples/).
+
+## Packages
+
+Clients
+
+- Precomputed Evaluations (Recommended) [[npm](https://www.npmjs.com/package/@statsig/js-client)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/js-client)]
+- On Device Evaluations [[npm](https://www.npmjs.com/package/@statsig/js-on-device-eval-client)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/js-on-device-eval-client)]
+
+Product Bundles
+
+- Session Replay [[npm](https://www.npmjs.com/package/@statsig/session-replay)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/session-replay)]
+- Web Analytics [[npm](https://www.npmjs.com/package/@statsig/web-analytics)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/web-analytics)]
+
+Framework Specific Bindings
+
+- React [[npm](https://www.npmjs.com/package/@statsig/react-bindings)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/react-bindings)]
+
+- React Native [[npm](https://www.npmjs.com/package/@statsig/react-native-bindings)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/react-native-bindings)]
+
+- React Native (Expo) [[npm](https://www.npmjs.com/package/@statsig/expo-bindings)] [[source](https://github.com/statsig-io/js-client-monorepo/tree/main/packages/expo-bindings)]
+
+## Community
+
+If you need any assistance or just have a question, feel free to reach out to us on [Slack](https://statsig.com/community?ref=gh_jsm).

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@statsig/cli-session-replay-node",
+  "version": "3.20.0",
+  "license": "ISC",
+  "homepage": "https://github.com/statsig-io/js-client-monorepo",
+  "repository": {
+    "type": "git",
+    "url": "github:statsig-io/js-client-monorepo",
+    "directory": "packages/cli-session-replay-node"
+  },
+  "dependencies": {
+    "@statsig/client-core": "3.20.0",
+    "intercept-stdout": "^0.1.2"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "devDependencies": {
+    "@types/intercept-stdout": "^0.1.3",
+    "@types/node": "18.19.18"
+  }
+}

package/src/AsciicastTypes.d.ts

@@ -0,0 +1,39 @@
+export interface AsciicastHeader {
+    version: 2;
+    width: number;
+    height: number;
+    timestamp?: number;
+    duration?: number;
+    idle_time_limit?: number;
+    command?: string;
+    title?: string;
+    env?: Record<string, string | undefined>;
+    theme?: {
+        fg?: string;
+        bg?: string;
+        palette?: string;
+    };
+}
+/**
+ * Event codes:
+ *  - o: Output
+ *  - i: Input
+ *  - m: Marker
+ *  - r: Resize
+ *  - x: Exit (Only defined by asciicast v3, but v2 supports custom events)
+ */
+export type AsciicastEventCode = 'o' | 'i' | 'm' | 'r' | 'x' | (string & {});
+export declare const AsciicastEventCode: {
+    Output: "o";
+    Input: "i";
+    Marker: "m";
+    Resize: "r";
+    /**
+     * Exit code
+     * Note: Only defined by asciicast v3, but v2 supports custom events
+     */
+    Exit: "x";
+};
+export type AsciicastEventData = unknown;
+export type AsciicastEvent = [number, AsciicastEventCode, AsciicastEventData];
+export type AsciicastArray = [AsciicastHeader, ...AsciicastEvent[]];

package/src/AsciicastTypes.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsciicastEventCode = void 0;
+exports.AsciicastEventCode = {
+    Output: 'o',
+    Input: 'i',
+    Marker: 'm',
+    Resize: 'r',
+    /**
+     * Exit code
+     * Note: Only defined by asciicast v3, but v2 supports custom events
+     */
+    Exit: 'x',
+};

package/src/CliRecording.d.ts

@@ -0,0 +1,60 @@
+import { PrecomputedEvaluationsInterface } from '@statsig/client-core';
+import { AsciicastEventCode, AsciicastEventData, AsciicastHeader } from './AsciicastTypes';
+export type StatsigAsciicastHeader = Omit<AsciicastHeader, 'version' | 'width' | 'height' | 'timestamp'>;
+export interface CliRecordingPrivateHooks {
+    onResize(width: number, height: number): void;
+    onOutput(contents: string): void;
+    addCustomEvent(code: AsciicastEventCode, contents: AsciicastEventData): void;
+}
+export interface CliRecordingAdapter {
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    start(): void;
+    stop(): void;
+}
+export type CliAdapterFactory = (hooks: CliRecordingPrivateHooks) => CliRecordingAdapter;
+export interface CliRecordingOptions {
+    /**
+     * Override the start timestamp. Defined in milliseconds.
+     * @default Date.now()
+     */
+    startTimestamp?: number;
+    asciicastHeader?: StatsigAsciicastHeader;
+}
+/**
+ * CliRecording represents a recording. This is a singleton to ensure there's only one active recording at a time.
+ */
+export declare class CliRecording {
+    private static _currentRecording;
+    static get currentRecording(): CliRecording | undefined;
+    static record(client: PrecomputedEvaluationsInterface, adapterFactory: CliAdapterFactory, options?: CliRecordingOptions): CliRecording;
+    static finish(): void;
+    static isRecording(): boolean;
+    startTimestamp: number;
+    endTimestamp?: number;
+    recording: boolean;
+    private _client;
+    private _sessionID;
+    private _adapter;
+    private _asciicastLines;
+    private _payloadSize;
+    private _unsubscribe?;
+    private constructor();
+    finish(endReason?: string): void;
+    /**
+     * Start recording
+     */
+    private _startRecording;
+    private _buildController;
+    private _appendEvent;
+    /**
+     * Create logging event and send it to Statsig
+     * @param endReason
+     */
+    private _logRecording;
+    private _getSessionIdFromClient;
+    private _recTime;
+    private _shutdown;
+}

package/src/CliRecording.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliRecording = void 0;
+const client_core_1 = require("@statsig/client-core");
+const TIMEOUT_MS = 1000 * 60 * 60 * 4; // 4 hours
+const MAX_RECORDING_STRLEN = 1024 * 1024; // 1 MB
+/**
+ * CliRecording represents a recording. This is a singleton to ensure there's only one active recording at a time.
+ */
+class CliRecording {
+    static get currentRecording() {
+        return this._currentRecording;
+    }
+    static record(client, adapterFactory, options) {
+        if (!this._currentRecording) {
+            this._currentRecording = new CliRecording(client, adapterFactory, options);
+        }
+        return this._currentRecording;
+    }
+    static finish() {
+        var _a;
+        (_a = this._currentRecording) === null || _a === void 0 ? void 0 : _a.finish();
+    }
+    static isRecording() {
+        return this._currentRecording !== undefined;
+    }
+    constructor(client, adapterFactory, options) {
+        var _a;
+        this.recording = true;
+        this._asciicastLines = [];
+        this._payloadSize = 0;
+        this._client = client;
+        this._adapter = adapterFactory(this._buildController());
+        // Read data from client
+        const clientContext = this._client.getContext();
+        this._sessionID = this._getSessionIdFromClient(clientContext);
+        // Subscribe to events
+        const timeout = setTimeout(() => {
+            this.finish('timeout');
+        }, TIMEOUT_MS);
+        const shutdownHandler = () => this.finish();
+        const sessionExpiredHandler = () => this.finish();
+        this._client.$on('pre_shutdown', shutdownHandler);
+        this._client.$on('session_expired', sessionExpiredHandler);
+        this._unsubscribe = () => {
+            clearTimeout(timeout);
+            this._client.off('pre_shutdown', shutdownHandler);
+            this._client.off('session_expired', sessionExpiredHandler);
+        };
+        // Create recording header
+        const { width, height } = this._adapter.getSize();
+        this.startTimestamp = (_a = options === null || options === void 0 ? void 0 : options.startTimestamp) !== null && _a !== void 0 ? _a : Date.now();
+        const header = Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.asciicastHeader), { version: 2, width,
+            height, timestamp: Math.floor(this.startTimestamp / 1000) });
+        this._asciicastLines.push(JSON.stringify(header));
+        // Start recording
+        this._startRecording();
+    }
+    finish(endReason) {
+        this.endTimestamp = Date.now();
+        this._shutdown();
+        this._logRecording(endReason);
+    }
+    /**
+     * Start recording
+     */
+    _startRecording() {
+        client_core_1.StatsigMetadataProvider.add({ isRecordingSession: 'true' });
+        this._adapter.start();
+    }
+    _buildController() {
+        return {
+            onResize: (width, height) => {
+                this._appendEvent('r', `${width}x${height}`);
+            },
+            onOutput: (contents) => {
+                this._appendEvent('o', contents);
+            },
+            addCustomEvent: (type, contents) => {
+                this._appendEvent(type, contents);
+            },
+        };
+    }
+    _appendEvent(type, content) {
+        if (!this.recording) {
+            return;
+        }
+        try {
+            if (this._sessionID !== this._getSessionIdFromClient()) {
+                this.finish('session_expired');
+                return;
+            }
+            const now = Date.now();
+            // Always keep a running end timestamp
+            this.endTimestamp = now;
+            const asciicastEvent = [
+                this._recTime(now),
+                type,
+                content,
+            ];
+            const asciicastEventLength = (0, client_core_1._fastApproxSizeOf)(asciicastEvent, MAX_RECORDING_STRLEN);
+            if (this._payloadSize + asciicastEventLength >= MAX_RECORDING_STRLEN) {
+                this.finish('max_size_exceeded');
+                return;
+            }
+            this._asciicastLines.push(JSON.stringify(asciicastEvent));
+            this._payloadSize += asciicastEventLength;
+        }
+        catch (e) {
+            // If we get an error here, we need to stop recording to avoid an infinite loop
+            this._asciicastLines.push(JSON.stringify([
+                this._recTime(),
+                'e',
+                e instanceof Error ? e.message : `${e}`,
+            ]));
+            this.finish('error');
+        }
+    }
+    /**
+     * Create logging event and send it to Statsig
+     * @param endReason
+     */
+    _logRecording(endReason) {
+        const file = this._asciicastLines.join('\n');
+        const metadata = {
+            session_start_ts: String(this.startTimestamp),
+            session_end_ts: String(this.endTimestamp),
+            asciinema_events: file,
+            asciinema_payload_size: String(file.length),
+            session_replay_sdk_version: client_core_1.SDK_VERSION,
+            platform: 'cli',
+            sdk_instance_id: this._client.getContext().sdkInstanceID,
+        };
+        if (endReason) {
+            metadata[endReason] = 'true';
+        }
+        this._client.logEvent({
+            eventName: 'statsig::session_recording',
+            value: this._sessionID,
+            metadata,
+        });
+    }
+    _getSessionIdFromClient(context = this._client.getContext()) {
+        return context.session.data.sessionID;
+    }
+    _recTime(now = Date.now()) {
+        return (now - this.startTimestamp) / 1000;
+    }
+    _shutdown() {
+        var _a;
+        this.recording = false;
+        this._adapter.stop();
+        (_a = this._unsubscribe) === null || _a === void 0 ? void 0 : _a.call(this);
+        this._unsubscribe = undefined;
+        client_core_1.StatsigMetadataProvider.add({ isRecordingSession: 'false' });
+        CliRecording._currentRecording = undefined;
+    }
+}
+exports.CliRecording = CliRecording;

package/src/CliRecordingNodeAdapter.d.ts

@@ -0,0 +1,14 @@
+import { CliAdapterFactory, CliRecordingAdapter, CliRecordingPrivateHooks } from './CliRecording';
+export declare class CliRecordingNodeAdapter implements CliRecordingAdapter {
+    private _hooks;
+    private _stopIntercept;
+    constructor(_hooks: CliRecordingPrivateHooks);
+    start(): void;
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    stop(): void;
+    private _resizeHandler;
+}
+export declare const CliRecordingNodeAdapterFactory: CliAdapterFactory;

package/src/CliRecordingNodeAdapter.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliRecordingNodeAdapterFactory = exports.CliRecordingNodeAdapter = void 0;
+const process = require("process");
+const intercept = require("intercept-stdout");
+class CliRecordingNodeAdapter {
+    constructor(_hooks) {
+        this._hooks = _hooks;
+        this._resizeHandler = () => {
+            this._hooks.onResize(process.stdout.columns, process.stdout.rows);
+        };
+    }
+    start() {
+        this._stopIntercept = intercept((str) => {
+            this._hooks.onOutput(str.replaceAll('\n', '\r\n'));
+        });
+        process.stdout.on('resize', this._resizeHandler);
+    }
+    getSize() {
+        return {
+            width: process.stdout.columns,
+            height: process.stdout.rows,
+        };
+    }
+    stop() {
+        if (this._stopIntercept) {
+            this._stopIntercept();
+            this._stopIntercept = undefined;
+        }
+        process.stdout.off('resize', this._resizeHandler);
+    }
+}
+exports.CliRecordingNodeAdapter = CliRecordingNodeAdapter;
+const CliRecordingNodeAdapterFactory = (hooks) => new CliRecordingNodeAdapter(hooks);
+exports.CliRecordingNodeAdapterFactory = CliRecordingNodeAdapterFactory;

package/src/CliSessionReplayPlugin.d.ts

@@ -0,0 +1,8 @@
+import { PrecomputedEvaluationsInterface, StatsigPlugin } from '@statsig/client-core';
+import { CliRecordingOptions } from './CliRecording';
+export declare class StatsigCliSessionReplayPlugin implements StatsigPlugin<PrecomputedEvaluationsInterface> {
+    private readonly options?;
+    readonly __plugin = "cli-session-replay-node";
+    constructor(options?: CliRecordingOptions | undefined);
+    bind(client: PrecomputedEvaluationsInterface): void;
+}

package/src/CliSessionReplayPlugin.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatsigCliSessionReplayPlugin = void 0;
+const CliRecording_1 = require("./CliRecording");
+const CliRecordingNodeAdapter_1 = require("./CliRecordingNodeAdapter");
+class StatsigCliSessionReplayPlugin {
+    constructor(options) {
+        this.options = options;
+        this.__plugin = 'cli-session-replay-node';
+    }
+    bind(client) {
+        CliRecording_1.CliRecording.record(client, CliRecordingNodeAdapter_1.CliRecordingNodeAdapterFactory, this.options);
+    }
+}
+exports.StatsigCliSessionReplayPlugin = StatsigCliSessionReplayPlugin;

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AsciicastTypes';
+export * from './CliRecordingNodeAdapter';
+export * from './CliSessionReplayPlugin';
+export * from './CliRecording';

package/src/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_core_1 = require("@statsig/client-core");
+const AsciicastTypes_1 = require("./AsciicastTypes");
+const CliRecording_1 = require("./CliRecording");
+const CliRecordingNodeAdapter_1 = require("./CliRecordingNodeAdapter");
+const CliSessionReplayPlugin_1 = require("./CliSessionReplayPlugin");
+__exportStar(require("./AsciicastTypes"), exports);
+__exportStar(require("./CliRecordingNodeAdapter"), exports);
+__exportStar(require("./CliSessionReplayPlugin"), exports);
+__exportStar(require("./CliRecording"), exports);
+Object.assign((0, client_core_1._getStatsigGlobal)(), {
+    AsciicastEventCode: AsciicastTypes_1.AsciicastEventCode,
+    CliRecording: CliRecording_1.CliRecording,
+    CliRecordingNodeAdapter: CliRecordingNodeAdapter_1.CliRecordingNodeAdapter,
+    CliRecordingNodeAdapterFactory: CliRecordingNodeAdapter_1.CliRecordingNodeAdapterFactory,
+    StatsigCliSessionReplayPlugin: CliSessionReplayPlugin_1.StatsigCliSessionReplayPlugin,
+});