telemetry.ts

import { createId } from '@paralleldrive/cuid2';
import { getPrismaVersion } from '@zenstackhq/sdk/prisma';
import { sleep } from '@zenstackhq/runtime/local-helpers';
import exitHook from 'async-exit-hook';
import { CommanderError } from 'commander';
import { init, Mixpanel } from 'mixpanel';
import * as os from 'os';
import { CliError } from './cli/cli-error';
import { TELEMETRY_TRACKING_TOKEN } from './constants';
import isDocker from './utils/is-docker';
import { isWsl } from './utils/is-wsl';
import { getMachineId } from './utils/machine-id-utils';
import { getVersion } from './utils/version-utils';
import { isInCi } from './utils/is-ci';
import { isInContainer } from './utils/is-container';

/**
 * Telemetry events
 */
export type TelemetryEvents =
    | 'cli:start'
    | 'cli:complete'
    | 'cli:error'
    | 'cli:crash'
    | 'cli:command:start'
    | 'cli:command:complete'
    | 'cli:command:error'
    | 'cli:plugin:start'
    | 'cli:plugin:complete'
    | 'cli:plugin:error'
    | 'prisma:error';

/**
 * Utility class for sending telemetry
 */
export class Telemetry {
    private readonly mixpanel: Mixpanel | undefined;
    private readonly hostId = getMachineId();
    private readonly sessionid = createId();
    private readonly _os_type = os.type();
    private readonly _os_release = os.release();
    private readonly _os_arch = os.arch();
    private readonly _os_version = os.version();
    private readonly _os_platform = os.platform();
    private readonly version = getVersion();
    private readonly prismaVersion = getPrismaVersion();
    private readonly isDocker = isDocker();
    private readonly isWsl = isWsl();
    private readonly isContainer = isInContainer();
    private readonly isCi = isInCi;
    private exitWait = 200;

    constructor() {
        if (process.env.DO_NOT_TRACK !== '1' && TELEMETRY_TRACKING_TOKEN) {
            this.mixpanel = init(TELEMETRY_TRACKING_TOKEN, {
                geolocate: true,
            });
        }

        exitHook(async (callback) => {
            if (this.mixpanel) {
                // a small delay to ensure telemetry is sent
                await sleep(this.exitWait);
            }
            callback();
        });

        const errorHandler = async (err: Error) => {
            if (err instanceof CliError || err instanceof CommanderError) {
                this.track('cli:error', {
                    message: err.message,
                    stack: err.stack,
                });
                if (this.mixpanel) {
                    // a small delay to ensure telemetry is sent
                    await sleep(this.exitWait);
                }
                // error already logged
            } else {
                console.error('\nAn unexpected error occurred:\n', err);
                this.track('cli:crash', {
                    message: err.message,
                    stack: err.stack,
                });
                if (this.mixpanel) {
                    // a small delay to ensure telemetry is sent
                    await sleep(this.exitWait);
                }
            }

            process.exit(1);
        };

        exitHook.unhandledRejectionHandler(errorHandler);
        exitHook.uncaughtExceptionHandler(errorHandler);
    }

    track(event: TelemetryEvents, properties: Record<string, unknown> = {}) {
        if (this.mixpanel) {
            const payload = {
                distinct_id: this.hostId,
                session: this.sessionid,
                time: new Date(),
                $os: this._os_type,
                osType: this._os_type,
                osRelease: this._os_release,
                osPlatform: this._os_platform,
                osArch: this._os_arch,
                osVersion: this._os_version,
                nodeVersion: process.version,
                version: this.version,
                prismaVersion: this.prismaVersion,
                isDocker: this.isDocker,
                isWsl: this.isWsl,
                isContainer: this.isContainer,
                isCi: this.isCi,
                ...properties,
            };
            this.mixpanel.track(event, payload);
        }
    }

    async trackSpan<T>(
        startEvent: TelemetryEvents,
        completeEvent: TelemetryEvents,
        errorEvent: TelemetryEvents,
        properties: Record<string, unknown>,
        action: () => Promise<T> | T
    ) {
        this.track(startEvent, properties);
        const start = Date.now();
        let success = true;
        try {
            return await action();
            // eslint-disable-next-line @typescript-eslint/no-explicit-any
        } catch (err: any) {
            this.track(errorEvent, {
                message: err.message,
                stack: err.stack,
                ...properties,
            });
            success = false;
            throw err;
        } finally {
            this.track(completeEvent, {
                duration: Date.now() - start,
                success,
                ...properties,
            });
        }
    }
}

export default new Telemetry();