Skip to content

test(nextjs): Switch DEBUG_BUILD with a getter instead of re-importing the SDK #25279

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.

Sign up for GitHub

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
JPeer264 merged 1 commit into from
Oct 14, 2026
Merged

test(nextjs): Switch DEBUG_BUILD with a getter instead of re-importing the SDK #25279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 19 additions & 25 deletions packages/nextjs/test/config/conflictingDebugOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
import { JSDOM } from 'jsdom';
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
import * as client from '../../src/client/index.js';
import * as edge from '../../src/edge/index.js';
import * as server from '../../src/server/index.js';

const TEST_DSN = 'https://public@dsn.ingest.sentry.io/1337';

const debugBuild = vi.hoisted(() => ({ value: true }));

// The entry points read `DEBUG_BUILD` inside `init()`, so a getter lets each test switch it without
// re-importing the SDK module graphs.
vi.mock('../../src/common/debug-build.js', () => ({
get DEBUG_BUILD() {
return debugBuild.value;
},
}));

function didWarnAboutDebugRemoved(warnSpy: ReturnType<typeof vi.spyOn>): boolean {
return warnSpy.mock.calls.some(call =>
call.some(
Expand All @@ -21,15 +34,7 @@ describe('debug: true + removeDebugLogging warning', () => {
let originalAddEventListener: unknown;
let originalRemoveEventListener: unknown;

beforeAll(async () => {
// Pre-warm V8 compilation cache for the large SDK module graphs.
// Without this, the first dynamic import after vi.resetModules() can hang
// because vitest needs to compile the entire module graph from scratch.
await import('../../src/client/index.js');
await import('../../src/server/index.js');
await import('../../src/edge/index.js');
vi.resetModules();

beforeAll(() => {
dom = new JSDOM('<!doctype html><html><head></head><body></body></html>', { url: 'https://example.com/' });

originalDocument = (globalThis as any).document;
Expand All @@ -52,41 +57,30 @@ describe('debug: true + removeDebugLogging warning', () => {

afterEach(() => {
vi.restoreAllMocks();
vi.resetModules();
vi.unmock('../../src/common/debug-build.js');
debugBuild.value = true;
delete process.env.NEXT_OTEL_FETCH_DISABLED;
delete process.env.NEXT_PHASE;
});

it('warns on client/server/edge when debug is true but DEBUG_BUILD is false', async () => {
vi.doMock('../../src/common/debug-build.js', () => ({ DEBUG_BUILD: false }));
it('warns on client/server/edge when debug is true but DEBUG_BUILD is false', () => {
debugBuild.value = false;

const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});

const client = await import('../../src/client/index.js');
client.init({ dsn: TEST_DSN, debug: true } as any);

const server = await import('../../src/server/index.js');
server.init({ dsn: TEST_DSN, debug: true } as any);

const edge = await import('../../src/edge/index.js');
edge.init({ dsn: TEST_DSN, debug: true } as any);

expect(didWarnAboutDebugRemoved(warnSpy)).toBe(true);
});

it('does not emit that warning when DEBUG_BUILD is true', async () => {
vi.doMock('../../src/common/debug-build.js', () => ({ DEBUG_BUILD: true }));
it('does not emit that warning when DEBUG_BUILD is true', () => {
debugBuild.value = true;

const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});

const client = await import('../../src/client/index.js');
client.init({ dsn: TEST_DSN, debug: true } as any);

const server = await import('../../src/server/index.js');
server.init({ dsn: TEST_DSN, debug: true } as any);

const edge = await import('../../src/edge/index.js');
edge.init({ dsn: TEST_DSN, debug: true } as any);

expect(didWarnAboutDebugRemoved(warnSpy)).toBe(false);
Expand Down
Loading