feat(bitbucket-server): Commit context

Author: jianyuan

src/sentry/integrations/bitbucket_server/blame.py

@@ -0,0 +1,119 @@
+import logging
+from collections.abc import Mapping, Sequence
+from dataclasses import asdict
+from datetime import datetime, timezone
+from typing import Any
+
+from sentry.integrations.bitbucket_server.utils import BitbucketServerAPIPath
+from sentry.integrations.source_code_management.commit_context import (
+    CommitInfo,
+    FileBlameInfo,
+    SourceLineInfo,
+)
+from sentry.shared_integrations.client.base import BaseApiClient
+from sentry.shared_integrations.exceptions import ApiError
+
+logger = logging.getLogger("sentry.integrations.bitbucket_server")
+
+
+def _blame_file(
+    client: BaseApiClient, file: SourceLineInfo, extra: Mapping[str, Any]
+) -> FileBlameInfo | None:
+    if file.lineno is None:
+        logger.warning("blame_file.no_lineno", extra=extra)
+        return None
+
+    project = file.repo.config["project"]
+    repo = file.repo.config["repo"]
+
+    browse_url = BitbucketServerAPIPath.get_browse(
+        project=project,
+        repo=repo,
+        path=file.path,
+        sha=file.ref,
+        blame=True,
+        no_content=True,
+    )
+
+    try:
+        data = client.get(browse_url)
+    except ApiError as e:
+        if e.code in (401, 403, 404):
+            logger.warning(
+                "blame_file.browse.api_error",
+                extra={
+                    **extra,
+                    "code": e.code,
+                    "error_message": e.text,
+                },
+            )
+            return None
+        raise
+
+    for entry in data:
+        start = entry["lineNumber"]
+        span = entry["spannedLines"]
+        end = start + span - 1  # inclusive range
+
+        if start <= file.lineno <= end:
+            commit_id = entry["commitId"]
+            commited_date = datetime.fromtimestamp(
+                entry["committerTimestamp"] / 1000.0, tz=timezone.utc
+            )
+
+            try:
+                commit_data = client.get_cached(
+                    BitbucketServerAPIPath.repository_commit.format(
+                        project=project, repo=repo, commit=commit_id
+                    ),
+                )
+            except ApiError as e:
+                logger.warning(
+                    "blame_file.commit.api_error",
+                    extra={
+                        **extra,
+                        "code": e.code,
+                        "error_message": e.text,
+                        "commit_id": commit_id,
+                    },
+                )
+                commit_message = None
+            else:
+                commit_message = commit_data.get("message")
+
+            return FileBlameInfo(
+                **asdict(file),
+                commit=CommitInfo(
+                    commitId=commit_id,
+                    committedDate=commited_date,
+                    commitMessage=commit_message,
+                    commitAuthorName=entry["author"].get("name"),
+                    commitAuthorEmail=entry["author"].get("emailAddress"),
+                ),
+            )
+
+    return None
+
+
+def fetch_file_blames(
+    client: BaseApiClient, files: Sequence[SourceLineInfo], extra: Mapping[str, Any]
+) -> list[FileBlameInfo]:
+    blames = []
+    for file in files:
+        extra_file = {
+            **extra,
+            "repo_name": file.repo.name,
+            "file_path": file.path,
+            "branch_name": file.ref,
+            "file_lineno": file.lineno,
+        }
+
+        blame = _blame_file(client, file, extra_file)
+        if blame:
+            blames.append(blame)
+        else:
+            logger.warning(
+                "fetch_file_blames.no_blame",
+                extra=extra_file,
+            )
+    return blames

src/sentry/integrations/bitbucket_server/client.py

@@ -1,18 +1,28 @@
 import logging
+from collections.abc import Mapping, Sequence
+from typing import Any
 from urllib.parse import parse_qsl
 
 from oauthlib.oauth1 import SIGNATURE_RSA
 from requests import PreparedRequest
 from requests_oauthlib import OAuth1
 
 from sentry.identity.services.identity.model import RpcIdentity
+from sentry.integrations.base import IntegrationFeatureNotImplementedError
+from sentry.integrations.bitbucket_server.blame import fetch_file_blames
 from sentry.integrations.bitbucket_server.utils import BitbucketServerAPIPath
 from sentry.integrations.client import ApiClient
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.services.integration.model import RpcIntegration
+from sentry.integrations.source_code_management.commit_context import (
+    CommitContextClient,
+    FileBlameInfo,
+    SourceLineInfo,
+)
 from sentry.integrations.source_code_management.repository import RepositoryClient
 from sentry.models.repository import Repository
 from sentry.shared_integrations.exceptions import ApiError
+from sentry.utils import metrics
 
 logger = logging.getLogger("sentry.integrations.bitbucket_server")
 
@@ -86,7 +96,7 @@ def request(self, *args, **kwargs):
         return self._request(*args, **kwargs)
 
 
-class BitbucketServerClient(ApiClient, RepositoryClient):
+class BitbucketServerClient(ApiClient, RepositoryClient, CommitContextClient):
     """
     Contains the BitBucket Server specifics in order to communicate with bitbucket
 
@@ -264,3 +274,28 @@ def get_file(
             raw_response=True,
         )
         return response.text
+
+    def get_blame_for_files(
+        self, files: Sequence[SourceLineInfo], extra: Mapping[str, Any]
+    ) -> list[FileBlameInfo]:
+        metrics.incr("integrations.bitbucket_server.get_blame_for_files")
+        return fetch_file_blames(
+            self,
+            files,
+            extra={
+                **extra,
+                "provider": "bitbucket_server",
+                "org_integration_id": self.integration_id,
+            },
+        )
+
+    def create_comment(self, repo: str, issue_id: str, data: Mapping[str, Any]) -> Any:
+        raise IntegrationFeatureNotImplementedError
+
+    def update_comment(
+        self, repo: str, issue_id: str, comment_id: str, data: Mapping[str, Any]
+    ) -> Any:
+        raise IntegrationFeatureNotImplementedError
+
+    def get_merge_commit_sha_from_commit(self, repo: str, sha: str) -> str | None:
+        raise IntegrationFeatureNotImplementedError

src/sentry/integrations/bitbucket_server/integration.py

@@ -26,6 +26,7 @@
 from sentry.integrations.models.integration import Integration
 from sentry.integrations.services.repository import repository_service
 from sentry.integrations.services.repository.model import RpcRepository
+from sentry.integrations.source_code_management.commit_context import CommitContextIntegration
 from sentry.integrations.source_code_management.repository import RepositoryIntegration
 from sentry.integrations.tasks.migrate_repo import migrate_repo
 from sentry.integrations.utils.metrics import (
@@ -251,7 +252,7 @@ def dispatch(self, request: HttpRequest, pipeline: Pipeline) -> HttpResponseBase
                 )
 
 
-class BitbucketServerIntegration(RepositoryIntegration):
+class BitbucketServerIntegration(RepositoryIntegration, CommitContextIntegration):
     """
     IntegrationInstallation implementation for Bitbucket Server
     """

src/sentry/tasks/post_process.py

@@ -1081,7 +1081,12 @@ def process_commits(job: PostProcessJob) -> None:
 
                     org_integrations = integration_service.get_organization_integrations(
                         organization_id=event.project.organization_id,
-                        providers=["github", "gitlab", "github_enterprise"],
+                        providers=[
+                            "github",
+                            "gitlab",
+                            "github_enterprise",
+                            "bitbucket_server",
+                        ],
                     )
                     has_integrations = len(org_integrations) > 0
                     # Cache the integrations check for 4 hours