ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@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

ref(browser): Add protocol attributes to resource spans - #15161

Merged
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span
Jan 29, 2025
Merged

ref(browser): Add protocol attributes to resource spans#15161
Lms24 merged 4 commits into
getsentry:developfrom
Zen-cronic:update/metadata-resource-span

Conversation

@Zen-cronic

@Zen-cronicZen-cronic commented Jan 26, 2025

Copy link
Copy Markdown
Contributor

Resolves#12395

Changes made:

  • Relocated extractNetworkProtocol util and its unit test to browser-utils.
  • Modified browserMetrics test to assert the new metadata.

  • If you've added code that should be tested, please add tests.
  • Ensure your code lints and the test suite passes (yarn lint) & (yarn test).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This prop is needed even if the metadata is not asserted, otherwise this line throws due to undefined value:

for(constcharofnextHopProtocol){

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

@Lms24Lms24 self-assigned this Jan 27, 2025
@Lms24
Lms24 self-requested a review January 27, 2025 09:25
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from 590a5ed to 857cc4bCompareJanuary 27, 2025 10:43

@Lms24Lms24 left a comment

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.

Hey @Zen-cronic, once again, thanks for contributing! :D

I took the liberty to refactor the unit tests a bit and make the integration test for resource spans a bit more robust (see comments).

encodedBodySize: 256,
decodedBodySize: 256,
renderBlockingStatus: 'non-blocking',
nextHopProtocol: 'http/1.1',

@Lms24Lms24Jan 27, 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.

Yeah I was a bit worried about this but I think it's okay. MDN classifies the nextHopProtocol prop as widely available and we previously treated it as such when adding timing info to fetch request spans. So it's okay to add this I think. If we get reports, we can still safeguard usage later.

['sip/2', { name: 'sip', version: '2' }],
['tds/8.0', { name: 'tds', version: '8.0' }],
['dicom', { name: 'dicom', version: 'unknown' }],
['', { name: '', version: 'unknown' }],

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.

I added this last case here because according to MDN, nextHopProtocol will be empty for cross-origin resource requests where the responses don't contain a Timing-Allow-Origin header.

I was briefly debating changing the implementation to {name: 'unknown', version: 'unknown'} for consistency but then realized that this doesn't let us distinguish between the cross origin case and when we simply don't recognize the protocol. So let's leave it as-is for now.

Comment on lines +77 to +79
'network.protocol.name': 'unknown',
'network.protocol.version': 'unknown',

@Lms24Lms24Jan 27, 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.

I was hoping this would actually be populated but looks like PlayWright/Chromium Headless emits a '' despite me returning a Timing-Allow-Origin: * header. Same goes for the deliveryType property which follows a similar pattern

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

gotcha, i tried asserting the network.protocol.name and version here as well. But they came out to be unkown. And the properties were more comprehensively tested in the unit test, so i didn't add them here.
thanks for updating the integration test for better coverage!

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.

Yeah, I'm also not super happy about this but it looks like some browser or playwright bugs might be responsible for the ''. Coincidentally, we opened #15164 where it seems like at least some changes were made to cross origin performance entry data. So maybe this actually solves itself.

@Zen-cronic

Copy link
Copy Markdown
ContributorAuthor

hey @Lms24 , anytime! I've been working on the graphqlClientIntegration for a while now, and i got somewhat familiar with the browser pkg. So, this fix seemed like a low-hanging fruit.
Appreciate that you digged into the mdn docs :)

@Lms24

Copy link
Copy Markdown
Member

FYI, I'm waiting on #15164 before merging this to see if the integration tests need some adjustments afterwards.

Zen-cronicand others added 4 commits January 28, 2025 17:59
- Relocated `extractNetworkProtocol` util to `browser-utils`.
- Modified `browserMetrics` test to assert the new metadata.
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
@Lms24
Lms24force-pushed the update/metadata-resource-span branch from d1323e9 to b75eb03CompareJanuary 28, 2025 16:59
@Lms24Lms24 changed the title ref(browser): Add protocol metadata to resource spansref(browser): Add protocol attributes to resource spansJan 29, 2025
@Lms24
Lms24 merged commit 52c40fc into getsentry:developJan 29, 2025
Lms24 added a commit that referenced this pull request Jan 29, 2025
This PR adds the external contributor to the CHANGELOG.md file, so that
they are credited for their contribution. See #15161
---------
Co-authored-by: Lms24 <8420481+Lms24@users.noreply.github.com>
Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>
Lms24 added a commit that referenced this pull request Jan 30, 2025
Backport of #15161
---------
Signed-off-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Co-authored-by: Kaung Zin Hein <83657429+Zen-cronic@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add protocol metadata to resource fetch requests

2 participants

@Zen-cronic@Lms24