feat(core): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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 \u003e 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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d
, '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): Add scope attribute APIs - #18165

Merged
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes
Nov 21, 2025
Merged

feat(core): Add scope attribute APIs#18165
Lms24 merged 17 commits into
developfrom
lms/feat-core-scope-setAttributes

Conversation

@Lms24

@Lms24Lms24 commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Member

This PR adds scope.setAttribute, scope.setAttributes and scope.removeAttribute methods, as specified in our develop docs.

This intial PR only enables setting the attributes (including attributes with units) as well as the usual scope data operations (clone(), update(), clear(), getSpanData()). These attributes are not yet applied to any of the telemetry we eventually want them to apply to. I'll take care of this in a follow-up PR.

closes#18140

ref https://linear.app/getsentry/project/implement-global-attributes-api-javascript-02c3c74184fc/issues

Lms24
Lms24 commented Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts

@Lms24Lms24Nov 11, 2025•
edited
Loading

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.

In contrast to logs and metrics attribute definitions and helper functions, this one already handles array attributes as well as attributes with units. My thinking is, we introduce this here then unify logs, metrics (+ spans eventually) to use the types and APIs here. While we'll have to change the used types for logs and metrics, I don't think this is breaking as theoretically logs and metrics support unknown for attribute values.

@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 3209923 to c94bcd6CompareNovember 11, 2025 12:32
@Lms24Lms24 self-assigned this Nov 11, 2025
@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB+0.3%+74 B 🔺
@sentry/browser - with treeshaking flags23.27 kB+0.34%+77 B 🔺
@sentry/browser (incl. Tracing)41.51 kB+0.2%+79 B 🔺
@sentry/browser (incl. Tracing, Profiling)45.83 kB+0.18%+80 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB+0.09%+71 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB+0.11%+76 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB+0.07%+52 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB+0.08%+76 B 🔺
@sentry/browser (incl. Feedback)41.45 kB+0.18%+73 B 🔺
@sentry/browser (incl. sendFeedback)29.46 kB+0.26%+76 B 🔺
@sentry/browser (incl. FeedbackAsync)34.4 kB+0.21%+72 B 🔺
@sentry/react26.49 kB+0.29%+74 B 🔺
@sentry/react (incl. Tracing)43.51 kB+0.17%+73 B 🔺
@sentry/vue29.22 kB+0.24%+69 B 🔺
@sentry/vue (incl. Tracing)43.31 kB+0.18%+77 B 🔺
@sentry/svelte24.79 kB+0.3%+73 B 🔺
CDN Bundle27.09 kB+0.27%+71 B 🔺
CDN Bundle (incl. Tracing)42.07 kB+0.14%+58 B 🔺
CDN Bundle (incl. Tracing, Replay)78.59 kB+0.08%+56 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.08 kB+0.07%+58 B 🔺
CDN Bundle - uncompressed79.46 kB+0.36%+284 B 🔺
CDN Bundle (incl. Tracing) - uncompressed124.83 kB+0.23%+278 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed240.86 kB+0.12%+278 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.63 kB+0.11%+278 B 🔺
@sentry/nextjs (client)45.93 kB+0.21%+92 B 🔺
@sentry/sveltekit (client)41.87 kB+0.19%+79 B 🔺
@sentry/node-core51.1 kB+0.16%+77 B 🔺
@sentry/node159.41 kB+0.05%+78 B 🔺
@sentry/node - without tracing92.98 kB+0.09%+82 B 🔺
@sentry/aws-serverless106.72 kB+0.07%+73 B 🔺

View base workflow run

@github-actions

github-actionsBot commented Nov 11, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,757-9,303-6%
GET With Sentry1,64419%1,624+1%
GET With Sentry (error only)6,09770%5,898+3%
POST Baseline1,194-1,209-1%
POST With Sentry58549%562+4%
POST With Sentry (error only)1,06489%1,044+2%
MYSQL Baseline3,360-3,274+3%
MYSQL With Sentry37211%432-14%
MYSQL With Sentry (error only)2,64979%2,689-1%

View base workflow run

@Lms24Lms24 changed the title feat(core): Add Scope::setAttribute(s) APIsfeat(core): Add scope attribute APIsNov 11, 2025
@Lms24
Lms24 marked this pull request as ready for review November 11, 2025 16:04
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/test/lib/scope.test.ts
cursor[bot]
cursorBot reviewed Nov 11, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts Outdated
@Lms24Lms24 mentioned this pull request Nov 12, 2025
Merged
cursor[bot]
cursorBot reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
logaretm
logaretm reviewed Nov 14, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
AbhiPrasad
AbhiPrasad reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts Outdated
Comment threadpackages/core/src/attributes.ts
cursor[bot]
cursorBot reviewed Nov 18, 2025
View reviewed changes
Comment threadpackages/core/src/scope.ts
@Lms24Lms24 mentioned this pull request Nov 18, 2025
Merged
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch 2 times, most recently from a3e204d to 205752cCompareNovember 18, 2025 16:51
@Lms24

Lms24 commented Nov 19, 2025

Copy link
Copy Markdown
MemberAuthor

Converting to draft because we learned yesterday that Relay doesn't yet support array attributes. So either we wait for support in Relay or we strip out the Array-related code. Units seem to get passed through but are not yet shown in the UI.

@Lms24
Lms24 marked this pull request as draft November 19, 2025 08:59
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from 205752c to fbbd768CompareNovember 20, 2025 10:47
@Lms24
Lms24 marked this pull request as ready for review November 20, 2025 12:10
@Lms24

Lms24 commented Nov 20, 2025

Copy link
Copy Markdown
MemberAuthor

So for now, we decided to just ship this, despite Relay still filtering out array values. Units are accepted but not shown in the UI. Which is fine. We're just future-proofing at this point.

cursor[bot]
cursorBot reviewed Nov 20, 2025
View reviewed changes
Comment threadpackages/core/src/attributes.ts
Lms24and others added 17 commits November 21, 2025 15:23
@Lms24
feat(core): Add Scope::SetAttribute(s) APIs
d47204c
@Lms24
add attributes.ts
227ebc7
@Lms24
add removeAttribute method
a1e1fcc
@Lms24
fix lint
d72787c
@Lms24
fix size limit
9b4e65c
@Lms24
fix remove scope listener test
cadc629
@Lms24
be extra careful with typed attribute values
c4e9005
@s1gr1d@Lms24
ref(attribute): Add type to accept unknown and official attribute t…
29e0b2f
…ype (#18201)
Uses a conditional type to infer whether an attribute object has the
type of an official attribute by checking if it has a `value` or a
`unit`:
```ts
export type ValidatedAttributes<T> = {
[K in keyof T]: T[K] extends { value: any } | { unit: any } ? ValidAttributeObject : unknown;
};
```
That way, TS can show an error when people attempt to use the attribute
type while still allowing non-official types.
<img width="673" height="250" alt="image"
src="https://github.com/user-attachments/assets/f635f46d-6c3f-49cb-b31f-a02a6ebf91d3"
/>
---
I also added a small helper type to generate the very long attribute
type object, so it can generate a type like this:
```ts
/*
| { value: string; type: 'string' }
| { value: number; type: 'integer' }
| { value: number; type: 'double' }
*/
```
@Lms24
attribute objects w/o type, keep attributes as-is on scope
8d04d23
@Lms24
adapt attributeValueToTypedAttributeValue
4540a35
@Lms24
ignore invalid units
994f487
@Lms24
streamline isAttributeObject
8cc1c2a
@Lms24
streamline primitive attribute value conversion
779e053
@Lms24
use MeasurementUnit (aka Relay's MetricUnit)
7d69b12
@Lms24
use metric units without custom and none units
ab75d4a
@Lms24
lint
bcb5925
@Lms24
save a few more bytes in getPrimitiveType
04d75b1
@Lms24
Lms24force-pushed the lms/feat-core-scope-setAttributes branch from fbbd768 to 04d75b1CompareNovember 21, 2025 14:23
@Lms24
Lms24 merged commit 3375de0 into developNov 21, 2025
198 checks passed
@Lms24
Lms24 deleted the lms/feat-core-scope-setAttributes branch November 21, 2025 14:42
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
@coderabbitaicoderabbitaiBot mentioned this pull request Apr 24, 2026
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@logaretmlogaretmlogaretm approved these changes
@chargomechargomechargome approved these changes
@cleptriccleptricAwaiting requested review from cleptric
@andreiborzaandreiborzaAwaiting requested review from andreiborza
+1 more reviewer
@AbhiPrasadAbhiPrasadAbhiPrasad left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@Lms24Lms24

Labels

ci-skip-cache

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add attribute APIs to Scope class

5 participants

@Lms24@logaretm@AbhiPrasad@chargome@s1gr1d