ref(related_issues): Improve code for title, subtitle and message by armenzg · Pull Request #73053 · getsentry/sentry

armenzg · 2024-06-20T14:28:36Z

This fixes the rendering of some issues to match what we do on the Issue Details page.

Changes:

Fix default events
Fix some error events edge cases using culprit and error.value information

This shows a working default event:

instead of this:

NOTE: We can't use the same function we use for the Issue Details page since the data come from different endpoints and have different types.

codecov · 2024-06-20T14:31:30Z

Bundle Report

Changes will decrease total bundle size by 16.5kB ⬇️

Bundle name	Size	Change
app-webpack-bundle-array-push	27.3MB	16.5kB ⬇️

codecov · 2024-07-03T18:06:00Z

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 78.13%. Comparing base (42068cb) to head (afd9492).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #73053      +/-   ##
==========================================
- Coverage   78.13%   78.13%   -0.01%     
==========================================
  Files        6652     6652              
  Lines      297597   297598       +1     
  Branches    51204    51205       +1     
==========================================
- Hits       232527   232526       -1     
- Misses      58766    58768       +2     
  Partials     6304     6304

Files	Coverage Δ
...ueDetails/traceTimeline/useTraceTimelineEvents.tsx	`93.54% <ø> (ø)`
...pp/views/issueDetails/traceTimeline/traceIssue.tsx	`85.29% <87.50%> (-5.62%)`	⬇️

This change tries to bring the code closer to what the Issues Details UI does for getting the title, subtitle and message displayed.

armenzg · 2024-07-04T15:34:39Z

+  try {
+    title = event.title.trimEnd();
+    if (event['event.type'] === 'error') {
+      if (title[title.length - 1] !== ':') {


This handles the case when the colon is still part of the title:

armenzg · 2024-07-04T15:44:55Z

+    // This is a case where the culprit is available while the transaction is not
+    transaction: '',
    'event.type': event.type,
+    'stack.function': [],


Typing is now actually working. I was not warned about this until now.

armenzg · 2024-07-04T15:45:26Z

    );
  });

+  it('trace-related: check title, subtitle for error event', async () => {


Since the code path to generating is different than an issue platform event we need this test.

armenzg · 2024-07-04T16:35:30Z

          <NoOverflowDiv>
            <TraceIssueEventTitle>{title}</TraceIssueEventTitle>
-            <TraceIssueEventSubtitle>{subtitle}</TraceIssueEventSubtitle>
+            <TraceIssueEventSubtitle data-test-id="subtitle-span">


This will enable a test for the default event type (which is the empty string).

armenzg · 2024-07-04T16:37:14Z

+      }
+      // https://github.com/getsentry/sentry/blob/f08644a004f9980d48f93dec2d7cfc9eeecd9a9e/static/app/utils/events.tsx#L48-L50
+      // It uses metadata.value which could differ depending on what error.value is used in the event manager
+      message = event['error.value'][event['error.value'].length - 1];


The case I'm thinking of is ANR mobile issues where the stack trace is reversed, thus, the title could come from the other end.

I'm still comfortable going this way as this would fix the majority of all other platforms.

armenzg · 2024-07-04T16:39:27Z

+      // https://github.com/getsentry/sentry/blob/f08644a004f9980d48f93dec2d7cfc9eeecd9a9e/static/app/utils/events.tsx#L48-L50
+      // It uses metadata.value which could differ depending on what error.value is used in the event manager
+      message = event['error.value'][event['error.value'].length - 1];
+    } else if (event['event.type'] === 'default') {


This is new support.

armenzg · 2024-07-04T16:39:33Z

+      const issuePlatformEvent = event as TimelineIssuePlatformEvent;
+      // It is suspected that this value is calculated somewhere in Relay
+      // and we deconstruct it here to match what the Issue details page shows
+      message = issuePlatformEvent.message


This is as it was:

armenzg · 2024-07-04T16:40:09Z

  transaction: string;
 }

-interface TimelineDiscoverEvent extends BaseEvent {}


This was incorrect as it should have contained event.type and stack.function.

armenzg · 2024-07-04T16:41:04Z

+    expect(await screen.findByText('The last error value')).toBeInTheDocument();
+  });
+
+  it('trace-related: check title, subtitle for default event', async () => {


The test for the default event.

armenzg · 2024-07-04T16:41:56Z

-    // It is suspected that this value is calculated somewhere in Relay
-    // and we deconstruct it here to match what the Issue details page shows
-    message = event.message.replace(event.transaction, '').replace(title, '');
+  let subtitle = event.culprit || '';


This moves us away from event.transaction:

getTitle in events.tsx sets the value to these:

sentry/static/app/utils/events.tsx

Line 136 in 7a19d0b

subtitle: culprit,

sentry/static/app/utils/events.tsx

Line 190 in 7a19d0b

subtitle: isIssue ? culprit : '',

armenzg · 2024-07-05T16:04:32Z

This PR has been split into the following PRs:

armenzg self-assigned this Jun 20, 2024

github-actions Bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Jun 20, 2024

vercel Bot deployed to Preview June 20, 2024 14:31 View deployment

armenzg force-pushed the fix/title/related_issue/armenzg branch from 1d3f5a1 to bee438f Compare June 21, 2024 18:42

armenzg commented Jun 21, 2024

View reviewed changes

Comment thread static/app/views/issueDetails/traceTimeline/traceIssue.tsx Outdated

Comment thread static/app/views/issueDetails/traceTimeline/traceIssue.tsx

Comment thread static/app/views/issueDetails/traceTimeline/traceIssue.tsx Outdated

vercel Bot deployed to Preview June 21, 2024 18:45 View deployment

armenzg force-pushed the fix/title/related_issue/armenzg branch from bee438f to cc3e1e3 Compare July 2, 2024 19:02

armenzg changed the base branch from master to feat/post_ga_work/related_issues/armenzg July 2, 2024 19:02

vercel Bot deployed to Preview July 2, 2024 19:06 View deployment

armenzg commented Jul 2, 2024

View reviewed changes

Comment thread static/app/views/issueDetails/traceTimeline/traceIssue.tsx

Base automatically changed from feat/post_ga_work/related_issues/armenzg to master July 3, 2024 11:46

armenzg force-pushed the fix/title/related_issue/armenzg branch from cc3e1e3 to afd9492 Compare July 3, 2024 17:56

vercel Bot deployed to Preview July 3, 2024 17:59 View deployment

armenzg added 5 commits July 4, 2024 09:08

ref(related_issues): Improve code for title, subtitle and message

7f473cd

This change tries to bring the code closer to what the Issues Details UI does for getting the title, subtitle and message displayed.

Fetch error.value

6ed37bd

Handle colon

d96b921

Update comment

de4292d

We do not need the message for error events

adaa46c

armenzg force-pushed the fix/title/related_issue/armenzg branch from afd9492 to adaa46c Compare July 4, 2024 15:12

vercel Bot deployed to Preview July 4, 2024 15:15 View deployment

armenzg added 2 commits July 4, 2024 11:21

Fix typing issue

a0931ca

Clean up diff

b83c700

vercel Bot deployed to Preview July 4, 2024 15:33 View deployment

armenzg added 2 commits July 4, 2024 12:30

Support default events

70ca452

Minor change

decd2ce

vercel Bot deployed to Preview July 4, 2024 16:36 View deployment

armenzg commented Jul 4, 2024

View reviewed changes

Fix typing

53c2622

vercel Bot deployed to Preview July 4, 2024 16:49 View deployment

armenzg closed this Jul 5, 2024

github-actions Bot locked and limited conversation to collaborators Jul 21, 2024

armenzg deleted the fix/title/related_issue/armenzg branch June 5, 2025 14:31

Uh oh!

Conversation

armenzg commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Jul 3, 2024

Codecov Report

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

armenzg commented Jul 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

armenzg commented Jun 20, 2024 •

edited

Loading

codecov Bot commented Jun 20, 2024 •

edited

Loading