Wrap raw response with data key and provide the headers

Author: cmanallen

src/sentry/scm/private/providers/github.py

@@ -712,7 +712,7 @@ def get_pull_request_diff(
         return {
             "data": response.text,
             "type": "github",
-            "raw": response.text,
+            "raw": {"data": response.text, "headers": response.headers},
             "meta": _extract_response_meta(response),
         }
 
@@ -933,7 +933,7 @@ def get_archive_link(
         return {
             "data": ArchiveLink(url=response.headers["Location"], headers={}),
             "type": "github",
-            "raw": response.headers["Location"],
+            "raw": {"data": response.headers["Location"], "headers": response.headers},
             "meta": _extract_response_meta(response),
         }
 
@@ -1125,7 +1125,7 @@ def map_action[T](
     return {
         "data": fn(raw),
         "type": "github",
-        "raw": raw,
+        "raw": {"data": raw, "headers": response.headers},
         "meta": _extract_response_meta(response),
     }
 
@@ -1143,6 +1143,6 @@ def map_paginated_action[T](
     return {
         "data": fn(raw),
         "type": "github",
-        "raw": raw,
+        "raw": {"data": raw, "headers": response.headers},
         "meta": meta,
     }

src/sentry/scm/private/providers/gitlab.py

@@ -354,7 +354,7 @@ def get_tree(
                 truncated=False,
             ),
             type="gitlab",
-            raw=raw,
+            raw={"data": raw, "headers": None},
             meta={},
         )
 
@@ -390,7 +390,7 @@ def get_archive_link(
         return ActionResult(
             data=data,
             type="gitlab",
-            raw=url,
+            raw={"data": url, "headers": None},
             meta={},
         )
 
@@ -597,7 +597,7 @@ def make_paginated_result[T](
     return PaginatedActionResult(
         data=[map_item(item) for item in raw_items],
         type="gitlab",
-        raw=raw,
+        raw={"data": raw, "headers": None},
         # No actual pagination for now
         meta=PaginatedResponseMeta(next_cursor=None),
     )
@@ -615,7 +615,7 @@ def make_result[T](
     return ActionResult(
         data=map_item(raw_item),
         type="gitlab",
-        raw=raw,
+        raw={"data": raw, "headers": None},
         meta={},
     )
 

src/sentry/scm/types.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, Literal, Protocol, Required, TypedDict, runtime_checkable
+from typing import Any, Literal, MutableMapping, Protocol, Required, TypedDict, runtime_checkable
 
 type Action = Literal["check_run", "comment", "pull_request"]
 type EventType = "CheckRunEvent" | "CommentEvent" | "PullRequestEvent"
@@ -217,6 +217,11 @@ class PullRequest(TypedDict):
     base: PullRequestBranch
 
 
+class RawResult(TypedDict):
+    headers: MutableMapping[str, str] | None
+    data: Any
+
+
 class ActionResult[T](TypedDict):
     """Wraps a provider response with metadata and the original API payload.
 
@@ -230,7 +235,7 @@ class ActionResult[T](TypedDict):
 
     data: T
     type: ProviderName
-    raw: Any
+    raw: RawResult
     meta: ResponseMeta
 
 
@@ -244,7 +249,7 @@ class PaginatedActionResult[T](TypedDict):
 
     data: list[T]
     type: ProviderName
-    raw: Any
+    raw: RawResult
     meta: PaginatedResponseMeta
 
 

tests/sentry/scm/unit/test_github_provider.py

@@ -178,26 +178,6 @@ def make_provider(client: RecordingClient | None = None) -> tuple[GitHubProvider
     return provider, transport
 
 
-def assert_action_result(result: Any, *, expected_data: Any, raw: Any) -> None:
-    assert result["type"] == "github"
-    assert result["raw"] == raw
-    assert result["data"] == expected_data
-    assert result["meta"] == {}
-
-
-def assert_paginated_result(
-    result: Any,
-    *,
-    expected_data: Any,
-    raw: Any,
-    next_cursor: str,
-) -> None:
-    assert result["type"] == "github"
-    assert result["raw"] == raw
-    assert result["data"] == expected_data
-    assert result["meta"] == {"next_cursor": next_cursor}
-
-
 def expected_comment(raw: dict[str, Any]) -> dict[str, Any]:
     return {
         "id": str(raw["id"]),
@@ -857,12 +837,11 @@ def test_paginated_methods(case: dict[str, Any]) -> None:
 
     result = getattr(provider, case["name"])(**case["kwargs"])
 
-    assert_paginated_result(
-        result,
-        expected_data=case["expected_data"],
-        raw=case["raw"],
-        next_cursor=case["next_cursor"],
-    )
+    assert result["type"] == "github"
+    assert result["raw"] == {"data": case["raw"], "headers": {}}
+    assert result["data"] == case["expected_data"]
+    assert result["meta"] == {"next_cursor": case["next_cursor"]}
+
     assert client.calls == [
         {
             "operation": "get",
@@ -885,7 +864,11 @@ def test_action_methods(case: dict[str, Any]) -> None:
 
     result = getattr(provider, case["name"])(**case["kwargs"])
 
-    assert_action_result(result, expected_data=case["expected_data"], raw=case["raw"])
+    assert result["type"] == "github"
+    assert result["raw"] == {"data": case["raw"], "headers": case.get("headers", {})}
+    assert result["data"] == case["expected_data"]
+    assert result["meta"] == {}
+
     expected_call = {"operation": case["operation"], "path": case["path"]}
     if "data" in case:
         expected_call["data"] = case["data"]
@@ -916,7 +899,13 @@ def test_get_pull_request_diff_uses_raw_request_and_extracts_meta() -> None:
     result = provider.get_pull_request_diff("42")
 
     assert result["type"] == "github"
-    assert result["raw"] == "diff --git a/f.py b/f.py"
+    assert result["raw"] == {
+        "data": "diff --git a/f.py b/f.py",
+        "headers": {
+            "ETag": '"etag-123"',
+            "Last-Modified": "Tue, 04 Feb 2026 10:00:00 GMT",
+        },
+    }
     assert result["data"] == "diff --git a/f.py b/f.py"
     assert result["meta"]["etag"] == '"etag-123"'
     assert result["meta"]["last_modified"].isoformat() == "2026-02-04T10:00:00+00:00"