Skip to content

fix(nextjs): Show errors and warnings only once during build #7651

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
lforst merged 1 commit into from
Mar 29, 2023
Merged

fix(nextjs): Show errors and warnings only once during build #7651

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
55 changes: 36 additions & 19 deletions packages/nextjs/src/config/webpack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ const RUNTIME_TO_SDK_ENTRYPOINT_MAP = {
edge: './edge',
} as const;

// Next.js runs webpack 3 times, once for the client, the server, and for edge. Because we don't want to print certain
// warnings 3 times, we keep track of them here.
let showedMissingAuthTokenErrorMsg = false;
let showedMissingOrgSlugErrorMsg = false;
let showedMissingProjectSlugErrorMsg = false;
let showedHiddenSourceMapsWarningMsg = false;

// TODO: merge default SentryWebpackPlugin ignore with their SentryWebpackPlugin ignore or ignoreFile
// TODO: merge default SentryWebpackPlugin include with their SentryWebpackPlugin include
// TODO: drop merged keys from override check? `includeDefaults` option?
Expand Down Expand Up @@ -649,12 +656,15 @@ export function getWebpackPluginOptions(
)} environment variable during the build.`;
}

// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry auth token configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
if (!showedMissingAuthTokenErrorMsg) {
// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry auth token configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
showedMissingAuthTokenErrorMsg = true;
}

return;
}
Expand All @@ -672,12 +682,15 @@ export function getWebpackPluginOptions(
)} environment variable to the to your organization slug during the build.`;
}

// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry organization slug configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
if (!showedMissingOrgSlugErrorMsg) {
// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry organization slug configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
showedMissingOrgSlugErrorMsg = true;
}

return;
}
Expand All @@ -695,12 +708,15 @@ export function getWebpackPluginOptions(
)} environment variable to the name of your Sentry project during the build.`;
}

// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry project slug configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
if (!showedMissingProjectSlugErrorMsg) {
// eslint-disable-next-line no-console
console.error(
`${errorMessagePrefix} ${chalk.bold(
'No Sentry project slug configured.',
)} Source maps will not be uploaded.\n${msg}\n`,
);
showedMissingProjectSlugErrorMsg = true;
}

return;
}
Expand Down Expand Up @@ -775,7 +791,7 @@ function handleSourcemapHidingOptionWarning(userSentryOptions: UserSentryOptions
const _sentry_ = codeFormat('sentry');
const _nextConfigJS_ = codeFormat('next.config.js');

if (isServer && userSentryOptions.hideSourceMaps === undefined) {
if (isServer && userSentryOptions.hideSourceMaps === undefined && !showedHiddenSourceMapsWarningMsg) {
// eslint-disable-next-line no-console
console.warn(
`\n${_warningPrefix_} In order to be able to deminify errors, ${_sentryNextjs_} creates sourcemaps and uploads ` +
Expand All @@ -787,6 +803,7 @@ function handleSourcemapHidingOptionWarning(userSentryOptions: UserSentryOptions
'https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#use-hidden-source-map for more ' +
'information.\n',
);
showedHiddenSourceMapsWarningMsg = true;
}

// TODO (v8): Remove the check above in favor of the one below
Expand Down