Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 47 additions & 14 deletions src/sentry/api/endpoints/organization_insights_tree.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import logging
import re
from typing import NamedTuple

from rest_framework.request import Request
from rest_framework.response import Response
Expand All @@ -12,6 +13,33 @@
logger = logging.getLogger(__name__)


class _ExtractionPattern(NamedTuple):
"""Extraction pattern for component type and path from span.description.
group(1) = kind/type (mapped through kind_map when present), group(2) = path.
"""

regex: re.Pattern[str]
kind_map: dict[str, str] | None = None


# SDK <10.32.0: '{component_type} ({path})'
# e.g. 'Page Server Component (/dashboard)'
_ParenthesisPattern = _ExtractionPattern(
regex=re.compile(r"^(.*?)\s+\((.*?)\)$"),
)

# SDK >=10.32.0: 'resolve {page|root layout|layout} server component "{route_or_segment}"'
# e.g. 'resolve page server component "/dashboard"'
_ResolvePattern = _ExtractionPattern(
regex=re.compile(r'^resolve (page|root layout|layout) server component(?:\s+"(.*)")?$'),
kind_map={
"page": "Page Server Component",
"layout": "Layout Server Component",
"root layout": "Layout Server Component",
},
)


@cell_silo_endpoint
class OrganizationInsightsTreeEndpoint(OrganizationEventsEndpoint):
"""
Expand Down Expand Up @@ -41,22 +69,27 @@ def get(self, request: Request, organization: Organization) -> Response:
response = super().get(request, organization)
return self._separate_span_description_info(response)

def _separate_span_description_info(self, response):
# Regex to split string into '{component_type}{space}({path})'
pattern = re.compile(r"^(.*?)\s+\((.*?)\)$")
_EXTRACTION_PATTERNS = (_ParenthesisPattern, _ResolvePattern)

@staticmethod
def _parse_path(path: str | None) -> list[str]:
if not path:
return []
parts = path.strip("/").split("/")
return parts if parts != [""] else []

def _separate_span_description_info(self, response):
for line in response.data["data"]:
match = pattern.match(line["span.description"])
if match:
component_type = match.group(1)
path = match.group(2)
path_components = path.strip("/").split("/")
if not path_components or (len(path_components) == 1 and path_components[0] == ""):
path_components = [] # Handle root path case

else:
component_type = None
path_components = []
component_type = None
path_components: list[str] = []

for pattern, kind_map in self._EXTRACTION_PATTERNS:
match = pattern.match(line["span.description"])
if match:
component_type = kind_map[match.group(1)] if kind_map else match.group(1)
path_components = self._parse_path(match.group(2))
break

line["function.nextjs.component_type"] = component_type
line["function.nextjs.path"] = path_components

Expand Down
68 changes: 67 additions & 1 deletion tests/sentry/api/endpoints/test_organization_insights_tree.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import pytest
from django.urls import reverse

from sentry.testutils.cases import SnubaTestCase, SpanTestCase
from sentry.api.endpoints.organization_insights_tree import OrganizationInsightsTreeEndpoint
from sentry.testutils.cases import SnubaTestCase, SpanTestCase, TestCase
from sentry.testutils.helpers.datetime import before_now
from sentry.testutils.skips import requires_snuba
from tests.snuba.api.endpoints.test_organization_events import OrganizationEventsEndpointTestBase
Expand Down Expand Up @@ -30,6 +31,7 @@ def setUp(self) -> None:
self._store_unrelated_spans()

def _store_nextjs_function_spans(self) -> None:
# Old SDK format (<10.32.0): '{ComponentType} Server Component ({route})'
descriptions = [
"Page Server Component (/app/dashboard/)",
"Loading Server Component (/app/dashboard/)",
Expand All @@ -50,6 +52,13 @@ def _store_nextjs_function_spans(self) -> None:
"Page Server Component (/app/[id]/)",
"Page Server Component (/app/[...slug]/)",
"Page Server Component (/app/[[...optional]]/)",
# New SDK format (>=10.32.0): 'resolve {type} server component "{route_or_segment}"'
'resolve page server component "/dashboard"',
'resolve page server component "/nested-layout/[dynamic]"',
'resolve layout server component "nested-layout"',
'resolve layout server component "(route-group)"',
'resolve layout server component "[dynamic]"',
"resolve root layout server component",
"unrelated description",
]
spans = []
Expand Down Expand Up @@ -125,4 +134,61 @@ def test_get_nextjs_function_data(self) -> None:
assert element["function.nextjs.component_type"] == "Page Server Component"
assert element["function.nextjs.path"] == ["app", "[...slug]"]

# New SDK format: resolve page server component with full route
resolve_page_idx = span_descriptions.index(
'resolve page server component "/nested-layout/[dynamic]"'
)
element = response.data["data"][resolve_page_idx]
assert element["function.nextjs.component_type"] == "Page Server Component"
assert element["function.nextjs.path"] == ["nested-layout", "[dynamic]"]

# New SDK format: resolve layout server component with segment
resolve_layout_idx = span_descriptions.index(
'resolve layout server component "nested-layout"'
)
element = response.data["data"][resolve_layout_idx]
assert element["function.nextjs.component_type"] == "Layout Server Component"
assert element["function.nextjs.path"] == ["nested-layout"]

# New SDK format: resolve root layout server component (no path)
resolve_root_idx = span_descriptions.index("resolve root layout server component")
element = response.data["data"][resolve_root_idx]
assert element["function.nextjs.component_type"] == "Layout Server Component"
assert element["function.nextjs.path"] == []

# New SDK format: route group segment
resolve_group_idx = span_descriptions.index(
'resolve layout server component "(route-group)"'
)
element = response.data["data"][resolve_group_idx]
assert element["function.nextjs.component_type"] == "Layout Server Component"
assert element["function.nextjs.path"] == ["(route-group)"]

assert "INSERT value INTO table" not in span_descriptions


class DescriptionParsingTest(TestCase):
"""Verifies that old (<10.32.0) and new (>=10.32.0) SDK formats produce identical parsed output."""

_endpoint = OrganizationInsightsTreeEndpoint()

def _parse(self, desc):
response = type("R", (), {"data": {"data": [{"span.description": desc}]}})()
self._endpoint._separate_span_description_info(response)
row = response.data["data"][0]
return row["function.nextjs.component_type"], row["function.nextjs.path"]

def test_page_simple_route(self):
assert self._parse("Page Server Component (/dashboard)") == self._parse(
'resolve page server component "/dashboard"'
)

def test_page_nested_route(self):
assert self._parse("Page Server Component (/nested/route)") == self._parse(
'resolve page server component "/nested/route"'
)

def test_layout_simple_route(self):
assert self._parse("Layout Server Component (/settings)") == self._parse(
'resolve layout server component "/settings"'
)
Loading