feat(sourcemaps) - Add `symbolicated_in_app` field to error events #88777

yuvmen · 2025-04-04T06:25:34Z

Add and populate new field symbolicated_in_app which indicates if all in_app frames of an error are symbolicated. Field is calculated during javascript symbolication and passed on to Snuba.
This required a change to the Kafka event adding the field, hence the kafka schema was bumped to the new 1.1.6 which includes it.

Field is calculated according to logic in tech spec:
https://www.notion.so/sentry/Sourcemapped-Frames-Search-Tech-Spec-15f8b10e4b5d803fa561cbeb5d2691a3?pvs=4#15f8b10e4b5d81848492db9bc0559cf0

Add and populate new field `symbolicated_in_app` which indicates if all in_app frames of an error are symbolicated. Field is calculated during javascript symbolication and passed on to reach snuba and be saved.

codecov · 2025-04-04T06:55:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@             Coverage Diff             @@
##           master   #88777       +/-   ##
===========================================
+ Coverage   46.18%   87.78%   +41.59%     
===========================================
  Files       10071    10092       +21     
  Lines      569697   571012     +1315     
  Branches    22433    22433               
===========================================
+ Hits       263139   501242   +238103     
+ Misses     306115    69327   -236788     
  Partials      443      443

loewenheim · 2025-04-04T08:34:00Z

src/sentry/lang/javascript/processing.py

+    data["symbolicated_in_app"] = (
+        True
+        if has_in_app_frames and all_in_app_frames_symbolicated
+        else (False if has_in_app_frames else None)
+    )


This can be simplified a bit:

Suggested change

data["symbolicated_in_app"] = (

True

if has_in_app_frames and all_in_app_frames_symbolicated

else (False if has_in_app_frames else None)

)

data["symbolicated_in_app"] = all_in_app_frames_symbolicated if has_in_app_frames else None

oh yea, much better

armenzg · 2025-04-07T17:01:27Z

src/sentry/lang/javascript/processing.py

@@ -296,6 +299,13 @@ def process_js_stacktraces(symbolicator: Symbolicator, data: Any) -> Any:
            if in_app is not None:
                merged_frame["in_app"] = in_app

+            # Track symbolication status for in-app frames
+            if merged_frame.get("in_app"):


Can you please remind me why we need this restriction?

not sure what you mean by restriction, you mean why check for in_app on its own? I mean we do that to set the flag to calculate the "None" case where you dont have any at all, is that what you mean?

Can the frame be not in-app yet be symbolicated=True?

I would remove if merged_frame.get("in_app"): completely unless there's a clear reason it has to be there.

But if I understand what we are doing correctly, I do not care about symbolification of non in_app frames right?, the flag is meant to indicate problems with your in app symbolification, the case you are talking about is not something I want to check in my logic I think

The only way a frame is symbolicated is because symbols have been provided by the customer.

I do not know if we guarantee that a symbolicated frame is also marked as in-app.

If we don't mark them as in-app when we symbolicate them, we probably should.

@loewenheim do you know?

The logic for when a frame is considered in-app is given by the is_in_app function in this file. We can't say that a symbolicated frame is definitely in-app because sourcemaps for frameworks might be available publicly.

armenzg · 2025-04-07T17:01:48Z

src/sentry/lang/javascript/processing.py

+            # Track symbolication status for in-app frames
+            if merged_frame.get("in_app"):
+                has_in_app_frames = True
+                frame_data = merged_frame.get("data", {})


This can be None.

you mean we can set frame_data to be None instead of {} in case it doesnt exist?

I have see merged_frame["data"] = None which would cause an error when calling merged_frame.get("in_app")

how would merged_frame["data"] value affect merged_frame.get("in_app")? or did you mean merged_frame.get("data")?
From what I can tell the only thing that would cause an error in this code is if merged_frame is None and I dont think thats possible, the rest are protected by get access no? it would not throw a key error it would simply return None (or default {} when we indicate it)

I may be getting confused but I think this would raise an error.

merged_data = {"data": None} frame_data = merged_frame.get("data", {}) if not None.get("symbolicated", False) // -> raises errors

I think that merged_frame.get("data", {}) would never return None, it would instead return the default we gave it - {}, so it would become if not {}.get("symbolicated", false), unless I am missing something

I just fixed this specific problem on this PR:
https://sentry.sentry.io/issues/6499816788/

>>> a = {'data': None} >>> print(a.get('data', {})) None

ahh interesting, it the field exists and is itself None it does return it, good to know, ill fix it, thanks!

armenzg · 2025-04-07T17:02:34Z

src/sentry/lang/javascript/processing.py

+            if merged_frame.get("in_app"):
+                has_in_app_frames = True
+                frame_data = merged_frame.get("data", {})
+                if not frame_data.get("symbolicated", False):


I don't know if this can ever come as None but we should protect against it.

lol sorry I dont quite understand your meaning here either, what can come as None? symbolicated? wouldn't that just be correctly treated as "false" here? Or do you think if we have an in_app frame with symbolicated: None we should treat it as a non in_app frame for this logic?

I have seen frame["data"] being None. I just don't know if it can also happen with symbolicated.

like I wrote above though, isnt that the point of get? if symbolicated doesnt exist no error should happen here, frame_data.get("symbolicated", False) would just return False no? I might be missing something about what you are saying

armenzg · 2025-04-07T17:03:51Z

requirements-base.txt

@@ -66,7 +66,7 @@ rfc3339-validator>=0.1.2
 rfc3986-validator>=0.1.1
 # [end] jsonschema format validators
 sentry-arroyo>=2.20.6
-sentry-kafka-schemas>=1.1.4
+sentry-kafka-schemas>=1.1.6


Why do we need to bump the schemas? Can you please mention it in the description of the PR if we do?

I am adding the calculated field as a new flag on the event now, symoblicated_in_app, passing it along to Snuba so I added it in the kafka schema and published, no problem ill mention it on the PR

tests/relay_integration/lang/javascript/test_plugin.py

armenzg · 2025-04-07T17:07:16Z

tests/relay_integration/lang/javascript/test_plugin.py

Are the tests in here necessary if we have already added tests in test_processing?

yea I wondered about it as well, they are a little redundant, I considered actually removing the more low level tests if anything. I think these tests in test_plugin assert the behaviour of the entire thing which is great, I get confidence that the event that gets generated holds the correct fields and should contain the value I want.
The more low level unit tests are basically helpers for the low level implementation (I created them first) but they run super fast and I felt like there isn't much harm in keeping them, you think maybe I should?

I would do all test cases in the fast tests and only one test case in the higher-level tests.
Do whatever you think works best.

yea I understand what you are saying and you may be right, thing is I kind of want to verify both a regular case and the None case on the top level to make sure it is preserved, but then it feels odd only testing the two cases and not the third so I think I will just keep them all if you dont feel strongly about it

armenzg · 2025-04-07T17:08:43Z

tests/relay_integration/lang/javascript/test_plugin.py

+        )
+        release.add_project(self.project)
+
+        # Create source files and sourcemaps


This could be a helper function since we use it multiple times in this module.

agreed, I will refactor a bit to remove redundancies in the tests

armenzg · 2025-04-07T17:17:27Z

tests/relay_integration/lang/javascript/test_plugin.py

+                file=f1,
+            )
+
+        data = {


You could have a helper function to create this data structure and make the test easier to read.

exception = self.generate_event([file.min.js, file.min.js])

yea youre right, I contemplated it, its also in use in other places in this file - ill add it

I added a method but it was hard to generalize it for the entire file and there was too much variance between cases imo, so I generalized for my tests only. Even for those I decided to still provide the frames from outside to keep it simple, I think its a good balance, let me know what you think

armenzg · 2025-04-07T17:23:09Z

tests/sentry/lang/javascript/test_processing.py

+        """Test symbolicated_in_app is None when all frames are non-in-app"""
+        data, symbolicator = self._get_test_data_and_symbolicator()
+
+        # Replace all frames with non-in-app frames that will pass _handles_frame


Can you please make _get_test_data_and_symbolicator receive parameters to create the data the way you want rather than updating it within the tests?

…rors

armenzg · 2025-04-08T12:31:42Z

tests/relay_integration/lang/javascript/test_plugin.py

I would do all test cases in the fast tests and only one test case in the higher-level tests.
Do whatever you think works best.

armenzg · 2025-04-08T12:32:05Z

tests/relay_integration/lang/javascript/test_plugin.py

-        )
-        release.add_project(self.project)
-
+    def _create_source_files_and_sourcemaps(self, release):


Thank you for adding the helper function!

…88777) Add and populate new field `symbolicated_in_app` which indicates if all in_app frames of an error are symbolicated. Field is calculated during javascript symbolication and passed on to Snuba. This required a change to the Kafka event adding the field, hence the kafka schema was bumped to the new 1.1.6 which includes it.

feat(sourcemaps) - Add symbolicated_in_app field to error events

137c3da

Add and populate new field `symbolicated_in_app` which indicates if all in_app frames of an error are symbolicated. Field is calculated during javascript symbolication and passed on to reach snuba and be saved.

yuvmen requested review from a team as code owners April 4, 2025 06:25

github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Apr 4, 2025

loewenheim reviewed Apr 4, 2025

View reviewed changes

yuvmen requested review from a team and JoshFerge April 4, 2025 16:54

feat(sourcemaps) - simplified symbolicated_in_app calculation

761b41e

vercel bot deployed to Preview April 4, 2025 17:20 View deployment

armenzg reviewed Apr 7, 2025

View reviewed changes

Refactored test to remove redundancies

57e7f52

vercel bot deployed to Preview April 7, 2025 19:59 View deployment

Merge branch 'master' into yuvmen/add_symbolicated_in_app_field_on_er…

c2e46f0

…rors

vercel bot deployed to Preview April 7, 2025 20:27 View deployment

armenzg reviewed Apr 8, 2025

View reviewed changes

added protection from frame 'data' being None at processing

97a3eb4

vercel bot deployed to Preview April 8, 2025 17:26 View deployment

armenzg self-requested a review April 8, 2025 17:54

armenzg approved these changes Apr 8, 2025

View reviewed changes

yuvmen merged commit edd0688 into master Apr 8, 2025
51 checks passed

yuvmen deleted the yuvmen/add_symbolicated_in_app_field_on_errors branch April 8, 2025 20:09

feat(sourcemaps) - Add symbolicated_in_app field to error events #88777

feat(sourcemaps) - Add symbolicated_in_app field to error events #88777

Conversation

yuvmen commented Apr 4, 2025 • edited Loading

codecov bot commented Apr 4, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yuvmen Apr 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat(sourcemaps) - Add `symbolicated_in_app` field to error events #88777

feat(sourcemaps) - Add `symbolicated_in_app` field to error events #88777

yuvmen commented Apr 4, 2025 •

edited

Loading

codecov bot commented Apr 4, 2025 •

edited

Loading

yuvmen Apr 7, 2025 •

edited

Loading