-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
ref(core): Export browser-specific span start APIs #23361
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.
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
Open
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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 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 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 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 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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,10 @@ | ||
| export * from './shared-exports'; | ||
| export * from './server-exports'; | ||
| export * from './browser-exports'; | ||
|
|
||
| // `server-exports` and `browser-exports` both export these APIs. | ||
| // We need to re-export them here to disambiguate the exports for anyone importing | ||
| // from `@sentry/core`. Server exports win over browser exports. | ||
| export { startSpan, startInactiveSpan, startSpanManual } from './tracing/trace'; | ||
| export { startIdleSpan } from './tracing/idleSpan'; | ||
| export { spanStreamingIntegration } from './integrations/spanStreaming'; |
16 changes: 7 additions & 9 deletions
16
...browser/src/integrations/spanstreaming.ts → .../src/integrations/browserSpanStreaming.ts
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 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 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 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 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 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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import type { Client } from '../client'; | ||
| import { getClient } from '../currentScopes'; | ||
| import { spanStreamingIntegration } from '../integrations/browserSpanStreaming'; | ||
| import type { Span } from '../types/span'; | ||
| import type { StartSpanOptions } from '../types/startSpanOptions'; | ||
| import { startIdleSpan as coreStartIdleSpan } from './idleSpan'; | ||
| import { hasSpanStreamingEnabled } from './spans/hasSpanStreamingEnabled'; | ||
| import { | ||
| startInactiveSpan as coreStartInactiveSpan, | ||
| startSpan as coreStartSpan, | ||
| startSpanManual as coreStartSpanManual, | ||
| } from './trace'; | ||
|
|
||
| /** | ||
| * Browser variants of the span-start APIs. | ||
| * | ||
| * These exist purely so that the span streaming integration is only reachable from code that can | ||
| * actually start a span. `@sentry/browser`'s `init()` deliberately doesn't reference spanStreamingIntegration, | ||
| * so error-only apps tree-shake the entire span streaming graph away without needing | ||
| * the `__SENTRY_TRACING__` flag. | ||
| */ | ||
|
|
||
| const clientsWithIntegration = new WeakSet<Client>(); | ||
|
|
||
| /** | ||
| * Lazily install the browser span streaming integration. | ||
| * | ||
| * Defaults to the current client; pass one explicitly from integration hooks, where the client being | ||
| * set up isn't necessarily the current one. | ||
| * | ||
| * @internal | ||
| */ | ||
| export function _INTERNAL_ensureBrowserSpanStreaming(client: Client | undefined = getClient()): void { | ||
| // The `WeakSet` is an allocation optimization, not a semantic gate — `addIntegration()` is already | ||
| // idempotent by integration name, including against a user-supplied instance. | ||
| if (!client || clientsWithIntegration.has(client) || !hasSpanStreamingEnabled(client)) { | ||
| return; | ||
| } | ||
|
|
||
| clientsWithIntegration.add(client); | ||
| client.addIntegration(spanStreamingIntegration()); | ||
| } | ||
|
|
||
| /** | ||
| * Wraps a function with a span and finishes the span after the function is done. | ||
| * | ||
| * See {@link startSpan} in `@sentry/core` for details. | ||
| */ | ||
| export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T { | ||
| _INTERNAL_ensureBrowserSpanStreaming(); | ||
| return coreStartSpan(options, callback); | ||
| } | ||
|
|
||
| /** | ||
| * Similar to `startSpan`, but forces the span to be ended manually. | ||
| * | ||
| * See {@link startSpanManual} in `@sentry/core` for details. | ||
| */ | ||
| export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T { | ||
| _INTERNAL_ensureBrowserSpanStreaming(); | ||
| return coreStartSpanManual(options, callback); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a span that is not set as active. | ||
| * | ||
| * See {@link startInactiveSpan} in `@sentry/core` for details. | ||
| */ | ||
| export function startInactiveSpan(options: StartSpanOptions): Span { | ||
| _INTERNAL_ensureBrowserSpanStreaming(); | ||
| return coreStartInactiveSpan(options); | ||
| } | ||
|
|
||
| /** | ||
| * Starts an idle span that automatically ends once no activity happens for a while. | ||
| * | ||
| * See {@link startIdleSpan} in `@sentry/core` for details. | ||
| * | ||
| * Typed via `typeof` because `IdleSpanOptions` is intentionally not part of the public type surface, | ||
| * and re-declaring the signature here would have to widen it. | ||
| */ | ||
| export const startIdleSpan: typeof coreStartIdleSpan = (startSpanOptions, options) => { | ||
| _INTERNAL_ensureBrowserSpanStreaming(); | ||
| return coreStartIdleSpan(startSpanOptions, options); | ||
| }; | ||
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 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
q: Did you check that our browser SDKs all use this method and not import from core directly? e.g. svelte still does
import { debug, startInactiveSpan } from '@sentry/core';