Skip to content

ref(replay): Remove circular @sentry/browser peerDependency #6736

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 1 commit into from
Jan 12, 2023
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
3 changes: 0 additions & 3 deletions packages/replay/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,6 @@
"@sentry/types": "7.30.0",
"@sentry/utils": "7.30.0"
},
"peerDependencies": {
"@sentry/browser": ">=7.24.0"
},
"engines": {
"node": ">=12"
},
Expand Down
3 changes: 1 addition & 2 deletions packages/replay/test/fixtures/error.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import type { SeverityLevel } from '@sentry/browser';
import type { Event } from '@sentry/types';

export function Error(obj?: Event): any {
Expand Down Expand Up @@ -31,7 +30,7 @@ export function Error(obj?: Event): any {
},
],
},
level: 'error' as SeverityLevel,
level: 'error',
event_id: 'event_id',
platform: 'javascript',
timestamp,
Expand Down
8 changes: 4 additions & 4 deletions packages/replay/test/mocks/mockSdk.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import type { BrowserOptions } from '@sentry/browser';
import { init } from '@sentry/browser';
import type { Envelope, Transport } from '@sentry/types';

import type { Replay as ReplayIntegration } from '../../src';
import type { ReplayContainer } from '../../src/replay';
import type { ReplayConfiguration } from '../../src/types';
import type { TestClientOptions } from '../utils/TestClient';
import { getDefaultClientOptions, init } from '../utils/TestClient';

export interface MockSdkParams {
replayOptions?: ReplayConfiguration;
sentryOptions?: BrowserOptions;
sentryOptions?: Partial<TestClientOptions>;
autoStart?: boolean;
}

Expand Down Expand Up @@ -64,13 +64,13 @@ export async function mockSdk({ replayOptions, sentryOptions, autoStart = true }
});

init({
...getDefaultClientOptions(),
dsn: 'https://[email protected]/1',
autoSessionTracking: false,
sendClientReports: false,
transport: () => new MockTransport(),
replaysSessionSampleRate: 1.0,
replaysOnErrorSampleRate: 0.0,
defaultIntegrations: false,
...sentryOptions,
integrations: [replayIntegration],
});
Expand Down
10 changes: 5 additions & 5 deletions packages/replay/test/unit/util/createReplayEnvelope.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ describe('Unit | util | createReplayEnvelope', () => {
environment: 'production',
sdk: {
integrations: ['BrowserTracing', 'Replay'],
name: 'sentry.javascript.browser',
name: 'sentry.javascript.unknown',
version: '7.25.0',
},
replay_type: 'error',
Expand All @@ -47,7 +47,7 @@ describe('Unit | util | createReplayEnvelope', () => {
expect(envelope).toEqual([
{
event_id: REPLAY_ID,
sdk: { name: 'sentry.javascript.browser', version: '7.25.0' },
sdk: { name: 'sentry.javascript.unknown', version: '7.25.0' },
sent_at: expect.any(String),
},
[
Expand All @@ -60,7 +60,7 @@ describe('Unit | util | createReplayEnvelope', () => {
platform: 'javascript',
replay_id: REPLAY_ID,
replay_type: 'error',
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.browser', version: '7.25.0' },
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
segment_id: 3,
tags: { errorSampleRate: 0, sessionSampleRate: 1 },
timestamp: 1670837008.634,
Expand All @@ -80,7 +80,7 @@ describe('Unit | util | createReplayEnvelope', () => {
expect(envelope).toEqual([
{
event_id: REPLAY_ID,
sdk: { name: 'sentry.javascript.browser', version: '7.25.0' },
sdk: { name: 'sentry.javascript.unknown', version: '7.25.0' },
sent_at: expect.any(String),
dsn: 'https://[email protected]:1234/123',
},
Expand All @@ -93,7 +93,7 @@ describe('Unit | util | createReplayEnvelope', () => {
event_id: REPLAY_ID,
platform: 'javascript',
replay_id: REPLAY_ID,
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.browser', version: '7.25.0' },
sdk: { integrations: ['BrowserTracing', 'Replay'], name: 'sentry.javascript.unknown', version: '7.25.0' },
segment_id: 3,
replay_type: 'error',
tags: { errorSampleRate: 0, sessionSampleRate: 1 },
Expand Down
7 changes: 3 additions & 4 deletions packages/replay/test/unit/util/getReplayEvent.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { BrowserClient } from '@sentry/browser';
import type { Hub, Scope } from '@sentry/core';
import { getCurrentHub } from '@sentry/core';
import type { Client, ReplayEvent } from '@sentry/types';

import { REPLAY_EVENT_NAME } from '../../../src/constants';
import { prepareReplayEvent } from '../../../src/util/prepareReplayEvent';
import { getDefaultBrowserClientOptions } from '../../utils/getDefaultBrowserClientOptions';
import { getDefaultClientOptions, TestClient } from '../../utils/TestClient';

describe('Unit | util | getReplayEvent', () => {
let hub: Hub;
Expand All @@ -14,7 +13,7 @@ describe('Unit | util | getReplayEvent', () => {

beforeEach(() => {
hub = getCurrentHub();
client = new BrowserClient(getDefaultBrowserClientOptions());
client = new TestClient(getDefaultClientOptions());
hub.bindClient(client);

client = hub.getClient()!;
Expand Down Expand Up @@ -53,7 +52,7 @@ describe('Unit | util | getReplayEvent', () => {
event_id: 'replay-ID',
environment: 'production',
sdk: {
name: 'sentry.javascript.browser',
name: 'sentry.javascript.unknown',
version: 'version:Test',
},
sdkProcessingMetadata: {},
Expand Down
7 changes: 3 additions & 4 deletions packages/replay/test/unit/util/prepareReplayEvent.test.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { BrowserClient } from '@sentry/browser';
import type { Hub, Scope } from '@sentry/core';
import { getCurrentHub } from '@sentry/core';
import type { Client, ReplayEvent } from '@sentry/types';

import { REPLAY_EVENT_NAME } from '../../../src/constants';
import { prepareReplayEvent } from '../../../src/util/prepareReplayEvent';
import { getDefaultBrowserClientOptions } from '../../utils/getDefaultBrowserClientOptions';
import { getDefaultClientOptions, TestClient } from '../../utils/TestClient';

describe('Unit | util | prepareReplayEvent', () => {
let hub: Hub;
Expand All @@ -14,7 +13,7 @@ describe('Unit | util | prepareReplayEvent', () => {

beforeEach(() => {
hub = getCurrentHub();
client = new BrowserClient(getDefaultBrowserClientOptions());
client = new TestClient(getDefaultClientOptions());
hub.bindClient(client);

client = hub.getClient()!;
Expand Down Expand Up @@ -53,7 +52,7 @@ describe('Unit | util | prepareReplayEvent', () => {
event_id: 'replay-ID',
environment: 'production',
sdk: {
name: 'sentry.javascript.browser',
name: 'sentry.javascript.unknown',
version: 'version:Test',
},
sdkProcessingMetadata: {},
Expand Down
44 changes: 44 additions & 0 deletions packages/replay/test/utils/TestClient.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { BaseClient, createTransport, initAndBind } from '@sentry/core';
import type { BrowserClientReplayOptions, ClientOptions, Event, SeverityLevel } from '@sentry/types';
import { resolvedSyncPromise } from '@sentry/utils';

export interface TestClientOptions extends ClientOptions, BrowserClientReplayOptions {}

export class TestClient extends BaseClient<TestClientOptions> {
public constructor(options: TestClientOptions) {
super(options);
}

public eventFromException(exception: any): PromiseLike<Event> {
return resolvedSyncPromise({
exception: {
values: [
{
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
type: exception.name,
value: exception.message,
/* eslint-enable @typescript-eslint/no-unsafe-member-access */
},
],
},
});
}

public eventFromMessage(message: string, level: SeverityLevel = 'info'): PromiseLike<Event> {
return resolvedSyncPromise({ message, level });
}
}

export function init(options: TestClientOptions): void {
initAndBind(TestClient, options);
}

export function getDefaultClientOptions(options: Partial<ClientOptions> = {}): ClientOptions {
return {
integrations: [],
dsn: 'https://username@domain/123',
transport: () => createTransport({ recordDroppedEvent: () => undefined }, _ => resolvedSyncPromise({})),
stackParser: () => [],
...options,
};
}
13 changes: 0 additions & 13 deletions packages/replay/test/utils/getDefaultBrowserClientOptions.ts

This file was deleted.