Skip to content

test(replay): Update replay tests to handle side effects explicitly #16135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,13 @@
* @vitest-environment jsdom
*/

import { afterEach, describe, expect, test, vi } from 'vitest';

import '../utils/mock-internal-setTimeout';
import { EventType } from '@sentry-internal/rrweb';

import { afterEach, beforeAll, describe, expect, test, vi } from 'vitest';
import { saveSession } from '../../src/session/saveSession';
import type { RecordingEvent } from '../../src/types';
import { addEvent } from '../../src/util/addEvent';
import { resetSdkMock } from '../mocks/resetSdkMock';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

vi.mock('../../src/session/saveSession', () => {
return {
Expand All @@ -21,6 +17,9 @@ vi.mock('../../src/session/saveSession', () => {
});

describe('Integration | autoSaveSession', () => {
beforeAll(() => {
vi.useFakeTimers();
});
afterEach(() => {
vi.clearAllMocks();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* @vitest-environment jsdom
*/

import '../utils/mock-internal-setTimeout';
import type { MockInstance, MockedFunction } from 'vitest';
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';

Expand All @@ -17,9 +18,6 @@ import { createPerformanceSpans } from '../../src/util/createPerformanceSpans';
import * as SendReplayRequest from '../../src/util/sendReplayRequest';
import { BASE_TIMESTAMP, mockRrweb, mockSdk } from '../index';
import type { DomHandler } from '../types';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

type MockTransportSend = MockedFunction<Transport['send']>;

Expand All @@ -32,6 +30,7 @@ describe('Integration | beforeAddRecordingEvent', () => {
const { record: mockRecord } = mockRrweb();

beforeAll(async () => {
vi.useFakeTimers();
vi.setSystemTime(new Date(BASE_TIMESTAMP));
vi.spyOn(SentryBrowserUtils, 'addClickKeypressInstrumentationHandler').mockImplementation(handler => {
domHandler = handler;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,11 @@
* @vitest-environment jsdom
*/

import type { MockInstance } from 'vitest';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { useFakeTimers } from '../../utils/use-fake-timers';

useFakeTimers();

import { getClient } from '@sentry/core';
import '../../utils/mock-internal-setTimeout';
import type { ErrorEvent, Event } from '@sentry/core';

import { getClient } from '@sentry/core';
import type { MockInstance } from 'vitest';
import { afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
import { UNABLE_TO_SEND_REPLAY } from '../../../src/constants';
import { handleAfterSendEvent } from '../../../src/coreHandlers/handleAfterSendEvent';
import type { ReplayContainer } from '../../../src/replay';
Expand All @@ -22,6 +17,10 @@ import { resetSdkMock } from '../../mocks/resetSdkMock';
let replay: ReplayContainer;

describe('Integration | coreHandlers | handleAfterSendEvent', () => {
beforeAll(() => {
vi.useFakeTimers();
});

afterEach(() => {
replay.stop();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@
* @vitest-environment jsdom
*/

import { afterEach, describe, expect, it, vi } from 'vitest';

import '../../utils/mock-internal-setTimeout';
import { afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
import { handleBeforeSendEvent } from '../../../src/coreHandlers/handleBeforeSendEvent';
import type { ReplayContainer } from '../../../src/replay';
import { Error } from '../../fixtures/error';
import { resetSdkMock } from '../../mocks/resetSdkMock';
import { useFakeTimers } from '../../utils/use-fake-timers';

useFakeTimers();
let replay: ReplayContainer;

describe('Integration | coreHandlers | handleBeforeSendEvent', () => {
beforeAll(() => {
vi.useFakeTimers();
});

afterEach(() => {
replay.stop();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { getClient } from '@sentry/core';
import '../../utils/mock-internal-setTimeout';
import type { Event } from '@sentry/core';

import { getClient } from '@sentry/core';
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { REPLAY_EVENT_NAME, SESSION_IDLE_EXPIRE_DURATION } from '../../../src/constants';
import { handleGlobalEventListener } from '../../../src/coreHandlers/handleGlobalEvent';
import type { ReplayContainer } from '../../../src/replay';
Expand All @@ -15,12 +14,14 @@ import * as resetReplayIdOnDynamicSamplingContextModule from '../../../src/util/
import { Error } from '../../fixtures/error';
import { Transaction } from '../../fixtures/transaction';
import { resetSdkMock } from '../../mocks/resetSdkMock';
import { useFakeTimers } from '../../utils/use-fake-timers';

useFakeTimers();
let replay: ReplayContainer;

describe('Integration | coreHandlers | handleGlobalEvent', () => {
beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(async () => {
({ replay } = await resetSdkMock({
replayOptions: {
Expand Down
12 changes: 6 additions & 6 deletions packages/replay-internal/test/integration/earlyEvents.test.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
/**
* @vitest-environment jsdom
*/

import { beforeEach, describe, expect, it, vi } from 'vitest';

import '../utils/mock-internal-setTimeout';
import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { BASE_TIMESTAMP } from '..';
import { resetSdkMock } from '../mocks/resetSdkMock';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

describe('Integration | early events', () => {
beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(() => {
vi.clearAllMocks();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import '../utils/mock-internal-setTimeout';
import { captureException, getClient } from '@sentry/core';

import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import {
BUFFER_CHECKOUT_TIME,
DEFAULT_FLUSH_MIN_DELAY,
Expand All @@ -24,9 +23,6 @@ import { BASE_TIMESTAMP } from '../index';
import { resetSdkMock } from '../mocks/resetSdkMock';
import type { DomHandler } from '../types';
import { getTestEventCheckout, getTestEventIncremental } from '../utils/getTestEvent';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

async function advanceTimers(time: number) {
vi.advanceTimersByTime(time);
Expand All @@ -43,6 +39,10 @@ describe('Integration | errorSampleRate', () => {
let mockRecord: RecordMock;
let domHandler: DomHandler;

beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(async () => {
({ mockRecord, domHandler, replay } = await resetSdkMock({
replayOptions: {
Expand Down
13 changes: 6 additions & 7 deletions packages/replay-internal/test/integration/eventBuffer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import '../utils/mock-internal-setTimeout';
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { WINDOW } from '../../src/constants';
import type { Replay } from '../../src/integration';
import type { ReplayContainer } from '../../src/replay';
import { addEvent } from '../../src/util/addEvent';

// mock functions need to be imported first
import { BASE_TIMESTAMP, mockSdk } from '../index';
import { getTestEventCheckout, getTestEventIncremental } from '../utils/getTestEvent';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

describe('Integration | eventBuffer | Event Buffer Max Size', () => {
let replay: ReplayContainer;
let integration: Replay;
const prevLocation = WINDOW.location;

beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(async () => {
vi.setSystemTime(new Date(BASE_TIMESTAMP));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@
* @vitest-environment jsdom
*/

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { getClient, getCurrentScope } from '@sentry/core';
import '../utils/mock-internal-setTimeout';
import type { Event } from '@sentry/core';

import { getClient, getCurrentScope } from '@sentry/core';
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { BASE_TIMESTAMP } from '..';
import { resetSdkMock } from '../mocks/resetSdkMock';
import { getTestEventIncremental } from '../utils/getTestEvent';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

describe('Integration | eventProcessors', () => {
beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(() => {
getCurrentScope().clear();
getCurrentScope().setClient(undefined);
Expand Down
8 changes: 4 additions & 4 deletions packages/replay-internal/test/integration/events.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
* @vitest-environment jsdom
*/

import '../utils/mock-internal-setTimeout';
import { getClient } from '@sentry/core';
import type { MockInstance } from 'vitest';
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';

Expand All @@ -16,9 +18,6 @@ import type { RecordMock } from '../index';
import { BASE_TIMESTAMP } from '../index';
import { resetSdkMock } from '../mocks/resetSdkMock';
import { getTestEventCheckout } from '../utils/getTestEvent';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

async function advanceTimers(time: number) {
vi.advanceTimersByTime(time);
Expand All @@ -32,8 +31,9 @@ describe('Integration | events', () => {
const prevLocation = WINDOW.location;

beforeAll(async () => {
vi.useFakeTimers();
vi.setSystemTime(new Date(BASE_TIMESTAMP));
vi.runAllTimers();
vi.runAllTimers(); // TODO???
});

beforeEach(async () => {
Expand Down
6 changes: 2 additions & 4 deletions packages/replay-internal/test/integration/flush.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@
* @vitest-environment jsdom
*/

import '../utils/mock-internal-setTimeout';
import type { MockedFunction } from 'vitest';
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';

import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

import * as SentryBrowserUtils from '@sentry-internal/browser-utils';
import * as SentryUtils from '@sentry/core';

Expand Down Expand Up @@ -48,6 +45,7 @@ describe('Integration | flush', () => {
let mockAddPerformanceEntries: MockAddPerformanceEntries;

beforeAll(async () => {
vi.useFakeTimers();
vi.spyOn(SentryBrowserUtils, 'addClickKeypressInstrumentationHandler').mockImplementation(handler => {
domHandler = handler;
});
Expand Down
11 changes: 6 additions & 5 deletions packages/replay-internal/test/integration/getReplayId.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
* @vitest-environment jsdom
*/

import { afterEach, describe, expect, it, vi } from 'vitest';

import '../utils/mock-internal-setTimeout';
import { afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
import { mockSdk } from '../mocks/mockSdk';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

describe('Integration | getReplayId', () => {
beforeAll(() => {
vi.useFakeTimers();
});

afterEach(() => {
vi.clearAllMocks();
});
Expand Down
16 changes: 8 additions & 8 deletions packages/replay-internal/test/integration/rateLimiting.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@
* @vitest-environment jsdom
*/

import type { MockedFunction } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { getClient } from '@sentry/core';
import '../utils/mock-internal-setTimeout';
import type { Transport, TransportMakeRequestResponse } from '@sentry/core';

import { getClient } from '@sentry/core';
import type { MockedFunction } from 'vitest';
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
import { DEFAULT_FLUSH_MIN_DELAY } from '../../src/constants';
import type { ReplayContainer } from '../../src/replay';
import { clearSession } from '../../src/session/clearSession';
import { BASE_TIMESTAMP, mockSdk } from '../index';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

async function advanceTimers(time: number) {
vi.advanceTimersByTime(time);
Expand All @@ -27,6 +23,10 @@ describe('Integration | rate-limiting behaviour', () => {
let replay: ReplayContainer;
let mockTransportSend: MockTransportSend;

beforeAll(() => {
vi.useFakeTimers();
});

beforeEach(async () => {
vi.setSystemTime(new Date(BASE_TIMESTAMP));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
* @vitest-environment jsdom
*/

import { describe, expect, test } from 'vitest';
import '../utils/mock-internal-setTimeout';
import { beforeAll, describe, expect, test, vi } from 'vitest';
import { resetSdkMock } from '../mocks/resetSdkMock';
import { useFakeTimers } from '../utils/use-fake-timers';

useFakeTimers();

describe('Integration | getRecordingMode()', () => {
beforeAll(() => {
vi.useFakeTimers();
});

test('returns "session" when session sampling is enabled', async () => {
const { integration } = await resetSdkMock({
replayOptions: {
Expand Down
Loading
Loading