feat(core): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

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

feat(core): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad
, '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): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

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

feat(core): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad
, '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): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad
, '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): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad
, '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): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad
, '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): Deprecate span tags, data, context & setters - #10053

Merged
mydea merged 1 commit into
developfrom
fn/spanData
Jan 10, 2024
Merged

feat(core): Deprecate span tags, data, context & setters#10053
mydea merged 1 commit into
developfrom
fn/spanData

Conversation

@mydea

@mydeamydea commented Jan 4, 2024

Copy link
Copy Markdown
Member

Also deprecate direct access to span.attributes (instead use spanToJSON(span)).

There are a few usages that we still need to figure out how we will replace them...!

@mydeamydea self-assigned this Jan 4, 2024
() => {
// TODO: Can we rewrite this to use attributes?
// eslint-disable-next-line deprecation/deprecation
transaction.setContext('profile', { profile_id: profileId, start_timestamp: startTimestamp });

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.

cc @JonasBa we either need to move this to be an attribute (~~data) on the transaction, or find a way to set these on the surrounding scope of the transaction instead 🤔 nothing to do in this PR but when we actually remove this in v8 we need to handle this somehow.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ok sounds good. Thanks for the ping!


if (this.op === 'ui.action.click') {
// eslint-disable-next-line deprecation/deprecation
this.setTag(FINISH_REASON_TAG, this._finishReason);

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.

Do we need this tag on the idle transaction in v8? @AbhiPrasad

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No we don't, we can remove.

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.

OK, I'll just change it to an attribute then!

Comment threadpackages/core/src/utils/spanUtils.ts Outdated
*/
export function spanToTraceContext(span: Span): TraceContext {
const { data, description, op, parent_span_id, span_id, status, tags, trace_id, origin } = span.toJSON();
const {

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.

This conflicted with some tests, but I figured it is overall safer as we assumed that this always is a Span class instance with toJSON() which may be a bit unsafe. Now we just treat this as a POJO which should be safer (and .toJSON() will actually go away for v8 as well, so we may as well already do that now)

// Since formDataObject is not a primitive, we cannot store it on the span as attributes
// so instead we put it as extra on the scope
const scope = getCurrentScope();
scope.setExtra('server_action_form_data', formDataObject);

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.

@lforst do we need this as a nested object here? attributes cannot be nested, so going forward we need to either flatten this, if the shape is known (which I guess it is not?), or store it as context on the scope (?), or as JSON string...


// TODO: Can we rewrite this to an attribute? Or set this on the scope?
// eslint-disable-next-line deprecation/deprecation
sentryTransaction.setContext('trpc', trpcContext);

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.

Any thoughts on this? Not sure how important that is, but I guess we need some way to access the scope of the sentryTransaction then we could just put it on there...?

const { op, description, source, data } = parseOtelSpanDescription(otelSpan);

// eslint-disable-next-line deprecation/deprecation
transaction.setContext('otel', {

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.

I guess this will generally go away in v8, so no need to worry about this.

Which reminds me, we should also deprecate these I guess...

@github-actions

github-actionsBot commented Jan 4, 2024

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser (incl. Tracing, Replay, Feedback) - Webpack (gzipped)76.66 KB (-0.24% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack (gzipped)68.02 KB (-0.28% 🔽)
@sentry/browser (incl. Tracing, Replay) - Webpack with treeshaking flags (gzipped)61.65 KB (-0.31% 🔽)
@sentry/browser (incl. Tracing) - Webpack (gzipped)32.29 KB (+0.16% 🔺)
@sentry/browser (incl. Feedback) - Webpack (gzipped)30.74 KB (+0.04% 🔺)
@sentry/browser - Webpack (gzipped)22.1 KB (+0.04% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback) - ES6 CDN Bundle (gzipped)74.23 KB (-0.42% 🔽)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (gzipped)65.86 KB (-0.47% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (gzipped)32.03 KB (+0.12% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped)23.74 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing, Replay) - ES6 CDN Bundle (minified & uncompressed)206.88 KB (-0.84% 🔽)
@sentry/browser (incl. Tracing) - ES6 CDN Bundle (minified & uncompressed)96.74 KB (+0.07% 🔺)
@sentry/browser - ES6 CDN Bundle (minified & uncompressed)70.95 KB (+0.03% 🔺)
@sentry/browser (incl. Tracing) - ES5 CDN Bundle (gzipped)35 KB (+0.1% 🔺)
@sentry/react (incl. Tracing, Replay) - Webpack (gzipped)68.4 KB (-0.28% 🔽)
@sentry/react - Webpack (gzipped)22.13 KB (+0.04% 🔺)
@sentry/nextjs Client (incl. Tracing, Replay) - Webpack (gzipped)85.12 KB (-0.24% 🔽)
@sentry/nextjs Client - Webpack (gzipped)49.48 KB (+0.09% 🔺)
@sentry-internal/feedback - Webpack (gzipped)16.75 KB (+0.06% 🔺)

Comment threadpackages/core/src/tracing/transaction.ts Outdated
@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 5ebab8f to 6cfe78bCompareJanuary 4, 2024 14:48
} else {
formDataObject[key] = '[non-string value]';
}
span?.setAttribute(

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.

After talking with @lforst, we decided to flatten this here, as the exact shape of this is not important, and thus we can more easily rewrite it to attributes!

@mydea
mydeaforce-pushed the fn/spanData branch 2 times, most recently from 30dc0ac to 4cb5aaaCompareJanuary 9, 2024 09:12
@mydea

mydea commented Jan 9, 2024

Copy link
Copy Markdown
MemberAuthor

I updated this to use spanToJSON().

Also deprecate direct access to `span.attributes` (instead use `spanGetAttributes(span)`).
There are a few usages that we still need to figure out how we will replace them.
@mydea
mydea merged commit a56fc29 into developJan 10, 2024
@mydea
mydea deleted the fn/spanData branch January 10, 2024 09:15
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.

4 participants

@mydea@Lms24@JonasBa@AbhiPrasad