Moves constants for webhook headers into the common types file, updates tests

Author: GabeVillalobos

src/sentry/integrations/github/webhook_types.py

@@ -2,6 +2,7 @@
 
 GITHUB_WEBHOOK_TYPE_HEADER = "HTTP_X_GITHUB_EVENT"
 GITHUB_WEBHOOK_TYPE_HEADER_KEY = "X-GITHUB-EVENT"
+GITHUB_INSTALLATION_TARGET_ID_HEADER = "X-GITHUB-HOOK-INSTALLATION-TARGET-ID"
 
 
 class GithubWebhookType(StrEnum):

src/sentry/overwatch_webhooks/webhook_forwarder.py

@@ -7,6 +7,7 @@
 from sentry import options
 from sentry.constants import ObjectStatus
 from sentry.integrations.github.webhook_types import (
+    GITHUB_INSTALLATION_TARGET_ID_HEADER,
     GITHUB_WEBHOOK_TYPE_HEADER_KEY,
     GithubWebhookType,
 )
@@ -29,10 +30,6 @@
 }
 
 
-GITHUB_INSTALLATION_TARGET_ID_HEADER = "X-GitHub-Hook-Installation-Target-ID"
-DJANGO_HTTP_GITHUB_INSTALLATION_TARGET_ID_HEADER = "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID"
-
-
 @dataclass(frozen=True)
 class OverwatchOrganizationContext:
     organization_integration: OrganizationIntegration
@@ -166,7 +163,7 @@ def forward_if_applicable(self, event: Mapping[str, Any], headers: Mapping[str,
 
                 raw_app_id = headers.get(
                     GITHUB_INSTALLATION_TARGET_ID_HEADER,
-                ) or headers.get(DJANGO_HTTP_GITHUB_INSTALLATION_TARGET_ID_HEADER)
+                )
                 verbose_log(
                     "overwatch.debug.raw_app_id",
                     extra={"region_name": region_name, "raw_app_id": raw_app_id},

tests/sentry/middleware/integrations/parsers/test_github.py

@@ -351,7 +351,10 @@ def test_overwatch_forwarder(self) -> None:
                 self.path,
                 data={"installation": {"id": "1"}, "action": "created"},
                 content_type="application/json",
-                headers={"x-github-event": GithubWebhookType.PULL_REQUEST.value},
+                headers={
+                    "x-github-event": GithubWebhookType.PULL_REQUEST.value,
+                    "x-github-hook-installation-target-id": "123",
+                },
             )
             parser = GithubRequestParser(
                 request=request,
@@ -379,7 +382,7 @@ def test_overwatch_forwarder(self) -> None:
                 }
             ]
             assert json_body["webhook_body"] == {"installation": {"id": "1"}, "action": "created"}
-
+            assert json_body["app_id"] == 123
             assert json_body["webhook_headers"]["X-Github-Event"] == "pull_request"
             assert json_body["integration_provider"] == "github"
             assert json_body["region"] == "us"
@@ -398,7 +401,10 @@ def test_overwatch_forwarder_missing_region_config(self) -> None:
                 self.path,
                 data={"installation": {"id": "1"}, "action": "created"},
                 content_type="application/json",
-                headers={"x-github-event": GithubWebhookType.PULL_REQUEST.value},
+                headers={
+                    "x-github-event": GithubWebhookType.PULL_REQUEST.value,
+                    "x-github-hook-installation-target-id": "1",
+                },
             )
             parser = GithubRequestParser(
                 request=request,

tests/sentry/overwatch_webhooks/test_webhook_forwarder.py

@@ -6,6 +6,10 @@
 from django.test.utils import override_settings
 
 from sentry.hybridcloud.models.outbox import outbox_context
+from sentry.integrations.github.webhook_types import (
+    GITHUB_INSTALLATION_TARGET_ID_HEADER,
+    GITHUB_WEBHOOK_TYPE_HEADER_KEY,
+)
 from sentry.integrations.models.organization_integration import OrganizationIntegration
 from sentry.overwatch_webhooks.types import (
     DEFAULT_REQUEST_TYPE,
@@ -46,15 +50,15 @@ def test_init_creates_publisher_with_correct_provider(self):
 
     def test_should_forward_to_overwatch_with_valid_events(self):
         for event_action in GITHUB_EVENTS_TO_FORWARD_OVERWATCH:
-            headers = {"HTTP_X_GITHUB_EVENT": event_action}
+            headers = {GITHUB_WEBHOOK_TYPE_HEADER_KEY: event_action}
             assert self.forwarder.should_forward_to_overwatch(headers) is True
 
     def test_should_forward_to_overwatch_with_invalid_events(self):
         invalid_events = [
-            {"HTTP_X_GITHUB_EVENT": "invalid_action"},
-            {"HTTP_X_GITHUB_EVENT": "create"},
-            {"HTTP_X_GITHUB_EVENT": "delete"},
-            {"HTTP_X_GITHUB_EVENT": "some_other_action"},
+            {GITHUB_WEBHOOK_TYPE_HEADER_KEY: "invalid_action"},
+            {GITHUB_WEBHOOK_TYPE_HEADER_KEY: "create"},
+            {GITHUB_WEBHOOK_TYPE_HEADER_KEY: "delete"},
+            {GITHUB_WEBHOOK_TYPE_HEADER_KEY: "some_other_action"},
             {},
         ]
 
@@ -128,7 +132,9 @@ def test_forward_if_applicable_no_organizations(self):
         event = {"action": "push", "data": "test"}
 
         with patch.object(OverwatchWebhookPublisher, "enqueue_webhook") as mock_enqueue:
-            self.forwarder.forward_if_applicable(event, headers={"HTTP_X_GITHUB_EVENT": "push"})
+            self.forwarder.forward_if_applicable(
+                event, headers={GITHUB_WEBHOOK_TYPE_HEADER_KEY: "push"}
+            )
             mock_enqueue.assert_not_called()
 
     @override_options({"overwatch.enabled-regions": ["us"]})
@@ -143,7 +149,7 @@ def test_forward_if_applicable_event_not_eligible_for_forwarding(self):
 
         with patch.object(OverwatchWebhookPublisher, "enqueue_webhook") as mock_enqueue:
             self.forwarder.forward_if_applicable(
-                event, headers={"HTTP_X_GITHUB_EVENT": "invalid_action"}
+                event, headers={GITHUB_WEBHOOK_TYPE_HEADER_KEY: "invalid_action"}
             )
             mock_enqueue.assert_not_called()
 
@@ -161,8 +167,8 @@ def test_forward_if_applicable_successful_forwarding(self):
             self.forwarder.forward_if_applicable(
                 event,
                 headers={
-                    "HTTP_X_GITHUB_EVENT": "pull_request",
-                    "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                    GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                    GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
                 },
             )
 
@@ -188,7 +194,7 @@ def test_forward_if_applicable_multiple_organizations(self):
 
         with patch.object(OverwatchWebhookPublisher, "enqueue_webhook") as mock_enqueue:
             self.forwarder.forward_if_applicable(
-                event, headers={"HTTP_X_GITHUB_EVENT": "pull_request"}
+                event, headers={GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request"}
             )
 
             mock_enqueue.assert_called_once()
@@ -213,7 +219,7 @@ def test_forward_if_applicable_all_valid_event_actions(self):
 
             with patch.object(OverwatchWebhookPublisher, "enqueue_webhook") as mock_enqueue:
                 self.forwarder.forward_if_applicable(
-                    event, headers={"HTTP_X_GITHUB_EVENT": event_type}
+                    event, headers={GITHUB_WEBHOOK_TYPE_HEADER_KEY: event_type}
                 )
                 mock_enqueue.assert_called_once()
 
@@ -246,7 +252,7 @@ def test_forward_if_applicable_preserves_webhook_body_data(self):
 
         with patch.object(OverwatchWebhookPublisher, "enqueue_webhook") as mock_enqueue:
             self.forwarder.forward_if_applicable(
-                complex_event, headers={"HTTP_X_GITHUB_EVENT": "pull_request"}
+                complex_event, headers={GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request"}
             )
 
             mock_enqueue.assert_called_once()
@@ -294,8 +300,8 @@ def test_forwards_to_correct_regions(self):
         self.forwarder.forward_if_applicable(
             event,
             headers={
-                "HTTP_X_GITHUB_EVENT": "pull_request",
-                "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
             },
         )
 
@@ -319,8 +325,8 @@ def test_forwards_to_correct_regions(self):
             ],
             "webhook_body": event,
             "webhook_headers": {
-                "HTTP_X_GITHUB_EVENT": "pull_request",
-                "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
             },
             "integration_provider": "github",
             "region": "us",
@@ -342,8 +348,8 @@ def test_forwards_to_correct_regions(self):
             ],
             "webhook_body": event,
             "webhook_headers": {
-                "HTTP_X_GITHUB_EVENT": "pull_request",
-                "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
             },
             "integration_provider": "github",
             "region": "de",
@@ -385,8 +391,8 @@ def test_forwards_conditionally_to_some_regions(self):
         self.forwarder.forward_if_applicable(
             event,
             headers={
-                "HTTP_X_GITHUB_EVENT": "pull_request",
-                "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
             },
         )
 
@@ -407,8 +413,8 @@ def test_forwards_conditionally_to_some_regions(self):
             ],
             "webhook_body": event,
             "webhook_headers": {
-                "HTTP_X_GITHUB_EVENT": "pull_request",
-                "HTTP_X_GITHUB_HOOK_INSTALLATION_TARGET_ID": "987654",
+                GITHUB_WEBHOOK_TYPE_HEADER_KEY: "pull_request",
+                GITHUB_INSTALLATION_TARGET_ID_HEADER: "987654",
             },
             "integration_provider": "github",
             "region": "us",