ref: CommitContextClient methods accept repository instance

Author: jianyuan

src/sentry/integrations/github/client.py

@@ -227,7 +227,7 @@ def get_commit(self, repo: str, sha: str) -> Any:
         """
         return self.get_cached(f"/repos/{repo}/commits/{sha}")
 
-    def get_merge_commit_sha_from_commit(self, repo: str, sha: str) -> str | None:
+    def get_merge_commit_sha_from_commit(self, repo: Repository, sha: str) -> str | None:
         """
         Get the merge commit sha from a commit sha.
         """
@@ -246,21 +246,21 @@ def get_merge_commit_sha_from_commit(self, repo: str, sha: str) -> str | None:
 
         return pull_request.get("merge_commit_sha")
 
-    def get_pullrequest_from_commit(self, repo: str, sha: str) -> Any:
+    def get_pullrequest_from_commit(self, repo: Repository, sha: str) -> Any:
         """
         https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit
 
         Returns the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
         """
-        return self.get(f"/repos/{repo}/commits/{sha}/pulls")
+        return self.get(f"/repos/{repo.name}/commits/{sha}/pulls")
 
-    def get_pullrequest_files(self, repo: str, pull_number: str) -> Any:
+    def get_pullrequest_files(self, repo: Repository, pull_number: str) -> Any:
         """
         https://docs.github.com/en/rest/pulls/pulls#list-pull-requests-files
 
         Returns up to 30 files associated with a pull request. Responses are paginated.
         """
-        return self.get(f"/repos/{repo}/pulls/{pull_number}/files")
+        return self.get(f"/repos/{repo.name}/pulls/{pull_number}/files")
 
     def get_repo(self, repo: str) -> Any:
         """
@@ -419,17 +419,17 @@ def create_issue(self, repo: str, data: Mapping[str, Any]) -> Any:
         endpoint = f"/repos/{repo}/issues"
         return self.post(endpoint, data=data)
 
-    def create_comment(self, repo: str, issue_id: str, data: Mapping[str, Any]) -> Any:
+    def create_comment(self, repo: Repository, issue_id: str, data: Mapping[str, Any]) -> Any:
         """
         https://docs.github.com/en/rest/issues/comments#create-an-issue-comment
         """
-        endpoint = f"/repos/{repo}/issues/{issue_id}/comments"
+        endpoint = f"/repos/{repo.name}/issues/{issue_id}/comments"
         return self.post(endpoint, data=data)
 
     def update_comment(
-        self, repo: str, issue_id: str, comment_id: str, data: Mapping[str, Any]
+        self, repo: Repository, issue_id: str, comment_id: str, data: Mapping[str, Any]
     ) -> Any:
-        endpoint = f"/repos/{repo}/issues/comments/{comment_id}"
+        endpoint = f"/repos/{repo.name}/issues/comments/{comment_id}"
         return self.patch(endpoint, data=data)
 
     def get_comment_reactions(self, repo: str, comment_id: str) -> Any:

src/sentry/integrations/github/tasks/open_pr_comment.py

@@ -168,9 +168,7 @@ def safe_for_comment(
 ) -> list[dict[str, str]]:
     logger.info("github.open_pr_comment.check_safe_for_comment")
     try:
-        pr_files = gh_client.get_pullrequest_files(
-            repo=repository.name, pull_number=pull_request.key
-        )
+        pr_files = gh_client.get_pullrequest_files(repo=repository, pull_number=pull_request.key)
     except ApiError as e:
         logger.info("github.open_pr_comment.api_error")
         if e.json and RATE_LIMITED_MESSAGE in e.json.get("message", ""):

src/sentry/integrations/gitlab/client.py

@@ -226,13 +226,16 @@ def create_issue(self, project, data):
         """
         return self.post(GitLabApiClientPath.issues.format(project=project), data=data)
 
-    def create_comment(self, repo: str, issue_id: str, data: dict[str, Any]):
+    def create_comment(self, repo: Repository, issue_id: str, data: dict[str, Any]):
         """Create an issue note/comment
 
         See https://docs.gitlab.com/ee/api/notes.html#create-new-issue-note
         """
         return self.post(
-            GitLabApiClientPath.create_note.format(project=repo, issue_id=issue_id), data=data
+            GitLabApiClientPath.create_note.format(
+                project=repo.config["project_id"], issue_id=issue_id
+            ),
+            data=data,
         )
 
     def update_comment(self, repo: str, issue_id: str, comment_id: str, data: dict[str, Any]):
@@ -309,7 +312,7 @@ def get_commit(self, project_id, sha):
         """
         return self.get_cached(GitLabApiClientPath.commit.format(project=project_id, sha=sha))
 
-    def get_merge_commit_sha_from_commit(self, repo: str, sha: str) -> str | None:
+    def get_merge_commit_sha_from_commit(self, repo: Repository, sha: str) -> str | None:
         raise IntegrationFeatureNotImplementedError
 
     def compare_commits(self, project_id, start_sha, end_sha):

src/sentry/integrations/source_code_management/commit_context.py

@@ -190,7 +190,7 @@ def queue_comment_task_if_needed(
             try:
                 client = self.get_client()
                 merge_commit_sha = client.get_merge_commit_sha_from_commit(
-                    repo=repo.name, sha=commit.key
+                    repo=repo, sha=commit.key
                 )
             except Exception as e:
                 sentry_sdk.capture_exception(e)
@@ -303,7 +303,7 @@ def create_or_update_comment(
         ).capture():
             if pr_comment is None:
                 resp = client.create_comment(
-                    repo=repo.name,
+                    repo=repo,
                     issue_id=str(pr_key),
                     data=(
                         {
@@ -338,7 +338,7 @@ def create_or_update_comment(
                     )
             else:
                 resp = client.update_comment(
-                    repo=repo.name,
+                    repo=repo,
                     issue_id=str(pr_key),
                     comment_id=pr_comment.external_id,
                     data=(

tests/sentry/integrations/github/test_client.py

@@ -306,7 +306,7 @@ def test_update_comment(self, get_jwt):
                 "author_association": "COLLABORATOR",
             },
         )
-        self.github_client.create_comment(repo=self.repo.name, issue_id="1", data={"body": "hello"})
+        self.github_client.create_comment(repo=self.repo, issue_id="1", data={"body": "hello"})
 
         responses.add(
             method=responses.PATCH,
@@ -325,7 +325,7 @@ def test_update_comment(self, get_jwt):
         )
 
         self.github_client.update_comment(
-            repo=self.repo.name, issue_id="1", comment_id="1", data={"body": "world"}
+            repo=self.repo, issue_id="1", comment_id="1", data={"body": "world"}
         )
         assert responses.calls[1].response.status_code == 200
         assert responses.calls[1].request.body == b'{"body": "world"}'
@@ -364,9 +364,7 @@ def test_get_merge_commit_sha_from_commit(self, get_jwt):
             json=pull_requests,
         )
 
-        sha = self.github_client.get_merge_commit_sha_from_commit(
-            repo=self.repo.name, sha=commit_sha
-        )
+        sha = self.github_client.get_merge_commit_sha_from_commit(repo=self.repo, sha=commit_sha)
         assert sha == merge_commit_sha
 
     @mock.patch("sentry.integrations.github.client.get_jwt", return_value="jwt_token_1")
@@ -381,9 +379,7 @@ def test_get_merge_commit_sha_from_commit_open_pr(self, get_jwt):
             json=pull_requests,
         )
 
-        sha = self.github_client.get_merge_commit_sha_from_commit(
-            repo=self.repo.name, sha=commit_sha
-        )
+        sha = self.github_client.get_merge_commit_sha_from_commit(repo=self.repo, sha=commit_sha)
         assert sha is None
 
     @responses.activate