feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831

Merged
chargome merged 13 commits into
developfrom
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged

feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom
cg/disallow-dropping-in-beforesendspan

Conversation

@chargome

@chargomechargome commented Dec 23, 2024•
edited
Loading

Copy link
Copy Markdown
Member
  • Disallows returning null from beforeSendSpan
  • Passes root spans to beforeSendSpan
  • Adds entry to migration guide and changelog

Looked at two options for passing the root span:

  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.

Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.

closes#14336

@chargomechargome self-assigned this Dec 23, 2024
@github-actions

github-actionsBot commented Dec 23, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺

View base workflow run

@chargome
chargome marked this pull request as ready for review December 31, 2024 11:55
@chargome
chargome requested review from Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24 reviewed Jan 2, 2025
View reviewed changes

@Lms24Lms24 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.

Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts Outdated
Comment threadpackages/core/src/baseclient.ts Outdated
@chargomechargome mentioned this pull request Jan 2, 2025
Merged
@chargome
chargome requested a review from Lms24January 3, 2025 13:23
Lms24
Lms24 approved these changes Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
};
}
return beforeSendTransaction(event, hint);
return beforeSendTransaction(processedEvent as TransactionEvent, hint);

@Lms24Lms24Jan 7, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔

@chargomechargomeJan 8, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do

processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);

@chargome
chargome merged commit d4e94fe into developJan 8, 2025
@chargome
chargome deleted the cg/disallow-dropping-in-beforesendspan branch January 8, 2025 18:05
This was referenced Apr 24, 2025
Merged
Closed
s1gr1d added a commit that referenced this pull request Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans

2 participants

@chargome@Lms24
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null - #14831
Merged
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Jan 8, 2025
Merged
feat(core)!: Pass root spans to beforeSendSpan and disallow returning null#14831
chargome merged 13 commits into
developfrom 
cg/disallow-dropping-in-beforesendspan
Conversation
@chargome
@chargomechargome
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Member
  •  Disallows returning null from beforeSendSpan
  •  Passes root spans to beforeSendSpan
  •  Adds entry to migration guide and changelog
Looked at two options for passing the root span:
  1. Within the SentrySpan class, before converting the root span into a transaction.
  2. Parsing a SpanJSON out of an event and then writing back the updated values into the event.
Went with (2), passing the root span within processBeforeSend to have all processing hooks centrally in one place and because the other approach would have been too messy.
closes#14336
@chargomechargome
self-assigned this
Dec 23, 2024
@github-actions
github-actionsBot
commented
Dec 23, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser23.01 KB+1.22%+282 B 🔺
@sentry/browser - with treeshaking flags21.72 KB+1%+219 B 🔺
@sentry/browser (incl. Tracing)35.58 KB+0.55%+197 B 🔺
@sentry/browser (incl. Tracing, Replay)72.3 KB+0.3%+217 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags62.82 KB+0.32%+203 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)76.56 KB+0.27%+211 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)88.58 KB+0.24%+209 B 🔺
@sentry/browser (incl. Feedback)39.32 KB+0.63%+251 B 🔺
@sentry/browser (incl. sendFeedback)27.67 KB+0.92%+256 B 🔺
@sentry/browser (incl. FeedbackAsync)32.5 KB+0.79%+260 B 🔺
@sentry/react25.72 KB+0.91%+237 B 🔺
@sentry/react (incl. Tracing)38.35 KB+0.53%+206 B 🔺
@sentry/vue27.25 KB+0.64%+176 B 🔺
@sentry/vue (incl. Tracing)37.4 KB+0.45%+169 B 🔺
@sentry/svelte23.14 KB+1.23%+287 B 🔺
CDN Bundle24.32 KB+0.86%+210 B 🔺
CDN Bundle (incl. Tracing)35.87 KB+0.49%+178 B 🔺
CDN Bundle (incl. Tracing, Replay)70.44 KB+0.28%+198 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)75.64 KB+0.25%+187 B 🔺
CDN Bundle - uncompressed71.15 KB+0.97%+696 B 🔺
CDN Bundle (incl. Tracing) - uncompressed106.67 KB+0.6%+648 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed217.55 KB+0.3%+648 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed230.3 KB+0.28%+648 B 🔺
@sentry/nextjs (client)38.49 KB+0.56%+219 B 🔺
@sentry/sveltekit (client)36.11 KB+0.58%+211 B 🔺
@sentry/node161.75 KB+0.18%+295 B 🔺
@sentry/node - without tracing97.54 KB+0.27%+266 B 🔺
@sentry/aws-serverless127.39 KB+0.22%+281 B 🔺
View base workflow run
@chargome
chargome
marked this pull request as ready for review
December 31, 2024 11:55
@chargome
chargome
requested review from
Lms24 and mydeaJanuary 2, 2025 12:14
Lms24
Lms24
reviewed
Jan 2, 2025
View reviewed changes
@Lms24Lms24
left a comment
•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This generally looks good to me and I think the conversion is correct. Before we merge this, let's please add a sentence to the PR description why we went with this approach instead of calling beforeSendSpan earlier for posterity.
Comment threadpackages/core/test/lib/baseclient.test.ts
Comment threadpackages/core/src/utils/transactionEvent.ts
Outdated

Comment threadpackages/core/src/baseclient.ts
Outdated

@chargomechargome
mentioned this pull request
Jan 2, 2025
 Merged

@chargome
chargome
requested a review
from Lms24January 3, 2025 13:23
Lms24
Lms24
approved these changes
Jan 7, 2025
View reviewed changes
Comment threadpackages/core/src/baseclient.ts
 };
 }
 return beforeSendTransaction(event, hint);
 return beforeSendTransaction(processedEvent as TransactionEvent, hint);
@Lms24Lms24Jan 7, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l (not blocking): Is there a way we can get rid of this type cast? No worries if not, just curious since there's the isTransactionEvent check above 🤔
@chargomechargomeJan 8, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah somehow no matter what I do, after the merge call ts thinks it's an event again, even if I do
processedEvent=merge<TransactionEvent>(processedEvent,convertSpanJsonToTransactionEvent(processedRootSpanJson),);
@chargome
chargome
merged commit d4e94fe
into
developJan 8, 2025
@chargome
chargome
deleted the

cg/disallow-dropping-in-beforesendspan

branch
January 8, 2025 18:05

This was referenced Apr 24, 2025
 Merged


Closed

s1gr1d added a commit
that referenced
this pull request
Apr 25, 2025
@s1gr1d@mydea
docs(core): Fix docs forbeforeSendSpan(#16129)
8131751
Docs follow-up for this PR:
#14831
---------
Co-authored-by: Francesco Gringl-Novy <francesco.novy@sentry.io>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@Lms24Lms24Lms24 approved these changes
@mydeamydeaAwaiting requested review from mydea

Assignees

@chargomechargome

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[v9] Disallow returning null from beforeSendSpan and also pass root spans


2 participants

@chargome@Lms24