disable for sveltekit component tracking

[JonathonRP]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/sveltekit

SDK Version

latest

Framework Version

svelte 5, sveltekit 2

Link to Sentry event

No response

SDK Setup

No response

Steps to Reproduce

follow install guide using svelte 5 and sveltekit 2,
follow guide to config component tracking for svelte
run dev

Expected Result

can run dev vite server without error
proper import and use should be documented, as can not find in docs or anywhere that does not result in error.

Actual Result

get error about not function if using @sentry/sveltekit,
get error about cjs if using @sentry/svelte,
all attempts to import results in error.

[AbhiPrasad]

Hi @JonathonRP - could you share your SDK setup (what you configured to add Sentry), and copy paste the error logs for us to look at? Otherwise this is hard for us to start investigating.

[JonathonRP]

@AbhiPrasad
error logs -

Error [ERR_REQUIRE_ESM]: require() of ES Module /workspaces/Finanzen/node_modules/.pnpm/svelte@5.0.0-next.36/node_modules/svelte/src/main/main-server.js from /workspaces/Finanzen/node_modules/.pnpm/@sentry+svelte@7.94.1_svelte@5.0.0-next.36/node_modules/@sentry/svelte/cjs/performance.js not supported.
Instead change the require of main-server.js in /workspaces/Finanzen/node_modules/.pnpm/@sentry+svelte@7.94.1_svelte@5.0.0-next.36/node_modules/@sentry/svelte/cjs/performance.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/workspaces/Finanzen/node_modules/.pnpm/@sentry+svelte@7.94.1_svelte@5.0.0-next.36/node_modules/@sentry/svelte/cjs/performance.js:4:16)
    at Object.<anonymous> (/workspaces/Finanzen/node_modules/.pnpm/@sentry+svelte@7.94.1_svelte@5.0.0-next.36/node_modules/@sentry/svelte/cjs/index.js:6:21)

TypeError: withSentryConfig is not a function
    at file:///workspaces/Finanzen/svelte.config.js?ts=1705683833309:35:16

error when starting dev server:
file:///workspaces/Finanzen/svelte.config.js?ts=1705683711184:3
import { withSentryConfig } from '@sentry/sveltekit';
         ^^^^^^^^^^^^^^^^
SyntaxError: Named export 'withSentryConfig' not found. The requested module '@sentry/sveltekit' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from '@sentry/sveltekit';
const { withSentryConfig } = pkg;

    at ModuleJob._instantiate (node:internal/modules/esm/module_job:124:21)
    at async ModuleJob.run (node:internal/modules/esm/module_job:190:5)

// hooks.client.ts
Sentry.init({
    dsn: "",
    tracesSampleRate: 1,
    replaysSessionSampleRate: 0.1,
    replaysOnErrorSampleRate: 1,
    integrations: [new Sentry.Replay(), new Sentry.BrowserTracing(), new Sentry.BrowserProfilingIntegration()]
})
// hooks.server.ts
Sentry.init({
    dsn: "",
    tracesSampleRate: 1.0,
	spotlight: dev
})
// config
sentrySvelteKit({
  sourceMapsUploadOptions: {
	  org: 'self-qw6',
	  project: 'finanzen',
  }
})

[Lms24]

Hi @JonathonRP thanks for writing in and apologies, this issue slipped through my radar.

So to confirm, the errors you're getting only appear when you add the withSentryConfig function to your svelte config? Otherwise, using the SDK works for you?

I must admit, we kinda neglected this feature in combination with SvelteKit (we added it to our browser-only Svelte SDK). So chances are high this doesn't work correctly. Ideally, we rid of the withSentryConfig wrapper because it's not really a pattern I like using anymore in our Svelte SDKs. Furthermore, Svelte 4 contains some changes to preprocessor logic and I'm not yet sure how Svelte 5 is going to work with component tracking at all. I suspect it should work but didn't try it yet.

So I think we should revisit this in our major version and see if we can make this feature work in a better way. Can't promise you an ETA but we'll look into it.