♻️ Convert highlight context to schema validator

Author: leeandher

src/sentry/api/endpoints/project_details.py

@@ -34,6 +34,7 @@
 from sentry.grouping.enhancer.exceptions import InvalidEnhancerConfig
 from sentry.grouping.fingerprinting import FingerprintingRules, InvalidFingerprintingConfig
 from sentry.ingest.inbound_filters import FilterTypes
+from sentry.issues.highlights import HighlightContextField
 from sentry.lang.native.sources import (
     InvalidSourcesError,
     parse_backfill_sources,
@@ -181,7 +182,7 @@ class ProjectAdminSerializer(ProjectMemberSerializer):
     dataScrubberDefaults = serializers.BooleanField(required=False)
     sensitiveFields = ListField(child=serializers.CharField(), required=False)
     safeFields = ListField(child=serializers.CharField(), required=False)
-    highlightContext = ListField(child=serializers.CharField(), required=False)
+    highlightContext = HighlightContextField(required=False)
     highlightTags = ListField(child=serializers.CharField(), required=False)
     storeCrashReports = serializers.IntegerField(
         min_value=-1, max_value=STORE_CRASH_REPORTS_MAX, required=False, allow_null=True

src/sentry/api/serializers/models/project.py

@@ -953,7 +953,7 @@ def serialize(
                 ),
                 "highlightContext": attrs["options"].get(
                     "sentry:highlight_context",
-                    attrs["highlight_preset"].get("context", []),
+                    attrs["highlight_preset"].get("context", {}),
                 ),
                 "groupingConfig": self.get_value_with_default(attrs, "sentry:grouping_config"),
                 "groupingEnhancements": self.get_value_with_default(

src/sentry/issues/highlights.py

@@ -1,30 +1,63 @@
+from collections.abc import Mapping
 from typing import TypedDict
 
+from jsonschema import Draft7Validator
+from jsonschema.exceptions import ValidationError as SchemaValidationError
+from rest_framework import serializers
+from rest_framework.serializers import ValidationError
+
 from sentry.models.project import Project
+from sentry.utils.json import JSONData
 from sentry.utils.platform_categories import BACKEND, FRONTEND, MOBILE
 
+HIGHLIGHT_CONTEXT_SCHEMA: JSONData = {
+    "type": "object",
+    "patternProperties": {"^.*$": {"type": "array", "items": {"type": "string"}}},
+    "additionalProperties": False,
+}
+
+
+class HighlightContextField(serializers.Field):
+    def to_internal_value(self, data):
+        if data is None:
+            return
+
+        if data == "" or data == {} or data == []:
+            return {}
+
+        v = Draft7Validator(HIGHLIGHT_CONTEXT_SCHEMA)
+        try:
+            v.validate(data)
+        except SchemaValidationError as e:
+            raise ValidationError(e.message)
+
+        return data
+
 
 class HighlightPreset(TypedDict):
     tags: list[str]
-    context: list[str]
+    context: Mapping[str, list[str]]
 
 
 SENTRY_TAGS = ["handled", "level", "release", "environment"]
 
 BACKEND_HIGHLIGHTS: HighlightPreset = {
     "tags": SENTRY_TAGS + ["url", "transaction", "status_code"],
-    "context": ["trace", "runtime"],
+    "context": {"trace": ["trace_id"], "runtime": ["name", "version"]},
 }
 FRONTEND_HIGHLIGHTS: HighlightPreset = {
     "tags": SENTRY_TAGS + ["url", "transaction", "browser", "replayId", "user"],
-    "context": ["browser", "state"],
+    "context": {"browser": ["name"], "user": ["email"]},
 }
 MOBILE_HIGHLIGHTS: HighlightPreset = {
     "tags": SENTRY_TAGS + ["mobile", "main_thread"],
-    "context": ["profile", "app", "device"],
+    "context": {"profile": ["profile_id"], "app": ["name"], "device": ["family"]},
 }
 
-FALLBACK_HIGLIGHTS: HighlightPreset = {"tags": SENTRY_TAGS, "context": ["user", "trace"]}
+FALLBACK_HIGLIGHTS: HighlightPreset = {
+    "tags": SENTRY_TAGS,
+    "context": {"user": ["email"], "trace": ["trace_id"]},
+}
 
 
 def get_highlight_preset_for_project(project: Project) -> HighlightPreset:

tests/sentry/api/endpoints/test_project_details.py

@@ -838,17 +838,14 @@ def test_safe_fields(self):
             'Invalid syntax near "er ror" (line 1),\nDeep wildcard used more than once (line 2)',
         ]
 
-    def test_highlights(self):
+    def test_highlight_tags(self):
         # Default with or without flag, ignore update attempt
-        highlight_context = ["red", "robin"]
         highlight_tags = ["bears", "beets", "battlestar_galactica"]
         resp = self.get_success_response(
             self.org_slug,
             self.proj_slug,
-            highlightContext=highlight_context,
             highlightTags=highlight_tags,
         )
-        assert self.project.get_option("sentry:highlight_context") is None
         assert self.project.get_option("sentry:highlight_tags") is None
 
         preset = get_highlight_preset_for_project(self.project)
@@ -860,26 +857,60 @@ def test_highlights(self):
             resp = self.get_success_response(
                 self.org_slug,
                 self.proj_slug,
-                highlightContext=highlight_context,
                 highlightTags=highlight_tags,
             )
-            assert self.project.get_option("sentry:highlight_context") == highlight_context
             assert self.project.get_option("sentry:highlight_tags") == highlight_tags
-            assert resp.data["highlightContext"] == highlight_context
             assert resp.data["highlightTags"] == highlight_tags
 
             # Set to empty
             resp = self.get_success_response(
                 self.org_slug,
                 self.proj_slug,
-                highlightContext=[],
                 highlightTags=[],
             )
-            assert self.project.get_option("sentry:highlight_context") == []
             assert self.project.get_option("sentry:highlight_tags") == []
-            assert resp.data["highlightContext"] == []
             assert resp.data["highlightTags"] == []
 
+    def test_highlight_context(self):
+        # Default with or without flag, ignore update attempt
+        highlight_context = {"bird-words": ["red", "robin"]}
+        resp = self.get_success_response(
+            self.org_slug,
+            self.proj_slug,
+            highlightContext=highlight_context,
+        )
+        assert self.project.get_option("sentry:highlight_context") is None
+
+        preset = get_highlight_preset_for_project(self.project)
+        assert resp.data["highlightContext"] == preset["context"]
+
+        with self.feature("organizations:event-tags-tree-ui"):
+            # Set to custom
+            resp = self.get_success_response(
+                self.org_slug,
+                self.proj_slug,
+                highlightContext=highlight_context,
+            )
+            assert self.project.get_option("sentry:highlight_context") == highlight_context
+            assert resp.data["highlightContext"] == highlight_context
+
+            # Set to empty
+            resp = self.get_success_response(
+                self.org_slug,
+                self.proj_slug,
+                highlightContext={},
+            )
+            assert self.project.get_option("sentry:highlight_context") == {}
+            assert resp.data["highlightContext"] == {}
+
+            # Checking schema validation
+            resp = self.get_error_response(
+                self.org_slug,
+                self.proj_slug,
+                highlightContext={"bird-words": ["invalid", 123, "integer"]},
+            )
+            assert "not of type 'string'" in resp.data["highlightContext"][0]
+
     def test_store_crash_reports(self):
         resp = self.get_success_response(self.org_slug, self.proj_slug, storeCrashReports=10)
         assert self.project.get_option("sentry:store_crash_reports") == 10