trezor-suite/suite/e2e/support/analytics.ts

import { Page } from '@playwright/test';

import { EventType } from '@suite/analytics';
import { urlSearchParams } from '@trezor/suite/src//utils/suite/metadata';

import { step } from './common';
import { expect } from './testExtends/customMatchers';
import { EventPayload, Requests, SuiteDesktopAnalyticsEventsForE2e } from './types';

export class AnalyticsFixture {
    private page: Page;
    private lastRequestCount = 0;
    requests: Requests = [];

    constructor(page: Page) {
        this.page = page;
    }

    /**
     * Finds analytics event by type. Works for both legacy events and events
     * migrated from older analytics tracking (e.g. DeviceConnect, TransportType when migrated).
     */
    findAnalyticsEventByType<T extends SuiteDesktopAnalyticsEventsForE2e>(eventType: T['type']) {
        const event = this.requests.find(req => req.c_type === eventType) as EventPayload<T>;

        if (!event) {
            throw new Error(`Event with type ${eventType} not found.`);
        }

        return event;
    }

    // @deprecated use findLatestRequestByType for migrated events, or findAnalyticsEventByType where payload is needed
    findLatestRequestByLegacyType(eventType: SuiteDesktopAnalyticsEventsForE2e['type']) {
        return [...this.requests].reverse().find(req => req.c_type === eventType);
    }

    findLatestRequestByType(eventType: EventType) {
        return [...this.requests].reverse().find(req => req.c_type === eventType);
    }

    @step()
    async interceptAnalytics() {
        await this.page.route('**://data.trezor.io/suite/log/**', route => {
            const url = route.request().url();
            const params = urlSearchParams(url);
            this.requests.push(params);
            route.continue();
        });
    }

    @step()
    async waitForAnalyticsRequests(expectedNewRequests = 1) {
        await expect
            .poll(
                () => this.requests.length,
                `expected ${expectedNewRequests} new analytics requests.
Last request count was ${this.lastRequestCount} so we should have total of ${this.lastRequestCount + expectedNewRequests}.
Currently intercepted: \n${JSON.stringify(this.requests, null, 2)}`,
            )
            .toBeGreaterThanOrEqual(this.lastRequestCount + expectedNewRequests);
        this.lastRequestCount = this.requests.length;
    }
}