Sentry creates rewriteFramesHelper.js during Nextjs "standalone" static generation

[calix]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which package are you using?

@sentry/nextjs

SDK Version

6.18.1

Framework Version

No response

Link to Sentry event

No response

Steps to Reproduce

We are switching to generating a standalone bundle for our Nextjs project according to: https://nextjs.org/docs/advanced-features/output-file-tracing

This issue is possible to reproduce when bundling NextJS using:

module.exports = { experimental: { outputStandalone: true, }, }

next.config.js consumes the config using withSentryConfig as described in the docs:

module.exports = withSentryConfig(moduleExports, sentryWebpackPluginOptions);

We first detected the issue when our Azure pipeline failed at:

> Build error occurred [Error: ENOENT: no such file or directory, mkdir 'D:\a\1\s\.next\standalone\.next\server\pages\C:\Users\VSSADM~1\AppData\Local\Temp\sentry-Yr02pe'] { errno: -4058, code: 'ENOENT', syscall: 'mkdir', path: 'D:\\a\\1\\s\\.next\\standalone\\.next\\server\\pages\\C:\\Users\\VSSADM~1\\AppData\\Local\\Temp\\sentry-Yr02pe' } ##[error]Cmd.exe exited with code '1'.
Sentry is for some reason trying to generate a folder for the file rewritesFramesHelper.js during nextjs "Generating static pages".

When running locally, this directory is created in the root NextJS folder.

Expected Result

Expect sentry not to spam the project folder with directory sentry-xxxxx.

Actual Result

As you can see, Sentry is creating a folder Users...../sentry-xxxxxx containing rewritesFramesHelper.js.

[AbhiPrasad]

This is the logic that concerns itself with this -

sentry-javascript/packages/nextjs/src/config/webpack.ts

Lines 135 to 148 in 889024a

	// Support non-default output directories by making the output path (easy to get here at build-time) available to the
	// server SDK's default `RewriteFrames` instance (which needs it at runtime). Doesn't work when using the dev server
	// because it somehow tricks the file watcher into thinking that compilation itself is a file change, triggering an
	// infinite recompiling loop. (This should be fine because we don't upload sourcemaps in dev in any case.)
	if (isServer && !isDev) {
	const rewriteFramesHelper = path.resolve(
	fs.mkdtempSync(path.resolve(os.tmpdir(), 'sentry-')),
	'rewriteFramesHelper.js',
	);
	fs.writeFileSync(rewriteFramesHelper, `global.__rewriteFramesDistDir__ = '${userNextConfig.distDir}';\n`);
	// stick our helper file ahead of the user's config file so the value is in the global namespace *before*
	// `Sentry.init()` is called
	filesToInject.unshift(rewriteFramesHelper);
	}

, but it seems that it doesn't account for .next/standalone.

Adding to the backlog, but PRs are welcome for anyone who wants to help out!

[lobsterkatie]

This is related to #4382, or rather, solving one will solve both.

Two possible approaches:

1. Do what the webpack plugin does and rather than create a new file, have a placeholder file whose contents we replace. Potential problem: Can we guarantee we know where that file will be within node_modules?

2. Instead of adding a new file to the webpack entry property, create a loader which inserts the code directly into the necessary files.

[calix]

I can mention that we have temporarily solved this by patching (using patch-package) the node module for this library. Its not a pretty patch but seems to work.

[bogdankatishev]

Hello, we also have this problem, when building the nextjs app with outputStandalone: true on our Jenkins, we get the following error message:

> Build error occurred
[Error: EACCES: permission denied, mkdir '/var/lib/tmp'] {
  errno: -13,
  code: 'EACCES',
  syscall: 'mkdir',
  path: '/var/lib/tmp'
}

Of course this path is protected on our Jenkins.

When debugging locally, I found out that Sentry writes a JS file to the tmp dir:

cat /var/lib/tmp/sentry-BLeAPp/rewriteFramesHelper.js 
global.__rewriteFramesDistDir__ = '.next';

[lobsterkatie]

When debugging locally, I found out that Sentry writes a JS file to the tmp dir

Yup, that is indeed what we do. Interesting that it's protected... I would have said the whole point of a temp folder was for processes to be able to throw whatever temporary files they need to in there without having to worry about cleaning them up, and protecting it completely defeats that purpose.

Regardless, in the long run, I think it's reasonable to change our approach, using one of the two strategies I outlined above. In the short run, would any of the strategies listed here solve your problem?

[webPlayer7]

I met the same problem. rewriteFramesHelper.js is created in other folder. Is there any way we can fix this quickly?

[svict4]

I can mention that we have temporarily solved this by patching (using patch-package) the node module for this library. Its not a pretty patch but seems to work.

Hey @calix can you share your patch, however ugly?

[webPlayer7]

That error disappear when I build in Linux. It occurs when only windows OS

[GorlikItsMe]

I meet the same problem, during build sentry want create new folder but with weird path
D:\\MyProjects\\next-app\\.next\\standalone\\.next\\server\\pages\\C:\\Users\\USER\\AppData\\Local\\Temp\\sentry-zVQYAF
You see it try connect 2 paths. Error occurs on windows.