From 64bf2515ac43f5d6711a123405e4de96fe1a0e7e Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 7 May 2024 10:47:24 +0000 Subject: [PATCH 1/8] feat(node): Register ESM patching hooks in `init` for supported Node.js versions --- .../code/otelEsmLoaderHookTemplate.js | 2 ++ packages/astro/src/server/sdk.ts | 3 +++ packages/google-cloud-serverless/src/sdk.ts | 1 + packages/nextjs/src/server/index.ts | 2 ++ packages/node/src/sdk/init.ts | 23 +++++++++++++------ packages/remix/src/index.server.ts | 4 +++- packages/utils/src/worldwide.ts | 1 + 7 files changed, 28 insertions(+), 8 deletions(-) diff --git a/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js b/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js index 51c72d9d7192..e7f411669c0a 100644 --- a/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js +++ b/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js @@ -1,2 +1,4 @@ import { getFormat, getSource, load, resolve } from '@opentelemetry/instrumentation/hook.mjs'; export { getFormat, getSource, load, resolve }; + +globalThis._sentrySkipLoaderHookWarning = true; diff --git a/packages/astro/src/server/sdk.ts b/packages/astro/src/server/sdk.ts index c2398c7d019f..e36ba683caa8 100644 --- a/packages/astro/src/server/sdk.ts +++ b/packages/astro/src/server/sdk.ts @@ -1,6 +1,7 @@ import { applySdkMetadata } from '@sentry/core'; import type { NodeOptions } from '@sentry/node'; import { init as initNodeSdk, setTag } from '@sentry/node'; +import { GLOBAL_OBJ } from '@sentry/utils'; /** * @@ -12,6 +13,8 @@ export function init(options: NodeOptions): void { }; applySdkMetadata(opts, 'astro', ['astro', 'node']); + GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; + initNodeSdk(opts); setTag('runtime', 'node'); diff --git a/packages/google-cloud-serverless/src/sdk.ts b/packages/google-cloud-serverless/src/sdk.ts index 838a3d97a4a3..1eb2712ff0fb 100644 --- a/packages/google-cloud-serverless/src/sdk.ts +++ b/packages/google-cloud-serverless/src/sdk.ts @@ -2,6 +2,7 @@ import type { NodeOptions } from '@sentry/node'; import { SDK_VERSION, getDefaultIntegrations as getDefaultNodeIntegrations, init as initNode } from '@sentry/node'; import type { Integration, Options, SdkMetadata } from '@sentry/types'; +import { GLOBAL_OBJ } from '@sentry/utils'; import { googleCloudGrpcIntegration } from './integrations/google-cloud-grpc'; import { googleCloudHttpIntegration } from './integrations/google-cloud-http'; diff --git a/packages/nextjs/src/server/index.ts b/packages/nextjs/src/server/index.ts index acfa4f03af97..c7014b2d4617 100644 --- a/packages/nextjs/src/server/index.ts +++ b/packages/nextjs/src/server/index.ts @@ -86,6 +86,8 @@ export function init(options: NodeOptions): void { return; } + GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; + const customDefaultIntegrations = [ ...getDefaultIntegrations(options).filter( integration => diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts index 07bb72208f59..30562f503b91 100644 --- a/packages/node/src/sdk/init.ts +++ b/packages/node/src/sdk/init.ts @@ -14,6 +14,7 @@ import { import { openTelemetrySetupCheck, setOpenTelemetryContextAsyncContextStrategy } from '@sentry/opentelemetry'; import type { Client, Integration, Options } from '@sentry/types'; import { + GLOBAL_OBJ, consoleSandbox, dropUndefinedKeys, logger, @@ -25,6 +26,7 @@ import { consoleIntegration } from '../integrations/console'; import { nodeContextIntegration } from '../integrations/context'; import { contextLinesIntegration } from '../integrations/contextlines'; +import moduleModule from 'module'; import { httpIntegration } from '../integrations/http'; import { localVariablesIntegration } from '../integrations/local-variables'; import { modulesIntegration } from '../integrations/modules'; @@ -90,13 +92,20 @@ export function init(options: NodeOptions | undefined = {}): void { } if (!isCjs()) { - // We want to make sure users see this warning - consoleSandbox(() => { - // eslint-disable-next-line no-console - console.warn( - '[Sentry] You are using the Sentry SDK with an ESM build. This version of the SDK is not compatible with ESM. Please either build your application with CommonJS, or use v7 of the SDK.', - ); - }); + const [nodeMajor, nodeMinor] = process.versions.node.split('.').map(Number); + + // Register hook was added in v20.6.0 and v18.19.0 + if (nodeMajor > 22 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) { + // @ts-expect-error register is available in these versions & import.meta is allowed + moduleModule.register('@opentelemetry/instrumentation/hook.mjs', import.meta.url); + } else if (!GLOBAL_OBJ._sentrySkipLoaderHookWarning) { + consoleSandbox(() => { + // eslint-disable-next-line no-console + console.warn( + '[Sentry] You are using the Sentry SDK in combination with an older version (pre 18.19.0 or pre 20.6.0) of Node.js in ESM mode. For the Sentry SDK to operate properly, please run your Node.js application with a `--experimental-loader=@sentry/node/loader` flag. For example: `node --experimental-loader=@sentry/node/loader your-app.js`', + ); + }); + } } setOpenTelemetryContextAsyncContextStrategy(); diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts index ff00f7a80e58..3bf7b76782fb 100644 --- a/packages/remix/src/index.server.ts +++ b/packages/remix/src/index.server.ts @@ -1,7 +1,7 @@ import { applySdkMetadata, isInitialized } from '@sentry/core'; import type { NodeOptions } from '@sentry/node'; import { init as nodeInit, setTag } from '@sentry/node'; -import { logger } from '@sentry/utils'; +import { GLOBAL_OBJ, logger } from '@sentry/utils'; import { DEBUG_BUILD } from './utils/debug-build'; import { instrumentServer } from './utils/instrumentServer'; @@ -131,6 +131,8 @@ export function init(options: RemixOptions): void { return; } + GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; + instrumentServer(); nodeInit(options as NodeOptions); diff --git a/packages/utils/src/worldwide.ts b/packages/utils/src/worldwide.ts index 3f67a044a607..96473ecab474 100644 --- a/packages/utils/src/worldwide.ts +++ b/packages/utils/src/worldwide.ts @@ -66,6 +66,7 @@ export interface InternalGlobal { * Keys are `error.stack` strings, values are the metadata. */ _sentryModuleMetadata?: Record; + _sentrySkipLoaderHookWarning?: boolean; } /** Get's the global object for the current JavaScript runtime */ From 6427e4dc01ef3e52c38dc5cdb20b26b9ed34e809 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 7 May 2024 10:51:58 +0000 Subject: [PATCH 2/8] loader --- packages/node/src/sdk/init.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts index 30562f503b91..d624947df98e 100644 --- a/packages/node/src/sdk/init.ts +++ b/packages/node/src/sdk/init.ts @@ -102,7 +102,7 @@ export function init(options: NodeOptions | undefined = {}): void { consoleSandbox(() => { // eslint-disable-next-line no-console console.warn( - '[Sentry] You are using the Sentry SDK in combination with an older version (pre 18.19.0 or pre 20.6.0) of Node.js in ESM mode. For the Sentry SDK to operate properly, please run your Node.js application with a `--experimental-loader=@sentry/node/loader` flag. For example: `node --experimental-loader=@sentry/node/loader your-app.js`', + '[Sentry] You are using the Sentry SDK in combination with an older version (pre 18.19.0 or pre 20.6.0) of Node.js in ESM mode. For the Sentry SDK to operate properly, please run your Node.js application with a `--loader=@sentry/node/loader` flag. For example: `node --loader=@sentry/node/loader your-app.js`', ); }); } From 087b6dcf5d40c446c035625a77b234851b7b4ac4 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 08:01:39 +0000 Subject: [PATCH 3/8] bump --- packages/nextjs/package.json | 2 +- packages/node/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/nextjs/package.json b/packages/nextjs/package.json index c02d6b5c6e3e..72ea287ba9f0 100644 --- a/packages/nextjs/package.json +++ b/packages/nextjs/package.json @@ -65,7 +65,7 @@ "access": "public" }, "dependencies": { - "@opentelemetry/instrumentation-http": "0.51.0", + "@opentelemetry/instrumentation-http": "0.51.1", "@rollup/plugin-commonjs": "24.0.0", "@sentry/core": "8.0.0-rc.1", "@sentry/node": "8.0.0-rc.1", diff --git a/packages/node/package.json b/packages/node/package.json index 0aa64d22fba7..24cbfcff103f 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -63,7 +63,7 @@ "@opentelemetry/instrumentation-fastify": "0.35.0", "@opentelemetry/instrumentation-graphql": "0.39.0", "@opentelemetry/instrumentation-hapi": "0.38.0", - "@opentelemetry/instrumentation-http": "0.51.0", + "@opentelemetry/instrumentation-http": "0.51.1", "@opentelemetry/instrumentation-ioredis": "0.40.0", "@opentelemetry/instrumentation-koa": "0.39.0", "@opentelemetry/instrumentation-mongodb": "0.39.0", From 76faf13c71d76c4d32bf8845b222143da9800bac Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 10:15:26 +0000 Subject: [PATCH 4/8] . --- .../code/otelEsmImportHookTemplate.js | 3 + .../code/otelEsmLoaderHookTemplate.js | 2 - packages/astro/src/server/sdk.ts | 3 - packages/google-cloud-serverless/src/sdk.ts | 1 - packages/nextjs/src/server/index.ts | 2 - packages/node/src/sdk/init.ts | 11 +- packages/remix/src/index.server.ts | 4 +- packages/utils/src/worldwide.ts | 2 +- yarn.lock | 107 ++++++++++++------ 9 files changed, 82 insertions(+), 53 deletions(-) diff --git a/dev-packages/rollup-utils/code/otelEsmImportHookTemplate.js b/dev-packages/rollup-utils/code/otelEsmImportHookTemplate.js index 99c312a20ab4..35c805c137f7 100644 --- a/dev-packages/rollup-utils/code/otelEsmImportHookTemplate.js +++ b/dev-packages/rollup-utils/code/otelEsmImportHookTemplate.js @@ -1,2 +1,5 @@ import { register } from 'module'; + register('@opentelemetry/instrumentation/hook.mjs', import.meta.url); + +globalThis._sentryEsmLoaderHookRegistered = true; diff --git a/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js b/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js index e7f411669c0a..51c72d9d7192 100644 --- a/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js +++ b/dev-packages/rollup-utils/code/otelEsmLoaderHookTemplate.js @@ -1,4 +1,2 @@ import { getFormat, getSource, load, resolve } from '@opentelemetry/instrumentation/hook.mjs'; export { getFormat, getSource, load, resolve }; - -globalThis._sentrySkipLoaderHookWarning = true; diff --git a/packages/astro/src/server/sdk.ts b/packages/astro/src/server/sdk.ts index e36ba683caa8..c2398c7d019f 100644 --- a/packages/astro/src/server/sdk.ts +++ b/packages/astro/src/server/sdk.ts @@ -1,7 +1,6 @@ import { applySdkMetadata } from '@sentry/core'; import type { NodeOptions } from '@sentry/node'; import { init as initNodeSdk, setTag } from '@sentry/node'; -import { GLOBAL_OBJ } from '@sentry/utils'; /** * @@ -13,8 +12,6 @@ export function init(options: NodeOptions): void { }; applySdkMetadata(opts, 'astro', ['astro', 'node']); - GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; - initNodeSdk(opts); setTag('runtime', 'node'); diff --git a/packages/google-cloud-serverless/src/sdk.ts b/packages/google-cloud-serverless/src/sdk.ts index 1eb2712ff0fb..838a3d97a4a3 100644 --- a/packages/google-cloud-serverless/src/sdk.ts +++ b/packages/google-cloud-serverless/src/sdk.ts @@ -2,7 +2,6 @@ import type { NodeOptions } from '@sentry/node'; import { SDK_VERSION, getDefaultIntegrations as getDefaultNodeIntegrations, init as initNode } from '@sentry/node'; import type { Integration, Options, SdkMetadata } from '@sentry/types'; -import { GLOBAL_OBJ } from '@sentry/utils'; import { googleCloudGrpcIntegration } from './integrations/google-cloud-grpc'; import { googleCloudHttpIntegration } from './integrations/google-cloud-http'; diff --git a/packages/nextjs/src/server/index.ts b/packages/nextjs/src/server/index.ts index c7014b2d4617..acfa4f03af97 100644 --- a/packages/nextjs/src/server/index.ts +++ b/packages/nextjs/src/server/index.ts @@ -86,8 +86,6 @@ export function init(options: NodeOptions): void { return; } - GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; - const customDefaultIntegrations = [ ...getDefaultIntegrations(options).filter( integration => diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts index d624947df98e..e2b34a6c261e 100644 --- a/packages/node/src/sdk/init.ts +++ b/packages/node/src/sdk/init.ts @@ -96,13 +96,16 @@ export function init(options: NodeOptions | undefined = {}): void { // Register hook was added in v20.6.0 and v18.19.0 if (nodeMajor > 22 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) { - // @ts-expect-error register is available in these versions & import.meta is allowed - moduleModule.register('@opentelemetry/instrumentation/hook.mjs', import.meta.url); - } else if (!GLOBAL_OBJ._sentrySkipLoaderHookWarning) { + if (!GLOBAL_OBJ._sentryEsmLoaderHookRegistered) { + // @ts-expect-error register is available in these versions & import.meta is allowed + moduleModule.register('@opentelemetry/instrumentation/hook.mjs', import.meta.url); + GLOBAL_OBJ._sentryEsmLoaderHookRegistered = true; + } + } else { consoleSandbox(() => { // eslint-disable-next-line no-console console.warn( - '[Sentry] You are using the Sentry SDK in combination with an older version (pre 18.19.0 or pre 20.6.0) of Node.js in ESM mode. For the Sentry SDK to operate properly, please run your Node.js application with a `--loader=@sentry/node/loader` flag. For example: `node --loader=@sentry/node/loader your-app.js`', + '[Sentry] You are using Node.js in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or use version 7.x of the Sentry Node.js SDK.', ); }); } diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts index 3bf7b76782fb..ff00f7a80e58 100644 --- a/packages/remix/src/index.server.ts +++ b/packages/remix/src/index.server.ts @@ -1,7 +1,7 @@ import { applySdkMetadata, isInitialized } from '@sentry/core'; import type { NodeOptions } from '@sentry/node'; import { init as nodeInit, setTag } from '@sentry/node'; -import { GLOBAL_OBJ, logger } from '@sentry/utils'; +import { logger } from '@sentry/utils'; import { DEBUG_BUILD } from './utils/debug-build'; import { instrumentServer } from './utils/instrumentServer'; @@ -131,8 +131,6 @@ export function init(options: RemixOptions): void { return; } - GLOBAL_OBJ._sentrySkipLoaderHookWarning = true; - instrumentServer(); nodeInit(options as NodeOptions); diff --git a/packages/utils/src/worldwide.ts b/packages/utils/src/worldwide.ts index 96473ecab474..cc5241f00e0f 100644 --- a/packages/utils/src/worldwide.ts +++ b/packages/utils/src/worldwide.ts @@ -66,7 +66,7 @@ export interface InternalGlobal { * Keys are `error.stack` strings, values are the metadata. */ _sentryModuleMetadata?: Record; - _sentrySkipLoaderHookWarning?: boolean; + _sentryEsmLoaderHookRegistered?: boolean; } /** Get's the global object for the current JavaScript runtime */ diff --git a/yarn.lock b/yarn.lock index 5ee23d0231e0..a96b1b9fe686 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6162,12 +6162,12 @@ dependencies: "@opentelemetry/semantic-conventions" "1.23.0" -"@opentelemetry/core@1.24.0": - version "1.24.0" - resolved "https://registry.yarnpkg.com/@opentelemetry/core/-/core-1.24.0.tgz#5568b6c1328a6b9c94a77f9b2c7f872b852bba40" - integrity sha512-FP2oN7mVPqcdxJDTTnKExj4mi91EH+DNuArKfHTjPuJWe2K1JfMIVXNfahw1h3onJxQnxS8K0stKkogX05s+Aw== +"@opentelemetry/core@1.24.1", "@opentelemetry/core@^1.24.1": + version "1.24.1" + resolved "https://registry.yarnpkg.com/@opentelemetry/core/-/core-1.24.1.tgz#35ab9d2ac9ca938e0ffbdfa40c49c169ac8ba80d" + integrity sha512-wMSGfsdmibI88K9wB498zXY04yThPexo8jvwNNlm542HZB7XrrMRBbAyKJqG8qDRJwIBdBrPMi4V9ZPW/sqrcg== dependencies: - "@opentelemetry/semantic-conventions" "1.24.0" + "@opentelemetry/semantic-conventions" "1.24.1" "@opentelemetry/core@^0.12.0": version "0.12.0" @@ -6178,13 +6178,6 @@ "@opentelemetry/context-base" "^0.12.0" semver "^7.1.3" -"@opentelemetry/core@^1.24.1": - version "1.24.1" - resolved "https://registry.yarnpkg.com/@opentelemetry/core/-/core-1.24.1.tgz#35ab9d2ac9ca938e0ffbdfa40c49c169ac8ba80d" - integrity sha512-wMSGfsdmibI88K9wB498zXY04yThPexo8jvwNNlm542HZB7XrrMRBbAyKJqG8qDRJwIBdBrPMi4V9ZPW/sqrcg== - dependencies: - "@opentelemetry/semantic-conventions" "1.24.1" - "@opentelemetry/instrumentation-aws-lambda@0.40.0": version "0.40.0" resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation-aws-lambda/-/instrumentation-aws-lambda-0.40.0.tgz#5a54025a1eccb4f2f33115a006a6f8a7c6be4ad8" @@ -6250,14 +6243,14 @@ "@opentelemetry/instrumentation" "^0.51.0" "@opentelemetry/semantic-conventions" "^1.0.0" -"@opentelemetry/instrumentation-http@0.51.0": - version "0.51.0" - resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation-http/-/instrumentation-http-0.51.0.tgz#f23fb24e2eed551859a14486893fe68ba6449de2" - integrity sha512-6VsGPBnU6iVKWhVBnuRpwrmiHfxt8EYrqfnH2glfsMpsn4xy+O6U0yGlggPLhoYeOVafV3h70EEk5MU0tpsbiw== +"@opentelemetry/instrumentation-http@0.51.1": + version "0.51.1" + resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation-http/-/instrumentation-http-0.51.1.tgz#c450f01af42e44cfd1302a527dc391f09e8364c0" + integrity sha512-6b3nZnFFEz/3xZ6w8bVxctPUWIPWiXuPQ725530JgxnN1cvYFd8CJ75PrHZNjynmzSSnqBkN3ef4R9N+RpMh8Q== dependencies: - "@opentelemetry/core" "1.24.0" - "@opentelemetry/instrumentation" "0.51.0" - "@opentelemetry/semantic-conventions" "1.24.0" + "@opentelemetry/core" "1.24.1" + "@opentelemetry/instrumentation" "0.51.1" + "@opentelemetry/semantic-conventions" "1.24.1" semver "^7.5.2" "@opentelemetry/instrumentation-ioredis@0.40.0": @@ -6347,14 +6340,14 @@ semver "^7.5.2" shimmer "^1.2.1" -"@opentelemetry/instrumentation@0.51.0", "@opentelemetry/instrumentation@^0.51.0": - version "0.51.0" - resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation/-/instrumentation-0.51.0.tgz#93dbe96c87da539081d0ccd07475cfc0b0c61233" - integrity sha512-Eg/+Od5bEvzpvZQGhvMyKIkrzB9S7jW+6z9LHEI2VXhl/GrqQ3oBqlzJt4tA6pGtxRmqQWKWGM1wAbwDdW/gUA== +"@opentelemetry/instrumentation@0.51.1", "@opentelemetry/instrumentation@^0.51.1": + version "0.51.1" + resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation/-/instrumentation-0.51.1.tgz#46fb2291150ec6923e50b2f094b9407bc726ca9b" + integrity sha512-JIrvhpgqY6437QIqToyozrUG1h5UhwHkaGK/WAX+fkrpyPtc+RO5FkRtUd9BH0MibabHHvqsnBGKfKVijbmp8w== dependencies: - "@opentelemetry/api-logs" "0.51.0" + "@opentelemetry/api-logs" "0.51.1" "@types/shimmer" "^1.0.2" - import-in-the-middle "1.7.1" + import-in-the-middle "1.7.4" require-in-the-middle "^7.1.1" semver "^7.5.2" shimmer "^1.2.1" @@ -6381,14 +6374,14 @@ semver "^7.5.2" shimmer "^1.2.1" -"@opentelemetry/instrumentation@^0.51.1": - version "0.51.1" - resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation/-/instrumentation-0.51.1.tgz#46fb2291150ec6923e50b2f094b9407bc726ca9b" - integrity sha512-JIrvhpgqY6437QIqToyozrUG1h5UhwHkaGK/WAX+fkrpyPtc+RO5FkRtUd9BH0MibabHHvqsnBGKfKVijbmp8w== +"@opentelemetry/instrumentation@^0.51.0": + version "0.51.0" + resolved "https://registry.yarnpkg.com/@opentelemetry/instrumentation/-/instrumentation-0.51.0.tgz#93dbe96c87da539081d0ccd07475cfc0b0c61233" + integrity sha512-Eg/+Od5bEvzpvZQGhvMyKIkrzB9S7jW+6z9LHEI2VXhl/GrqQ3oBqlzJt4tA6pGtxRmqQWKWGM1wAbwDdW/gUA== dependencies: - "@opentelemetry/api-logs" "0.51.1" + "@opentelemetry/api-logs" "0.51.0" "@types/shimmer" "^1.0.2" - import-in-the-middle "1.7.4" + import-in-the-middle "1.7.1" require-in-the-middle "^7.1.1" semver "^7.5.2" shimmer "^1.2.1" @@ -6449,11 +6442,6 @@ resolved "https://registry.yarnpkg.com/@opentelemetry/semantic-conventions/-/semantic-conventions-1.23.0.tgz#627f2721b960fe586b7f72a07912cb7699f06eef" integrity sha512-MiqFvfOzfR31t8cc74CTP1OZfz7MbqpAnLCra8NqQoaHJX6ncIRTdYOQYBDQ2uFISDq0WY8Y9dDTWvsgzzBYRg== -"@opentelemetry/semantic-conventions@1.24.0": - version "1.24.0" - resolved "https://registry.yarnpkg.com/@opentelemetry/semantic-conventions/-/semantic-conventions-1.24.0.tgz#f074db930a7feb4d64103a9a576c5fbad046fcac" - integrity sha512-yL0jI6Ltuz8R+Opj7jClGrul6pOoYrdfVmzQS4SITXRPH7I5IRZbrwe/6/v8v4WYMa6MYZG480S1+uc/IGfqsA== - "@opentelemetry/semantic-conventions@1.24.1": version "1.24.1" resolved "https://registry.yarnpkg.com/@opentelemetry/semantic-conventions/-/semantic-conventions-1.24.1.tgz#d4bcebda1cb5146d47a2a53daaa7922f8e084dfb" @@ -8579,6 +8567,11 @@ resolved "https://registry.yarnpkg.com/@types/node-abi/-/node-abi-3.0.3.tgz#a8334d75fe45ccd4cdb2a6c1ae82540a7a76828c" integrity sha512-5oos6sivyXcDEuVC5oX3+wLwfgrGZu4NIOn826PGAjPCHsqp2zSPTGU7H1Tv+GZBOiDUY3nBXY1MdaofSEt4fw== +"@types/node-cron@^3.0.11": + version "3.0.11" + resolved "https://registry.yarnpkg.com/@types/node-cron/-/node-cron-3.0.11.tgz#70b7131f65038ae63cfe841354c8aba363632344" + integrity sha512-0ikrnug3/IyneSHqCBeslAhlK2aBfYek1fGo4bP4QnZPmiqSGRK+Oy7ZMisLWkesffJvQ1cqAcBnJC+8+nxIAg== + "@types/node-fetch@^2.6.0": version "2.6.2" resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.2.tgz#d1a9c5fd049d9415dce61571557104dec3ec81da" @@ -8594,6 +8587,13 @@ dependencies: "@types/node" "*" +"@types/node-schedule@^2.1.7": + version "2.1.7" + resolved "https://registry.yarnpkg.com/@types/node-schedule/-/node-schedule-2.1.7.tgz#79a1e61adc7bbf8d8eaabcef307e07d76cb40d82" + integrity sha512-G7Z3R9H7r3TowoH6D2pkzUHPhcJrDF4Jz1JOQ80AX0K2DWTHoN9VC94XzFAPNMdbW9TBzMZ3LjpFi7RYdbxtXA== + dependencies: + "@types/node" "*" + "@types/node@*", "@types/node@>=10.0.0", "@types/node@>=12.12.47", "@types/node@>=13.7.0": version "17.0.38" resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.38.tgz#f8bb07c371ccb1903f3752872c89f44006132947" @@ -13361,6 +13361,13 @@ critters@0.0.16: postcss "^8.3.7" pretty-bytes "^5.3.0" +cron-parser@^4.2.0: + version "4.9.0" + resolved "https://registry.yarnpkg.com/cron-parser/-/cron-parser-4.9.0.tgz#0340694af3e46a0894978c6f52a6dbb5c0f11ad5" + integrity sha512-p0SaNjrHOnQeR8/VnfGbmg9te2kfyYSQ7Sc/j/6DtPL3JQvKxmjO9TSjNFpujqV3vEYYBvNNvXSxzyksBWAx1Q== + dependencies: + luxon "^3.2.1" + cron@^3.1.6: version "3.1.6" resolved "https://registry.yarnpkg.com/cron/-/cron-3.1.6.tgz#e7e1798a468e017c8d31459ecd7c2d088f97346c" @@ -21092,6 +21099,11 @@ loglevel@^1.6.8: resolved "https://registry.yarnpkg.com/loglevel/-/loglevel-1.8.0.tgz#e7ec73a57e1e7b419cb6c6ac06bf050b67356114" integrity sha512-G6A/nJLRgWOuuwdNuA6koovfEV1YpqqAG4pRUlFaz3jj2QNZ8M4vBqnVA+HBTmU/AMNUtlOsMmSpF6NyOjztbA== +long-timeout@0.1.1: + version "0.1.1" + resolved "https://registry.yarnpkg.com/long-timeout/-/long-timeout-0.1.1.tgz#9721d788b47e0bcb5a24c2e2bee1a0da55dab514" + integrity sha512-BFRuQUqc7x2NWxfJBCyUrN8iYUYznzL9JROmRz1gZ6KlOIgmoD+njPVbb+VNn2nGMKggMsK79iUNErillsrx7w== + long@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/long/-/long-4.0.0.tgz#9a7b71cfb7d361a194ea555241c92f7468d5bf28" @@ -21194,7 +21206,7 @@ lunr@^2.3.8: resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1" integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow== -luxon@~3.4.0: +luxon@^3.2.1, luxon@~3.4.0: version "3.4.4" resolved "https://registry.yarnpkg.com/luxon/-/luxon-3.4.4.tgz#cf20dc27dc532ba41a169c43fdcc0063601577af" integrity sha512-zobTr7akeGHnv7eBOXcRgMeCP6+uyYsczwmeRCauvpvaAltgNyTbLH/+VaEAPUeWBT+1GuNmz4wC/6jtQzbbVA== @@ -22927,6 +22939,13 @@ node-addon-api@^6.1.0: resolved "https://registry.yarnpkg.com/node-addon-api/-/node-addon-api-6.1.0.tgz#ac8470034e58e67d0c6f1204a18ae6995d9c0d76" integrity sha512-+eawOlIgy680F0kBzPUNFhMZGtJ1YmqM6l4+Crf4IkImjYrO/mqPwRMh352g23uIaQKFItcQ64I7KMaJxHgAVA== +node-cron@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/node-cron/-/node-cron-3.0.3.tgz#c4bc7173dd96d96c50bdb51122c64415458caff2" + integrity sha512-dOal67//nohNgYWb+nWmg5dkFdIwDm8EpeGYMekPMrngV3637lqnX0lbUcCtgibHTz6SEz7DAIjKvKDFYCnO1A== + dependencies: + uuid "8.3.2" + node-fetch@2.6.7, node-fetch@^2.2.0, node-fetch@^2.3.0, node-fetch@^2.6.0, node-fetch@^2.6.1, node-fetch@^2.6.7: version "2.6.7" resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad" @@ -23061,6 +23080,15 @@ node-releases@^2.0.6: resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.6.tgz#8a7088c63a55e493845683ebf3c828d8c51c5503" integrity sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg== +node-schedule@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/node-schedule/-/node-schedule-2.1.1.tgz#6958b2c5af8834954f69bb0a7a97c62b97185de3" + integrity sha512-OXdegQq03OmXEjt2hZP33W2YPs/E5BcFQks46+G2gAxs4gHOIVD1u7EqlYLYSKsaIpyKCK9Gbk0ta1/gjRSMRQ== + dependencies: + cron-parser "^4.2.0" + long-timeout "0.1.1" + sorted-array-functions "^1.3.0" + node-source-walk@^4.0.0, node-source-walk@^4.2.0: version "4.2.0" resolved "https://registry.yarnpkg.com/node-source-walk/-/node-source-walk-4.2.0.tgz#c2efe731ea8ba9c03c562aa0a9d984e54f27bc2c" @@ -27579,6 +27607,11 @@ sort-package-json@^1.57.0: is-plain-obj "2.1.0" sort-object-keys "^1.1.3" +sorted-array-functions@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/sorted-array-functions/-/sorted-array-functions-1.3.0.tgz#8605695563294dffb2c9796d602bd8459f7a0dd5" + integrity sha512-2sqgzeFlid6N4Z2fUQ1cvFmTOLRi/sEDzSQ0OKYchqgoPmQBVyM3959qYx3fpS6Esef80KjmpgPeEr028dP3OA== + source-list-map@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/source-list-map/-/source-list-map-2.0.1.tgz#3993bd873bfc48479cca9ea3a547835c7c154b34" From ae935fb784d14ef44cca6a517b207772fa6192e3 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 10:58:25 +0000 Subject: [PATCH 5/8] Fix tests? --- .../suites/esm/warn-esm/test.ts | 2 +- dev-packages/rollup-utils/npmHelpers.mjs | 5 +++++ dev-packages/rollup-utils/plugins/npmPlugins.mjs | 13 +++++++++++++ packages/node/src/sdk/init.ts | 12 +++++++++--- 4 files changed, 28 insertions(+), 4 deletions(-) diff --git a/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts b/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts index fa369a12db28..6c5acba75067 100644 --- a/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts +++ b/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts @@ -5,7 +5,7 @@ afterAll(() => { }); const esmWarning = - '[Sentry] You are using the Sentry SDK with an ESM build. This version of the SDK is not compatible with ESM. Please either build your application with CommonJS, or use v7 of the SDK.'; + '[Sentry] You are using Node.js in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or use version 7.x of the Sentry Node.js SDK.'; test('warns if using ESM', async () => { const runner = createRunner(__dirname, 'server.mjs').ignore('session', 'sessions', 'event').start(); diff --git a/dev-packages/rollup-utils/npmHelpers.mjs b/dev-packages/rollup-utils/npmHelpers.mjs index f984cbf518b9..0347c1d9e12b 100644 --- a/dev-packages/rollup-utils/npmHelpers.mjs +++ b/dev-packages/rollup-utils/npmHelpers.mjs @@ -1,3 +1,5 @@ +// @ts-check + /** * Rollup config docs: https://rollupjs.org/guide/en/#big-list-of-options */ @@ -14,6 +16,7 @@ import { makeCleanupPlugin, makeDebugBuildStatementReplacePlugin, makeExtractPolyfillsPlugin, + makeImportMetaUrlReplacePlugin, makeNodeResolvePlugin, makeRrwebBuildPlugin, makeSetSDKSourcePlugin, @@ -39,6 +42,7 @@ export function makeBaseNPMConfig(options = {}) { const nodeResolvePlugin = makeNodeResolvePlugin(); const sucrasePlugin = makeSucrasePlugin({ disableESTransforms: !addPolyfills, ...sucrase }); const debugBuildStatementReplacePlugin = makeDebugBuildStatementReplacePlugin(); + const importMetaUrlReplacePlugin = makeImportMetaUrlReplacePlugin(); const cleanupPlugin = makeCleanupPlugin(); const extractPolyfillsPlugin = makeExtractPolyfillsPlugin(); const setSdkSourcePlugin = makeSetSDKSourcePlugin('npm'); @@ -105,6 +109,7 @@ export function makeBaseNPMConfig(options = {}) { setSdkSourcePlugin, sucrasePlugin, debugBuildStatementReplacePlugin, + importMetaUrlReplacePlugin, rrwebBuildPlugin, cleanupPlugin, ], diff --git a/dev-packages/rollup-utils/plugins/npmPlugins.mjs b/dev-packages/rollup-utils/plugins/npmPlugins.mjs index 1c6f929c751c..89a0cfda7bb9 100644 --- a/dev-packages/rollup-utils/plugins/npmPlugins.mjs +++ b/dev-packages/rollup-utils/plugins/npmPlugins.mjs @@ -117,6 +117,19 @@ export function makeDebugBuildStatementReplacePlugin() { }); } +/** + * Because jest doesn't like `import.meta` statements but we still need it in the code base we instead use a magic + * string that we replace with import.meta.url in the build. + */ +export function makeImportMetaUrlReplacePlugin() { + return replace({ + preventAssignment: false, + values: { + __IMPORT_META_URL_REPLACEMENT__: 'import.meta.url', + }, + }); +} + /** * Creates a plugin to replace build flags of rrweb with either a constant (if passed true/false) or with a safe statement that: * a) evaluates to `true` diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts index e2b34a6c261e..3ddfd97b11ed 100644 --- a/packages/node/src/sdk/init.ts +++ b/packages/node/src/sdk/init.ts @@ -73,6 +73,8 @@ export function getDefaultIntegrations(options: Options): Integration[] { ]; } +declare const __IMPORT_META_URL_REPLACEMENT__: string; + /** * Initialize Sentry for Node. */ @@ -96,9 +98,13 @@ export function init(options: NodeOptions | undefined = {}): void { // Register hook was added in v20.6.0 and v18.19.0 if (nodeMajor > 22 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) { - if (!GLOBAL_OBJ._sentryEsmLoaderHookRegistered) { - // @ts-expect-error register is available in these versions & import.meta is allowed - moduleModule.register('@opentelemetry/instrumentation/hook.mjs', import.meta.url); + // We need to work around using import.meta.url directly because jest complains about it. + const importMetaUrl = + typeof __IMPORT_META_URL_REPLACEMENT__ !== 'undefined' ? __IMPORT_META_URL_REPLACEMENT__ : undefined; + + if (!GLOBAL_OBJ._sentryEsmLoaderHookRegistered && importMetaUrl) { + // @ts-expect-error register is available in these versions + moduleModule.register('@opentelemetry/instrumentation/hook.mjs', importMetaUrl); GLOBAL_OBJ._sentryEsmLoaderHookRegistered = true; } } else { From 1617fe81617c6b67a4c822711dc0c0d155592fe0 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 11:20:57 +0000 Subject: [PATCH 6/8] fix size-limit --- .size-limit.js | 1 + 1 file changed, 1 insertion(+) diff --git a/.size-limit.js b/.size-limit.js index 9ead34df50f0..2e8e07f15971 100644 --- a/.size-limit.js +++ b/.size-limit.js @@ -206,6 +206,7 @@ module.exports = [ 'zlib', 'net', 'tls', + 'module', ], gzip: true, limit: '180 KB', From 8a6c30ebed92d952b0e0596481488d63bdc523b3 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 12:25:44 +0000 Subject: [PATCH 7/8] fix tests --- .../suites/esm/warn-esm/test.ts | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts b/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts index 6c5acba75067..e52f8b915f86 100644 --- a/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts +++ b/dev-packages/node-integration-tests/suites/esm/warn-esm/test.ts @@ -7,7 +7,12 @@ afterAll(() => { const esmWarning = '[Sentry] You are using Node.js in ESM mode ("import syntax"). The Sentry Node.js SDK is not compatible with ESM in Node.js versions before 18.19.0 or before 20.6.0. Please either build your application with CommonJS ("require() syntax"), or use version 7.x of the Sentry Node.js SDK.'; -test('warns if using ESM', async () => { +test("warns if using ESM on Node.js versions that don't support `register()`", async () => { + const nodeMajorVersion = Number(process.versions.node.split('.')[0]); + if (nodeMajorVersion >= 18) { + return; + } + const runner = createRunner(__dirname, 'server.mjs').ignore('session', 'sessions', 'event').start(); await runner.makeRequest('get', '/test/success'); @@ -15,6 +20,19 @@ test('warns if using ESM', async () => { expect(runner.getLogs()).toContain(esmWarning); }); +test('does not warn if using ESM on Node.js versions that support `register()`', async () => { + const nodeMajorVersion = Number(process.versions.node.split('.')[0]); + if (nodeMajorVersion < 18) { + return; + } + + const runner = createRunner(__dirname, 'server.mjs').ignore('session', 'sessions', 'event').start(); + + await runner.makeRequest('get', '/test/success'); + + expect(runner.getLogs()).not.toContain(esmWarning); +}); + test('does not warn if using CJS', async () => { const runner = createRunner(__dirname, 'server.js').ignore('session', 'sessions', 'event').start(); From ce6f1b3be0834a8647dfcb74a213adcf858d4c53 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Wed, 8 May 2024 12:42:49 +0000 Subject: [PATCH 8/8] fix condition --- packages/node/src/sdk/init.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/node/src/sdk/init.ts b/packages/node/src/sdk/init.ts index 3ddfd97b11ed..7ce2616b8206 100644 --- a/packages/node/src/sdk/init.ts +++ b/packages/node/src/sdk/init.ts @@ -97,7 +97,7 @@ export function init(options: NodeOptions | undefined = {}): void { const [nodeMajor, nodeMinor] = process.versions.node.split('.').map(Number); // Register hook was added in v20.6.0 and v18.19.0 - if (nodeMajor > 22 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) { + if (nodeMajor >= 22 || (nodeMajor === 20 && nodeMinor >= 6) || (nodeMajor === 18 && nodeMinor >= 19)) { // We need to work around using import.meta.url directly because jest complains about it. const importMetaUrl = typeof __IMPORT_META_URL_REPLACEMENT__ !== 'undefined' ? __IMPORT_META_URL_REPLACEMENT__ : undefined;