@servicetitan/journey 2.0.0 → 3.0.0

package/src/__tests__/axios.test.ts

@@ -1,365 +0,0 @@
-/** @jest-environment jsdom */
-import { useJourneyTestRuntime } from '../__mocks__/test-runtime';
-import { completeJourney, JourneyStepTag, journeyStep, startJourney } from '../core';
-import { instrumentAxios, type AxiosLikeInstance } from '../integrations/axios';
-
-const emitMock = jest.fn();
-
-type RequestHandler = (config: any) => any;
-type ResponseOk = (response: any) => any;
-type ResponseErr = (error: any) => any;
-
-function createAxiosMock(): AxiosLikeInstance & {
-    requestHandlers: RequestHandler[];
-    responseOkHandlers: ResponseOk[];
-    responseErrHandlers: ResponseErr[];
-} {
-    const request: RequestHandler[] = [];
-    const responseOk: ResponseOk[] = [];
-    const responseErr: ResponseErr[] = [];
-
-    return {
-        defaults: { baseURL: 'https://app.example.com' },
-        interceptors: {
-            request: {
-                use(onFulfilled) {
-                    request.push(onFulfilled);
-                    return 0;
-                },
-            },
-            response: {
-                use(onFulfilled, onRejected) {
-                    responseOk.push(onFulfilled);
-                    if (onRejected) {
-                        responseErr.push(onRejected);
-                    }
-                    return 0;
-                },
-            },
-        },
-        requestHandlers: request,
-        responseOkHandlers: responseOk,
-        responseErrHandlers: responseErr,
-    };
-}
-
-describe('[journey] instrumentAxios', () => {
-    const def = {
-        name: 'axios-journey',
-        team: 'test',
-        group: 'test',
-        service: 'test',
-        timeoutMs: 0,
-        requestTimeoutMs: 5_000,
-    };
-
-    useJourneyTestRuntime(emitMock);
-
-    beforeEach(() => {
-        jest.spyOn(globalThis.performance, 'now').mockReturnValue(1_000);
-    });
-
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-
-    test('is idempotent for the same axios instance', () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-        instrumentAxios(axios);
-
-        expect(axios.requestHandlers).toHaveLength(1);
-        expect(axios.responseOkHandlers).toHaveLength(1);
-        expect(axios.responseErrHandlers).toHaveLength(1);
-    });
-
-    test('reports a successful response against the ambient step', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await journeyStep(def.name, 'book-job', () => {
-            const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-            expect(config.journeyStep).toBeInstanceOf(JourneyStepTag);
-            expect(config.journeyStart).toBe(1_000);
-
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_050);
-            const response = axios.responseOkHandlers[0]({ status: 200, config });
-            expect(response.status).toBe(200);
-        });
-        completeJourney(def.name);
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('marks journey bad on 5xx via the rejection interceptor', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await expect(
-            journeyStep(def.name, 'book-job', async () => {
-                const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-                (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-                await axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 500 },
-                });
-            })
-        ).rejects.toMatchObject({ response: { status: 500 } });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('honors an explicit journeyStep from step.tag()', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await journeyStep(def.name, 'book-job', async step => {
-            const tagged = step.tag() as { journeyStep: unknown };
-            const config = axios.requestHandlers[0]({
-                url: '/CallScreen/BookJob',
-                journeyStep: tagged.journeyStep,
-            });
-            expect(config.journeyStep).toBe(tagged.journeyStep);
-
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-            await expect(
-                axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 503 },
-                })
-            ).rejects.toBeDefined();
-        });
-
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('soft ambient: overlapping steps do not auto-stamp HTTP', async () => {
-        const other = { ...def, name: 'axios-journey-other' };
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        startJourney(other);
-
-        let releaseA!: () => void;
-        const gateA = new Promise<void>(r => {
-            releaseA = r;
-        });
-
-        const stepA = journeyStep(def.name, 'load', async () => {
-            await gateA;
-        });
-
-        await journeyStep(other.name, 'book', async () => {
-            const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-            expect(config.journeyStep).toBeUndefined();
-
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-            await expect(
-                axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 500 },
-                })
-            ).rejects.toMatchObject({ response: { status: 500 } });
-        });
-
-        releaseA();
-        await stepA;
-
-        expect(emitMock).not.toHaveBeenCalled();
-        completeJourney(def.name);
-        completeJourney(other.name);
-        expect(emitMock).toHaveBeenCalledTimes(2);
-        expect(emitMock.mock.calls.every(c => c[0].journey.outcome === 'good')).toBe(true);
-    });
-
-    test('soft ambient: step.tag() still attributes during overlap', async () => {
-        const other = { ...def, name: 'axios-journey-tagged' };
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        startJourney(other);
-
-        let releaseA!: () => void;
-        const gateA = new Promise<void>(r => {
-            releaseA = r;
-        });
-
-        const stepA = journeyStep(def.name, 'load', async () => {
-            await gateA;
-        });
-
-        await expect(
-            journeyStep(other.name, 'book', async step => {
-                const tagged = step.tag() as { journeyStep: unknown };
-                const config = axios.requestHandlers[0]({
-                    url: '/CallScreen/BookJob',
-                    journeyStep: tagged.journeyStep,
-                });
-                expect(config.journeyStep).toBe(tagged.journeyStep);
-
-                (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-                await axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 500 },
-                });
-            })
-        ).rejects.toMatchObject({ response: { status: 500 } });
-
-        releaseA();
-        await stepA;
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.name).toBe(other.name);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-
-        completeJourney(def.name);
-    });
-
-    test('ignores responses with no journey step on the config', () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        // Outside a step — request interceptor finds no ambient step.
-        const config = axios.requestHandlers[0]({ url: '/orphan' });
-        expect(config.journeyStep).toBeUndefined();
-        axios.responseOkHandlers[0]({ status: 500, config });
-
-        expect(emitMock).not.toHaveBeenCalled();
-    });
-
-    test('non-axios errors without config are rethrown without reporting', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        await expect(axios.responseErrHandlers[0](new Error('boom'))).rejects.toThrow('boom');
-        expect(emitMock).not.toHaveBeenCalled();
-    });
-
-    test('falls back to performance.now when journeyStart is missing', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await journeyStep(def.name, 'book-job', step => {
-            const tagged = step.tag() as { journeyStep: unknown };
-            const config = {
-                url: '/CallScreen/BookJob',
-                journeyStep: tagged.journeyStep,
-            };
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_200);
-            axios.responseOkHandlers[0]({ status: 200, config });
-        });
-        completeJourney(def.name);
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('marks request-latency on a slow successful response', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney({ ...def, requestTimeoutMs: 50 });
-        await journeyStep(def.name, 'book-job', () => {
-            const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_200);
-            axios.responseOkHandlers[0]({ status: 200, config });
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-latency');
-    });
-
-    test('does not mark bad on 4xx via the rejection interceptor', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await journeyStep(def.name, 'book-job', async () => {
-            const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-            await expect(
-                axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 400 },
-                })
-            ).rejects.toMatchObject({ response: { status: 400 } });
-        });
-        completeJourney(def.name);
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('network errors without a response status mark request-error', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney(def);
-        await expect(
-            journeyStep(def.name, 'book-job', async () => {
-                const config = axios.requestHandlers[0]({ url: '/CallScreen/BookJob' });
-                (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-                await axios.responseErrHandlers[0]({ config });
-            })
-        ).rejects.toBeDefined();
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('ok interceptor tolerates a missing response config', () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        expect(() => axios.responseOkHandlers[0]({ status: 200 })).not.toThrow();
-        expect(emitMock).not.toHaveBeenCalled();
-    });
-
-    test('rejection interceptor tolerates a missing error config', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        await expect(axios.responseErrHandlers[0]({ response: { status: 500 } })).rejects.toEqual({
-            response: { status: 500 },
-        });
-        expect(emitMock).not.toHaveBeenCalled();
-    });
-
-    test('uses config.baseURL when building the request key', async () => {
-        const axios = createAxiosMock();
-        instrumentAxios(axios);
-
-        startJourney({
-            ...def,
-            endpoints: [{ match: 'api.example.com/invoices', ignore: true }],
-        });
-        await journeyStep(def.name, 'book-job', async () => {
-            const config = axios.requestHandlers[0]({
-                url: '/invoices',
-                baseURL: 'https://api.example.com',
-            });
-            (globalThis.performance.now as jest.Mock).mockReturnValue(1_020);
-            await expect(
-                axios.responseErrHandlers[0]({
-                    config,
-                    response: { status: 500 },
-                })
-            ).rejects.toBeDefined();
-        });
-        completeJourney(def.name);
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-});

package/src/__tests__/jquery.test.ts

@@ -1,327 +0,0 @@
-/** @jest-environment jsdom */
-import { useJourneyTestRuntime } from '../__mocks__/test-runtime';
-import { completeJourney, journeyStep, startJourney } from '../core';
-import { instrumentJquery } from '../integrations/jquery/instrument';
-
-const emitMock = jest.fn();
-
-function createJqueryMock() {
-    const prefilters: ((o: any, orig: any, xhr: any) => void)[] = [];
-    const completes: ((event: unknown, xhr: any, settings: any) => void)[] = [];
-
-    const $ = ((_selector: Document) => ({
-        ajaxComplete(handler: (event: unknown, xhr: any, settings: any) => void) {
-            completes.push(handler);
-        },
-    })) as any;
-
-    $.ajaxPrefilter = (handler: (o: any, orig: any, xhr: any) => void) => {
-        prefilters.push(handler);
-    };
-    $.__prefilters = prefilters;
-    $.__completes = completes;
-    return $;
-}
-
-function simulateAjax($: any, url: string, status: number, durationMs = 10) {
-    const xhr = { status };
-    const settings = { url };
-    const start = globalThis.performance.now();
-
-    for (const prefilter of $.__prefilters) {
-        prefilter(settings, settings, xhr);
-    }
-
-    (globalThis.performance.now as jest.Mock).mockReturnValue(start + durationMs);
-
-    for (const complete of $.__completes) {
-        complete({}, xhr, settings);
-    }
-}
-
-describe('[journey] instrumentJquery', () => {
-    useJourneyTestRuntime(emitMock);
-
-    beforeEach(() => {
-        jest.spyOn(globalThis.performance, 'now').mockReturnValue(1_000);
-    });
-
-    afterEach(() => {
-        jest.restoreAllMocks();
-    });
-
-    test('is idempotent for the same $ instance', () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-        instrumentJquery($);
-
-        expect($.__prefilters).toHaveLength(1);
-        expect($.__completes).toHaveLength(1);
-    });
-
-    test('ignores ajax outside an active journey step', () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-idle',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 50,
-        });
-
-        simulateAjax($, '/CallScreen/BookJob', 500);
-        completeJourney('jq-idle');
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('marks journey bad on 5xx inside a journey step', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-5xx',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-5xx', 'book-job', () => {
-            simulateAjax($, '/CallScreen/BookJob', 500, 20);
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        const event = emitMock.mock.calls[0][0].journey;
-        expect(event.outcome).toBe('bad');
-        expect(event.reason).toBe('request-error');
-    });
-
-    test('marks journey bad on slow request inside a journey step', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-slow',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 50,
-        });
-
-        await journeyStep('jq-slow', 'book-job', () => {
-            simulateAjax($, '/CallScreen/BookJob', 200, 200);
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        const event = emitMock.mock.calls[0][0].journey;
-        expect(event.outcome).toBe('bad');
-        expect(event.reason).toBe('request-latency');
-    });
-
-    test('treats status 0 as a network/request error', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-network',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-network', 'book-job', () => {
-            simulateAjax($, '/CallScreen/BookJob', 0, 10);
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('does not mark bad on 4xx (user/validation)', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-4xx',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-4xx', 'book-job', () => {
-            simulateAjax($, '/CallScreen/BookJob', 400, 10);
-        });
-        completeJourney('jq-4xx');
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('honors an explicit journeyStep already stamped on the XHR', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-explicit',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-explicit', 'book-job', step => {
-            const tagged = step.tag() as { journeyStep: unknown };
-            const xhr: {
-                status: number;
-                journeyStep: unknown;
-                journeyStart?: number;
-            } = { status: 500, journeyStep: tagged.journeyStep };
-            const settings = { url: '/CallScreen/BookJob' };
-            const start = globalThis.performance.now();
-            for (const prefilter of $.__prefilters) {
-                prefilter(settings, settings, xhr);
-            }
-            // Prefilter must not clear the explicit step; it should stamp a start time.
-            expect(xhr.journeyStep).toBe(tagged.journeyStep);
-            expect(xhr.journeyStart).toBeDefined();
-            (globalThis.performance.now as jest.Mock).mockReturnValue(start + 20);
-            for (const complete of $.__completes) {
-                complete({}, xhr, settings);
-            }
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('falls back to performance.now when journeyStart is missing', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-no-start',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-no-start', 'book-job', step => {
-            const tagged = step.tag() as { journeyStep: unknown };
-            // Bypass prefilter stamping — only fire ajaxComplete with a step and no start.
-            const xhr = { status: 200, journeyStep: tagged.journeyStep };
-            for (const complete of $.__completes) {
-                complete({}, xhr, { url: '/ok' });
-            }
-        });
-        completeJourney('jq-no-start');
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-
-    test('honors step.tag() on ajax settings without deep-merge stack overflow', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        // Mimic jQuery.ajaxSetup: deep-merge plain objects only (class instances by ref).
-        function isPlainObject(obj: unknown): obj is Record<string, unknown> {
-            return (
-                !!obj && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype
-            );
-        }
-        function deepExtend(target: Record<string, unknown>, ...sources: unknown[]) {
-            for (const source of sources) {
-                if (!source || typeof source !== 'object') {
-                    continue;
-                }
-                for (const key of Object.keys(source as object)) {
-                    // Block prototype-polluting keys (CodeQL js/prototype-pollution-utility).
-                    if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-                        continue;
-                    }
-                    const copy = (source as Record<string, unknown>)[key];
-                    if (isPlainObject(copy)) {
-                        const dest = isPlainObject(target[key])
-                            ? (target[key] as Record<string, unknown>)
-                            : {};
-                        target[key] = deepExtend(dest, copy);
-                    } else {
-                        target[key] = copy;
-                    }
-                }
-            }
-            return target;
-        }
-
-        startJourney({
-            name: 'jq-settings-tag',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-        });
-
-        await journeyStep('jq-settings-tag', 'book-job', step => {
-            const tagged = step.tag() as { journeyStep: unknown };
-            expect(() => deepExtend({}, tagged)).not.toThrow();
-            const settings = deepExtend({ url: '/CallScreen/BookJob' }, tagged);
-            const xhr: { status: number; journeyStep?: unknown; journeyStart?: number } = {
-                status: 500,
-            };
-            const start = globalThis.performance.now();
-            for (const prefilter of $.__prefilters) {
-                prefilter(settings, settings, xhr);
-            }
-            expect(xhr.journeyStep).toBe(tagged.journeyStep);
-            (globalThis.performance.now as jest.Mock).mockReturnValue(start + 20);
-            for (const complete of $.__completes) {
-                complete({}, xhr, settings);
-            }
-        });
-
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('bad');
-        expect(emitMock.mock.calls[0][0].journey.reason).toBe('request-error');
-    });
-
-    test('keys cross-origin ajax urls as host/path', async () => {
-        const $ = createJqueryMock();
-        instrumentJquery($);
-
-        startJourney({
-            name: 'jq-cross',
-            team: 'test',
-            group: 'test',
-            service: 'test',
-            timeoutMs: 0,
-            requestTimeoutMs: 5_000,
-            endpoints: [{ match: 'pdf.vendor.com/render', ignore: true }],
-        });
-
-        await journeyStep('jq-cross', 'book-job', () => {
-            simulateAjax($, 'https://pdf.vendor.com/render', 500, 20);
-        });
-        completeJourney('jq-cross');
-
-        // Ignored endpoint — 5xx must not close the journey as bad.
-        expect(emitMock).toHaveBeenCalledTimes(1);
-        expect(emitMock.mock.calls[0][0].journey.outcome).toBe('good');
-    });
-});