fix(copilot): guard token refresh with asyncio.Lock to prevent race condition

_get_copilot_access_token had a check-then-act race: concurrent chat()
calls after token expiry both fetched new tokens and clobbered each other.
Add asyncio.Lock with double-checked locking so only one fetch happens
per expiry window.

Closes #4677
This commit is contained in:
axelray-dev
2026-07-04 21:19:12 +08:00
committed by Xubin Ren
parent 614ea86a81
commit 28011413bc
2 changed files with 152 additions and 22 deletions
+33 -22
View File
@@ -2,6 +2,7 @@
from __future__ import annotations
import asyncio
import os
import time
import webbrowser
@@ -174,6 +175,7 @@ class GitHubCopilotProvider(OpenAICompatProvider):
self._copilot_access_token: str | None = None
self._copilot_expires_at: float = 0.0
self._copilot_token_lock: asyncio.Lock = asyncio.Lock()
super().__init__(
api_key="no-key",
api_base=_resolve("NANOBOT_COPILOT_BASE_URL", DEFAULT_COPILOT_BASE_URL),
@@ -191,31 +193,40 @@ class GitHubCopilotProvider(OpenAICompatProvider):
if self._copilot_access_token and now < self._copilot_expires_at - _EXPIRY_SKEW_SECONDS:
return self._copilot_access_token
github_token = _load_github_token()
if not github_token or not github_token.access:
raise RuntimeError("GitHub Copilot is not logged in. Run: nanobot provider login github-copilot")
async with self._copilot_token_lock:
# Re-check after acquiring the lock: another task may have refreshed
# the token while we were waiting.
now = time.time()
if self._copilot_access_token and now < self._copilot_expires_at - _EXPIRY_SKEW_SECONDS:
return self._copilot_access_token
timeout = httpx.Timeout(20.0, connect=20.0)
async with httpx.AsyncClient(timeout=timeout, follow_redirects=True, trust_env=True) as client:
response = await client.get(
_resolve("NANOBOT_COPILOT_TOKEN_URL", DEFAULT_COPILOT_TOKEN_URL),
headers=_copilot_headers(github_token.access),
)
response.raise_for_status()
payload = response.json()
github_token = _load_github_token()
if not github_token or not github_token.access:
raise RuntimeError(
"GitHub Copilot is not logged in. Run: nanobot provider login github-copilot"
)
token = payload.get("token")
if not token:
raise RuntimeError("GitHub Copilot token exchange returned no token.")
timeout = httpx.Timeout(20.0, connect=20.0)
async with httpx.AsyncClient(timeout=timeout, follow_redirects=True, trust_env=True) as client:
response = await client.get(
_resolve("NANOBOT_COPILOT_TOKEN_URL", DEFAULT_COPILOT_TOKEN_URL),
headers=_copilot_headers(github_token.access),
)
response.raise_for_status()
payload = response.json()
expires_at = payload.get("expires_at")
if isinstance(expires_at, (int, float)):
self._copilot_expires_at = float(expires_at)
else:
refresh_in = payload.get("refresh_in") or 1500
self._copilot_expires_at = time.time() + int(refresh_in)
self._copilot_access_token = str(token)
return self._copilot_access_token
token = payload.get("token")
if not token:
raise RuntimeError("GitHub Copilot token exchange returned no token.")
expires_at = payload.get("expires_at")
if isinstance(expires_at, (int, float)):
self._copilot_expires_at = float(expires_at)
else:
refresh_in = payload.get("refresh_in") or 1500
self._copilot_expires_at = time.time() + int(refresh_in)
self._copilot_access_token = str(token)
return self._copilot_access_token
async def _refresh_client_api_key(self) -> str:
token = await self._get_copilot_access_token()
@@ -0,0 +1,119 @@
"""Regression tests for concurrent token refresh in GitHubCopilotProvider (#4677)."""
from __future__ import annotations
import asyncio
from types import SimpleNamespace
import pytest
from nanobot.providers import github_copilot_provider as gc
@pytest.mark.asyncio
async def test_concurrent_token_refresh_fetches_once(monkeypatch):
"""Two concurrent _get_copilot_access_token calls should trigger only one
HTTP fetch when the token is expired, not two."""
monkeypatch.setattr(gc, "_load_github_token", lambda: SimpleNamespace(access="github-token"))
fetch_count = 0
class FakeResponse:
def raise_for_status(self):
pass
def json(self):
return {"token": "copilot-token", "refresh_in": 1500}
class FakeAsyncClient:
def __init__(self, *args, **kwargs):
pass
async def __aenter__(self):
return self
async def __aexit__(self, *args):
return False
async def get(self, url, *, headers):
nonlocal fetch_count
fetch_count += 1
# Simulate network latency so both coroutines overlap before the
# lock serializes them.
await asyncio.sleep(0.05)
return FakeResponse()
monkeypatch.setattr(gc.httpx, "AsyncClient", FakeAsyncClient)
provider = gc.GitHubCopilotProvider()
# Force token expiry.
provider._copilot_access_token = None
provider._copilot_expires_at = 0.0
token_a, token_b = await asyncio.gather(
provider._get_copilot_access_token(),
provider._get_copilot_access_token(),
)
assert token_a == "copilot-token"
assert token_b == "copilot-token"
assert fetch_count == 1, (
f"Expected exactly 1 token fetch under concurrency, got {fetch_count}"
)
@pytest.mark.asyncio
async def test_second_call_returns_cached_token_while_first_in_flight(monkeypatch):
"""If task A is mid-fetch inside the lock, task B should wait, then find
the cached token and skip the HTTP call entirely."""
monkeypatch.setattr(gc, "_load_github_token", lambda: SimpleNamespace(access="github-token"))
fetch_count = 0
class FakeResponse:
def raise_for_status(self):
pass
def json(self):
return {"token": "cached-token", "refresh_in": 1500}
class FakeAsyncClient:
def __init__(self, *args, **kwargs):
pass
async def __aenter__(self):
return self
async def __aexit__(self, *args):
return False
async def get(self, url, *, headers):
nonlocal fetch_count
fetch_count += 1
await asyncio.sleep(0.1)
return FakeResponse()
monkeypatch.setattr(gc.httpx, "AsyncClient", FakeAsyncClient)
provider = gc.GitHubCopilotProvider()
provider._copilot_access_token = None
provider._copilot_expires_at = 0.0
# Start task A, let it acquire the lock and begin the HTTP fetch.
task_a = asyncio.create_task(provider._get_copilot_access_token())
await asyncio.sleep(0.02) # task A is now inside the lock, mid-fetch
# Task B starts while A is still in flight.
token_b = await provider._get_copilot_access_token()
token_a = await task_a
assert token_a == "cached-token"
assert token_b == "cached-token"
assert fetch_count == 1
@pytest.mark.asyncio
async def test_copilot_token_lock_exists():
"""Provider should have an asyncio.Lock for token refresh."""
provider = gc.GitHubCopilotProvider()
assert isinstance(provider._copilot_token_lock, asyncio.Lock)