Skip to content

fix(nextjs): Show misconfiguration warning (no instrumentation.ts) #11266

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
merged 1 commit into from
Mar 25, 2024
Merged

fix(nextjs): Show misconfiguration warning (no instrumentation.ts) #11266

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
20 changes: 11 additions & 9 deletions packages/nextjs/src/config/webpack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ export function constructWebpackConfigFunction(
const { isServer, dev: isDev, dir: projectDir } = buildContext;
const runtime = isServer ? (buildContext.nextRuntime === 'edge' ? 'edge' : 'server') : 'client';

if (runtime !== 'client') {
warnAboutDeprecatedConfigFiles(projectDir, runtime);
}

let rawNewConfig = { ...incomingConfig };

// if user has custom webpack config (which always takes the form of a function), run it so we have actual values to
Expand Down Expand Up @@ -508,25 +512,23 @@ async function addSentryToClientEntryProperty(
* Searches for old `sentry.(server|edge).config.ts` files and warns if it finds any.
*
* @param projectDir The root directory of the project, where config files would be located
* @param platform Either "server", "client" or "edge", so that we know which file to look for
* @param platform Either "server" or "edge", so that we know which file to look for
*/
export function warnAboutDeprecatedConfigFiles(projectDir: string, platform: 'server' | 'client' | 'edge'): void {
function warnAboutDeprecatedConfigFiles(projectDir: string, platform: 'server' | 'edge'): void {
const possibilities = [`sentry.${platform}.config.ts`, `sentry.${platform}.config.js`];

for (const filename of possibilities) {
if (fs.existsSync(path.resolve(projectDir, filename))) {
if (platform === 'server' || platform === 'edge') {
// eslint-disable-next-line no-console
console.warn(
`[@sentry/nextjs] It seems you have configured a \`${filename}\` file. You need to put this file's content into a Next.js instrumentation hook instead! Read more: https://nextjs.org/docs/app/building-your-application/optimizing/instrumentation`,
);
}
// eslint-disable-next-line no-console
console.warn(
`[@sentry/nextjs] It appears you've configured a \`${filename}\` file. Please ensure to put this file's content into the \`register()\` function of a Next.js instrumentation hook instead. To ensure correct functionality of the SDK, \`Sentry.init\` must be called inside \`instrumentation.ts\`. Learn more about setting up an instrumentation hook in Next.js: https://nextjs.org/docs/app/building-your-application/optimizing/instrumentation. You can safely delete the \`${filename}\` file afterward.`,
);
}
}
}

/**
* Searches for a `sentry.client.config.ts|js` file and returns it's file name if it finds one. (ts being prioritized)
* Searches for a `sentry.client.config.ts|js` file and returns its file name if it finds one. (ts being prioritized)
*
* @param projectDir The root directory of the project, where config files would be located
*/
Expand Down