feat(nextjs-insights): add endpoint to transform EAP response into array / tree structure

[shellmayr]

• Closes https://github.com/getsentry/projects/issues/878
• Adds a new endpoint as subclass of OrganizationEventsEndpoint, because we basically just do post-processing on the result, and ensure that certain parameter values are set correctly.
• Parses current span.description into its components using a regex, then split the path using string functions. Adds two new fields to the API response: nextjs.function.component_type and nextjs.function.path
• Purpose of the endpoint is to generate an representation of the component type and path of a component that is both easily usable by the frontend and will not need a rewrite when EAP starts supporting arrays.

[codecov]

Codecov Report

Attention: Patch coverage is 97.89474% with 2 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...sentry/api/endpoints/organization_insights_tree.py	93.93%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #88665     +/-   ##
=========================================
  Coverage   87.75%   87.75%             
=========================================
  Files       10013    10044     +31     
  Lines      567352   569283   +1931     
  Branches    22297    22297             
=========================================
+ Hits       497860   499577   +1717     
- Misses      69075    69289    +214     
  Partials      417      417             

[lforst]

This is potentially vulnerable to redos: re.compile(r"^(.*?)\s+\((.*?)\)$").match(('\t' * 50000) + ')')

sauce

Are we limiting the length of the description somewhere?

[shellmayr]

Good catch! I don't know off the top of my head if we do limit it and didn't find anything in the spec - I know we limit all strings generally though; I'll check what the limit is and rethink the regex somehow if it's an issue.

[lforst]

Imo it's fine if we limit the length here once more before we pass it to the regex. That way we don't depend on any upstream logic.

[shellmayr]

I think EAP should have some size limit on it as well - would like to have those two to be consistent if we do a check here.

[shellmayr]

Checked with ingest regarding size limits - this is trimmed to 8192 characters, and the other point to be made here is that the regex is only needed until we have separate fields from the SDK, so I think we can go ahead with this. I may refactor this to use string splitting instead soon though, just for performance and robustness.

[JoshFerge]

could you provide more color as to what the end product result is? will this be generalized to other modules or is this next.js specific?

[shellmayr]

@JoshFerge the goal is to replicate the tree of server side rendered backend components in insights - which for now is pretty Next.js specific. We had a debate about doing this on the frontend vs the backend, but since there is a plan for EAP to support arrays at some point (which will make querying and aggregating this type of data easier) we wanted to do the intermediate solution that will cause the least troubles in migrating later - which is the backend. No plans for generalization at this point, but if the feature gets adopeted well, I can see us doing this for other platforms as well in a similar way. Are there specific concerns you'd like to see addressed?

[JoshFerge]

@JoshFerge the goal is to replicate the tree of server side rendered backend components in insights - which for now is pretty Next.js specific. We had a debate about doing this on the frontend vs the backend, but since there is a plan for EAP to support arrays at some point (which will make querying and aggregating this type of data easier) we wanted to do the intermediate solution that will cause the least troubles in migrating later - which is the backend. No plans for generalization at this point, but if the feature gets adopeted well, I can see us doing this for other platforms as well in a similar war. Are there specific concerns you'd like to see addressed?

got it, that makes sense. mind just adding a note about this in the docstring? just want to make sure future folks understand the context of the endpoint.

when you do migrate, will this endpoint still be necessary?

[shellmayr]

@JoshFerge yeah I'll add that - good point. The endpoint will not be needed once the feature exists in EAP and the feature can be migrated over.

[sentry-io]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ KeyError: 'span.description' /api/0/organizations/{organization_id_or_slug}/... View Issue

_{Did you find this useful? React with a 👍 or 👎}