Nextjs "server Sentry.Init()" is never called if `npm run build` happened in different environment than hosting

[jtn-junedesk]

• Review the documentation: https://docs.sentry.io/
• Search for existing issues: https://github.com/getsentry/sentry-javascript/issues
• Use the latest release: https://github.com/getsentry/sentry-javascript/releases
• Provide a link to the affected event from your Sentry account

Package + Version

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

Version:

6.5.1

Description

I use Github Actions to build my nextjs application, then deploy artifacts to a NodeJS Server hosted elsewhere.
https://nextjs.org/docs/deployment#nodejs-server

During npm run build @sentry/nextjs creates a file .env.local and sets an environment variable SENTRY_SERVER_INIT_PATH. The value of said variable is an absolute path i.e. C:\some_path_to_project\.next\server\sentry\initServerSDK.js

During npm run start process.env.SENTRY_SERVER_INIT_PATH is used to require initServerSDK.js. However, npm run start is called after artifacts have been uploaded to a different environment running a NodeJS server. Because of this, the absolute path of process.env.SENTRY_SERVER_INIT_PATH is no longer valid.

initServerSDK.js cannot be found and Sentry.Init() is never called - serverside logging does not happen.

Source code

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

Line 161 in e44bc63

setRuntimeEnvVars(projectDir, { SENTRY_SERVER_INIT_PATH: serverSDKInitOutputPath });

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

Line 117 in e44bc63

require(process.env.SENTRY_SERVER_INIT_PATH as string);

[edoko]

I am having the same problem and same version.

I running the production mode, and it created .env.local, it has SENTRY_SERVER_INIT_PATH=/project_path/.next/server/sentry/initServerSDK.js.
But, .next/server/sentry is not here.
And Sentry logger is not working.

[AbhiPrasad]

Hey! Thank you for reporting, this was definitely an oversight on our part. We’ve merged in a fix for this bug, which will go out in the next release of the SDK.

I will update this issue when that release is out.

[jtn-junedesk]

@AbhiPrasad Thank you for fixing this so quickly! Looking forward to the release 👍

[jtn-junedesk]

@AbhiPrasad Looking through the code, I am a bit curious why you have chosen a 2 step model (create/consume) which creates a disk file dependency (.env.local).

Could instrumentServer.ts not simply do this:

import * as path from 'path';
import { SERVER_SDK_INIT_PATH } from './utils/config';

[...]

const serverSdk = path.join(this.server.serverBuildDir, config.SERVER_SDK_INIT_PATH);
require(serverSdk);

With this solution you would not need to create .env.local during build and could remove some complexity :)