-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): Extract scope application to util (#9804)
This is a try to move the application of scope data to events out of the scope class into a util function. This changes the flow to be: 1. The scope has a `getScopeData()` method that returns data that should be applied to events. 2. The `prepareEvent` method uses that to actually apply scope data to the event etc. 3. This also makes it much easier to do the experimentation in node-experimental (#9799) because we only need to overwrite this, and can leave the rest of the event processing the same. I _think_ this makes sense but would appreciate some more eyes on this as well. For me the separation makes also more sense, as e.g. the application of event processors etc. should not really be tied to the scope at all. This is also is a first step to then allow us to add global scopes more easily. --------- Co-authored-by: Lukas Stracke <[email protected]>
- Loading branch information
Showing
13 changed files
with
220 additions
and
197 deletions.
There are no files selected for viewing
This file contains 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 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 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,97 @@ | ||
| import type { Breadcrumb, Event, PropagationContext, ScopeData, Span } from '@sentry/types'; | ||
| import { arrayify } from '@sentry/utils'; | ||
|
|
||
| /** | ||
| * Applies data from the scope to the event and runs all event processors on it. | ||
| */ | ||
| export function applyScopeDataToEvent(event: Event, data: ScopeData): void { | ||
| const { fingerprint, span, breadcrumbs, sdkProcessingMetadata, propagationContext } = data; | ||
|
|
||
| // Apply general data | ||
| applyDataToEvent(event, data); | ||
|
|
||
| // We want to set the trace context for normal events only if there isn't already | ||
| // a trace context on the event. There is a product feature in place where we link | ||
| // errors with transaction and it relies on that. | ||
| if (span) { | ||
| applySpanToEvent(event, span); | ||
| } | ||
|
|
||
| applyFingerprintToEvent(event, fingerprint); | ||
| applyBreadcrumbsToEvent(event, breadcrumbs); | ||
| applySdkMetadataToEvent(event, sdkProcessingMetadata, propagationContext); | ||
| } | ||
|
|
||
| function applyDataToEvent(event: Event, data: ScopeData): void { | ||
| const { extra, tags, user, contexts, level, transactionName } = data; | ||
|
|
||
| if (extra && Object.keys(extra).length) { | ||
| event.extra = { ...extra, ...event.extra }; | ||
| } | ||
| if (tags && Object.keys(tags).length) { | ||
| event.tags = { ...tags, ...event.tags }; | ||
| } | ||
| if (user && Object.keys(user).length) { | ||
| event.user = { ...user, ...event.user }; | ||
| } | ||
| if (contexts && Object.keys(contexts).length) { | ||
| event.contexts = { ...contexts, ...event.contexts }; | ||
| } | ||
| if (level) { | ||
| event.level = level; | ||
| } | ||
| if (transactionName) { | ||
| event.transaction = transactionName; | ||
| } | ||
| } | ||
|
|
||
| function applyBreadcrumbsToEvent(event: Event, breadcrumbs: Breadcrumb[]): void { | ||
| const mergedBreadcrumbs = [...(event.breadcrumbs || []), ...breadcrumbs]; | ||
| event.breadcrumbs = mergedBreadcrumbs.length ? mergedBreadcrumbs : undefined; | ||
| } | ||
|
|
||
| function applySdkMetadataToEvent( | ||
| event: Event, | ||
| sdkProcessingMetadata: ScopeData['sdkProcessingMetadata'], | ||
| propagationContext: PropagationContext, | ||
| ): void { | ||
| event.sdkProcessingMetadata = { | ||
| ...event.sdkProcessingMetadata, | ||
| ...sdkProcessingMetadata, | ||
| propagationContext: propagationContext, | ||
| }; | ||
| } | ||
|
|
||
| function applySpanToEvent(event: Event, span: Span): void { | ||
| event.contexts = { trace: span.getTraceContext(), ...event.contexts }; | ||
| const transaction = span.transaction; | ||
| if (transaction) { | ||
| event.sdkProcessingMetadata = { | ||
| dynamicSamplingContext: transaction.getDynamicSamplingContext(), | ||
| ...event.sdkProcessingMetadata, | ||
| }; | ||
| const transactionName = transaction.name; | ||
| if (transactionName) { | ||
| event.tags = { transaction: transactionName, ...event.tags }; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Applies fingerprint from the scope to the event if there's one, | ||
| * uses message if there's one instead or get rid of empty fingerprint | ||
| */ | ||
| function applyFingerprintToEvent(event: Event, fingerprint: ScopeData['fingerprint'] | undefined): void { | ||
| // Make sure it's an array first and we actually have something in place | ||
| event.fingerprint = event.fingerprint ? arrayify(event.fingerprint) : []; | ||
|
|
||
| // If we have something on the scope, then merge it with event | ||
| if (fingerprint) { | ||
| event.fingerprint = event.fingerprint.concat(fingerprint); | ||
| } | ||
|
|
||
| // If we have no data at all, remove empty array default | ||
| if (event.fingerprint && !event.fingerprint.length) { | ||
| delete event.fingerprint; | ||
| } | ||
| } |
This file contains 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 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.