sase-github 0.2.2__tar.gz → 0.2.4__tar.gz

sase_github-0.2.4/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.2.4"
+}

{sase_github-0.2.2 → sase_github-0.2.4}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.4](https://github.com/sase-org/sase-github/compare/v0.2.3...v0.2.4) (2026-08-11)
+
+
+### Features
+
+* implement vcs_list_pull_requests over gh pr list ([2b0d6a8](https://github.com/sase-org/sase-github/commit/2b0d6a8d6bc3ecd4cd9e7ebdeb012978cddb1181))
+
+## [0.2.3](https://github.com/sase-org/sase-github/compare/v0.2.2...v0.2.3) (2026-08-09)
+
+
+### Documentation
+
+* mark github plugin patch compatibility boundaries ([e79c33b](https://github.com/sase-org/sase-github/commit/e79c33b231d72605957f793fb6a338c910913af0))
+
 ## [0.2.2](https://github.com/sase-org/sase-github/compare/v0.2.1...v0.2.2) (2026-08-08)
 
 

{sase_github-0.2.2 → sase_github-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: sase-github
-Version: 0.2.2
+Version: 0.2.4
 Summary: GitHub VCS plugin for sase
 License-Expression: MIT
 License-File: LICENSE

{sase_github-0.2.2 → sase_github-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sase-github"
-version = "0.2.2"
+version = "0.2.4"
 description = "GitHub VCS plugin for sase"
 requires-python = ">=3.12"
 license = "MIT"

{sase_github-0.2.2 → sase_github-0.2.4}/src/sase_github/plugin.py

@@ -10,7 +10,14 @@ import subprocess
 from collections.abc import Sequence
 from typing import Any, cast
 
-from sase.vcs_provider import IssueListState, IssueState, IssueWire
+from sase.vcs_provider import (
+    IssueListState,
+    IssueState,
+    IssueWire,
+    PullRequestListState,
+    PullRequestState,
+    PullRequestWire,
+)
 from sase.vcs_provider._hookspec import hookimpl
 from sase.vcs_provider._types import CommandOutput
 from sase.vcs_provider.plugins._git_common import GitCommon
@@ -22,7 +29,12 @@ from sase_github.errors import (
 )
 
 _ISSUE_JSON_FIELDS = (
-    "number,title,state,body,labels,assignees,author,createdAt,updatedAt,url,comments"
+    "id,number,title,state,body,labels,assignees,author,createdAt,updatedAt,url,"
+    "comments"
+)
+_PR_JSON_FIELDS = (
+    "id,number,title,state,body,isDraft,author,headRefName,baseRefName,createdAt,"
+    "updatedAt,closedAt,mergedAt,url"
 )
 _UNBOUNDED_ISSUE_LIMIT = 1_000_000
 _AUTH_ERROR_MARKERS = (
@@ -140,6 +152,56 @@ def _issue_from_json(payload: object) -> IssueWire:
         updated_at=_string_field(payload, "updatedAt"),
         url=_string_field(payload, "url"),
         comment_count=_comment_count(payload.get("comments")),
+        provider_id=_string_field(payload, "id"),
+    )
+
+
+def _pull_request_from_json(payload: object) -> PullRequestWire:
+    """Normalize one ``gh pr --json`` object into :class:`PullRequestWire`.
+
+    GitHub reports a merged PR's raw ``state`` as ``MERGED``, distinct from
+    ``CLOSED``; that collapses into our two-valued ``state`` as ``"closed"``,
+    with ``merged_at`` left populated as the signal that tells the two apart.
+    """
+    if not isinstance(payload, dict):
+        raise ValueError("pull request must be an object")
+
+    number = payload.get("number")
+    title = payload.get("title")
+    raw_state = payload.get("state")
+    is_draft = payload.get("isDraft")
+    if not isinstance(number, int) or isinstance(number, bool):
+        raise ValueError("number must be an integer")
+    if not isinstance(title, str):
+        raise ValueError("title must be a string")
+    if not isinstance(raw_state, str) or raw_state.casefold() not in {
+        "open",
+        "closed",
+        "merged",
+    }:
+        raise ValueError("state must be open, closed, or merged")
+    if not isinstance(is_draft, bool):
+        raise ValueError("isDraft must be a boolean")
+
+    state = cast(
+        PullRequestState,
+        "closed" if raw_state.casefold() == "merged" else raw_state.casefold(),
+    )
+    return PullRequestWire(
+        number=number,
+        title=title,
+        state=state,
+        provider_id=_string_field(payload, "id"),
+        url=_string_field(payload, "url"),
+        body=_string_field(payload, "body"),
+        is_draft=is_draft,
+        author=_login(payload.get("author"), "author"),
+        head_ref=_string_field(payload, "headRefName"),
+        base_ref=_string_field(payload, "baseRefName"),
+        created_at=_string_field(payload, "createdAt"),
+        updated_at=_string_field(payload, "updatedAt"),
+        closed_at=_string_field(payload, "closedAt"),
+        merged_at=_string_field(payload, "mergedAt"),
     )
 
 
@@ -182,14 +244,14 @@ class GitHubPlugin(GitCommon):
 
     # --- Optional issue-tracker operations ---
 
-    def _run_issue_command(self, cmd: list[str], cwd: str, operation: str) -> str:
+    def _run_gh_command(self, cmd: list[str], cwd: str, operation: str) -> str:
         out = self._run(cmd, cwd)
         if not out.success:
             raise _command_error(operation, out)
         return out.stdout
 
-    def _run_issue_json(self, cmd: list[str], cwd: str, operation: str) -> object:
-        raw = self._run_issue_command(cmd, cwd, operation)
+    def _run_gh_json(self, cmd: list[str], cwd: str, operation: str) -> object:
+        raw = self._run_gh_command(cmd, cwd, operation)
         try:
             return json.loads(raw)
         except json.JSONDecodeError as exc:
@@ -200,7 +262,7 @@ class GitHubPlugin(GitCommon):
 
     def _view_issue(self, issue_ref: int | str, cwd: str) -> IssueWire:
         operation = "gh issue view"
-        payload = self._run_issue_json(
+        payload = self._run_gh_json(
             [
                 "gh",
                 "issue",
@@ -229,7 +291,7 @@ class GitHubPlugin(GitCommon):
     ) -> list[IssueWire]:
         """List GitHub issues and normalize ``gh`` JSON output."""
         operation = "gh issue list"
-        payload = self._run_issue_json(
+        payload = self._run_gh_json(
             [
                 "gh",
                 "issue",
@@ -272,7 +334,7 @@ class GitHubPlugin(GitCommon):
         cmd = ["gh", "issue", "create", "--title", title, "--body", body]
         for label in _ordered_unique(labels):
             cmd.extend(("--label", label))
-        issue_ref = self._run_issue_command(cmd, cwd, operation).strip()
+        issue_ref = self._run_gh_command(cmd, cwd, operation).strip()
         if not issue_ref:
             raise GitHubIssueError(operation, "gh returned no created issue URL")
         return self._view_issue(issue_ref, cwd)
@@ -305,11 +367,11 @@ class GitHubPlugin(GitCommon):
                 if label not in current_set:
                     edit_cmd.extend(("--add-label", label))
         if len(edit_cmd) > 4:
-            self._run_issue_command(edit_cmd, cwd, "gh issue edit")
+            self._run_gh_command(edit_cmd, cwd, "gh issue edit")
 
         if state is not None and state != current.state:
             state_operation = f"gh issue {'close' if state == 'closed' else 'reopen'}"
-            self._run_issue_command(
+            self._run_gh_command(
                 ["gh", "issue", state_operation.rsplit(" ", 1)[-1], str(number)],
                 cwd,
                 state_operation,
@@ -323,7 +385,7 @@ class GitHubPlugin(GitCommon):
     def vcs_get_issue_url(self, number: int, cwd: str) -> str:
         """Return the issue URL while requesting no other issue fields."""
         operation = "gh issue view"
-        url = self._run_issue_command(
+        url = self._run_gh_command(
             [
                 "gh",
                 "issue",
@@ -341,6 +403,58 @@ class GitHubPlugin(GitCommon):
             raise GitHubIssueError(operation, "gh returned no issue URL")
         return url
 
+    # --- Optional pull-request operations ---
+
+    @hookimpl
+    def vcs_list_pull_requests(
+        self,
+        cwd: str,
+        state: PullRequestListState,
+        limit: int,
+    ) -> list[PullRequestWire]:
+        """List GitHub pull requests and normalize ``gh`` JSON output.
+
+        ``gh pr list --state closed`` is not documented to include merged
+        PRs, so any request beyond ``"open"`` fetches ``--state all`` and
+        filters locally by normalized (open/closed) state.
+        """
+        operation = "gh pr list"
+        gh_state = "open" if state == "open" else "all"
+        needs_local_filter = state == "closed"
+        fetch_limit = (
+            _UNBOUNDED_ISSUE_LIMIT
+            if needs_local_filter
+            else (limit if limit > 0 else _UNBOUNDED_ISSUE_LIMIT)
+        )
+        payload = self._run_gh_json(
+            [
+                "gh",
+                "pr",
+                "list",
+                "--state",
+                gh_state,
+                "--limit",
+                str(fetch_limit),
+                "--json",
+                _PR_JSON_FIELDS,
+            ],
+            cwd,
+            operation,
+        )
+        if not isinstance(payload, list):
+            raise GitHubIssueError(operation, "gh returned a non-list JSON value")
+        try:
+            pull_requests = [_pull_request_from_json(pr) for pr in payload]
+        except ValueError as exc:
+            raise GitHubIssueError(
+                operation,
+                f"gh returned invalid pull request JSON: {exc}",
+            ) from exc
+        if needs_local_filter:
+            pull_requests = [pr for pr in pull_requests if pr.state == "closed"]
+            return pull_requests if limit <= 0 else pull_requests[:limit]
+        return pull_requests
+
     @hookimpl
     def vcs_abandon_change(
         self, cl: str, revision: str, cwd: str

{sase_github-0.2.2 → sase_github-0.2.4}/src/sase_github/workspace_plugin.py

@@ -22,7 +22,9 @@ try:
     from sase.ace.patch.project_spec_path import preferred_project_spec_path
 except ImportError:  # Older supported SASE releases expose only ChangeSpec names.
     from sase.ace.changespec import (  # type: ignore[no-redef]
+        # Legacy import names are adapted to canonical Patch locals.
         ChangeSpec as Patch,
+        # Legacy import names are adapted to canonical Patch locals.
         find_all_changespecs as find_all_patches,
     )
     from sase.ace.changespec.project_spec_path import (  # type: ignore[no-redef]
@@ -430,7 +432,9 @@ class GitHubWorkspacePlugin:
     @hookimpl
     def ws_prepare_mail(
         self,
+        # Legacy hook argument name retained for compatibility.
         changespec_name: str,
+        # Legacy hook argument name retained for compatibility.
         changespec_parent: str | None,
         project_basename: str,
         project_file: str,
@@ -461,6 +465,7 @@ class GitHubWorkspacePlugin:
     @hookimpl
     def ws_submit(
         self,
+        # Legacy hook argument name retained for compatibility.
         changespec_file: str,
         changespec_name: str,
         project_basename: str,
@@ -469,7 +474,7 @@ class GitHubWorkspacePlugin:
         """Submit a GitHub Patch by merging its PR."""
         from sase.workspace_provider import detect_workflow_type
 
-        patch_file = changespec_file
+        patch_file = changespec_file  # legacy hook argument name
         patch_name = changespec_name
         vcs_type = detect_workflow_type(patch_file)
         if vcs_type != "gh":

{sase_github-0.2.2 → sase_github-0.2.4}/tests/test_github_issues.py

@@ -20,7 +20,8 @@ from sase_github.plugin import GitHubPlugin
 
 _MOCK_TARGET = "sase.vcs_provider._command_runner.subprocess.run"
 _JSON_FIELDS = (
-    "number,title,state,body,labels,assignees,author,createdAt,updatedAt,url,comments"
+    "id,number,title,state,body,labels,assignees,author,createdAt,updatedAt,url,"
+    "comments"
 )
 
 
@@ -42,8 +43,10 @@ def _json_issue(
     assignees: tuple[str, ...] = ("octocat",),
     author: str | None = "hubot",
     comments: int = 2,
+    node_id: str | None = None,
 ) -> dict[str, Any]:
     return {
+        "id": node_id if node_id is not None else f"I_kwDOissue{number}",
         "number": number,
         "title": title,
         "state": state,
@@ -105,6 +108,7 @@ def test_list_issues_uses_json_and_normalizes_records(
             updated_at="2026-07-15T11:00:00Z",
             url="https://github.example/owner/repo/issues/42",
             comment_count=2,
+            provider_id="I_kwDOissue42",
         ),
         IssueWire(
             number=7,
@@ -113,6 +117,7 @@ def test_list_issues_uses_json_and_normalizes_records(
             created_at="2026-07-14T10:00:00Z",
             updated_at="2026-07-15T11:00:00Z",
             url="https://github.example/owner/repo/issues/7",
+            provider_id="I_kwDOissue7",
         ),
     ]
     assert _command(mock_run) == [

sase_github-0.2.4/tests/test_github_pull_requests.py

@@ -0,0 +1,200 @@
+"""Tests for the GitHub pull-request listing hook."""
+
+import json
+from typing import Any
+from unittest.mock import MagicMock, patch
+
+import pluggy
+import pytest
+from sase.vcs_provider import PullRequestWire
+from sase.vcs_provider._hookspec import VCSHookSpec
+from sase.vcs_provider._plugin_manager import VCSPluginManager
+
+from sase_github.errors import GitHubIssueError
+from sase_github.plugin import GitHubPlugin
+
+_MOCK_TARGET = "sase.vcs_provider._command_runner.subprocess.run"
+_JSON_FIELDS = (
+    "id,number,title,state,body,isDraft,author,headRefName,baseRefName,createdAt,"
+    "updatedAt,closedAt,mergedAt,url"
+)
+
+
+@pytest.fixture
+def github_provider() -> VCSPluginManager:
+    pm = pluggy.PluginManager("sase_vcs")
+    pm.add_hookspecs(VCSHookSpec)
+    pm.register(GitHubPlugin())
+    return VCSPluginManager(pm)
+
+
+def _json_pr(
+    number: int = 42,
+    *,
+    state: str = "OPEN",
+    title: str = "Add feature",
+    body: str | None = "Description",
+    is_draft: bool = False,
+    author: str | None = "hubot",
+    head_ref: str = "feature-branch",
+    base_ref: str = "main",
+    closed_at: str | None = None,
+    merged_at: str | None = None,
+    node_id: str | None = None,
+) -> dict[str, Any]:
+    return {
+        "id": node_id if node_id is not None else f"PR_kwDOpr{number}",
+        "number": number,
+        "title": title,
+        "state": state,
+        "body": body,
+        "isDraft": is_draft,
+        "author": {"login": author} if author is not None else None,
+        "headRefName": head_ref,
+        "baseRefName": base_ref,
+        "createdAt": "2026-07-14T10:00:00Z",
+        "updatedAt": "2026-07-15T11:00:00Z",
+        "closedAt": closed_at,
+        "mergedAt": merged_at,
+        "url": f"https://github.example/owner/repo/pull/{number}",
+    }
+
+
+def _completed(*, returncode: int = 0, stdout: str = "", stderr: str = "") -> MagicMock:
+    return MagicMock(returncode=returncode, stdout=stdout, stderr=stderr)
+
+
+def _command(mock_run: MagicMock, index: int = 0) -> list[str]:
+    return mock_run.call_args_list[index].args[0]
+
+
+def test_github_provider_advertises_pull_request_capability(
+    github_provider: VCSPluginManager,
+) -> None:
+    assert github_provider.supports_pull_requests() is True
+
+
+@patch(_MOCK_TARGET)
+def test_list_pull_requests_open_requests_state_open_and_normalizes_records(
+    mock_run: MagicMock, github_provider: VCSPluginManager
+) -> None:
+    mock_run.return_value = _completed(stdout=json.dumps([_json_pr()]))
+
+    pull_requests = github_provider.list_pull_requests(
+        "/workspace", state="open", limit=25
+    )
+
+    assert pull_requests == [
+        PullRequestWire(
+            number=42,
+            title="Add feature",
+            state="open",
+            provider_id="PR_kwDOpr42",
+            url="https://github.example/owner/repo/pull/42",
+            body="Description",
+            is_draft=False,
+            author="hubot",
+            head_ref="feature-branch",
+            base_ref="main",
+            created_at="2026-07-14T10:00:00Z",
+            updated_at="2026-07-15T11:00:00Z",
+            closed_at="",
+            merged_at="",
+        )
+    ]
+    assert _command(mock_run) == [
+        "gh",
+        "pr",
+        "list",
+        "--state",
+        "open",
+        "--limit",
+        "25",
+        "--json",
+        _JSON_FIELDS,
+    ]
+    assert mock_run.call_args.kwargs["cwd"] == "/workspace"
+
+
+@patch(_MOCK_TARGET)
+def test_list_pull_requests_all_requests_state_all_directly(
+    mock_run: MagicMock, github_provider: VCSPluginManager
+) -> None:
+    mock_run.return_value = _completed(stdout="[]")
+
+    assert github_provider.list_pull_requests("/workspace", state="all", limit=10) == []
+
+    command = _command(mock_run)
+    assert command[command.index("--state") + 1] == "all"
+    assert command[command.index("--limit") + 1] == "10"
+
+
+@patch(_MOCK_TARGET)
+def test_list_pull_requests_closed_folds_in_merged_and_excludes_open(
+    mock_run: MagicMock, github_provider: VCSPluginManager
+) -> None:
+    open_pr = _json_pr(1, state="OPEN")
+    closed_pr = _json_pr(2, state="CLOSED", closed_at="2026-07-20T00:00:00Z")
+    merged_pr = _json_pr(
+        3,
+        state="MERGED",
+        closed_at="2026-07-21T00:00:00Z",
+        merged_at="2026-07-21T00:00:00Z",
+    )
+    mock_run.return_value = _completed(
+        stdout=json.dumps([open_pr, closed_pr, merged_pr])
+    )
+
+    pull_requests = github_provider.list_pull_requests("/workspace", state="closed")
+
+    assert [pr.number for pr in pull_requests] == [2, 3]
+    assert all(pr.state == "closed" for pr in pull_requests)
+    merged = next(pr for pr in pull_requests if pr.number == 3)
+    assert merged.merged_at == "2026-07-21T00:00:00Z"
+    closed_unmerged = next(pr for pr in pull_requests if pr.number == 2)
+    assert closed_unmerged.merged_at == ""
+
+    command = _command(mock_run)
+    assert command[command.index("--state") + 1] == "all"
+    assert command[command.index("--limit") + 1] == "1000000"
+
+
+@patch(_MOCK_TARGET)
+def test_list_pull_requests_non_positive_limit_requests_all_available_results(
+    mock_run: MagicMock, github_provider: VCSPluginManager
+) -> None:
+    mock_run.return_value = _completed(stdout="[]")
+
+    assert github_provider.list_pull_requests("/workspace", limit=0) == []
+
+    command = _command(mock_run)
+    assert command[command.index("--limit") + 1] == "1000000"
+
+
+@patch(_MOCK_TARGET)
+def test_list_pull_requests_normalizes_draft_flag(
+    mock_run: MagicMock, github_provider: VCSPluginManager
+) -> None:
+    mock_run.return_value = _completed(stdout=json.dumps([_json_pr(is_draft=True)]))
+
+    pull_requests = github_provider.list_pull_requests("/workspace")
+
+    assert pull_requests[0].is_draft is True
+
+
+@pytest.mark.parametrize(
+    "stdout",
+    [
+        "not json",
+        "{}",
+        json.dumps([{"number": 1, "title": "Missing state"}]),
+    ],
+)
+@patch(_MOCK_TARGET)
+def test_malformed_pull_request_json_raises_typed_error(
+    mock_run: MagicMock, stdout: str, github_provider: VCSPluginManager
+) -> None:
+    mock_run.return_value = _completed(stdout=stdout)
+
+    with pytest.raises(GitHubIssueError, match="gh pr list"):
+        github_provider.list_pull_requests("/workspace")

sase_github-0.2.2/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "0.2.2"
-}