-
Notifications
You must be signed in to change notification settings - Fork 1
feat(slack): expose web_client property on SlackAdapter (#98) #127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 4 commits
d0692a4
a7f5b53
dcb798a
41c8f31
e8a7dae
eff1a00
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ | |
| import os | ||
| import re | ||
| import time | ||
| import warnings | ||
| from collections import OrderedDict | ||
| from collections.abc import AsyncIterable, Awaitable, Callable | ||
| from contextvars import ContextVar | ||
|
|
@@ -466,6 +467,16 @@ def __init__(self, config: SlackAdapterConfig | None = None) -> None: | |
| self._client_cache: OrderedDict[str, Any] = OrderedDict() | ||
| self._client_cache_max = config.client_cache_max if config.client_cache_max is not None else 100 | ||
|
|
||
| # Cache of synchronous slack_sdk.WebClient instances keyed by bot | ||
| # token, backing the public ``web_client`` property (the direct port | ||
| # of upstream's ``getClientForToken``). Kept separate from | ||
| # ``_client_cache`` because that one holds async ``AsyncWebClient`` | ||
| # instances used by the adapter's own API calls; the two client types | ||
| # are not interchangeable. Mirrors upstream's plain (unbounded) Map — | ||
| # one entry per distinct token — since callers reach for this escape | ||
| # hatch rarely and tokens are low-cardinality. | ||
| self._web_client_cache: dict[str, Any] = {} | ||
|
|
||
| # Multi-workspace OAuth fields. | ||
| # ``is not None`` (not truthiness) so an explicit empty-string user | ||
| # config does not silently fall back to env (hazard #1). Empty env | ||
|
|
@@ -590,6 +601,61 @@ def current_client(self) -> Any: | |
| """ | ||
| return self._get_client() | ||
|
|
||
| @property | ||
| def web_client(self) -> Any: | ||
| """Direct access to a synchronous ``slack_sdk.WebClient``. | ||
|
|
||
| Bound to the bot token for the current request context | ||
| (multi-workspace) or the configured default token | ||
| (single-workspace). Use for any Slack Web API call not covered by | ||
| the adapter's high-level methods — e.g. | ||
| ``adapter.web_client.pins_add(...)`` or | ||
| ``adapter.web_client.usergroups_list(...)``. | ||
|
|
||
| Resolution order (the standard 3-level resolver): | ||
|
|
||
| 1. Token from the current request context (set during webhook | ||
| handling, or by :meth:`with_bot_token` / :meth:`with_bot_token_async`). | ||
| 2. The default bot token, when configured as a static string or | ||
| already-resolved value. | ||
| 3. Otherwise raise :class:`AuthenticationError`. | ||
|
|
||
| Raises :class:`AuthenticationError` if neither is available — | ||
| typical causes are accessing ``web_client`` outside any | ||
| webhook / :meth:`with_bot_token` context in multi-workspace mode, | ||
| or having configured ``bot_token`` as an async resolver that has | ||
| not run yet. In the latter case await | ||
| :meth:`current_token_async` (or process the work inside the | ||
| webhook flow) so the resolver primes the token first. | ||
|
|
||
| Return type is ``Any`` (rather than the concrete ``WebClient``) | ||
| because ``slack_sdk`` is an optional dependency — consumers who do | ||
| not install the ``slack`` extra should not pay an import cost. | ||
|
|
||
| This is the direct port of upstream's ``adapter.webClient`` getter | ||
| (vercel/chat ``2f108bd``). Unlike :attr:`current_client` it returns | ||
| the *synchronous* ``WebClient`` (the analog of the single TS | ||
| ``WebClient``), so its methods are not awaitables. | ||
| """ | ||
| return self._get_web_client_for_token(self._get_token()) | ||
|
|
||
| @property | ||
| def client(self) -> Any: | ||
| """Deprecated alias for :attr:`web_client`. | ||
|
|
||
| .. deprecated:: | ||
| Use :attr:`web_client` instead. This alias mirrors upstream's | ||
| pre-rename ``adapter.client`` (vercel/chat ``8366b8b``) and is | ||
| kept for one release for backwards compatibility; it will be | ||
| removed in a future version. Emits :class:`DeprecationWarning`. | ||
| """ | ||
| warnings.warn( | ||
| "SlackAdapter.client is deprecated; use SlackAdapter.web_client instead.", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
| return self.web_client | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Token management | ||
| # ------------------------------------------------------------------ | ||
|
|
@@ -623,13 +689,49 @@ def _get_token(self) -> str: | |
| if self._default_bot_token_cache is not None: | ||
| return self._default_bot_token_cache | ||
| if self._default_bot_token_provider is not None: | ||
| # Resolver-based default token configured but never resolved. This | ||
| # is a programming error: the async entry path should have awaited | ||
| # ``_resolve_default_token()`` before reaching here. | ||
| provider = self._default_bot_token_provider | ||
| # Sync callable resolver: invoke it directly and prime the | ||
| # process-wide cache so subsequent sync access stays fast. Mirrors | ||
| # the cache-update semantics in ``_resolve_default_token`` (the | ||
| # async path). Async resolvers cannot be awaited from a sync | ||
| # context, so those still raise below — call ``current_token_async`` | ||
| # or enter via ``handle_webhook`` to prime the cache first. | ||
| if not inspect.iscoroutinefunction(provider): | ||
| resolved = provider() | ||
| # Defensive: a "sync" callable may still *return* a coroutine | ||
| # (e.g. ``lambda: some_async_fn()``) and ``iscoroutinefunction`` | ||
| # would not catch that. Caching a coroutine in | ||
| # ``_default_bot_token_cache`` would be a latent bug, so detect | ||
| # and raise instead. | ||
| if inspect.isawaitable(resolved): | ||
| # Close to suppress "coroutine was never awaited" | ||
| # RuntimeWarning before raising. ``isawaitable`` matches | ||
| # both coroutines and awaitable objects; both implement | ||
| # ``close`` via their ``__await__`` / Coroutine protocol. | ||
| close = getattr(resolved, "close", None) | ||
| if callable(close): | ||
| close() | ||
| raise AuthenticationError( | ||
| "slack", | ||
| "Bot token resolver returned an awaitable in a sync " | ||
| "context. Use the async API (handle_webhook / " | ||
| "current_token_async) so the resolver can be awaited.", | ||
| ) | ||
| if not isinstance(resolved, str) or not resolved: | ||
| raise AuthenticationError( | ||
| "slack", | ||
| "Bot token resolver returned an empty or non-string value.", | ||
| ) | ||
| self._default_bot_token_cache = resolved | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When Useful? React with 👍 / 👎. |
||
| return resolved | ||
| # Async resolver-based default token configured but never resolved. | ||
| # Cannot be awaited from a sync context — the async entry path must | ||
| # have awaited ``_resolve_default_token()`` before reaching here. | ||
| raise AuthenticationError( | ||
| "slack", | ||
| "Bot token resolver has not been invoked yet. Use the async API " | ||
| "(handle_webhook / current_token_async) so the resolver runs first.", | ||
| "Async bot token resolver has not been invoked yet. Use the " | ||
| "async API (handle_webhook / current_token_async) so the " | ||
| "resolver runs first.", | ||
| ) | ||
| raise AuthenticationError( | ||
| "slack", | ||
|
|
@@ -742,6 +844,26 @@ def _get_client(self, token: str | None = None) -> Any: | |
| def _invalidate_client(self, token: str) -> None: | ||
| """Remove a cached client (e.g., on token revocation).""" | ||
| self._client_cache.pop(token, None) | ||
| self._web_client_cache.pop(token, None) | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| def _get_web_client_for_token(self, token: str) -> Any: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The newly introduced def _invalidate_client(self, token: str) -> None:
"""Remove a cached client (e.g., on token revocation)."""
self._client_cache.pop(token, None)
self._web_client_cache.pop(token, None) self._client_cache.pop(token, None)
self._web_client_cache.pop(token, None) |
||
| """Return a synchronous ``slack_sdk.WebClient`` for *token*, cached. | ||
|
|
||
| Backs the public :attr:`web_client` property and is the direct port | ||
| of upstream's ``getClientForToken`` (vercel/chat ``2f108bd``): one | ||
| cached ``WebClient`` instance per distinct token. The import is | ||
| deferred so ``slack_sdk`` stays an optional dependency (hazard #10). | ||
|
|
||
| Distinct from :meth:`_get_client`, which caches the *async* | ||
| ``AsyncWebClient`` used by the adapter's own API calls. | ||
| """ | ||
| client = self._web_client_cache.get(token) | ||
| if client is None: | ||
| from slack_sdk import WebClient | ||
|
|
||
| client = WebClient(token=token) | ||
| self._web_client_cache[token] = client | ||
| return client | ||
|
|
||
| # ------------------------------------------------------------------ | ||
| # Initialization | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When
SlackAdapterConfig.bot_tokenis a synchronous callable andweb_clientis accessed before a webhook orcurrent_token_async()has primed_default_bot_token_cache, this path calls_get_token(), which raisesAuthenticationErrorinstead of invoking the configured resolver. That leaves single-workspace apps that use a sync resolver for rotation or lazy secret loading unable to use the new direct WebClient outside a request context, even though the resolver can be evaluated synchronously here.Useful? React with 👍 / 👎.