Include source files in your Node.js bundles

[punkpeye]

Problem Statement

At the moment, some of the stack traces are linking to source files, e.g.

… es/.pnpm/@sentry+node@9.40.0/node_modules/@sentry/node/src/integrations/tracing/fastify/index.ts in handleFastifyError.handleFastifyError at line 87:5
… es/.pnpm/@sentry+node@9.40.0/node_modules/@sentry/node/src/integrations/tracing/fastify/index.ts in <anonymous> at line 123:24
node:diagnostics_channel in Channel.publish at line 150:9

but these is only build directory in node_modules, making it impossible to look up the original site of the error.

Solution Brainstorm

Related to #17119 (comment)

[linear]

JS-761 Include source files in your Node.js bundles

[Lms24]

It's unlikely that we'll do this, given that it blows up the package size substantially. We don't minify our sources, so it should be fairly easy to read up what's going on in the original source code of the SDK.

Maybe as a middleground, we can inline the sources into the source maps we ship. Not sure yet. Gonna backlog for now.

[punkpeye]

It's unlikely that we'll do this, given that it blows up the package size substantially. We don't minify our sources, so it should be fairly easy to read up what's going on in the original source code of the SDK.

Maybe as a middleground, we can inline the sources into the source maps we ship. Not sure yet. Gonna backlog for now.

Is there a particular reason you care how large are the npm packages of Node.js-specific dependencies?

Another option would be to strip out the sourcemaps from the builds, then at least the error stack would refer to the actual origin of the error.

[Lms24]

Is there a particular reason you care how large are the npm packages of Node.js-specific dependencies?

Yes, for serverless functions. For example, AWS Lambda function size is limited to 300MB. Were of course far from that (roughly around 0.6MB at the moment, soon ~2MB) but we received complaints about our current package size already.

I'm not aware of shipping source code in NPM packages being best practise. Will bring this up with the team and see if anyone has opinions.

[punkpeye]

Alternatively, maybe it is possible to have the sourcemaps to link to GitHub hosted file with tagged version?

All I care is to find the location where the error originates from and I found it hard (impossible?) to do it with the current setup.

I ended up stripping out the inline sourcemaps and that gave the accurate location in the build.