imbi-plugin-github 2.9.2__tar.gz → 2.9.3__tar.gz

{imbi_plugin_github-2.9.2 → imbi_plugin_github-2.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: imbi-plugin-github
-Version: 2.9.2
+Version: 2.9.3
 Summary: GitHub identity plugin for Imbi (github.com / GHEC / GHES)
 Author-email: "Gavin M. Roy" <gavinr@aweber.com>
 License: BSD-3-Clause

{imbi_plugin_github-2.9.2 → imbi_plugin_github-2.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "imbi-plugin-github"
-version = "2.9.2"
+version = "2.9.3"
 description = "GitHub identity plugin for Imbi (github.com / GHEC / GHES)"
 readme = "README.md"
 requires-python = ">=3.14"

{imbi_plugin_github-2.9.2 → imbi_plugin_github-2.9.3}/src/imbi_plugin_github/commits.py

@@ -565,20 +565,46 @@ async def _annotated_tag(
     return typing.cast('dict[str, typing.Any]', resp.json())
 
 
+def _web_base(api_base: str) -> str:
+    """Map a REST API base to the web host (inverse of the routing table).
+
+    ``https://api.github.com`` -> ``https://github.com``;
+    ``https://api.<tenant>.ghe.com`` -> ``https://<tenant>.ghe.com``;
+    GHES ``https://<host>/api/v3`` -> ``https://<host>``.
+    """
+    if api_base.endswith('/api/v3'):
+        return api_base[: -len('/api/v3')]
+    return api_base.replace('://api.', '://', 1)
+
+
+def _tag_web_url(client: httpx.AsyncClient, name: str) -> str:
+    """Build the web URL for *name* from the client's repo-scoped base."""
+    full = str(client.base_url).rstrip('/')
+    marker = '/repos/'
+    idx = full.find(marker)
+    if idx == -1:
+        return ''
+    web = _web_base(full[:idx])
+    owner_repo = full[idx + len(marker) :]
+    return f'{web}/{owner_repo}/releases/tag/{urllib.parse.quote(name)}'
+
+
 def _tag_record(
     *,
     project_id: str,
     name: str,
     sha: str,
     annotated: dict[str, typing.Any] | None = None,
+    url: str = '',
 ) -> TagRecord:
     if annotated is None:
-        return TagRecord(project_id=project_id, name=name, sha=sha)
+        return TagRecord(project_id=project_id, name=name, sha=sha, url=url)
     tagger: dict[str, typing.Any] = annotated.get('tagger') or {}
     return TagRecord(
         project_id=project_id,
         name=name,
         sha=sha,
+        url=url,
         message=str(annotated.get('message') or ''),
         tagger_name=str(tagger.get('name') or ''),
         tagger_email=str(tagger.get('email') or ''),
@@ -589,22 +615,41 @@ def _tag_record(
 async def _reconcile_tags(
     client: httpx.AsyncClient, project_id: str
 ) -> list[TagRecord]:
-    """Upsert the repo's full tag list (lightweight); ``ReplacingMergeTree``
-    dedupes against rows recorded from individual pushes."""
+    """Upsert the repo's full tag list via the git-refs API.
+
+    ``/git/matching-refs/tags`` yields each tag's object sha + type;
+    annotated tags (``type == 'tag'``) are enriched with tagger/message/
+    date from the tag object, lightweight tags carry name/sha/url only.
+    ``ReplacingMergeTree`` dedupes against rows recorded from pushes.
+    """
     out: list[TagRecord] = []
+    prefix = 'refs/tags/'
     params: dict[str, str] = {'per_page': '100'}
     while True:
-        resp = await client.get('/tags', params=params)
+        resp = await client.get('/git/matching-refs/tags', params=params)
         resp.raise_for_status()
         rows = typing.cast('list[dict[str, typing.Any]]', resp.json())
         for row in rows:
-            name = str(row.get('name') or '')
-            commit: dict[str, typing.Any] = row.get('commit') or {}
-            sha = str(commit.get('sha') or '')
-            if name and sha:
-                out.append(
-                    _tag_record(project_id=project_id, name=name, sha=sha)
+            ref = str(row.get('ref') or '')
+            obj: dict[str, typing.Any] = row.get('object') or {}
+            sha = str(obj.get('sha') or '')
+            if not ref.startswith(prefix) or not sha:
+                continue
+            name = ref[len(prefix) :]
+            annotated = (
+                await _annotated_tag(client, sha)
+                if obj.get('type') == 'tag'
+                else None
+            )
+            out.append(
+                _tag_record(
+                    project_id=project_id,
+                    name=name,
+                    sha=sha,
+                    annotated=annotated,
+                    url=_tag_web_url(client, name),
                 )
+            )
         next_url = _next_page_url(resp.headers.get('link'))
         if next_url is None:
             return out
@@ -650,6 +695,7 @@ async def sync_tags(
                 name=name,
                 sha=after,
                 annotated=annotated,
+                url=_tag_web_url(client, name),
             )
         ]
         if action_config.reconcile_all:

{imbi_plugin_github-2.9.2 → imbi_plugin_github-2.9.3}/tests/test_commits.py

@@ -470,12 +470,20 @@ class SyncTagsTestCase(unittest.IsolatedAsyncioTestCase):
         respx.get(
             f'https://api.github.com/repos/octo/demo/git/tags/{sha}'
         ).mock(return_value=httpx.Response(404))
-        respx.get('https://api.github.com/repos/octo/demo/tags').mock(
+        respx.get(
+            'https://api.github.com/repos/octo/demo/git/matching-refs/tags'
+        ).mock(
             return_value=httpx.Response(
                 200,
                 json=[
-                    {'name': 'v1.2.3', 'commit': {'sha': sha}},
-                    {'name': 'v1.0.0', 'commit': {'sha': 'z' * 40}},
+                    {
+                        'ref': 'refs/tags/v1.2.3',
+                        'object': {'sha': sha, 'type': 'commit'},
+                    },
+                    {
+                        'ref': 'refs/tags/v1.0.0',
+                        'object': {'sha': 'z' * 40, 'type': 'commit'},
+                    },
                 ],
             )
         )
@@ -490,6 +498,14 @@ class SyncTagsTestCase(unittest.IsolatedAsyncioTestCase):
         _, records = _await_args(insert)
         names = {r.name for r in records}
         self.assertEqual({'v1.2.3', 'v1.0.0'}, names)
+        urls = {r.name: r.url for r in records}
+        self.assertEqual(
+            {
+                'v1.2.3': 'https://github.com/octo/demo/releases/tag/v1.2.3',
+                'v1.0.0': 'https://github.com/octo/demo/releases/tag/v1.0.0',
+            },
+            urls,
+        )
 
     @respx.mock
     async def test_reconcile_all_paginates(self) -> None:
@@ -497,17 +513,27 @@ class SyncTagsTestCase(unittest.IsolatedAsyncioTestCase):
         respx.get(
             f'https://api.github.com/repos/octo/demo/git/tags/{sha}'
         ).mock(return_value=httpx.Response(404))
-        url = 'https://api.github.com/repos/octo/demo/tags'
+        url = 'https://api.github.com/repos/octo/demo/git/matching-refs/tags'
         respx.get(url).mock(
             side_effect=[
                 httpx.Response(
                     200,
-                    json=[{'name': 'v1.2.3', 'commit': {'sha': sha}}],
+                    json=[
+                        {
+                            'ref': 'refs/tags/v1.2.3',
+                            'object': {'sha': sha, 'type': 'commit'},
+                        }
+                    ],
                     headers={'link': f'<{url}?page=2>; rel="next"'},
                 ),
                 httpx.Response(
                     200,
-                    json=[{'name': 'v1.0.0', 'commit': {'sha': 'z' * 40}}],
+                    json=[
+                        {
+                            'ref': 'refs/tags/v1.0.0',
+                            'object': {'sha': 'z' * 40, 'type': 'commit'},
+                        }
+                    ],
                 ),
             ]
         )
@@ -522,6 +548,14 @@ class SyncTagsTestCase(unittest.IsolatedAsyncioTestCase):
         _, records = _await_args(insert)
         names = {r.name for r in records}
         self.assertEqual({'v1.2.3', 'v1.0.0'}, names)
+        urls = {r.name: r.url for r in records}
+        self.assertEqual(
+            {
+                'v1.2.3': 'https://github.com/octo/demo/releases/tag/v1.2.3',
+                'v1.0.0': 'https://github.com/octo/demo/releases/tag/v1.0.0',
+            },
+            urls,
+        )
 
     @respx.mock
     async def test_401_raises_authentication_failed(self) -> None:
@@ -850,12 +884,18 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
                 200, json=[_commit('c' * 40), _commit('d' * 40)]
             )
         )
-        respx.get(f'{self._REPO}/tags').mock(
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
             return_value=httpx.Response(
                 200,
                 json=[
-                    {'name': 'v1.0.0', 'commit': {'sha': 'z' * 40}},
-                    {'name': 'v1.1.0', 'commit': {'sha': 'y' * 40}},
+                    {
+                        'ref': 'refs/tags/v1.0.0',
+                        'object': {'sha': 'z' * 40, 'type': 'commit'},
+                    },
+                    {
+                        'ref': 'refs/tags/v1.1.0',
+                        'object': {'sha': 'y' * 40, 'type': 'commit'},
+                    },
                 ],
             )
         )
@@ -876,6 +916,17 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
         records = commit_call.args[1]
         self.assertIsInstance(records[0], CommitRecord)
         self.assertEqual('main', records[0].ref)
+        tag_call = next(
+            c for c in insert.await_args_list if c.args[0] == 'tags'
+        )
+        urls = {r.name: r.url for r in tag_call.args[1]}
+        self.assertEqual(
+            {
+                'v1.0.0': 'https://github.com/octo/demo/releases/tag/v1.0.0',
+                'v1.1.0': 'https://github.com/octo/demo/releases/tag/v1.1.0',
+            },
+            urls,
+        )
 
     @respx.mock
     async def test_paginates_commits(self) -> None:
@@ -891,7 +942,7 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
                 httpx.Response(200, json=[_commit('2' * 40)]),
             ]
         )
-        respx.get(f'{self._REPO}/tags').mock(
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
             return_value=httpx.Response(200, json=[])
         )
         with mock.patch(_INSERT, new=mock.AsyncMock()) as insert:
@@ -917,7 +968,7 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
                 headers={'link': f'<{url}?page=2>; rel="next"'},
             )
         )
-        respx.get(f'{self._REPO}/tags').mock(
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
             return_value=httpx.Response(200, json=[])
         )
         with mock.patch.object(commits, '_MAX_HISTORY_PAGES', 1):
@@ -941,7 +992,7 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
         respx.get(f'{self._REPO}/commits').mock(
             return_value=httpx.Response(200, json=[_commit('c' * 40)])
         )
-        respx.get(f'{self._REPO}/tags').mock(
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
             return_value=httpx.Response(200, json=[])
         )
         failing = mock.AsyncMock(side_effect=RuntimeError('clickhouse down'))
@@ -969,7 +1020,7 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
         respx.get(f'{self._REPO}/commits').mock(
             return_value=httpx.Response(200, json=[_commit('c' * 40)])
         )
-        respx.get(f'{self._REPO}/tags').mock(
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
             return_value=httpx.Response(200, json=[])
         )
         creds = {
@@ -982,3 +1033,65 @@ class SyncAllHistoryTestCase(unittest.IsolatedAsyncioTestCase):
                 ctx=self._ctx(), credentials=creds
             )
         self.assertEqual(1, token_route.call_count)
+
+    @respx.mock
+    async def test_annotated_tags_enriched_with_metadata(self) -> None:
+        self._mock_default_branch()
+        respx.get(f'{self._REPO}/commits').mock(
+            return_value=httpx.Response(200, json=[_commit('c' * 40)])
+        )
+        tag_sha = 'a' * 40
+        respx.get(f'{self._REPO}/git/matching-refs/tags').mock(
+            return_value=httpx.Response(
+                200,
+                json=[
+                    {
+                        'ref': 'refs/tags/v2.0.0',
+                        'object': {'sha': tag_sha, 'type': 'tag'},
+                    }
+                ],
+            )
+        )
+        respx.get(f'{self._REPO}/git/tags/{tag_sha}').mock(
+            return_value=httpx.Response(
+                200,
+                json={
+                    'message': 'Release 2.0.0',
+                    'tagger': {
+                        'name': 'Rel Bot',
+                        'email': 'rel@example.com',
+                        'date': '2026-02-01T00:00:00Z',
+                    },
+                },
+            )
+        )
+        with mock.patch(_INSERT, new=mock.AsyncMock()) as insert:
+            await commits.GitHubCommitSyncPlugin().sync_all_history(
+                ctx=self._ctx(), credentials=_CREDS
+            )
+        tag_call = next(
+            c for c in insert.await_args_list if c.args[0] == 'tags'
+        )
+        record = tag_call.args[1][0]
+        self.assertEqual('Release 2.0.0', record.message)
+        self.assertEqual('Rel Bot', record.tagger_name)
+        self.assertIsNotNone(record.tagged_at)
+        self.assertEqual(
+            'https://github.com/octo/demo/releases/tag/v2.0.0', record.url
+        )
+
+
+class WebBaseTestCase(unittest.TestCase):
+    def test_web_base_flavors(self) -> None:
+        self.assertEqual(
+            'https://github.com',
+            commits._web_base('https://api.github.com'),
+        )
+        self.assertEqual(
+            'https://tenant.ghe.com',
+            commits._web_base('https://api.tenant.ghe.com'),
+        )
+        self.assertEqual(
+            'https://ghe.example.com',
+            commits._web_base('https://ghe.example.com/api/v3'),
+        )

{imbi_plugin_github-2.9.2 → imbi_plugin_github-2.9.3}/uv.lock

@@ -703,7 +703,7 @@ server = [
 
 [[package]]
 name = "imbi-plugin-github"
-version = "2.9.2"
+version = "2.9.3"
 source = { editable = "." }
 dependencies = [
   { name = "httpx" },