fix(svelte): Make component tracking compatible with Svelte 5 #10312
Conversation
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
This was referenced Jan 24, 2024
|
in addition blocked on jest (#10318) - moving to draft |
AbhiPrasad
reviewed
Jan 24, 2024
| @@ -1,7 +1,6 @@ | |||
| import { getCurrentScope } from '@sentry/browser'; | |||
| import type { Span, Transaction } from '@sentry/types'; | |||
| import { afterUpdate, beforeUpdate, onMount } from 'svelte'; | |||
| import { current_component } from 'svelte/internal'; | |||
There was a problem hiding this comment.
Can we not conditionally access this via a version check?
In SvelteKit we can inject stuff via vite plugin so we can inject a version into the bundle in if Svelte themselves does not expose it. Or is that problematic for other reasons?
2 tasks
|
@Lms24 anymore progress on this? |
Lms24
force-pushed
the
lms/ref-svelte-component-tracking-svelte-5
branch
from
e3bf653 to
b6f7fa8
Compare
Bundle ReportChanges will decrease total bundle size by 3.37MB ⬇️
|
size-limit report 📦
|
|
Superseded by #11807 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
depends on #10311
This PR adds compatibility for Svelte 5 by adjusting our component tracking functionality to work with Svelte 5.
TLDR: This change entails a minor behaviour "breaking" change for a subset of Svelte component tracking users.
Our previous implementation relied on an exported internal API (
current_component) to automatically detect the name of the component name for the respective spans. This API was removed in Svelte 5, so we can no longer use it. Importing it causes a build error. This means that going forward, calls totrackComponentneed to set thecomponentNameoption or the span will get the fallback<Svelte Component>name. However, this only applies if the function is called manually.In case users use our
withSentryConfigwrapper in theirsvelte.config.js, we inject a preprocessor that already creates passes the component name from the component file name to the injectedtrackComponentcall. So nothing changes in this use case - component spans will still automatically get the correct name. We recommend this approach in our docs.ref #10275