Skip to content

ref(tracing): Rework tracestate internals to allow for third-party data #3266

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

Merged
merged 9 commits into from
Feb 17, 2021
Merged

ref(tracing): Rework tracestate internals to allow for third-party data #3266

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d955dba
add TransactionMetadata type to @sentry/types
lobsterkatie Feb 17, 2021
f70e334
move method for getting new header from Transaction class to Span class
lobsterkatie Feb 17, 2021
b4e8b8a
store sentry tracestate value in metadata object rather than as top-l…
lobsterkatie Feb 17, 2021
628d33a
let orphan spans get tracestate headers also
lobsterkatie Feb 17, 2021
2124f20
fix envelope headers
lobsterkatie Feb 17, 2021
1df7bfb
clean up tracestate computation function
lobsterkatie Feb 17, 2021
1ee03f3
fix linting issues
lobsterkatie Feb 17, 2021
29a8e02
fix test
lobsterkatie Feb 17, 2021
dd45062
clarify that tracestate.sentry should exist
lobsterkatie Feb 17, 2021
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
Prev Previous commit
clarify that tracestate.sentry should exist
  • Loading branch information
@lobsterkatie
lobsterkatie committed Feb 17, 2021
commit dd450628aa24fa2f8096aab3e6fd5593cb57d735
6 changes: 5 additions & 1 deletion packages/core/src/request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,11 @@ export function transactionToSentryRequest(event: Event, api: API): SentryReques
// so we have to decode and reinflate it
let reinflatedTracestate;
try {
const encodedSentryValue = (tracestate?.sentry as string).replace('sentry=', '');
// Because transaction metadata passes through a number of locations (transactionContext, transaction, event during
// processing, event as sent), each with different requirements, all of the parts are typed as optional. That said,
// if we get to this point and either `tracestate` or `tracestate.sentry` are undefined, something's gone very wrong.
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const encodedSentryValue = tracestate!.sentry!.replace('sentry=', '');
reinflatedTracestate = JSON.parse(base64ToUnicode(encodedSentryValue));
} catch (err) {
logger.warn(err);
Copy link
Contributor

@kamilogorek kamilogorek Feb 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would log Cannot read property 'replace' of undefined for situations when there's simply no tracestate.sentry which might be confusing to the user.

Copy link
Member Author

@lobsterkatie lobsterkatie Feb 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. Originally I had it as const encodedSentryValue = tracestate!.sentry!.replace('sentry=', '');, since if we get to that point and there's no tracestate.sentry, things have gone real wrong, but then it was yelling at me about the !. But I think maybe I should change it back, to better communicate to the reader that it's not optional.

Or maybe I can write my types in a smarter way... In any case, will fix it one way or another.

UPDATE: Okay, tried with the types, but there are too many stages at which this or that property may (legitimately) not be defined, so I'm going with the !.

Expand Down