asyncgh 0.3.0__tar.gz → 0.3.2__tar.gz

{asyncgh-0.3.0 → asyncgh-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: asyncgh
-Version: 0.3.0
+Version: 0.3.2
 Summary: Minimal async GitHub REST + GraphQL transport: auth, retry, pagination -- no generated models
 Project-URL: Homepage, https://github.com/hugoh/gh-workflows/tree/main/asyncgh
 Project-URL: Issues, https://github.com/hugoh/gh-workflows/issues
@@ -25,6 +25,8 @@ Description-Content-Type: text/markdown
 
 # asyncgh
 
+[![PyPI](https://img.shields.io/pypi/v/asyncgh)](https://pypi.org/project/asyncgh/)
+
 A minimal async GitHub API transport — the plumbing an account-wide config
 tool needs before any of its domain logic: authentication, a connection,
 retrying error handling, REST pagination, and GraphQL.

{asyncgh-0.3.0 → asyncgh-0.3.2}/README.md

@@ -1,5 +1,7 @@
 # asyncgh
 
+[![PyPI](https://img.shields.io/pypi/v/asyncgh)](https://pypi.org/project/asyncgh/)
+
 A minimal async GitHub API transport — the plumbing an account-wide config
 tool needs before any of its domain logic: authentication, a connection,
 retrying error handling, REST pagination, and GraphQL.

{asyncgh-0.3.0 → asyncgh-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asyncgh"
-version = "0.3.0"
+version = "0.3.2"
 description = "Minimal async GitHub REST + GraphQL transport: auth, retry, pagination -- no generated models"
 readme = "README.md"
 requires-python = ">=3.11"

{asyncgh-0.3.0 → asyncgh-0.3.2}/src/asyncgh/client.py

@@ -144,6 +144,8 @@ class GitHubClient:
         )
         self._http: httpx2.AsyncClient | None = None
         self._lock = asyncio.Lock()
+        self._viewer: str | None = None
+        self._viewer_lock = asyncio.Lock()
 
     async def _get_http(self) -> httpx2.AsyncClient:
         if self._http is None:
@@ -160,6 +162,19 @@ class GitHubClient:
                     )
         return self._http
 
+    async def viewer(self) -> str:
+        """The login of the authenticated user (`GET /user`), cached for the
+        life of this client -- it's the same account for as long as the
+        client's token doesn't change, so repeated callers (e.g. fetch_repos
+        on every invocation) share one request instead of each firing their
+        own.
+        """
+        if self._viewer is None:
+            async with self._viewer_lock:
+                if self._viewer is None:
+                    self._viewer = (await self.api_json("GET", "/user"))["login"]
+        return self._viewer
+
     async def aclose(self) -> None:
         if self._http is not None:
             await self._http.aclose()

{asyncgh-0.3.0 → asyncgh-0.3.2}/src/asyncgh/endpoints.py

@@ -47,7 +47,7 @@ async def fetch_repos(
     only ever returns public repos.
     """
     client = client or _get_default_client()
-    viewer = (await client.api_json("GET", "/user")).get("login")
+    viewer = await client.viewer()
     if owner == viewer:
         repos = await client.paginated(
             "GET", "/user/repos", params={"affiliation": "owner", "per_page": "100"}

{asyncgh-0.3.0 → asyncgh-0.3.2}/tests/test_client.py

@@ -1,3 +1,4 @@
+import asyncio
 import json
 
 import httpx
@@ -388,6 +389,40 @@ async def test_github_client_max_retries_overrides_the_default(
     await gh.aclose()
 
 
+async def test_viewer_caches_the_authenticated_login_across_calls(
+    httpx2_mock: respx.Router,
+):
+    route = httpx2_mock.get(f"{API_BASE}/user").mock(
+        return_value=httpx.Response(200, json={"login": "hugoh"})
+    )
+    gh = GitHubClient(token="t")
+    assert await gh.viewer() == "hugoh"
+    assert await gh.viewer() == "hugoh"
+    assert route.call_count == 1
+    await gh.aclose()
+
+
+async def test_viewer_concurrent_callers_share_one_request(
+    httpx2_mock: respx.Router,
+):
+    # The mocked transport normally resolves without ever suspending, so
+    # concurrent callers would run to completion one at a time regardless of
+    # locking and never actually race. Force a real suspension point inside
+    # the request so the second caller's check-then-await genuinely
+    # interleaves with the first's, the way it would over a real network
+    # call.
+    async def delayed_response(request):
+        await asyncio.sleep(0)
+        return httpx.Response(200, json={"login": "hugoh"})
+
+    route = httpx2_mock.get(f"{API_BASE}/user").mock(side_effect=delayed_response)
+    gh = GitHubClient(token="t")
+    results = await asyncio.gather(*(gh.viewer() for _ in range(5)))
+    assert results == ["hugoh"] * 5
+    assert route.call_count == 1
+    await gh.aclose()
+
+
 async def test_github_client_as_context_manager_closes_on_exit(
     httpx2_mock: respx.Router,
 ):

{asyncgh-0.3.0 → asyncgh-0.3.2}/tests/test_endpoints.py

@@ -111,6 +111,17 @@ def _sealed_box_key() -> tuple[public.PrivateKey, str]:
     return private_key, public_key_b64
 
 
+def _assert_put_body_encrypts(
+    put_route: respx.Route, private_key: public.PrivateKey, expected_value: bytes
+) -> None:
+    body = json.loads(put_route.calls[0].request.content)
+    assert body["key_id"] == "key-id-123"
+    decrypted = public.SealedBox(private_key).decrypt(
+        base64.b64decode(body["encrypted_value"])
+    )
+    assert decrypted == expected_value
+
+
 async def test_get_repo_public_key_returns_key_and_id(httpx2_mock: respx.Router):
     httpx2_mock.get(f"{API_BASE}/repos/hugoh/repo/actions/secrets/public-key").mock(
         return_value=httpx.Response(
@@ -139,12 +150,7 @@ async def test_set_repo_secret_encrypts_and_puts_with_key_id(
     await set_repo_secret("hugoh", "repo", "NAME", "the-value")
 
     assert put_route.call_count == 1
-    body = json.loads(put_route.calls[0].request.content)
-    assert body["key_id"] == "key-id-123"
-    decrypted = public.SealedBox(private_key).decrypt(
-        base64.b64decode(body["encrypted_value"])
-    )
-    assert decrypted == b"the-value"
+    _assert_put_body_encrypts(put_route, private_key, b"the-value")
 
 
 async def test_set_repo_secret_reuses_a_passed_in_public_key(
@@ -166,9 +172,4 @@ async def test_set_repo_secret_reuses_a_passed_in_public_key(
         public_key={"key": public_key_b64, "key_id": "key-id-123"},
     )
 
-    body = json.loads(put_route.calls[0].request.content)
-    assert body["key_id"] == "key-id-123"
-    decrypted = public.SealedBox(private_key).decrypt(
-        base64.b64decode(body["encrypted_value"])
-    )
-    assert decrypted == b"the-value"
+    _assert_put_body_encrypts(put_route, private_key, b"the-value")