Skip to content

fix: externalize @opentelemetry/api to prevent chunk colocation #16302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
elliott-with-the-longest-name-on-github wants to merge 1 commit into from
+24 −2
Draft

fix: externalize @opentelemetry/api to prevent chunk colocation #16302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/externalize-opentelemetry-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@sveltejs/kit': patch
'@sveltejs/adapter-node': patch
---

fix: externalize `@opentelemetry/api` to prevent bundler chunk colocation between `instrumentation.server.js` and application code
7 changes: 6 additions & 1 deletion packages/adapter-node/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,12 @@ export default function (opts = {}) {
input,
external: [
// dependencies could have deep exports, so we need a regex
...Object.keys(pkg.dependencies || {}).map((d) => new RegExp(`^${d}(\\/.*)?$`))
...Object.keys(pkg.dependencies || {}).map((d) => new RegExp(`^${d}(\\/.*)?$`)),
// `@opentelemetry/api` is an optional peer dependency of `@sveltejs/kit`,
// so it's not in `pkg.dependencies` and wouldn't be matched by the regex above.
// It must stay external so that `instrumentation.server.js` and the SvelteKit
// runtime share a single instance — see https://github.com/sveltejs/kit/issues/16288
/^@opentelemetry\/api(\/.*)?$/
],
platform: 'node',
resolve: {
Expand Down
13 changes: 12 additions & 1 deletion packages/kit/src/exports/vite/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,18 @@ function kit({ svelte_config }) {

// These Kit dependencies are packaged as CommonJS, which means they must always be externalized.
// Without this, the tests will still pass but `pnpm dev` will fail in projects that link `@sveltejs/kit`.
/** @type {NonNullable<UserConfig['ssr']>} */ (new_config.ssr).external = ['cookie'];
//
// `@opentelemetry/api` must be externalized so that `instrumentation.server.js` and the
// SvelteKit runtime share a single instance of the module (the global tracer/propagation
// is set on that instance — two bundled copies would mean instrumentation hooks are
// invisible to the runtime). Externalizing also prevents the bundler from colocating
// `@opentelemetry/api` into a shared chunk that also contains application modules, which
// would cause those modules to be evaluated before `Server.init()` sets env vars — see
// https://github.com/sveltejs/kit/issues/16288
/** @type {NonNullable<UserConfig['ssr']>} */ (new_config.ssr).external = [
'cookie',
'@opentelemetry/api'
];
}

// Vite's `define` is a compile-time text replacement, but Vitest strips
Expand Down
Loading