ESM `require('http')` breaks SSR in SolidStart

[jchatard]

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?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/node

SDK Version

7.49.0

Framework Version

solid-start version 0.2.26

Link to Sentry event

No response

SDK Setup

No response

Steps to Reproduce

1. Clone repro https://github.com/jchatard/sentry-solid
2. cd sentry-solid
3. pnpm install
4. pnpm build
5. pnpm start

I think if you get SvelteKit working, my guess is that Solid Start would almost identical.

The work done here: #7377

Was probably the way to go, but it was reverted.

Expected Result

1. Application start and is reachable on port 3000
2. The example exception is logged to Sentry.io https://github.com/jchatard/sentry-solid/blob/main/src/entry-server.tsx#L24

Actual Result

Server won't start with this output:

file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:26181
    const httpModule = require('http');
                       ^

ReferenceError: require is not defined in ES module scope, you can use import instead
This file is being treated as an ES module because it has a '.js' file extension and '/Users/jchatard/Desktop/sentry-solid/package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.
    at Http.setupOnce (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:26181:24)
    at setupIntegration (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:21977:17)
    at file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:21965:7
    at Array.forEach (<anonymous>)
    at setupIntegrations (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:21962:16)
    at NodeClient.setupIntegrations (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:22480:28)
    at Hub.bindClient (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:20241:14)
    at initAndBind (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:22946:7)
    at init (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:28588:3)
    at file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:30282:1

Node.js v18.9.0
 ELIFECYCLE  Command failed with exit code 1

[AbhiPrasad]

Hey @jchatard, thanks for writing in! Unfortunately we had to revert the changes in #7377 because we need to monkeypatch the http library for our instrumentation.

ESM has no in-process solution for this, since es modules are considered immutable on import. Their recommended solution is to use esm loaders, but this is considered experimental API, so we hesitant in adding anything until it gets more stable (it also requires you to provide a cmd line argument to add a loader, which makes DX suffer a lot).

I would recommend you use the CJS bundle instead or remove the Http integration.

[jchatard]

Hey @AbhiPrasad are you talking about this:

https://docs.sentry.io/platforms/node/configuration/integrations/default-integrations/#http ?

[AbhiPrasad]

@jchatard Yes!

[jchatard]

Ok, so I just tried that:

import * as Sentry from "@sentry/node";

Sentry.init({
  dsn: "https://.....",

  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,
  defaultIntegrations:[
    new Sentry.Integrations.Console(),
    //new Sentry.Integrations.Http(), // Disable me
    new Sentry.Integrations.OnUncaughtException(),
    new Sentry.Integrations.OnUnhandledRejection(),
    new Sentry.Integrations.ContextLines(),
    new Sentry.Integrations.LocalVariables({
      captureAllExceptions: true,
    }),
    new Sentry.Integrations.RequestData(),
  ],
  // integrations: function(integrations) {
  //   // integrations will be all default integrations
  //   return integrations.filter(integration => integration.name !== "Http");
  // },
});

But now I get:

Listening on port 3000
file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:29758
  const base = (require && require.main && require.main.filename && dir) || global.process.cwd();
               ^

ReferenceError: require is not defined
    at getModule (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:29758:16)
    at file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:17206:29
    at file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:17263:23
    at parseStackFrames (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:24488:10)
    at exceptionFromError (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:24500:18)
    at eventFromUnknownInput (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:24548:16)
    at NodeClient.eventFromException (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:24708:32)
    at NodeClient.captureException (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:22448:12)
    at NodeClient.captureException (file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:24651:18)
    at file:///Users/jchatard/Desktop/sentry-solid/dist/server.js:20347:14

Node.js v18.9.0
 ELIFECYCLE  Command failed with exit code 7.

Which comes from node/src/module.ts export function getModule():

//...
const base = (require && require.main && require.main.filename && dir) || global.process.cwd();
//...

So I add to change this line to this:

const base = global.process.cwd();

Now I can see the test failure being sent to Sentry.io.