@sentry/cloudflare/vite: Auto-instrumentation skips the Worker when wrangler `main` is a package specifier
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 58/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript, vite
- Domain
- backend, build-system
Research direction
Start with packages/cloudflare/src/vite/wranglerConfig.ts, autoInstrument.ts, and instrumentFile.ts, then inspect the existing Cloudflare Vite test fixtures. Trace how Wrangler's main value is resolved and compared with transformed module IDs. Done means package-specifier entries are instrumented, node_modules entries find the project instrument file, unmatched entries produce a warning, and a package-specifier fixture passes.
Written by the indexing model from the issue text.
Description
Description
sentryCloudflareVitePlugin() does not wrap the Worker when main in the Wrangler config is a package specifier and not a file path. The build succeeds, but the bundle contains no Sentry code, and the plugin logs no warning.
@cloudflare/vite-plugin supports this config, and vinext generates it by default with vinext init --platform=cloudflare:
// wrangler.jsonc
{
"main": "vinext/server/fetch-handler",
// ...
}
// vite.config.ts
export default defineConfig({
plugins: [
vinext(),
cloudflare({ viteEnvironment: { name: "rsc", childEnvironments: ["ssr"] } }),
sentryCloudflareVitePlugin(),
],
});
Tested with @sentry/cloudflare@11.0.0-rc.0, @cloudflare/vite-plugin@1.56.0, wrangler@4.135.0, vinext@1.0.0-beta.10 and Vite 8.3.
Cause
resolveWranglerConfig() calls unstable_readConfig() without preserveOriginalMain (wranglerConfig.ts#L70). Wrangler then resolves every main as a path relative to the config file:
main: "vinext/server/fetch-handler"
-> <project>/vinext/server/fetch-handler (file does not exist)
autoInstrument.ts compares this path with the module IDs in transform (L75), so no module matches. resolveInstrumentFile() also looks for instrument.server.* in the directory of this path (instrumentFile.ts#L23), and a package entry has no such file.
@cloudflare/vite-plugin handles the same value differently:
- It reads the config with
unstable_readConfig(..., { preserveOriginalMain: true }). maybeResolveMain()makesmainabsolute only when it ends with a JS or TS extension.- It resolves the entry with Vite:
await this.resolve(workerConfig.main).
Workaround
Add a local entry that re-exports the package entry, and set main to it. Put instrument.server.ts in the same directory:
// worker/index.ts
import handler from "vinext/server/fetch-handler";
export default handler;
{ "main": "./worker/index.ts" }
Proposed fix
- Read the config with
preserveOriginalMain: true, and keep a package specifier unchanged. - Resolve
mainwiththis.resolve()(for example inbuildStart, or lazily intransform), and compare the resolved module ID. - When the resolved entry is in
node_modules, look forinstrument.server.*in the Wrangler config directory (the Vite root) and not next to the entry. - Log a warning when
maindoes not resolve to a module that the plugin transforms, so the failure is not silent. - Add a test fixture where
mainis a package specifier.
- Dominant language
- TypeScript
- Stars
- 8.7k
- Forks
- 1.9k
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 543
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-javascript
-
Browser Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24577 · 1 comment ·
-
Task
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-javascript#24558 · 1 comment ·
-
Task
Difficulty 1/5 Under an hour Newbie friendliness 90/100
getsentry/sentry-javascript#24557 · 1 comment ·
-
Task
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
getsentry/sentry-javascript#24556 · 1 comment ·
-
Task
Difficulty 1/5 1-3 hours Newbie friendliness 90/100
getsentry/sentry-javascript#24555 · 1 comment ·
All issues in getsentry/sentry-javascript
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
ontola/atomic-server#1625 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
melgarafael/DeskcommCRM#1451 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bot:ai-assisted component:compact-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
midnightntwrk/midnight-sdk#403 ·