Next.js v12 server side crashing on Vercel

[iker-barriocanal]

Related to #4103.

The Next.js SDK crashes apps on the server-side when deployed on Vercel. It doesn't happen locally.

Error logs

2021-12-01T13:01:48.296Z	31dc2972-71bb-4bcd-8ca1-d0d7502aa36c	ERROR	Error: Cannot find module '/var/task/node_modules/next/dist/server/next.js'. Please verify that the package.json has a valid "main" entry
    at tryPackage (internal/modules/cjs/loader.js:321:19)
    at Function.Module._findPath (internal/modules/cjs/loader.js:534:18)
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:888:27)
    at Function.Module._load (internal/modules/cjs/loader.js:746:27)
    at Module.require (internal/modules/cjs/loader.js:974:19)
    at require (internal/modules/cjs/helpers.js:93:18)
    at Object.<anonymous> (/var/task/node_modules/@sentry/nextjs/dist/utils/instrumentServer.js:8:14)
    at Module._compile (internal/modules/cjs/loader.js:1085:14)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
    at Module.load (internal/modules/cjs/loader.js:950:32) {
  code: 'MODULE_NOT_FOUND',
  path: '/var/task/node_modules/next/package.json',
  requestPath: 'next'
}
RequestId: 31dc2972-71bb-4bcd-8ca1-d0d7502aa36c Error: Runtime exited with error: exit status 1
Runtime.ExitError

Cause

This error is caused by importing modules from next. In the SDK, this import is required to instrument the server, see

sentry-javascript/packages/nextjs/src/utils/instrumentServer.ts

Line 14 in a6c384c

import { default as createNextServer } from 'next';

and the server instrumentation is run when initializing the SDK on the server side, see

sentry-javascript/packages/nextjs/src/index.server.ts

Lines 122 to 123 in a6c384c

	// wrap various server methods to enable error monitoring and tracing
	instrumentServer();

Solution

On Vercel, the server instrumentation has no effect. Errors and transactions are captured through the custom _error.js page and the withSentry handler. Not instrumenting the server (to not import any modules from next) when an app is deployed on Vercel should fix the issue, and the VERCEL environment variable can be helpful here, as used in

sentry-javascript/packages/nextjs/src/index.server.ts

Line 57 in a6c384c

if (process.env.VERCEL) {

Technical details may be more complex, to be defined.

[rocketman-21]

Any ETA on this? Been waiting to upgrade to Next12 for quite some time now and have been blocked because of Sentry.

[boennemann]

I really don't want to be a dick on an open source issue tracker, but this whole thing is just so damn frustrating. It's entirely blocking nextjs@12, for not just us, but also a ton of users customers it seems.

All the hype around next.js conf – Sentry was a gold sponsor for that – and then it takes two months+ to get the first party integration going, with barely any word, commitment or timeline?

… and there I was thinking I'm tracking errors with Sentry, not causing them …

Even just an official update/timeline would be appreciated.

[smeubank]

HI @boennemann and everyone else who is impacted by this.

Totally justified. We have a fix we hope to put out by the end of business week, pending some peer code review on the following branch. We appreciate that Sentry is important to all our users and customers alike. Apologies for the delay. Your message, and others like yours, are much appreciated and taken very seriously by the team here.

https://github.com/getsentry/sentry-javascript/tree/kmclb-nextjs-no-instrumentserver-on-vercel

[boennemann]

@smeubank Thank you very much. Your answer is much appreciated!

[iker-barriocanal]

Hello everyone,

We have made a change that fixes some issues with the Next.js server when deployed on Vercel. These are available in the latest release, v6.16.1. Could you try this new version and provide any feedback?

Thanks!

[swudged]

Hi @iker-barriocanal 👋

I've tried upgrading to 6.16.1, also removing outputFileTracing: false that I had set as suggested in #4103. I'm still getting the Error: Cannot find module '../browser' error that others were reporting on other threads. This is happening on API routes specifically, everything else seems to be working ok.

[iker-barriocanal]

@swudged is this only happening on Vercel? What next.js version are you using? Could you attach the code of your API route, so that we can replicate it? Thanks.

[shinnoki]

Thank you for fix this issue.

I've tried server side api routes with next: 12.0.4 and @sentry/nextjs: 6.16.1 deployed to Vercel and it worked fine! 🎉
It crashed so far with @sentry/nextjs: 6.15.0.

In our project Automatically expose System Environment Variables is enabled in Vercel settings, but possibly process.env.VERCEL is used internally, so it may crash without enabling that?
https://vercel.com/docs/concepts/projects/environment-variables#system-environment-variables

[iker-barriocanal]

@shinnoki, thanks for your message. @swudged, could you confirm whether you have the System Environment Variables exposed? The SDK currently relies on the existence of process.env.VERCEL.