Skip to content

feat(nextjs): Emit warning for conflicting treeshaking / debug settings #18638

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
chargome merged 2 commits into from
Dec 30, 2025
+107 −0
Merged

feat(nextjs): Emit warning for conflicting treeshaking / debug settings #18638

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8574543
add warnings
chargome Dec 30, 2025
08154cb
test
chargome Dec 30, 2025
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
Prev Previous commit
test
  • Loading branch information
@chargome
chargome committed Dec 30, 2025
commit 08154cb913cde4fafaefc4ac9ce9f870dc632b82
82 changes: 82 additions & 0 deletions packages/nextjs/test/config/conflictingDebugOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
import { JSDOM } from 'jsdom';
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';

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

function didWarnAboutDebugRemoved(warnSpy: ReturnType<typeof vi.spyOn>): boolean {
return warnSpy.mock.calls.some(call =>
call.some(
arg =>
typeof arg === 'string' &&
arg.includes('You have enabled `debug: true`') &&
arg.includes('debug logging was removed from your bundle'),
),
);
}

describe('debug: true + removeDebugLogging warning', () => {
let dom: JSDOM;
let originalDocument: unknown;
let originalLocation: unknown;
let originalAddEventListener: unknown;

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

originalDocument = (globalThis as any).document;
originalLocation = (globalThis as any).location;
originalAddEventListener = (globalThis as any).addEventListener;

Object.defineProperty(globalThis, 'document', { value: dom.window.document, writable: true });
Object.defineProperty(globalThis, 'location', { value: dom.window.location, writable: true });
Object.defineProperty(globalThis, 'addEventListener', { value: () => undefined, writable: true });
});

afterAll(() => {
Object.defineProperty(globalThis, 'document', { value: originalDocument, writable: true });
Object.defineProperty(globalThis, 'location', { value: originalLocation, writable: true });
Object.defineProperty(globalThis, 'addEventListener', { value: originalAddEventListener, writable: true });
});

afterEach(() => {
vi.restoreAllMocks();
vi.resetModules();
vi.unmock('../../src/common/debug-build.js');
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 }));

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 }));

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);
});
});
Loading