docs(js): Restructure the Node install methods for v11 - #19368
Draft
JPeer264 wants to merge 1 commit into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
github-actions
Bot
added
the
Priority: Needs Triage
Bring the Node install pages in line with the v11 install methods, and fix the snippets that stop the app from starting. - Fix the extensionless `import "./instrument"` in the Express, Fastify, Hapi and Connect ESM tabs, in `install/esm-without-import.mdx` and in the NestJS ESM page. The config step creates `instrument.mjs`, and Node ESM does not probe extensions, so the app stopped with `ERR_MODULE_NOT_FOUND`. - Start the Koa ESM tab with `--import` instead. With the extension fixed the app starts, but `koa` is already loaded when `Sentry.init` runs, so every router and middleware span and every route name is lost. - Rewrite `install/late-initialization.mdx` around `node --import @sentry/node/import`. The page told readers to use `@sentry/node/preload`, which is no longer exported and fails with `ERR_PACKAGE_PATH_NOT_EXPORTED`. Drop `SENTRY_PRELOAD_INTEGRATIONS` with it, and show a CommonJS entry point next to the ESM one, since `--import` covers both. - Rework `install/index.mdx` around the three v11 methods: `--import` your instrument file, a bundler plugin with a top-level import, and `--import` the SDK with a later `Sentry.init()`. Say that `--import` covers CommonJS as well, and that `--require` is gone. - Rewrite `install/esm-without-import.mdx` around the bundler plugin and the deferred entry point, and say why a top-level import alone is not equivalent to `--import`. - Remove the `registerEsmLoaderHooks` troubleshooting from `install/esm.mdx`. The option was removed and the SDK no longer depends on `import-in-the-middle`. - Drop the `@sentry/node-core` lightweight mode entry. The package was merged back into `@sentry/node`. - Run the CommonJS example with `--import` in `getting-started-run`. `--require` is no longer supported for initialization. Refs SDK-1494 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
JPeer264
force-pushed
the
janpeer/sdk-1494-node-getting-started-manual-setup
branch
from
September 11, 2026 14:41
9552415 to
aa05a3d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
closes SDK-1494
(kept the version v18 ranges as they ill be removed here: #19317)
Bring the Node install pages in line with the v11 install methods, and fix the ESM snippets that stop the app from starting.
import "./instrument"in the Express, Fastify, Hapi and Connect ESM tabs, ininstall/esm-without-import.mdxand in the NestJS ESM page. The config step createsinstrument.mjs, and Node ESM does not probe extensions, so the app stopped withERR_MODULE_NOT_FOUND.--importinstead. With the extension fixed the app starts, butkoais already loaded whenSentry.initruns, so every router and middleware span and every route name is lost.install/late-initialization.mdxaroundnode --import @sentry/node/import. The page told readers to use@sentry/node/preload, which is no longer exported and fails withERR_PACKAGE_PATH_NOT_EXPORTED. DropSENTRY_PRELOAD_INTEGRATIONSwith it, and show a CommonJS entry point next to the ESM one, since--importcovers both.install/index.mdxaround the three v11 methods:--importyour instrument file, a bundler plugin with a top-level import, and--importthe SDK with a laterSentry.init(). Say that--importcovers CommonJS as well, and that--requireis gone.install/esm-without-import.mdxaround the bundler plugin and the deferred entry point, and say why a top-level import alone is not equivalent to--import.registerEsmLoaderHookstroubleshooting frominstall/esm.mdx. The option was removed and the SDK no longer depends onimport-in-the-middle.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES