fix(eco): Fixes webhook forwarding logic to use headers in the correct format

Author: GabeVillalobos

src/sentry/integrations/github/webhook_types.py

@@ -1,6 +1,7 @@
 from enum import StrEnum
 
 GITHUB_WEBHOOK_TYPE_HEADER = "HTTP_X_GITHUB_EVENT"
+GITHUB_WEBHOOK_TYPE_HEADER_KEY = "X-GITHUB-EVENT"
 
 
 class GithubWebhookType(StrEnum):

src/sentry/middleware/integrations/parsers/github.py

@@ -106,7 +106,7 @@ def get_response(self) -> HttpResponseBase:
 
         # The overwatch forwarder implements its own region-based checks
         OverwatchGithubWebhookForwarder(integration=integration).forward_if_applicable(
-            event=event, headers=self.request.META
+            event=event, headers=self.request.headers
         )
 
         return response

src/sentry/overwatch_webhooks/webhook_forwarder.py

@@ -6,7 +6,10 @@
 
 from sentry import options
 from sentry.constants import ObjectStatus
-from sentry.integrations.github.webhook_types import GITHUB_WEBHOOK_TYPE_HEADER, GithubWebhookType
+from sentry.integrations.github.webhook_types import (
+    GITHUB_WEBHOOK_TYPE_HEADER_KEY,
+    GithubWebhookType,
+)
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.models.organization_integration import OrganizationIntegration
 from sentry.models.organizationmapping import OrganizationMapping
@@ -51,7 +54,7 @@ def __init__(self, integration: Integration):
         self.integration = integration
 
     def should_forward_to_overwatch(self, headers: Mapping[str, str]) -> bool:
-        event_type = headers.get(GITHUB_WEBHOOK_TYPE_HEADER)
+        event_type = headers.get(GITHUB_WEBHOOK_TYPE_HEADER_KEY)
         verbose_log(
             "overwatch.debug.should_forward_to_overwatch.checked",
             extra={
@@ -179,10 +182,12 @@ def forward_if_applicable(self, event: Mapping[str, Any], headers: Mapping[str,
                         )
                         app_id = None
 
+                formatted_headers = {k: v for k, v in headers.items()}
+
                 webhook_detail = WebhookDetails(
                     organizations=org_summaries,
                     webhook_body=dict(event),
-                    webhook_headers=headers,
+                    webhook_headers=formatted_headers,
                     integration_provider=self.integration.provider,
                     region=region_name,
                     app_id=app_id,

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

@@ -1,3 +1,4 @@
+import orjson
 import pytest
 import responses
 from django.db import router, transaction
@@ -17,7 +18,7 @@
 from sentry.testutils.helpers.options import override_options
 from sentry.testutils.outbox import assert_no_webhook_payloads, assert_webhook_payloads_for_mailbox
 from sentry.testutils.region import override_regions
-from sentry.testutils.silo import control_silo_test
+from sentry.testutils.silo import control_silo_test, create_test_regions
 from sentry.types.region import Region, RegionCategory
 
 region = Region("us", 1, "https://us.testserver", RegionCategory.MULTI_TENANT)
@@ -304,3 +305,109 @@ class GithubRequestParserTypeRoutingTest(GithubRequestParserTest):
     def setup(self):
         with override_options({"github.webhook-type-routing.enabled": True}):
             yield
+
+
+@control_silo_test(regions=create_test_regions("us"))
+class GithubRequestParserOverwatchForwarderTest(TestCase):
+    factory = RequestFactory()
+    path = reverse("sentry-integration-github-webhook")
+
+    @pytest.fixture(autouse=True)
+    def setup(self):
+        with override_options({"github.webhook-type-routing.enabled": True}):
+            yield
+
+    def setUp(self) -> None:
+        super().setUp()
+        self.organization = self.create_organization(
+            name="Test Org",
+            slug="test-org",
+            region="us",
+            owner=self.create_user(email="test@example.com"),
+        )
+        self.integration = self.create_integration(
+            provider="github",
+            external_id="1",
+            name="Test Integration",
+            organization=self.organization,
+        )
+
+    @responses.activate
+    def test_overwatch_forwarder(self) -> None:
+        with (
+            override_options({"overwatch.enabled-regions": ["us"]}),
+            override_settings(
+                OVERWATCH_REGION_URLS={"us": "https://us.example.com/api"},
+                OVERWATCH_WEBHOOK_SECRET="test-secret",
+            ),
+        ):
+            responses.add(
+                responses.POST,
+                "https://us.example.com/api/webhooks/sentry",
+                status=200,
+            )
+
+            request = self.factory.post(
+                self.path,
+                data={"installation": {"id": "1"}, "action": "created"},
+                content_type="application/json",
+                headers={"x-github-event": GithubWebhookType.PULL_REQUEST.value},
+            )
+            parser = GithubRequestParser(
+                request=request,
+                response_handler=lambda _: HttpResponse(status=200, content="passthrough"),
+            )
+
+            response = parser.get_response()
+            assert isinstance(response, HttpResponse)
+            assert response.status_code == status.HTTP_202_ACCEPTED
+            assert response.content == b""
+
+            assert len(responses.calls) == 1
+            assert responses.calls[0].request.url == "https://us.example.com/api/webhooks/sentry"
+            assert responses.calls[0].request.method == "POST"
+            json_body = orjson.loads(responses.calls[0].request.body)
+
+            assert json_body["organizations"] == [
+                {
+                    "name": "Test Org",
+                    "slug": "test-org",
+                    "id": self.organization.id,
+                    "region": "us",
+                    "github_integration_id": self.integration.id,
+                    "organization_integration_id": self.organization_integration.id,
+                }
+            ]
+            assert json_body["webhook_body"] == {"installation": {"id": "1"}, "action": "created"}
+
+            assert json_body["webhook_headers"]["X-Github-Event"] == "pull_request"
+            assert json_body["integration_provider"] == "github"
+            assert json_body["region"] == "us"
+            assert json_body["event_type"] == "github"
+
+    @responses.activate
+    def test_overwatch_forwarder_missing_region_config(self) -> None:
+        with (
+            override_options({"overwatch.enabled-regions": ["us"]}),
+            override_settings(
+                OVERWATCH_REGION_URLS={"de": "https://de.example.com/api"},
+                OVERWATCH_WEBHOOK_SECRET="test-secret",
+            ),
+        ):
+            request = self.factory.post(
+                self.path,
+                data={"installation": {"id": "1"}, "action": "created"},
+                content_type="application/json",
+                headers={"x-github-event": GithubWebhookType.PULL_REQUEST.value},
+            )
+            parser = GithubRequestParser(
+                request=request,
+                response_handler=lambda _: HttpResponse(status=200, content="passthrough"),
+            )
+
+            response = parser.get_response()
+            assert isinstance(response, HttpResponse)
+            assert response.status_code == status.HTTP_202_ACCEPTED
+            assert response.content == b""
+
+            assert len(responses.calls) == 0