Skip to content

feat(nextjs): Update default ignore list for sourcemaps #18938

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 4 commits into from
Jan 23, 2026
Merged

feat(nextjs): Update default ignore list for sourcemaps #18938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
916b2ad
update default ignore
chargome Jan 22, 2026
d4efe82
Merge branch 'develop' into cg/JS-1501/nextjs-add-option-to-suppress-…
chargome Jan 22, 2026
9cdbabe
rm logs
chargome Jan 22, 2026
a332750
hold my horses
chargome Jan 22, 2026
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
36 changes: 34 additions & 2 deletions packages/nextjs/src/config/getBuildPluginOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ const FILE_PATTERNS = {
FRAMEWORK_CHUNKS_DOT: 'static/chunks/framework.*',
POLYFILLS_CHUNKS: 'static/chunks/polyfills-*',
WEBPACK_CHUNKS: 'static/chunks/webpack-*',
PAGE_CLIENT_REFERENCE_MANIFEST: '**/page_client-reference-manifest.js',
SERVER_REFERENCE_MANIFEST: '**/server-reference-manifest.js',
NEXT_FONT_MANIFEST: '**/next-font-manifest.js',
MIDDLEWARE_BUILD_MANIFEST: '**/middleware-build-manifest.js',
INTERCEPTION_ROUTE_REWRITE_MANIFEST: '**/interception-route-rewrite-manifest.js',
ROUTE_CLIENT_REFERENCE_MANIFEST: '**/route_client-reference-manifest.js',
MIDDLEWARE_REACT_LOADABLE_MANIFEST: '**/middleware-react-loadable-manifest.js',
} as const;

// Source map file extensions to delete
Expand Down Expand Up @@ -142,6 +149,16 @@ function createSourcemapUploadIgnorePattern(
path.posix.join(normalizedDistPath, FILE_PATTERNS.FRAMEWORK_CHUNKS_DOT),
path.posix.join(normalizedDistPath, FILE_PATTERNS.POLYFILLS_CHUNKS),
path.posix.join(normalizedDistPath, FILE_PATTERNS.WEBPACK_CHUNKS),
// Next.js internal manifest files that don't have source maps
// These files are auto-generated by Next.js and do not contain user code.
// Ignoring them prevents "Could not determine source map reference" warnings.
FILE_PATTERNS.PAGE_CLIENT_REFERENCE_MANIFEST,
FILE_PATTERNS.SERVER_REFERENCE_MANIFEST,
FILE_PATTERNS.NEXT_FONT_MANIFEST,
FILE_PATTERNS.MIDDLEWARE_BUILD_MANIFEST,
FILE_PATTERNS.INTERCEPTION_ROUTE_REWRITE_MANIFEST,
FILE_PATTERNS.ROUTE_CLIENT_REFERENCE_MANIFEST,
FILE_PATTERNS.MIDDLEWARE_REACT_LOADABLE_MANIFEST,
);

return ignore;
Expand Down Expand Up @@ -216,6 +233,20 @@ function createReleaseConfig(
};
}

/**
* Merges default ignore patterns with user-provided ignore patterns.
* User patterns are appended to the defaults to ensure internal Next.js
* files are always ignored while allowing users to add additional patterns.
*/
function mergeIgnorePatterns(defaultPatterns: string[], userPatterns: string | string[] | undefined): string[] {
if (!userPatterns) {
return defaultPatterns;
}

const userPatternsArray = Array.isArray(userPatterns) ? userPatterns : [userPatterns];
return [...defaultPatterns, ...userPatternsArray];
}

/**
* Get Sentry Build Plugin options for both webpack and turbopack builds.
* These options can be used in two ways:
Expand All @@ -239,7 +270,6 @@ export function getBuildPluginOptions({
// glob characters. This clashes with Windows path separators.
// See: https://www.npmjs.com/package/glob
const normalizedDistDirAbsPath = normalizePathForGlob(distDirAbsPath);

const loggerPrefix = LOGGER_PREFIXES[buildTool];
const widenClientFileUpload = sentryBuildOptions.widenClientFileUpload ?? false;
const deleteSourcemapsAfterUpload = sentryBuildOptions.sourcemaps?.deleteSourcemapsAfterUpload ?? false;
Expand All @@ -252,6 +282,8 @@ export function getBuildPluginOptions({

const sourcemapUploadIgnore = createSourcemapUploadIgnorePattern(normalizedDistDirAbsPath, widenClientFileUpload);

const finalIgnorePatterns = mergeIgnorePatterns(sourcemapUploadIgnore, sentryBuildOptions.sourcemaps?.ignore);

const filesToDeleteAfterUpload = createFilesToDeleteAfterUploadPattern(
normalizedDistDirAbsPath,
buildTool,
Expand Down Expand Up @@ -281,7 +313,7 @@ export function getBuildPluginOptions({
disable: skipSourcemapsUpload ? true : (sentryBuildOptions.sourcemaps?.disable ?? false),
rewriteSources: rewriteWebpackSources,
assets: sentryBuildOptions.sourcemaps?.assets ?? sourcemapUploadAssets,
ignore: sentryBuildOptions.sourcemaps?.ignore ?? sourcemapUploadIgnore,
ignore: finalIgnorePatterns,
filesToDeleteAfterUpload,
...sentryBuildOptions.webpack?.unstable_sentryWebpackPluginOptions?.sourcemaps,
},
Expand Down
3 changes: 2 additions & 1 deletion packages/nextjs/src/config/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,8 @@ export type SentryBuildOptions = {
/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* Default: `[]`
* The SDK automatically ignores Next.js internal files that don't have source maps (such as manifest files)
* to prevent "Could not determine source map" warnings. Your custom patterns are merged with these defaults.
*
* The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)
*
Expand Down
111 changes: 109 additions & 2 deletions packages/nextjs/test/config/getBuildPluginOptions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
],
filesToDeleteAfterUpload: undefined,
rewriteSources: expect.any(Function),
Expand Down Expand Up @@ -121,6 +128,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
expect(result.reactComponentAnnotation).toBeDefined();
});
Expand All @@ -142,6 +156,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
});

Expand All @@ -161,6 +182,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
expect(result.reactComponentAnnotation).toBeDefined();
});
Expand All @@ -181,6 +209,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
expect(result.reactComponentAnnotation).toBeDefined();
});
Expand All @@ -205,6 +240,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
expect(result.reactComponentAnnotation).toBeUndefined();
});
Expand All @@ -228,6 +270,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
]);
expect(result.reactComponentAnnotation).toBeUndefined();
});
Expand Down Expand Up @@ -444,7 +493,7 @@ describe('getBuildPluginOptions', () => {
expect(result.sourcemaps?.assets).toEqual(customAssets);
});

it('uses custom sourcemap ignore patterns when provided', () => {
it('merges custom sourcemap ignore patterns with defaults', () => {
const customIgnore = ['**/vendor/**', '**/node_modules/**'];
const sentryBuildOptions: SentryBuildOptions = {
org: 'test-org',
Expand All @@ -461,7 +510,58 @@ describe('getBuildPluginOptions', () => {
buildTool: 'webpack-client',
});

expect(result.sourcemaps?.ignore).toEqual(customIgnore);
// Custom patterns should be appended to defaults, not replace them
expect(result.sourcemaps?.ignore).toEqual([
'/path/to/.next/static/chunks/main-*',
'/path/to/.next/static/chunks/framework-*',
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
'**/vendor/**',
'**/node_modules/**',
]);
});

it('handles single string custom sourcemap ignore pattern', () => {
const customIgnore = '**/vendor/**';
const sentryBuildOptions: SentryBuildOptions = {
org: 'test-org',
project: 'test-project',
sourcemaps: {
ignore: customIgnore,
},
};

const result = getBuildPluginOptions({
sentryBuildOptions,
releaseName: mockReleaseName,
distDirAbsPath: mockDistDirAbsPath,
buildTool: 'webpack-client',
});

// Single string pattern should be appended to defaults
expect(result.sourcemaps?.ignore).toEqual([
'/path/to/.next/static/chunks/main-*',
'/path/to/.next/static/chunks/framework-*',
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
'**/vendor/**',
]);
Copy link

@cursor cursor bot Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing integration or E2E test for feature PR

Low Severity · Bugbot Rules

This feat PR changes the sourcemap ignore pattern behavior (merging user patterns with defaults instead of replacing) but only includes unit tests. Per the review rules: "When reviewing a feat PR, check if the PR includes at least one integration or E2E test. If neither of the two are present, add a comment, recommending to add one." An integration test verifying the actual sourcemap upload/ignore behavior with the new merged patterns would help ensure the feature works correctly in real build scenarios.

Fix in Cursor Fix in Web

});

it('disables sourcemaps when disable flag is set', () => {
Expand Down Expand Up @@ -769,6 +869,13 @@ describe('getBuildPluginOptions', () => {
'/path/to/.next/static/chunks/framework.*',
'/path/to/.next/static/chunks/polyfills-*',
'/path/to/.next/static/chunks/webpack-*',
'**/page_client-reference-manifest.js',
'**/server-reference-manifest.js',
'**/next-font-manifest.js',
'**/middleware-build-manifest.js',
'**/interception-route-rewrite-manifest.js',
'**/route_client-reference-manifest.js',
'**/middleware-react-loadable-manifest.js',
],
filesToDeleteAfterUpload: undefined,
rewriteSources: expect.any(Function),
Expand Down
Loading