Add method 'get_repository' (#2)

This replaces getsentry/sentry#112569 and
getsentry/seer#5688.

Author: jacquev6

src/scm/actions.py

@@ -54,10 +54,12 @@
     GetPullRequestProtocol,
     GetPullRequestReactionsProtocol,
     GetPullRequestsProtocol,
+    GetRepositoryProtocol,
     GetTreeProtocol,
     GitBlob,
     GitCommitObject,
     GitRef,
+    GitRepository,
     GitTree,
     InputTreeEntry,
     MinimizeCommentProtocol,
@@ -83,6 +85,11 @@
 )
 
 
+def get_repository(scm: GetRepositoryProtocol) -> ActionResult[GitRepository]:
+    """Get the repository associated with this SourceCodeManager."""
+    return scm.get_repository()
+
+
 def get_issue_comments(
     scm: GetIssueCommentsProtocol,
     issue_id: str,

src/scm/providers/github/provider.py

@@ -35,6 +35,7 @@
     GitCommitObject,
     GitCommitTree,
     GitRef,
+    GitRepository,
     GitTree,
     InputTreeEntry,
     PaginatedActionResult,
@@ -302,6 +303,10 @@ def graphql(
 
         return response_data.get("data", {})
 
+    def get_repository(self) -> ActionResult[GitRepository]:
+        response = self.get(f"/repos/{self.repository['name']}")
+        return map_action(response, map_repository)
+
     def get_issue_comments(
         self,
         issue_id: str,
@@ -1064,6 +1069,16 @@ def map_pull_request(raw: dict[str, Any]) -> PullRequest:
     )
 
 
+def map_repository(raw: dict[str, Any]) -> GitRepository:
+    return GitRepository(
+        full_name=raw["full_name"],
+        default_branch=raw["default_branch"],
+        clone_url=raw["clone_url"],
+        private=raw["private"],
+        size=raw["size"],
+    )
+
+
 def map_action[T](response: requests.Response, fn: Callable[[dict[str, Any]], T]) -> ActionResult[T]:
     raw = response.json()
     return {

src/scm/providers/gitlab/provider.py

@@ -20,6 +20,7 @@
     GitCommitObject,
     GitCommitTree,
     GitRef,
+    GitRepository,
     GitTree,
     PaginatedActionResult,
     PaginatedResponseMeta,
@@ -222,6 +223,10 @@ def patch(
     def delete(self, path: str) -> requests.Response:
         return self._request("DELETE", path=path)
 
+    def get_repository(self) -> ActionResult[GitRepository]:
+        response = self.get(GitLab.project.format(project=self.project_id), params={"statistics": "true"})
+        return make_result(map_repository, response.json())
+
     def get_issue_comments(
         self,
         issue_id: str,
@@ -874,6 +879,19 @@ def map_pull_request_file(raw: dict[str, Any]) -> PullRequestFile:
     )
 
 
+def map_repository(raw: dict[str, Any]) -> GitRepository:
+    statistics = raw.get("statistics")
+    repo_size = statistics.get("repository_size", 0) if statistics else 0
+    return GitRepository(
+        full_name=raw["path_with_namespace"],
+        default_branch=raw.get("default_branch"),
+        clone_url=raw["http_url_to_repo"],
+        private=raw["visibility"] != "public",
+        # GitLab returns size in bytes. We convert to kB to match GitHub
+        size=repo_size // 1000,
+    )
+
+
 def map_reaction_result(raw: dict[str, Any]) -> ReactionResult:
     return ReactionResult(
         id=str(raw["id"]),

src/scm/types.py

@@ -264,6 +264,16 @@ class Repository(TypedDict):
     provider_name: ProviderName
 
 
+class GitRepository(TypedDict):
+    """Information about a git repository at an SCM provider."""
+
+    full_name: str
+    default_branch: str | None
+    clone_url: str
+    private: bool
+    size: int
+
+
 class GitRef(TypedDict):
     """A git reference (branch pointer)."""
 
@@ -460,6 +470,14 @@ class PullRequestEventData(TypedDict):
     author: Author | None
 
 
+# Basic protocols
+
+
+@runtime_checkable
+class GetRepositoryProtocol(Protocol):
+    def get_repository(self) -> ActionResult[GitRepository]: ...
+
+
 # Issue Comment Protocols
 
 
@@ -986,6 +1004,7 @@ def resolve_review_thread(self, thread_node_id: str) -> None: ...
     GetPullRequestProtocol,
     GetPullRequestReactionsProtocol,
     GetPullRequestsProtocol,
+    GetRepositoryProtocol,
     GetTreeProtocol,
     MinimizeCommentProtocol,
     RequestReviewProtocol,

tests/test_fixtures.py

@@ -44,6 +44,17 @@
 )
 
 
+def make_github_repository() -> dict[str, Any]:
+    """Factory for GitHub repository API responses."""
+    return {
+        "full_name": "test-org/test-repo",
+        "default_branch": "main",
+        "clone_url": "https://github.com/test-org/test-repo.git",
+        "private": False,
+        "size": 1234,
+    }
+
+
 def make_github_comment(
     comment_id: int = 1,
     body: str = "Test comment",

tests/unit/provider/test_github.py

@@ -26,6 +26,7 @@
     make_github_pull_request_commit,
     make_github_pull_request_file,
     make_github_reaction,
+    make_github_repository,
     make_github_review,
     make_github_review_comment,
 )
@@ -182,6 +183,16 @@ def make_provider(client: RecordingClient | None = None) -> tuple[GitHubProvider
     return provider, transport
 
 
+def expected_repository(raw: dict[str, Any]) -> dict[str, Any]:
+    return {
+        "full_name": raw["full_name"],
+        "default_branch": raw["default_branch"],
+        "clone_url": raw["clone_url"],
+        "private": raw["private"],
+        "size": raw["size"],
+    }
+
+
 def expected_comment(raw: dict[str, Any]) -> dict[str, Any]:
     return {
         "id": str(raw["id"]),
@@ -331,6 +342,7 @@ def expected_check_run(raw: dict[str, Any]) -> dict[str, Any]:
     }
 
 
+REPOSITORY_RAW = make_github_repository()
 COMMENT_RAW = make_github_comment()
 REACTION_RAW = make_github_reaction()
 PULL_REQUEST_RAW = make_github_pull_request()
@@ -459,6 +471,14 @@ def expected_check_run(raw: dict[str, Any]) -> dict[str, Any]:
 
 ACTION_CASES: list[dict[str, Any]] = [
     {
+        "name": "get_repository",
+        "operation": "get",
+        "kwargs": {},
+        "path": "/repos/test-org/test-repo",
+        "raw": REPOSITORY_RAW,
+        "expected_data": expected_repository(REPOSITORY_RAW),
+    },
+     {
         "name": "create_issue_comment",
         "operation": "post",
         "kwargs": {"issue_id": "42", "body": "hello"},

tests/unit/provider/test_gitlab.py

@@ -56,6 +56,45 @@ def _make_mock_response(json_data):
 @pytest.mark.parametrize(
     "param",
     [
+        ForwardToClientTest(
+            provider_method=GitLabProvider.get_repository,
+            provider_args={},
+            client_calls=[
+                ClientForwardedCall(
+                    method="GET",
+                    path="/projects/79787061",
+                    params={"statistics": "true"},
+                    json_response={
+                        "path_with_namespace": "test-org/test-repo",
+                        "default_branch": "main",
+                        "http_url_to_repo": "https://gitlab.com/test-org/test-repo.git",
+                        "visibility": "public",
+                        "statistics": {"repository_size": 123456},
+                    },
+                ),
+            ],
+            provider_return_value={
+                "data": {
+                    "full_name": "test-org/test-repo",
+                    "default_branch": "main",
+                    "clone_url": "https://gitlab.com/test-org/test-repo.git",
+                    "private": False,
+                    "size": 123,  # Size converted from bytes to kB
+                },
+                "type": "gitlab",
+                "raw": {
+                    "data": {
+                        "path_with_namespace": "test-org/test-repo",
+                        "default_branch": "main",
+                        "http_url_to_repo": "https://gitlab.com/test-org/test-repo.git",
+                        "visibility": "public",
+                        "statistics": {"repository_size": 123456},
+                    },
+                    "headers": None,
+                },
+                "meta": {},
+            },
+        ),
         # Actual calls made with an actual GitLab integration, captured for this file.
         ForwardToClientTest(
             provider_method=GitLabProvider.get_pull_requests,

tests/unit/test_rpc_integration.py

@@ -30,6 +30,7 @@
     make_github_pull_request_commit,
     make_github_pull_request_file,
     make_github_reaction,
+    make_github_repository,
     make_github_review,
     make_github_review_comment,
 )
@@ -128,6 +129,13 @@ def make_client_scm(organization_id, repository_id, server):
 # Each entry: (action_name, action_callable, mock_response_body, status_code, extra_headers)
 # action_callable receives the scm instance and calls the action with appropriate args.
 ACTION_TEST_CASES: list[tuple[str, Callable, dict | list | str, int, dict[str, str] | None]] = [
+    (
+        "get_repository",
+        lambda scm: actions.get_repository(scm),
+        make_github_repository(),
+        200,
+        None,
+    ),
     # Pull request operations
     (
         "get_pull_request",