Repository navigation
Expand file tree
/
Copy pathtoken_manager.py
More file actions
289 lines (248 loc) · 11.4 KB
/
Copy pathtoken_manager.py
File metadata and controls
289 lines (248 loc) · 11.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
"""Holds the live token state and owns token recovery + persistence.
Two recovery strategies, picked automatically:
* **refresh_token** (user flows): rotates — every refresh returns a NEW refresh token,
persisted BEFORE the retried request can use it (the critical invariant).
* **re-mint** (client_credentials): cc tokens have NO refresh token, but a client built via
``Wefunder.from_client_credentials`` holds the grant inputs, so it mints a fresh token on
expiry/401 instead of raising.
Either way, concurrent callers coalesce: a burst of 401s performs ONE recovery. The
transport passes the token it just used; if the manager already holds a different token,
another caller recovered in the meantime and the current token is returned without a
round-trip (no rotation race, no thundering herd).
"""
from __future__ import annotations
import asyncio
import inspect
import threading
import time
from collections.abc import Awaitable, Callable
from typing import Any, Protocol
from .errors import WefunderAuthError
from .oauth import Now, TokenSet, async_refresh_token, refresh_token, resolve_token_base
DEFAULT_EXPIRY_LEEWAY_SECONDS = 30.0
class WefunderTokenPersistenceError(Exception):
"""The token store failed to save a rotated token set.
``tokens`` is the rotated set that is NOT yet durable and NOT yet in use: the manager keeps
it pending and retries the save on the next call (or persist it yourself and call
``mark_persisted()``). Until it is saved no request uses it, and the consumed refresh token
is never reused either.
"""
def __init__(self, tokens: TokenSet, cause: BaseException) -> None:
super().__init__(f"Token store failed to save the rotated token set: {cause}")
self.tokens = tokens
self.__cause__ = cause
class TokenStore(Protocol):
"""Pluggable persistence for the rotating token set (DB row, secrets manager, …).
``save`` may be sync or async."""
def save(self, tokens: TokenSet) -> Any: ...
async def _maybe_await(value: Any) -> Any:
if inspect.isawaitable(value):
return await value
return value
class _TokenManagerBase:
def __init__(
self,
tokens: TokenSet,
*,
client_id: str | None = None,
client_secret: str | None = None,
on_token_refresh: Callable[[TokenSet], Any] | None = None,
store: TokenStore | None = None,
now: Now | None = None,
expiry_leeway_seconds: float = DEFAULT_EXPIRY_LEEWAY_SECONDS,
token_base_url: str | None = None,
oauth_base_url: str | None = None,
timeout: Any = 30.0,
) -> None:
self._timeout = timeout
self._tokens = tokens
self._pending: TokenSet | None = None
self._client_id = client_id
self._client_secret = client_secret
self._on_token_refresh = on_token_refresh
self._store = store
self._now = now or time.time
self._leeway = expiry_leeway_seconds
self._token_base_url = resolve_token_base(token_base_url=token_base_url, oauth_base_url=oauth_base_url)
@property
def current(self) -> TokenSet:
"""The durable, in-use token set. A rotated set that could not be persisted sits in ``pending_tokens``."""
return self._tokens
@property
def pending_tokens(self) -> TokenSet | None:
"""A rotated set awaiting a successful ``store.save`` (see :class:`WefunderTokenPersistenceError`)."""
return self._pending
def _can_rotate(self) -> bool:
return bool(self._tokens.refresh_token and self._client_id)
def _near_expiry(self) -> bool:
exp = self._tokens.expires_at
return exp is not None and self._now() >= exp - self._leeway
def _keep_refresh_token(self, nxt: TokenSet, previous: str | None) -> TokenSet:
# Some servers omit a fresh refresh_token on rotation-disabled flows; keep the
# previous one rather than dropping our ability to refresh.
if not nxt.refresh_token:
nxt.refresh_token = previous
return nxt
def _no_recovery(self) -> WefunderAuthError:
return WefunderAuthError("Access token expired and no refresh token / re-mint capability is configured.")
class TokenManager(_TokenManagerBase):
"""Thread-safe (sync) token manager."""
def __init__(
self,
tokens: TokenSet,
*,
re_mint: Callable[[], TokenSet] | None = None,
transport: Any = None,
**kwargs: Any,
) -> None:
super().__init__(tokens, **kwargs)
self._re_mint = re_mint
self._transport = transport
self._lock = threading.Lock()
@property
def can_refresh(self) -> bool:
"""True if an expired token can be recovered (rotate a refresh token or re-mint)."""
return self._can_rotate() or self._re_mint is not None
def get_access_token(self) -> str:
"""A valid access token, refreshing proactively if expired / within the leeway. If a
rotated set is pending persistence, the save is retried first — no request uses an
undurable token."""
if self._pending is not None:
with self._lock:
if self._pending is not None: # re-check under the lock
self._publish_pending()
if self._near_expiry() and self.can_refresh:
self.refresh(stale_token=self._tokens.access_token)
return self._tokens.access_token
def mark_persisted(self) -> TokenSet:
"""Tell the manager you persisted ``pending_tokens`` yourself; publishes it."""
with self._lock:
if self._pending is None:
return self._tokens
self._tokens, self._pending = self._pending, None
if self._on_token_refresh is not None:
self._on_token_refresh(self._tokens)
return self._tokens
def _publish_pending(self) -> TokenSet:
# Persist BEFORE publishing (caller holds the lock): no thread may use the rotated token
# until it is durable, and a failed save must not leave the process working in memory but
# unable to reconnect after a restart. On failure the set stays pending and
# WefunderTokenPersistenceError is raised; the next call retries the save.
tokens = self._pending
assert tokens is not None
try:
if self._store is not None:
self._store.save(tokens)
except Exception as exc:
raise WefunderTokenPersistenceError(tokens, exc) from exc
self._pending = None
self._tokens = tokens
if self._on_token_refresh is not None:
self._on_token_refresh(tokens)
return tokens
def refresh(self, *, stale_token: str | None = None) -> TokenSet:
"""Recover the token (after a 401 or proactively). Coalesces concurrent callers:
if ``stale_token`` is no longer the current token, someone else already recovered
and the current set is returned without a network round-trip."""
with self._lock:
# A rotated set awaiting persistence: retry the save rather than rotating again (the
# old refresh token was consumed by that rotation).
if self._pending is not None:
return self._publish_pending()
if stale_token is not None and self._tokens.access_token != stale_token:
return self._tokens
previous_refresh = self._tokens.refresh_token
if self._can_rotate():
nxt = refresh_token(
client_id=self._client_id or "",
client_secret=self._client_secret,
refresh_token=previous_refresh or "",
token_base_url=self._token_base_url,
transport=self._transport,
now=self._now,
timeout=self._timeout,
)
nxt = self._keep_refresh_token(nxt, previous_refresh)
elif self._re_mint is not None:
nxt = self._re_mint()
else:
raise self._no_recovery()
self._pending = nxt
return self._publish_pending()
class AsyncTokenManager(_TokenManagerBase):
"""asyncio token manager. ``re_mint``, ``store.save`` and ``on_token_refresh`` may be
coroutine functions or plain callables."""
def __init__(
self,
tokens: TokenSet,
*,
re_mint: Callable[[], Awaitable[TokenSet] | TokenSet] | None = None,
transport: Any = None,
**kwargs: Any,
) -> None:
super().__init__(tokens, **kwargs)
self._re_mint = re_mint
self._transport = transport
self._lock: asyncio.Lock | None = None
def _get_lock(self) -> asyncio.Lock:
# Created lazily so the manager can be built outside a running loop.
if self._lock is None:
self._lock = asyncio.Lock()
return self._lock
@property
def can_refresh(self) -> bool:
return self._can_rotate() or self._re_mint is not None
async def get_access_token(self) -> str:
if self._pending is not None:
async with self._get_lock():
if self._pending is not None: # re-check under the lock
await self._publish_pending()
if self._near_expiry() and self.can_refresh:
await self.refresh(stale_token=self._tokens.access_token)
return self._tokens.access_token
async def mark_persisted(self) -> TokenSet:
"""Tell the manager you persisted ``pending_tokens`` yourself; publishes it."""
async with self._get_lock():
if self._pending is None:
return self._tokens
self._tokens, self._pending = self._pending, None
if self._on_token_refresh is not None:
await _maybe_await(self._on_token_refresh(self._tokens))
return self._tokens
async def _publish_pending(self) -> TokenSet:
tokens = self._pending
assert tokens is not None
try:
if self._store is not None:
await _maybe_await(self._store.save(tokens))
except Exception as exc:
raise WefunderTokenPersistenceError(tokens, exc) from exc
self._pending = None
self._tokens = tokens
if self._on_token_refresh is not None:
await _maybe_await(self._on_token_refresh(tokens))
return tokens
async def refresh(self, *, stale_token: str | None = None) -> TokenSet:
async with self._get_lock():
if self._pending is not None:
return await self._publish_pending()
if stale_token is not None and self._tokens.access_token != stale_token:
return self._tokens
previous_refresh = self._tokens.refresh_token
if self._can_rotate():
nxt = await async_refresh_token(
client_id=self._client_id or "",
client_secret=self._client_secret,
refresh_token=previous_refresh or "",
token_base_url=self._token_base_url,
transport=self._transport,
now=self._now,
timeout=self._timeout,
)
nxt = self._keep_refresh_token(nxt, previous_refresh)
elif self._re_mint is not None:
nxt = await _maybe_await(self._re_mint())
else:
raise self._no_recovery()
self._pending = nxt
return await self._publish_pending()