@sentry/nextjs not working when deployed to Vercel

[pudgereyem]

Package + Version

• @sentry/browser
• @sentry/node
• raven-js
• raven-node (raven for node)
• other:@sentry/nextjs

Version:

6.3.0

Description

I'm trying to integrate @sentry/nextjs, to my Next.js application. However, when deploying to Vercel the application falls over due to an error in the code. See stacktrace below.

ERROR	Unhandled error during request: Error: EROFS: read-only file system, open './node_modules/@sentry/next-plugin-sentry/package.json'
    at Object.openSync (fs.js:462:3)
    at Object.writeFileSync (fs.js:1384:35)
    at syncPluginVersionWithNextVersion (/var/task/node_modules/@sentry/nextjs/dist/utils/config.js:34:8)
    at Object.<anonymous> (/var/task/node_modules/@sentry/nextjs/dist/utils/config.js:80:1)
    at Module._compile (internal/modules/cjs/loader.js:999:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
    at Module.load (internal/modules/cjs/loader.js:863:32)
    at Function.Module._load (internal/modules/cjs/loader.js:708:14)
    at Module.require (internal/modules/cjs/loader.js:887:19)
    at require (internal/modules/cjs/helpers.js:74:18) {
  errno: -30,
  syscall: 'open',
  code: 'EROFS',
  path: './node_modules/@sentry/next-plugin-sentry/package.json'
}

It seems like the function syncPluginVersionWithNextVersion() from @sentry/nextjs is trying to update ./node_modules/@sentry/next-plugin-sentry/package.json, which Vercel doesn't allow.

@iker-barriocanal, I can see that you commented that this is necessary:

Next requires that plugins be tagged with the same version number as the currently-running next.js package, so
modify our package.json to trick it into thinking we comply. Run before the plugin is loaded at server startup.

I tried to look up this and it does indeed seems to be the case, see PR; vercel/next.js#19084.

However, It seems unnecessary to do this during runtime on every request in a serverless environment. I'm thinking that there has to be a better solution to this issue. I've posted the question to the developers of Next.js here, hopefully they have good input.

[pudgereyem]

The response from Tim Neutkens from Next.js can be seen here. Doesn't help us much. So we should probably think of a solution ourselves :)

Ping @HazAT, would be AWESOME if we could solve this issue. Currently this prevents me from using @sentry/nextjs. My other option would be to use @sentry/react and @sentry/node instead. Which brings me to ask; are there any advantages using @sentry/nextjs over using @sentry/react and @sentry/node separately myself? I read in the PR from @iker-barriocanal that "Performance Monitoring (transactions frontend + backend" is coming soon. Care to elaborate?

Thanks.

[lobsterkatie]

Hi, @pudgereyem. We are looking into this. Agreed that we're going to need to find another workaround (as the package.json rewriting was already its own workaround.)

In the meantime, as for comparing the @sentry/react/@sentry/node solution to the @sentry/nextjs solution, I actually just wrote up an answer to this in the forum. TL;DR, the major tradeoff for the moment is stability and the ability to run during all development stages (build/dev/prod) vs the benefits that come from using the "official" solution, i.e., the one we're going to be putting resources into supporting and expanding. (Performance monitoring is a great example. It needs to be built in a way that's specific to nextjs, so it will be added to @sentry/nextjs, not @sentry/node or @sentry/react.)