ESM require('http') breaks SSR in SolidStart
#7938
Comments
|
Hey @jchatard, thanks for writing in! Unfortunately we had to revert the changes in #7377 because we need to monkeypatch the 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 |
AbhiPrasad
added
Meta: Breaking
Package: node
|
Hey @AbhiPrasad are you talking about this: https://docs.sentry.io/platforms/node/configuration/integrations/default-integrations/#http ? |
|
@jchatard Yes! |
|
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 //...
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. |
|
Ah yeah this is because of the stacktrace parsing needing require 🤔 Backlogging since we need to re-visits and fix this! |
|
I was going to report an issue for that but found that this one exists already. I guess the issue is pretty much the same even if I'm in a different environment and using different SDK. I'm trying to run a Lambda in AWS on Node 18 using native Node ES support. I have an esm bundle of the lambda code that includes the code of I guess the only option for me right now is to create a CJS bundle instead. |
|
Not really a concrete update unfortunately but we briefly discussed making the Serverless SDK no longer depend on the Node SDK once #8693 is completed. Also, we're currently experimenting with |
|
Same problem here, bundling my node backend to ESM using vite (similar to SolidStart). I used
diff --git a/esm/integrations/http.js b/esm/integrations/http.js
index a37a69b2b0cde0c5f0ac41ef9dfd6857e68a0b5f..56ca380be34133eb5839a8683db17ae8662a787c 100644
--- a/esm/integrations/http.js
+++ b/esm/integrations/http.js
@@ -5,6 +5,9 @@ import { LRUMap } from 'lru_map';
import { NODE_VERSION } from '../nodeVersion.js';
import { normalizeRequestArgs, extractRawUrl, extractUrl, isSentryRequest, cleanSpanDescription } from './utils/http.js';
+import { createRequire } from "module"
+const require = createRequire(import.meta.url)
+
/**
* The http module integration instruments Node's internal http module. It creates breadcrumbs, transactions for outgoing
* http requests and attaches trace data when tracing is enabled via its `tracing` option.
diff --git a/esm/integrations/localvariables.js b/esm/integrations/localvariables.js
index 7faad1039e59ed51acdf103ae82f14c29645ed59..8d08c3e74936bc2445494101973c5fc59b1651ec 100644
--- a/esm/integrations/localvariables.js
+++ b/esm/integrations/localvariables.js
@@ -3,6 +3,9 @@ import { logger } from '@sentry/utils';
import { LRUMap } from 'lru_map';
import { NODE_VERSION } from '../nodeVersion.js';
+import { createRequire } from "module"
+const require = createRequire(import.meta.url)
+
/** Creates a container for callbacks to be called sequentially */
function createCallbackList(complete) {
// A collection of callbacks to be executed last to first
diff --git a/esm/integrations/undici/index.js b/esm/integrations/undici/index.js
index 06785c3c2cc36efffec32905e12b02f166f707c4..86bd58f6c4efa19eb44453c2aeb0a9f727cfdfcb 100644
--- a/esm/integrations/undici/index.js
+++ b/esm/integrations/undici/index.js
@@ -5,6 +5,9 @@ import { LRUMap } from 'lru_map';
import { NODE_VERSION } from '../../nodeVersion.js';
import { isSentryRequest } from '../utils/http.js';
+import { createRequire } from "module"
+const require = createRequire(import.meta.url)
+
var ChannelName;(function (ChannelName) {
// https://github.com/nodejs/undici/blob/e6fc80f809d1217814c044f52ed40ef13f21e43c/docs/api/DiagnosticsChannel.md#undicirequestcreate
const RequestCreate = 'undici:request:create'; ChannelName["RequestCreate"] = RequestCreate;
@@ -66,7 +69,7 @@ class Undici {
let ds;
try {
// eslint-disable-next-line @typescript-eslint/no-var-requires
- ds = dynamicRequire(module, 'diagnostics_channel') ;
+ ds = require('diagnostics_channel');
} catch (e) {
// no-op
}
diff --git a/esm/module.js b/esm/module.js
index a6fad0044835c5657e83380438cda1d5688e4f24..79ac7727036b39e5f7d9f32e1eb2d118f795fe35 100644
--- a/esm/module.js
+++ b/esm/module.js
@@ -23,7 +23,7 @@ function getModuleFromFilename(
// eslint-disable-next-line prefer-const
let { root, dir, base: basename, ext } = posix.parse(normalizedFilename);
- const base = (require && require.main && require.main.filename && dir) || global.process.cwd();
+ const base = global.process.cwd();
const normalizedBase = `${base}/`;
diff --git a/esm/sdk.js b/esm/sdk.js
index 4e7a9174c701e163dd54a188b4ad9792dce41497..62ff95fb26d557575e2d553b2fd472480aea724b 100644
--- a/esm/sdk.js
+++ b/esm/sdk.js
@@ -34,7 +34,6 @@ const defaultIntegrations = [
new ContextLines(),
new LocalVariables(),
new Context(),
- new Modules(),
new RequestData(),
// Misc
new LinkedErrors(), |
|
I have a similar issue. We're updating our projects to use ESM and we have issues when is a Serverless Framework for AWS Lambda with Typescript and esbuild. When is CommonJS project there isn't any problem. The issues are in local (sls invoke local) and deployed in AWS. In esbuild config, we need to use After resolve this, when we invoke lambda functions, it throws: {
"errorType": "Error",
"errorMessage": "Dynamic require of \"http\" is not supported",
"trace": [
"Error: Dynamic require of \"http\" is not supported",
" at file:///var/task/src/handler/CellDataHandler.mjs:12:9",
" at _Http.setupOnce (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/integrations/http.ts:200:24)",
" at setupIntegration (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/integration.ts:134:105)",
" at <anonymous> (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/integration.ts:104:7)",
" at Array.forEach (<anonymous>)",
" at setupIntegrations (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/integration.ts:101:16)",
" at NodeClient._setupIntegrations (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/baseclient.ts:559:20)",
" at NodeClient.init (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/baseclient.ts:333:12)",
" at initializeClient (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/sdk.ts:59:12)",
" at initAndBind (/node_modules/.pnpm/@[email protected]/node_modules/@sentry/src/sdk.ts:38:3)"
]
}Finally we tried to mark @sentry/serverless as external, but then lambda throws an error with @serverless/utils package: {
"errorType": "Runtime.ImportModuleError",
"errorMessage": "Error: Cannot find module '@sentry/utils'\nRequire stack:\n- /var/task/node_modules/@sentry/serverless/cjs/awslambda.js\n- /var/task/node_modules/@sentry/serverless/cjs/index.js",
"trace": [
"Runtime.ImportModuleError: Error: Cannot find module '@sentry/utils'",
"Require stack:",
"- /var/task/node_modules/@sentry/serverless/cjs/awslambda.js",
"- /var/task/node_modules/@sentry/serverless/cjs/index.js",
" at _loadUserApp (file:///var/runtime/index.mjs:1087:17)",
" at async UserFunction.js.module.exports.load (file:///var/runtime/index.mjs:1119:21)",
" at async start (file:///var/runtime/index.mjs:1282:23)",
" at async file:///var/runtime/index.mjs:1288:1"
]
}If we comment every code related with sentry our code is executed correctly. Our tsconfig.json: {
"$schema": "https://json.schemastore.org/tsconfig",
"display": "Node 20",
"compilerOptions": {
"allowSyntheticDefaultImports": true,
"emitDecoratorMetadata": true,
"esModuleInterop": true,
"experimentalDecorators": true,
"forceConsistentCasingInFileNames": true,
"incremental": true,
"lib": ["ES2023"],
"module": "nodenext",
"moduleResolution": "bundler",
"outDir": "build",
"removeComments": true,
"sourceMap": true,
"skipLibCheck": true,
"target": "ES2022",
"strictNullChecks": false
},
"include": [
"./src/**/*.ts"
],
}And our esbuild.config.js // @ts-check
module.exports = (serverless) => ({
mainFields: ['module', 'main'],
packager: 'pnpm',
platform: 'node',
target: 'node20',
format: 'esm',
bundle: true,
outputFileExtension: '.mjs',
sourcemap: 'inline',
tsconfig: './tsconfig.json',
// minify: true,
// external: ['@sentry/serverless']
});I've contact with Sentry support but they said that they never seen this error before and refer to this issue 🤷 |
The current serverless package is not esm compatible, we ship with require calls in the node package. We'll fix the node version issues with our next major version release #9508 |
|
Hi this should be resolved with We are also actively building an SDK for solidstart: #11293 and we released an official SDK for solid! https://www.npmjs.com/package/@sentry/solid |
Is there an existing issue for this?
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
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
Actual Result
Server won't start with this output:
The text was updated successfully, but these errors were encountered: