feat(replays): Add replay.analyzer_service_url option (#59109)

Author: cmanallen

src/sentry/conf/server.py

@@ -1703,6 +1703,8 @@ def custom_parameter_sort(parameter: dict) -> tuple[str, int]:
     "organizations:session-replay-new-event-counts": False,
     # Enable the Replay Details > New timeline
     "organizations:session-replay-new-timeline": False,
+    # Enable the accessibility issues endpoint
+    "organizations:session-replay-accessibility-issues": False,
     # Enable the new suggested assignees feature
     "organizations:streamline-targeting-context": False,
     # Enable the new experimental starfish view

src/sentry/features/__init__.py

@@ -210,6 +210,7 @@
 default_manager.add("organizations:session-replay-new-event-counts", OrganizationFeature, FeatureHandlerStrategy.REMOTE)
 default_manager.add("organizations:session-replay-weekly-email", OrganizationFeature, FeatureHandlerStrategy.INTERNAL)
 default_manager.add("organizations:session-replay-new-timeline", OrganizationFeature, FeatureHandlerStrategy.REMOTE)
+default_manager.add("organizations:session-replay-accessibility-issues", OrganizationFeature, FeatureHandlerStrategy.REMOTE)
 default_manager.add("organizations:set-grouping-config", OrganizationFeature, FeatureHandlerStrategy.INTERNAL)
 default_manager.add("organizations:slack-overage-notifications", OrganizationFeature, FeatureHandlerStrategy.REMOTE)
 default_manager.add("organizations:sdk-crash-detection", OrganizationFeature, FeatureHandlerStrategy.INTERNAL)

src/sentry/options/defaults.py

@@ -381,6 +381,12 @@
     default=0,
     flags=FLAG_ALLOW_EMPTY | FLAG_PRIORITIZE_DISK | FLAG_AUTOMATOR_MODIFIABLE,
 )
+# Replay Analyzer service.
+register(
+    "replay.analyzer_service_url",
+    default=None,
+    flags=FLAG_ALLOW_EMPTY | FLAG_PRIORITIZE_DISK | FLAG_AUTOMATOR_MODIFIABLE,
+)
 
 # Analytics
 register("analytics.backend", default="noop", flags=FLAG_NOSTORE)

src/sentry/replays/endpoints/project_replay_accessibility_issues.py

@@ -4,12 +4,12 @@
 import uuid
 from typing import Any
 
-# import requests
-# from rest_framework.exceptions import ParseError
+import requests
+from rest_framework.exceptions import ParseError
 from rest_framework.request import Request
 from rest_framework.response import Response
 
-from sentry import features
+from sentry import features, options
 from sentry.api.api_owners import ApiOwner
 from sentry.api.api_publish_status import ApiPublishStatus
 from sentry.api.base import region_silo_endpoint
@@ -37,6 +37,13 @@ def get(self, request: Request, project: Project, replay_id: str) -> Response:
         ):
             return Response(status=404)
 
+        if not features.has(
+            "organizations:session-replay-accessibility-issues",
+            project.organization,
+            actor=request.user,
+        ):
+            return Response(status=404)
+
         try:
             replay_id = str(uuid.UUID(replay_id))
         except ValueError:
@@ -78,53 +85,11 @@ def get_result(self, limit, cursor=None):
 
 
 def request_accessibility_issues(filenames: list[str]) -> Any:
-    # TODO: Remove this once the service is ready.
-    return {
-        "meta": {"total": 1},
-        "data": [
-            {
-                "elements": [
-                    {
-                        "alternatives": [
-                            {
-                                "id": "button-has-visible-text",
-                                "message": "Element does not have inner text that is visible to screen readers",
-                            },
-                            {
-                                "id": "aria-label",
-                                "message": "aria-label attribute does not exist or is empty",
-                            },
-                            {
-                                "id": "aria-labelledby",
-                                "message": "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
-                            },
-                            {
-                                "id": "non-empty-title",
-                                "message": "Element has no title attribute",
-                            },
-                            {
-                                "id": "presentational-role",
-                                "message": 'Element\'s default semantics were not overridden with role="none" or role="presentation"',
-                            },
-                        ],
-                        "element": '<button class="svelte-19ke1iv">',
-                        "target": ["button:nth-child(1)"],
-                    }
-                ],
-                "help_url": "https://dequeuniversity.com/rules/axe/4.8/button-name?application=playwright",
-                "help": "Buttons must have discernible text",
-                "id": "button-name",
-                "impact": "critical",
-                "timestamp": 1695967678108,
-            }
-        ],
-    }
-    # TODO: When the service is deploy this should be the primary path.
-    # try:
-    #     return requests.post(
-    #         "/api/0/analyze/accessibility",
-    #         json={"data": {"filenames": filenames}},
-    #     ).json()
-    # except Exception:
-    #     logger.exception("replay accessibility analysis failed")
-    #     raise ParseError("Could not analyze accessibility issues at this time.")
+    try:
+        return requests.post(
+            f"{options.get('replay.analyzer_service_url')}/api/0/analyze/accessibility",
+            json={"data": {"filenames": filenames}},
+        ).json()
+    except Exception:
+        logger.exception("replay accessibility analysis failed")
+        raise ParseError("Could not analyze accessibility issues at this time.")

tests/sentry/replays/test_project_replay_accessibility_issues.py

@@ -8,7 +8,10 @@
 from sentry.testutils.cases import APITestCase, ReplaysSnubaTestCase
 from sentry.testutils.silo import region_silo_test
 
-REPLAYS_FEATURES = {"organizations:session-replay": True}
+REPLAYS_FEATURES = {
+    "organizations:session-replay": True,
+    "organizations:session-replay-accessibility-issues": True,
+}
 
 
 @region_silo_test(stable=True)