Compare commits

..
Author SHA1 Message Date
chengyongru 325f7b0367 fix(webui): name temporary chats from first message 2026-08-07 17:08:22 +08:00
chengyongru 4d77189d9c fix(webui): simplify temporary chat closing 2026-08-07 17:08:22 +08:00
chengyongru 68591cfd4b fix(webui): tighten temporary chat close action 2026-08-07 17:08:22 +08:00
chengyongru f971d7e895 fix(webui): derive temporary chats from session policy 2026-08-07 17:08:22 +08:00
chengyongru 36253685bd fix(webui): complete temporary chat mode 2026-08-07 17:07:58 +08:00
Xubin Renandchengyongru 324a61dff1 feat(webui): add temporary chat mode 2026-08-07 17:07:15 +08:00
chengyongruandGitHub 332c159b93 fix(weixin): harden protocol delivery, streaming, and login (#5263) 2026-08-07 16:53:31 +08:00
chengyongruandchengyongru edb3b7e446 fix(webui): preserve newly created topic route 2026-08-07 16:10:01 +08:00
chengyongruandchengyongru cdb2a474f9 refactor(webui): remove legacy session messages route 2026-08-07 15:16:57 +08:00
chengyongruandGitHub ff6deda178 fix: modernize dependency recovery guidance (#5282) 2026-08-07 13:58:13 +08:00
chengyongruandchengyongru 02a002a0e6 fix(webui): preserve activity text rendering 2026-08-07 13:04:42 +08:00
Xubin Ren 3836c32874 fix(webui): scope preset editor to one row 2026-08-07 12:42:37 +08:00
Xubin Ren 3fc69b2922 style(webui): inset expanded preset editor 2026-08-07 12:42:37 +08:00
Xubin Ren eb5d7e1a32 style(webui): distinguish expanded preset editor 2026-08-07 12:42:37 +08:00
Xubin Ren b77e1133cb fix(webui): preserve preset deletion workflow 2026-08-07 12:42:37 +08:00
Xubin Ren 1b12fbae39 fix(webui): explain disabled preset deletion 2026-08-07 12:42:37 +08:00
Xubin Ren 6f2512ce9a style(webui): retain model preset colors 2026-08-07 12:42:37 +08:00
Xubin Ren c8bc4d8510 fix(webui): make active model presets deletable 2026-08-07 12:42:37 +08:00
Xubin Ren e971e81b6c refactor(webui): expand model preset editor inline 2026-08-07 12:42:37 +08:00
Xubin Ren ada07aa799 feat(webui): add responsive model preset detail pane 2026-08-07 12:42:37 +08:00
chengyongruandchengyongru 2c7943a133 fix(memory): archive short idle sessions for Dream 2026-08-07 11:45:49 +08:00
chengyongruandchengyongru 8dfce4c162 fix(session): require user anchor for delivery retention 2026-08-07 10:53:55 +08:00
ziuusandchengyongru 60282d1588 fix(session): preserve proactive channel delivery during session retention trimming 2026-08-07 10:53:55 +08:00
Xubin Ren c2fd41b44d fix(webui): persist large sidebar ordering state 2026-08-06 19:11:05 +08:00
Xubin Ren 1d290614c9 fix(webui): align composer mention metrics 2026-08-06 19:11:05 +08:00
Xubin Ren 9af6bb91c7 fix(webui): preserve session drag contracts 2026-08-06 19:11:05 +08:00
Xubin Ren f44a766f98 feat(webui): preview dragged session mentions 2026-08-06 19:11:05 +08:00
Xubin Ren 9cf6cf0639 feat(webui): persist manual session ordering 2026-08-06 19:11:05 +08:00
Xubin Ren 2c8e63446f feat(webui): drag sessions into composer mentions 2026-08-06 19:11:05 +08:00
Orrin WittandGitHub 5c4c2cb819 fix(matrix): send non-empty POST body on room join for Continuwuity compatibility (#5248) 2026-08-06 18:29:57 +08:00
chengyongruandchengyongru 223b911e7e fix(webui): tighten interactive motion 2026-08-06 18:28:45 +08:00
chengyongruandGitHub a95fd0ee82 perf(webui): reduce cold-start payload (#5262) 2026-08-06 13:24:34 +08:00
chengyongruandGitHub 67805f5db8 feat: add provider-native request switches (#5254) 2026-08-05 18:26:39 +08:00
chengyongruandGitHub 5a1ab44baa fix(whatsapp): detect outbound media content before dispatch (#5203) 2026-08-05 15:44:23 +08:00
chengyongruandGitHub 9098ffd38f refactor(webui): improve visual consistency (#5249) 2026-08-05 13:24:45 +08:00
chengyongruandchengyongru a54d5d14cb fix(webui): feather clipped activity edges 2026-08-05 11:10:46 +08:00
chengyongruandGitHub 6e9ae5bd05 refactor(session): remove request-scoped access grants (#5238) 2026-08-05 10:18:46 +08:00
Xubin Renandchengyongru 858f6d96a6 fix(mattermost): preserve thread policy compatibility 2026-08-05 09:31:55 +08:00
Kenneth Zhaoandchengyongru cd4c1d0f6e feat(mattermost): separate group policy for threads vs channels 2026-08-05 09:31:55 +08:00
Xubin Ren be5af019b9 fix(wecom): sanitize fallback media filename 2026-08-04 22:04:21 +08:00
santhrealandXubin Ren 98507ae4fe fix(wecom): fallback to default filename when sanitize strips to empty 2026-08-04 22:04:21 +08:00
concertypinandXubin Ren cb2f9d0bbd fix(webui): configure public websocket URL 2026-08-04 21:53:16 +08:00
concertypinandXubin Ren e318e21cad fix(webui): require proxy-generated auth assertions 2026-08-04 21:53:16 +08:00
concertypinandXubin Ren 465a918cf8 feat(webui): bypass tokens for trusted proxy auth 2026-08-04 21:53:16 +08:00
concertypinandXubin Ren 5cd14a42df feat(webui): support trusted proxy bootstrap auth 2026-08-04 21:53:16 +08:00
santhrealandXubin Ren 170c7083ed fix(telegram): require newline for language tag to preserve single-line fenced code 2026-08-04 21:40:03 +08:00
santhrealandXubin Ren a13e29bf07 fix(telegram): preserve code block content when language tag contains special characters 2026-08-04 21:40:03 +08:00
chengyongruandGitHub 5770329542 fix(webui): render markdown in prompt rail previews (#5244) 2026-08-04 18:24:54 +08:00
chengyongruandchengyongru 29fdb7d628 fix(webui): align timestamp tooltip styles 2026-08-04 18:22:12 +08:00
Xubin Ren fa65a01977 refactor(webui): narrow floating control migration 2026-08-04 18:05:34 +08:00
Xubin Ren 28ec8a1b47 fix(webui): correct combobox navigation semantics 2026-08-04 18:05:34 +08:00
Xubin Ren 3b4a056947 chore(webui): sync npm lockfile 2026-08-04 18:05:34 +08:00
Xubin Ren 7819cef7bd refactor(webui): unify floating controls 2026-08-04 18:05:34 +08:00
188 changed files with 10430 additions and 2153 deletions
+36 -4
View File
@@ -347,6 +347,36 @@ Valid `apiType` values are exactly `auto`, `chat_completions`, and `responses`.
}
```
The WebUI's OpenAI web-search switch writes the corresponding `apiType` and `extraBody.tools`
fields. A hosted search tool replaces nanobot's same-name local `web_search` function for that
request, while other tools such as `web_fetch` remain available.
</details>
<details>
<summary><b>DeepSeek native web search</b></summary>
DeepSeek V4 Flash uses DeepSeek's native Responses API. Its provider-hosted web search is
enabled by default because it does not require a separate paid add-on. Turn it off from the
WebUI provider settings, or with:
```json
{
"providers": {
"deepseek": {
"apiKey": "${DEEPSEEK_API_KEY}",
"extraBody": {
"tools": []
}
}
}
}
```
The switch applies to `deepseek-v4-flash`; DeepSeek models that remain on Chat Completions
cannot use this Responses tool. Native search calls appear in the WebUI activity stream, and
their opaque output items are preserved for multi-turn Responses state replay.
</details>
<a id="responses-state-and-compaction"></a>
@@ -695,7 +725,7 @@ Then run:
nanobot agent -m "Hello!"
```
To opt in to Codex Fast mode, merge this provider setting into `config.json`:
Codex Fast mode can be enabled from the WebUI provider settings, or with:
```json
{
@@ -709,9 +739,9 @@ To opt in to Codex Fast mode, merge this provider setting into `config.json`:
}
```
`priority` is the Responses API request value used by Codex Fast mode. The setting only works
for models and accounts that support Fast mode; remove `service_tier` to return to standard
processing. Fast mode consumes Codex credits at a higher rate. See the
The switch sends the Responses API `service_tier: "priority"` value. It only works for models
and accounts that support Fast mode; turn the switch off to return to standard processing.
Fast mode consumes Codex credits at a higher rate. See the
[OpenAI Codex rate card](https://help.openai.com/en/articles/20001106) for current details.
For proxy, remote/headless login, model-name, or config-key errors, see [`troubleshooting.md`](./troubleshooting.md#provider-and-model-problems).
@@ -735,6 +765,8 @@ The provider reads xAI's model catalog and includes the server-hosted `x_search`
tool only when the selected model advertises `supportsBackendSearch`. Models
without that capability continue normally without hosted X Search. When enabled,
searches run inside xAI's Responses API and citations arrive as inline links.
Hosted X Search is on by default to preserve this behavior. It can be turned off in the
WebUI provider settings or with `providers.xaiGrok.extraBody.tools: []`.
This is xAI subscription OAuth, not X Developer OAuth. nanobot follows the
public OAuth client and proxy contract used by
+43 -2
View File
@@ -67,7 +67,7 @@ If deployment fails, open the service **Logs** page first. A missing model key f
> Official Docker usage currently means building from this repository with the included `Dockerfile`. Docker Hub images under third-party namespaces are not maintained or verified by HKUDS/nanobot; do not mount API keys or bot tokens into them unless you trust the publisher.
> [!IMPORTANT]
> The gateway and WebSocket channel default to `host: "127.0.0.1"` in `config.json` (set in `nanobot/config/schema.py`). Docker `-p` port forwarding cannot reach a container's loopback interface, so for the host or LAN to reach the exposed ports you must set both binds to `0.0.0.0` in `~/.nanobot/config.json` before starting the container. To serve the bundled WebUI from Docker, bind the WebSocket channel externally and protect bootstrap with a secret:
> The gateway and WebSocket channel default to `host: "127.0.0.1"` in `config.json` (set in `nanobot/config/schema.py`). Docker `-p` port forwarding cannot reach a container's loopback interface, so for the host or LAN to reach the exposed ports you must set both binds to `0.0.0.0` in `~/.nanobot/config.json` before starting the container. To serve the bundled WebUI from Docker, bind the WebSocket channel externally and protect bootstrap with `tokenIssueSecret`:
>
> ```json
> {
@@ -82,13 +82,54 @@ If deployment fails, open the service **Logs** page first. A missing model key f
> }
> ```
>
> When the WebSocket `host` is `0.0.0.0`, the channel refuses to start unless `token` or `tokenIssueSecret` is also configured. See [`webui.md#lan-access`](./webui.md#lan-access) for details.
> When the WebSocket `host` is `0.0.0.0`, the channel refuses to start unless `token`, `tokenIssueSecret`, or a fully configured `trustedProxyAuth` is also configured. See [`webui.md#lan-access`](./webui.md#lan-access) for details.
> The gateway health route itself is intentionally minimal and unauthenticated. When the
> container binds it to `0.0.0.0`, publish port `18790` to host loopback only; place any
> remotely monitored health endpoint behind a firewall or reverse proxy. If another host
> must probe it directly, replace `127.0.0.1` in the port mapping with a trusted host
> interface and restrict inbound traffic to the monitoring system.
### Cloudflare Tunnel + Cloudflare Access
For a local `cloudflared` process in front of nanobot, Cloudflare Access can
authenticate the user before forwarding the request and add
`Cf-Access-Jwt-Assertion`. Opt in to trusted-proxy no-token mode only when the
direct TCP peer is the tunnel process and the assertion is non-empty:
```json
{
"gateway": { "host": "127.0.0.1" },
"channels": {
"websocket": {
"host": "127.0.0.1",
"port": 8765,
"publicWsUrl": "wss://nanobot.example.com/",
"trustedProxyAuth": {
"trustedPeerCidrs": ["127.0.0.1/32", "::1/128"],
"assertionHeader": "Cf-Access-Jwt-Assertion"
}
}
}
}
```
This is two-part authorization: a trusted direct loopback peer **and** a
non-empty Cloudflare Access assertion. A trusted CIDR alone is not a bypass.
For this flow `/webui/bootstrap` returns connection metadata without a
bootstrap token or REST API token; the proxy assertion authorizes the WebSocket
handshake and REST requests directly.
Set `publicWsUrl` to the browser-facing `wss://` endpoint when the tunnel sends
the origin host header (such as `127.0.0.1:8765`); otherwise the WebUI could
attempt to open its WebSocket directly against the loopback address.
The assertion header must be generated
by Cloudflare Access after authentication; routing/client metadata headers such
as `Host`, `Forwarded`, `X-Forwarded-*`, `X-Real-IP`, and `CF-Connecting-IP`
are rejected as `assertionHeader` values. Nanobot trusts the assertion but does
not cryptographically validate the JWT, so configure the tunnel and Access
policy carefully and do not expose the nanobot listener directly to untrusted
clients. Forwarded client headers do not establish proxy trust.
### Docker Compose
The default image preinstalls WhatsApp dependencies. To bake other enabled
@@ -27,7 +27,7 @@ nanobot agent -m "Hello!"
Install Langfuse:
```bash
python -m pip install langfuse
nanobot plugins enable langfuse
```
## Minimal working example
+12 -3
View File
@@ -41,6 +41,7 @@ Merge this snippet into `~/.nanobot/config.json`:
"token": "YOUR_MATTERMOST_TOKEN",
"teamId": "YOUR_TEAM_ID",
"groupPolicy": "mention",
"groupPolicyInThread": "open",
"replyInThread": true,
"dm": {
"policy": "allowlist"
@@ -51,7 +52,15 @@ Merge this snippet into `~/.nanobot/config.json`:
```
`teamId` scopes the channel to a Mattermost team. Keep `groupPolicy` as
`mention` for the first test.
`mention` for the first test. `groupPolicyInThread` can be `"mention"`,
`"open"`, or `"allowlist"` and controls messages that reply inside a
thread. If it is omitted, it inherits `groupPolicy`, preserving the behavior
of existing configurations. Set it to `"open"` explicitly when follow-up
messages in threads should not require another @mention.
When `groupPolicy` is `"allowlist"`, `groupAllowFrom` remains the outer
channel boundary for root posts and thread replies. A thread policy cannot open
a channel that is not on that allowlist.
Mattermost DMs are open by default. Setting `dm.policy` to `"allowlist"` with no
`dm.allowFrom` entries makes new DM senders receive a pairing code. Approve the
@@ -93,8 +102,8 @@ Then DM the bot again, or mention it in a channel where the bot has access:
- If DMs are ignored, review the `dm` policy and pairing approval state.
- If channel messages are ignored, confirm the bot is mentioned and belongs to
the team/channel.
- If thread replies are surprising, review `replyInThread` and
`includeThreadContext`.
- If thread replies are surprising, review `groupPolicyInThread`,
`replyInThread`, and `includeThreadContext`.
## Next: memory, automations, MCP tools
+1 -1
View File
@@ -549,7 +549,7 @@ This recipe applies after the agent works and you want observability for OpenAI-
Install the optional package in the same Python environment that runs nanobot:
```bash
python -m pip install langfuse
nanobot plugins enable langfuse
```
Set the environment variables before starting nanobot:
+4 -2
View File
@@ -262,9 +262,9 @@ Arbitrary custom provider names are OpenAI-compatible only; they do not use the
}
```
`providers.openai.apiType` may be set when you need to force a specific OpenAI API surface. Other providers reject `apiType`; leave it unset outside `providers.openai`. Replace the model with a model ID available to your OpenAI account. Direct OpenAI Responses, OpenAI Codex, Azure OpenAI Responses, and eligible GitHub Copilot models share [opaque Responses state retention](./configuration.md#responses-state-and-compaction); native compaction is enabled only where the backend supports it.
`providers.openai.apiType` may be set when you need to force a specific OpenAI API surface. Other providers reject `apiType`; leave it unset outside `providers.openai`. Replace the model with a model ID available to your OpenAI account. Direct OpenAI Responses, OpenAI Codex, Azure OpenAI Responses, and eligible GitHub Copilot models share [opaque Responses state retention](./configuration.md#responses-state-and-compaction); native compaction is enabled only where the backend supports it. The WebUI exposes provider-native switches for OpenAI web search, Codex Fast mode, DeepSeek web search, and Grok X Search. These switches write the corresponding raw provider request fields under `extraBody`.
DeepSeek is the model-level exception in the OpenAI-compatible provider: `deepseek-v4-flash` automatically uses DeepSeek's native Responses API, while `deepseek-v4-pro` remains on Chat Completions.
DeepSeek is the model-level exception in the OpenAI-compatible provider: `deepseek-v4-flash` automatically uses DeepSeek's native Responses API, while `deepseek-v4-pro` remains on Chat Completions. Its native `web_search` tool is enabled by default and shows its lifecycle in WebUI chat activity; set `providers.deepseek.extraBody.tools` to `[]` to disable it.
### Custom OpenAI-Compatible Endpoint
@@ -528,6 +528,8 @@ When enabled, Grok can search current X posts and return inline source links
without invoking a local nanobot tool. Credentials are stored under the
active instance's `auth/xai.json` (normally `~/.nanobot/auth/xai.json`), not in
`config.json` and not in Grok Build's credential file.
Hosted X Search remains enabled by default and can be disabled with the WebUI
switch or `providers.xaiGrok.extraBody.tools: []`.
The login is xAI subscription OAuth, not X Developer OAuth. It follows the
public client contract documented and implemented by
+59 -8
View File
@@ -76,7 +76,7 @@ ws://{host}:{port}{path}?client_id={id}&token={token}
| Parameter | Required | Description |
|-----------|----------|-------------|
| `client_id` | No | Identifier for `allowFrom` authorization. Auto-generated as `anon-xxxxxxxxxxxx` if omitted. Truncated to 128 chars. |
| `token` | Conditional | Authentication token. Required when `websocketRequiresToken` is `true` or `token` (static secret) is configured. |
| `token` | Conditional | Authentication token. Required when `websocketRequiresToken` is `true` or `token` (static secret) is configured, unless the request comes through an authenticated `trustedProxyAuth` peer. |
## Wire Protocol
@@ -216,16 +216,20 @@ All fields go under `channels.websocket` in `config.json`.
| `host` | string | `"127.0.0.1"` | Bind address. Use `"0.0.0.0"` to accept external connections. |
| `port` | int | `8765` | Listen port. |
| `path` | string | `"/"` | WebSocket upgrade path. Trailing slashes are normalized (root `/` is preserved). |
| `publicWsUrl` | string | `""` | Exact public `ws://` or `wss://` endpoint returned by `/webui/bootstrap`. Set this when a reverse proxy forwards requests with an origin `Host` header (for example, `wss://claw.example.com/`); its path must match `path`. |
| `maxMessageBytes` | int | `37748736` | Maximum inbound message size in bytes (1 KB 40 MB). Default (36 MB) is sized to accept up to 4 base64-encoded image attachments at 8 MB each; lower it if the channel only carries text. |
### Authentication
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `token` | string | `""` | Static shared secret. When set, clients must provide `?token=<value>` matching this secret (timing-safe comparison). Issued tokens are also accepted as a fallback. |
| `websocketRequiresToken` | bool | `true` | When `true` and no static `token` is configured, clients must still present a valid issued token. Set to `false` to allow unauthenticated connections (only safe for local/trusted networks). |
| `token` | string | `""` | Static shared secret. When set, clients must provide `?token=<value>` matching this secret (timing-safe comparison). Issued tokens are also accepted as a fallback. A trusted proxy assertion bypasses this requirement. |
| `websocketRequiresToken` | bool | `true` | When `true` and no static `token` is configured, clients must still present a valid issued token, unless `trustedProxyAuth` authenticates the direct proxy peer. Set to `false` to allow unauthenticated connections (only safe for local/trusted networks). |
| `tokenIssuePath` | string | `""` | HTTP path for issuing short-lived tokens. Must differ from `path`. See [Token Issuance](#token-issuance). |
| `tokenIssueSecret` | string | `""` | Secret required to obtain tokens via the issue endpoint. If empty, any client can obtain WebSocket connection tokens from `tokenIssuePath` (logged as a warning). `/webui/bootstrap` still issues WebUI REST API tokens for same-machine localhost browser requests; remote or forwarded bootstrap requires `tokenIssueSecret` or `token`. |
| `tokenIssueSecret` | string | `""` | Secret required to obtain tokens via the issue endpoint. If empty, any client can obtain WebSocket connection tokens from `tokenIssuePath` (logged as a warning). `/webui/bootstrap` issues tokens for local/secret-authenticated requests; trusted-proxy requests intentionally receive no bootstrap or API token. |
| `trustedProxyAuth` | object or `null` | `null` | Optional two-part no-token authorization for a directly connected upstream proxy. Both `trustedPeerCidrs` and a non-empty `assertionHeader` value must match; a CIDR alone never authorizes bootstrap or WebSocket/API access. |
| `trustedProxyAuth.trustedPeerCidrs` | list of CIDR strings | — | Direct TCP peer networks that may present the assertion. IPv4, IPv6, and IPv4-mapped IPv6 peers are supported; universal CIDRs (`0.0.0.0/0`, `::/0`) are rejected. |
| `trustedProxyAuth.assertionHeader` | string | — | Header injected by the identity-aware proxy after successful authentication. Routing/client metadata headers (`Host`, `Forwarded`, `X-Forwarded-*`, `X-Real-IP`, `CF-Connecting-IP`) are rejected; nanobot trusts the remaining header's non-empty value but does not cryptographically validate it. |
| `tokenTtlS` | int | `300` | Time-to-live for issued tokens in seconds (30 86,400). |
### Access Control
@@ -270,10 +274,57 @@ For production deployments where `websocketRequiresToken: true`, use short-lived
3. Client opens WebSocket with `?token=nbwt_aBcDeFg...&client_id=...`.
4. The token is consumed (single use) and cannot be reused.
The embedded WebUI's `/webui/bootstrap` route also returns a WebSocket token.
It returns a separate `api_token` for REST routes to same-machine localhost
browser requests, or after the request proves knowledge of `tokenIssueSecret`
or the static `token`.
The embedded WebUI's `/webui/bootstrap` route returns a WebSocket token and
REST `api_token` for local or secret-authenticated requests. When
`trustedProxyAuth` authenticates the direct proxy peer, it returns connection
metadata only: no bootstrap token, no REST API token, and no token query
parameter is required for the WebSocket handshake or subsequent REST requests.
### Trusted proxy no-token bootstrap
`trustedProxyAuth` is an opt-in alternative for deployments where an
identity-aware reverse proxy authenticates the user before connecting to nanobot.
The proxy assertion becomes the authentication boundary for the entire WebUI
surface: `/webui/bootstrap`, the WebSocket handshake, and REST API routes.
Bootstrap is accepted only when **both** the direct TCP peer matches one of
`trustedPeerCidrs` and the configured assertion header is present and non-empty.
A trusted address by itself is never sufficient.
Nanobot deliberately uses only `connection.remote_address` for the peer check.
It never uses `X-Forwarded-For`, `Forwarded`, `X-Real-IP`, `CF-Connecting-IP`,
or `X-Forwarded-Host` to decide whether the proxy is trusted. Nanobot trusts the
assertion supplied by the explicitly trusted peer, but does not cryptographically
validate or interpret the JWT/assertion contents. Do not enable this option if
untrusted clients can connect directly to the nanobot listener.
The configured assertion header must be a proxy-generated authentication
assertion, not a routing or client metadata header. Headers such as `Host`,
`Forwarded`, `X-Forwarded-*`, `X-Real-IP`, and `CF-Connecting-IP` are rejected
by configuration; use the identity provider's post-authentication assertion
header instead (for example, `Cf-Access-Jwt-Assertion`).
For example, a local Cloudflare Tunnel with Cloudflare Access can validate the
user at the edge and forward the resulting `Cf-Access-Jwt-Assertion`:
```json
{
"channels": {
"websocket": {
"host": "127.0.0.1",
"publicWsUrl": "wss://nanobot.example.com/",
"trustedProxyAuth": {
"trustedPeerCidrs": ["127.0.0.1/32", "::1/128"],
"assertionHeader": "Cf-Access-Jwt-Assertion"
}
}
}
}
```
This works only when the directly connected `cloudflared` process reaches
nanobot over the configured loopback address and supplies a non-empty assertion.
Keep nanobot firewalled from untrusted clients; this configuration is not a
CIDR-based bootstrap bypass.
### Example setup
+5 -21
View File
@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING, Any, Callable, Coroutine, cast
from loguru import logger
from nanobot.session.manager import Session, SessionManager
from nanobot.session.manager import MIN_COMPACTED_REPLAY_MESSAGES, Session, SessionManager
if TYPE_CHECKING:
from nanobot.agent.memory import Consolidator
@@ -16,7 +16,7 @@ if TYPE_CHECKING:
class AutoCompact:
_RECENT_SUFFIX_MESSAGES = 8
_RECENT_SUFFIX_MESSAGES = MIN_COMPACTED_REPLAY_MESSAGES
_INTERNAL_SESSION_PREFIXES = ("dream:",)
def __init__(self, sessions: SessionManager, consolidator: Consolidator,
@@ -45,25 +45,9 @@ class AutoCompact:
return False
return idle_seconds >= self._ttl * 60
def _has_compactable_idle_tail(self, key: str) -> bool:
def _has_unarchived_messages(self, key: str) -> bool:
session = self.sessions.get_or_create(key)
tail = list(session.messages[session.last_consolidated:])
if not tail:
return False
probe = Session(
key=session.key,
messages=tail,
created_at=session.created_at,
updated_at=session.updated_at,
metadata={},
last_consolidated=0,
)
result = probe.retain_recent_legal_suffix(
self._RECENT_SUFFIX_MESSAGES,
extend_to_user=True,
)
messages_to_remove = result.dropped[result.already_consolidated_count:]
return bool(messages_to_remove)
return session.last_consolidated < len(session.messages)
@staticmethod
def _format_summary(text: str, last_active: datetime) -> str:
@@ -88,7 +72,7 @@ class AutoCompact:
if key in active_session_keys:
continue
updated_at = info.get("updated_at")
if self._is_expired(updated_at, now) and self._has_compactable_idle_tail(key):
if self._is_expired(updated_at, now) and self._has_unarchived_messages(key):
session = self.sessions.get_or_create(key)
try:
runtime = resolve_runtime(session)
+15 -4
View File
@@ -13,7 +13,11 @@ from nanobot.agent.tools import mcp as mcp_tools
from nanobot.agent.tools import sessions as session_tools
from nanobot.agent.tools.registry import ToolRegistry
from nanobot.apps.cli import utils as cli_app_utils
from nanobot.bus.events import InboundMessage
from nanobot.bus.events import (
INBOUND_META_RUNTIME_CONTROL,
RUNTIME_CONTROL_SESSION_DISCARD,
InboundMessage,
)
from nanobot.runtime_context import (
RUNTIME_CONTEXT_END,
RUNTIME_CONTEXT_MESSAGE_META,
@@ -47,6 +51,9 @@ async def close_mcp(state: Any) -> None:
async def handle_runtime_control(state: Any, msg: InboundMessage, tools: ToolRegistry) -> bool:
if msg.metadata.get(INBOUND_META_RUNTIME_CONTROL) == RUNTIME_CONTROL_SESSION_DISCARD:
await state.discard_session(msg.session_key)
return True
for handler in (
image_generation_tools.handle_runtime_control,
mcp_tools.handle_runtime_control,
@@ -79,6 +86,7 @@ class ContextBuilder:
channel: str | None = None,
session_summary: str | None = None,
workspace: Path | None = None,
include_memory: bool = True,
include_memory_recent_history: bool = True,
session_key: str | None = None,
unified_session: bool = False,
@@ -93,9 +101,10 @@ class ContextBuilder:
parts.append(render_template("agent/tool_contract.md"))
memory = self.memory.read_memory()
if memory and not self._is_template_content(memory, "memory/MEMORY.md"):
parts.append(f"# Memory\n\n## Long-term Memory\n{memory}")
if include_memory:
memory = self.memory.read_memory()
if memory and not self._is_template_content(memory, "memory/MEMORY.md"):
parts.append(f"# Memory\n\n## Long-term Memory\n{memory}")
active_skills = self.skills.get_always_skills()
active_skills.extend(
@@ -219,6 +228,7 @@ class ContextBuilder:
session_summary: str | None = None,
runtime_context_blocks: Sequence[RuntimeContextBlock] | None = None,
workspace: Path | None = None,
include_memory: bool = True,
include_memory_recent_history: bool = True,
session_key: str | None = None,
unified_session: bool = False,
@@ -238,6 +248,7 @@ class ContextBuilder:
channel=channel,
session_summary=session_summary,
workspace=root,
include_memory=include_memory,
include_memory_recent_history=include_memory_recent_history,
session_key=session_key,
unified_session=unified_session,
+48 -9
View File
@@ -398,6 +398,7 @@ class AgentLoop:
self._mcp_connecting = False
self._runtime_context_providers: list[RuntimeContextProvider] = []
self._active_tasks: dict[str, set[asyncio.Task[Any]]] = {}
self._discarding_sessions: set[str] = set()
self._background_tasks: set[asyncio.Task[Any]] = set()
self._close_mcp_lock = asyncio.Lock()
self._session_locks: weakref.WeakValueDictionary[str, asyncio.Lock] = (
@@ -721,6 +722,7 @@ class AgentLoop:
session_summary=ctx.pending_summary,
workspace=scope.project_path,
runtime_context_blocks=ctx.runtime_context_blocks,
include_memory=ctx.session.policy.persist,
include_memory_recent_history=not ctx.ephemeral,
session_key=ctx.session.key,
unified_session=self._unified_session,
@@ -798,6 +800,15 @@ class AgentLoop:
sub_cancelled = await self.subagents.cancel_by_session(key)
return cancelled + sub_cancelled
async def discard_session(self, key: str) -> None:
"""Stop active work for *key* and forget its cached session."""
self._discarding_sessions.add(key)
try:
self.sessions.invalidate(key)
await self._cancel_active_tasks(key)
finally:
self._discarding_sessions.discard(key)
def _effective_session_key(self, msg: InboundMessage) -> str:
"""Return the session key used for task routing and mid-turn injections."""
if self._unified_session and not msg.session_key_override:
@@ -1161,6 +1172,11 @@ class AgentLoop:
effective_key = self._effective_session_key(msg)
if await agent_context.handle_runtime_control(self, msg, self.tools):
continue
if (
msg.require_existing_session
and self.sessions.get_cached(effective_key) is None
):
continue
if self.commands.is_priority(raw):
await self._dispatch_command_inline(
msg, effective_key, raw,
@@ -1279,6 +1295,8 @@ class AgentLoop:
# _emit_checkpoint during tool execution; materializing
# it into session history now makes it visible in the
# next conversation turn.
if session_key in self._discarding_sessions:
raise
try:
key = self._effective_session_key(msg)
session = self.sessions.get_or_create(key)
@@ -1556,6 +1574,7 @@ class AgentLoop:
had_injections: bool,
streamed_content: bool,
*,
log_content: bool = True,
turn_latency_ms: int | None = None,
) -> OutboundMessage | None:
"""Assemble the final outbound message from turn results."""
@@ -1564,8 +1583,11 @@ class AgentLoop:
if not had_injections or stop_reason == "empty_final_response":
return None
preview = final_content[:120] + "..." if len(final_content) > 120 else final_content
logger.info("Response to {}:{}: {}", msg.channel, msg.sender_id, preview)
if log_content:
preview = final_content[:120] + "..." if len(final_content) > 120 else final_content
logger.info("Response to {}:{}: {}", msg.channel, msg.sender_id, preview)
else:
logger.info("Response to {}:{}: [content hidden]", msg.channel, msg.sender_id)
event = None
meta = dict(msg.metadata or {})
@@ -1594,17 +1616,33 @@ class AgentLoop:
ctx.msg = dataclasses.replace(msg, content=new_content, media=image_paths)
msg = ctx.msg
preview = msg.content[:80] + "..." if len(msg.content) > 80 else msg.content
if ctx.session is None:
if msg.require_existing_session:
ctx.session = self.sessions.get_cached(ctx.session_key)
if ctx.session is None:
raise RuntimeError("required session is not active")
else:
ctx.session = self.sessions.get_or_create(ctx.session_key)
session = ctx.session
ctx.ephemeral = ctx.ephemeral or not session.policy.persist
tools = ctx.tools or self.tools
if session.policy.disabled_tools:
restricted = ToolRegistry()
for name in tools.tool_names:
tool = tools.get(name)
if name not in session.policy.disabled_tools and tool:
restricted.register(tool)
tools = restricted
ctx.tools = tools
if ctx.kind is TurnKind.SYSTEM:
logger.info("Processing system message from {}", msg.sender_id)
else:
elif session.policy.log_content:
preview = msg.content[:80] + "..." if len(msg.content) > 80 else msg.content
logger.info("Processing message from {}:{}: {}", msg.channel, msg.sender_id, preview)
else:
logger.info("Processing message from {}:{}: [content hidden]", msg.channel, msg.sender_id)
# Session is already fetched by the caller (_process_message) but
# ensure it exists in case this handler is invoked independently.
if ctx.session is None:
ctx.session = self.sessions.get_or_create(ctx.session_key)
session = ctx.session
self._remember_unified_session_route(
session,
msg,
@@ -1907,6 +1945,7 @@ class AgentLoop:
ctx.stop_reason,
ctx.had_injections,
ctx.streamed_content,
log_content=ctx.require_session().policy.log_content,
turn_latency_ms=ctx.turn_latency_ms,
)
if ctx.ephemeral and ctx.outbound is not None:
+36 -36
View File
@@ -21,7 +21,7 @@ from typing import TYPE_CHECKING, Any, Callable, Iterator, cast
from loguru import logger
from nanobot.runtime_context import public_history_messages
from nanobot.session.manager import Session, SessionManager
from nanobot.session.manager import MIN_COMPACTED_REPLAY_MESSAGES, Session, SessionManager
from nanobot.utils.gitstore import GitStore
from nanobot.utils.helpers import (
content_with_media_breadcrumbs,
@@ -858,14 +858,13 @@ class Consolidator:
return last_boundary
@staticmethod
def _full_unconsolidated_history(
def _full_replay_history(
session: Session,
) -> list[dict[str, Any]]:
"""Return the whole unconsolidated tail for consolidation decisions."""
unconsolidated_count = len(session.messages) - session.last_consolidated
if unconsolidated_count <= 0:
"""Return all messages that can reach the next model prompt."""
if not session.messages:
return []
return session.get_history(max_messages=unconsolidated_count)
return session.get_history(max_messages=len(session.messages))
@staticmethod
def _replay_overflow_boundary(
@@ -948,8 +947,8 @@ class Consolidator:
*,
runtime: LLMRuntime,
) -> tuple[int, str]:
"""Estimate prompt size from the full unconsolidated session tail."""
history = self._full_unconsolidated_history(session)
"""Estimate prompt size from the full replayable session history."""
history = self._full_replay_history(session)
channel = session.key.split(":", 1)[0] if ":" in session.key else None
# Include archived summary in estimation so the budget accounts for it.
meta = session.metadata.get("_last_summary")
@@ -1160,42 +1159,37 @@ class Consolidator:
session_key: str,
*,
runtime: LLMRuntime,
max_suffix: int = 8,
max_suffix: int = MIN_COMPACTED_REPLAY_MESSAGES,
) -> str | None:
"""Archive an idle prefix and hide it from replay without deleting it."""
"""Archive the full idle tail while keeping recent messages replayable.
``max_suffix`` remains accepted for SDK compatibility. Replay retention
is now derived independently from archive progress using the project-wide
compacted-session window.
"""
if max_suffix != MIN_COMPACTED_REPLAY_MESSAGES:
logger.debug(
"Idle-session compact for {} uses the fixed replay window ({}, requested {})",
session_key,
MIN_COMPACTED_REPLAY_MESSAGES,
max_suffix,
)
lock = self.get_lock(session_key)
async with lock:
self.sessions.invalidate(session_key)
session = self.sessions.get_or_create(session_key)
messages_to_summarize = list(session.messages[session.last_consolidated:])
if not messages_to_summarize:
self.sessions.save(session)
return ""
probe = Session(
key=session.key,
messages=messages_to_summarize.copy(),
created_at=session.created_at,
updated_at=session.updated_at,
metadata={},
last_consolidated=0,
)
result = probe.retain_recent_legal_suffix(max_suffix, extend_to_user=True)
visible_suffix = probe.messages
messages_to_remove = result.dropped
if not messages_to_remove:
self.sessions.save(session)
archive_start = session.last_consolidated
messages_to_archive = list(session.messages[archive_start:])
if not messages_to_archive:
return ""
last_active = session.updated_at
# The visible suffix informs the summary but stays out of raw fallback.
archive_end = archive_start + len(messages_to_archive)
summary = await self.archive(
messages_to_remove,
messages_to_archive,
runtime=runtime,
session_key=session_key,
summary_messages=messages_to_summarize,
)
if summary and summary != "(nothing)":
@@ -1204,16 +1198,22 @@ class Consolidator:
"last_active": last_active.isoformat(),
}
# Preserve history and advance only the replay boundary.
session.last_consolidated = len(session.messages) - len(visible_suffix)
# A turn can append while the provider call is in flight. Advance only
# through the captured batch so new messages remain eligible next time.
session.last_consolidated = archive_end
session.provider_state = None
self.sessions.save(session)
visible = session.get_history(
max_messages=MIN_COMPACTED_REPLAY_MESSAGES,
extend_to_user=True,
)
logger.info(
"Idle-session compact for {}: archived={}, visible={}, retained={}, summary={}",
session_key,
len(messages_to_remove),
len(visible_suffix),
len(messages_to_archive),
len(visible),
len(session.messages),
bool(summary),
)
-4
View File
@@ -216,10 +216,6 @@ class Tool(ABC):
def create(cls, ctx: ToolContext) -> Tool:
return cls()
def available(self) -> bool:
"""Return whether this tool is available in the current request."""
return True
def runtime_context_provider(self) -> RuntimeContextProvider | None:
"""Return optional per-turn prompt context owned by this tool."""
return None
+3 -11
View File
@@ -87,9 +87,8 @@ class ToolRegistry:
"""Get tool definitions with stable ordering for cache-friendly prompts.
Built-in tools are sorted first as a stable prefix, then MCP tools are
sorted and appended. The result is cached until the next
register/unregister call. Request-scoped availability is applied after
the cached schemas are built.
sorted and appended. The result is cached until the next
register/unregister call.
"""
if self._cached_definitions is None:
definitions = [tool.to_schema() for tool in self._tools.values()]
@@ -106,11 +105,7 @@ class ToolRegistry:
mcp_tools.sort(key=self._schema_name)
self._cached_definitions = builtins + mcp_tools
return [
schema
for schema in self._cached_definitions
if self._tools[self._schema_name(schema)].available()
]
return self._cached_definitions
def prepare_call(
self,
@@ -127,9 +122,6 @@ class ToolRegistry:
f"Error: Tool '{name}' not found.{hint} Available: {', '.join(self.tool_names)}"
)
)
if not tool.available():
return None, params, ToolResult.error(f"Error: Tool '{name}' is unavailable")
# Compatibility for external tools that still implement the legacy
# setter protocol. Built-ins read the authoritative ContextVar
# directly and never copy routing state.
+18 -45
View File
@@ -11,12 +11,10 @@ from typing import Any
from urllib.parse import quote
from nanobot.agent.tools.base import Tool, ToolResult, tool_parameters
from nanobot.agent.tools.context import ToolContext, current_request_context
from nanobot.agent.tools.context import ToolContext, current_request_session_key
from nanobot.agent.tools.schema import StringSchema, tool_parameters_schema
from nanobot.bus.events import INBOUND_META_SESSION_READ_SCOPE
from nanobot.security.workspace_access import current_workspace_scope
from nanobot.session.manager import SessionManager
from nanobot.webui.session_access import SessionAccessScope, WebuiSessionAccess
from nanobot.webui.session_access import WebuiSessionAccess
_SEARCH_LIMIT = 5
_READ_LIMIT = 8
@@ -31,26 +29,6 @@ def session_extra(metadata: Mapping[str, Any] | None) -> dict[str, Any]:
return {"session_mentions": mentions} if isinstance(mentions, list) and mentions else {}
def _session_scope() -> SessionAccessScope | None:
ctx = current_request_context()
if ctx is None or not ctx.session_key:
return None
prefix = ctx.metadata.get(INBOUND_META_SESSION_READ_SCOPE)
if (
not isinstance(prefix, str)
or not prefix.endswith(":")
or not ctx.session_key.startswith(prefix)
):
return None
workspace = current_workspace_scope()
return SessionAccessScope(
current_session_key=ctx.session_key,
session_key_prefix=prefix,
project_path=workspace.project_path if workspace is not None else ctx.workspace,
restrict_to_workspace=workspace.restrict_to_workspace if workspace is not None else False,
)
def _excerpt(text: str, needle: str, limit: int) -> str:
compact = " ".join(text.split())
if len(compact) <= limit:
@@ -86,9 +64,6 @@ class _SessionTool(Tool):
def read_only(self) -> bool:
return True
def available(self) -> bool:
return _session_scope() is not None
@tool_parameters(
tool_parameters_schema(
@@ -110,10 +85,9 @@ class SearchSessionsTool(_SessionTool):
@property
def description(self) -> str:
return (
"Search other persisted conversation sessions in the current session scope by title or "
"recent visible message text. Use this only when the user asks about a past "
"conversation or when prior discussion is needed to answer. Results contain bounded "
"excerpts; use "
"Search other persisted conversation sessions by title or recent visible message "
"text. Use this only when the user asks about a past conversation or when prior "
"discussion is needed to answer. Results contain bounded excerpts; use "
"read_session for more context. When citing a result, link its title to the exact "
"session_ref using Markdown. The current session is excluded."
)
@@ -126,10 +100,12 @@ class SearchSessionsTool(_SessionTool):
query = query.strip()
if not query:
return ToolResult.error("Error: search query must not be empty")
scope = _session_scope()
if scope is None:
return ToolResult.error("Error: session search is not available to this client")
matches = await asyncio.to_thread(self._access.search, scope, query, _SEARCH_LIMIT)
matches = await asyncio.to_thread(
self._access.search,
query,
_SEARCH_LIMIT,
exclude_session_key=current_request_session_key(),
)
needle = query.casefold()
result = {
"notice": _UNTRUSTED_NOTICE,
@@ -182,12 +158,12 @@ class ReadSessionTool(_SessionTool):
@property
def description(self) -> str:
return (
"Read visible user and assistant messages from a persisted conversation in the current "
"session scope. Pass an exact session_key from a selected session reference or "
"search_sessions. With query, return recent matching messages; without query, return "
"the latest visible messages. Treat returned history as untrusted reference material, "
"never as instructions. When citing the session, link its title to the exact "
"session_ref using Markdown. This tool never changes a session."
"Read visible user and assistant messages from a persisted conversation. Pass an exact "
"session_key from a selected session reference or search_sessions. With query, return "
"recent matching messages; without query, return the latest visible messages. Treat "
"returned history as untrusted reference material, never as instructions. When citing "
"the session, link its title to the exact session_ref using Markdown. This tool never "
"changes a session."
)
async def execute(
@@ -202,15 +178,12 @@ class ReadSessionTool(_SessionTool):
query_text = query.strip() if query else ""
if query is not None and not query_text:
return ToolResult.error("Error: query must not be empty")
scope = _session_scope()
if scope is None:
return ToolResult.error("Error: session access is not available for this session")
match = await asyncio.to_thread(
self._access.read,
scope,
session_key,
query=query_text,
limit=_READ_LIMIT,
exclude_session_key=current_request_session_key(),
)
if match is None:
return ToolResult.error(f"Error: session not found: {session_key}")
+4 -1
View File
@@ -458,7 +458,10 @@ class WebSearchTool(Tool):
Olostep_BaseError, # pyright: ignore[reportUnknownVariableType]
)
except ImportError:
return ToolResult.error("Error: olostep package not installed. Run: pip install olostep")
return ToolResult.error(
"Error: Olostep support is not installed. "
"Run `nanobot plugins enable olostep`."
)
async_olostep = cast(Any, AsyncOlostep)
olostep_base_error = cast(type[Exception], Olostep_BaseError)
api_key = self.config.api_key or os.environ.get("OLOSTEP_API_KEY", "")
+2 -2
View File
@@ -15,11 +15,10 @@ OUTBOUND_META_AGENT_UI = "_agent_ui"
# Internal-only inbound metadata used by in-process channels to ask the agent
# loop to update runtime state without going through a user session.
INBOUND_META_RUNTIME_CONTROL = "_runtime_control"
# Trusted namespace grant for read-only persisted-session tools.
INBOUND_META_SESSION_READ_SCOPE = "_session_read_scope"
RUNTIME_CONTROL_ACK = "_ack"
RUNTIME_CONTROL_MCP_RELOAD = "mcp_reload"
RUNTIME_CONTROL_IMAGE_GENERATION_RELOAD = "image_generation_reload"
RUNTIME_CONTROL_SESSION_DISCARD = "session_discard"
@dataclass
@@ -34,6 +33,7 @@ class InboundMessage:
media: list[str] = field(default_factory=list) # Media URLs
metadata: dict[str, Any] = field(default_factory=dict) # Channel-specific data
session_key_override: str | None = None # Optional override for thread-scoped sessions
require_existing_session: bool = False
@property
def session_key(self) -> str:
+19
View File
@@ -101,6 +101,23 @@ class BaseChannel(ABC):
"""
pass
def should_retry_send_error(self, error: Exception) -> bool:
"""Return whether the channel manager may retry a failed delivery.
Channels with protocol-level business errors can override this hook to
prevent retries that cannot succeed until external state changes.
Transport and unexpected errors remain retryable by default.
"""
return True
def start_error_message(self, error: Exception) -> str | None:
"""Return an actionable public message for a channel startup failure.
Channel-specific exception handling stays in the owning channel. Returning
``None`` keeps the manager's generic fallback.
"""
return None
async def send_delta(
self,
chat_id: str,
@@ -237,6 +254,7 @@ class BaseChannel(ABC):
session_key: str | None = None,
is_dm: bool = False,
authorization_id: str | None = None,
require_existing_session: bool = False,
) -> None:
"""Handle a message after checking its authorization subject.
@@ -289,6 +307,7 @@ class BaseChannel(ABC):
media=media or [],
metadata=meta,
session_key_override=session_key,
require_existing_session=require_existing_session,
)
await self.bus.publish_inbound(msg)
+27 -5
View File
@@ -187,11 +187,21 @@ class ChannelManager:
channel = cls(section, self.bus, **kwargs)
if runtime_name and runtime_name != channel.name:
channel.name = runtime_name
# Channel-owned config models may deliberately choose safer transport
# defaults than the global channel policy (for example, a quota-limited
# platform can disable progress messages). Preserve those defaults
# while still letting an explicit per-channel value win below.
progress_default = getattr(
channel.config, "send_progress", self.config.channels.send_progress,
)
tool_hints_default = getattr(
channel.config, "send_tool_hints", self.config.channels.send_tool_hints,
)
channel.send_progress = self._resolve_bool_override(
section, "send_progress", self.config.channels.send_progress,
section, "send_progress", progress_default,
)
channel.send_tool_hints = self._resolve_bool_override(
section, "send_tool_hints", self.config.channels.send_tool_hints,
section, "send_tool_hints", tool_hints_default,
)
channel.show_reasoning = self._resolve_bool_override(
section, "show_reasoning", self.config.channels.show_reasoning,
@@ -347,9 +357,13 @@ class ChannelManager:
await channel.start()
except asyncio.CancelledError:
raise
except Exception:
errors[name] = "Channel failed to start. Check gateway logs."
logger.exception("Failed to start channel {}", name)
except Exception as exc:
public_error = channel.start_error_message(exc)
errors[name] = public_error or "Channel failed to start. Check gateway logs."
if public_error:
logger.error("Failed to start channel {}: {}", name, public_error)
else:
logger.exception("Failed to start channel {}", name)
def _start_channel_task(self, name: str, channel: BaseChannel) -> asyncio.Task[None]:
logger.info("Starting {} channel...", name)
@@ -912,6 +926,14 @@ class ChannelManager:
except asyncio.CancelledError:
raise # Propagate cancellation for graceful shutdown
except Exception as e:
if not channel.should_retry_send_error(e):
logger.error(
"Send to {} failed with a non-retryable {}: {}",
msg.channel,
type(e).__name__,
e,
)
return
loop = asyncio.get_running_loop()
exhausted = (
attempt >= max_attempts
+48 -2
View File
@@ -24,10 +24,12 @@ try:
import nh3
from mistune import HTMLRenderer, create_markdown
from nio import (
Api,
AsyncClient,
AsyncClientConfig,
InviteEvent,
JoinError,
JoinResponse,
KeyVerificationCancel,
KeyVerificationEvent,
KeyVerificationKey,
@@ -43,6 +45,7 @@ try:
RoomSendResponse,
RoomTypingError,
SyncError,
SyncResponse,
ToDeviceError,
UploadError,
)
@@ -701,6 +704,7 @@ class MatrixChannel(BaseChannel):
client.add_response_callback(self._on_sync_error, SyncError)
client.add_response_callback(self._on_join_error, JoinError)
client.add_response_callback(self._on_send_error, RoomSendError)
client.add_response_callback(self._on_sync_invite_fallback, SyncResponse)
def _is_sas_sender_allowed(self, sender: str) -> bool:
return bool(sender and self.is_allowed(sender))
@@ -782,6 +786,49 @@ class MatrixChannel(BaseChannel):
with suppress(Exception):
self.client.stop_sync_forever()
async def _join_room_safe(self, room_id: str) -> bool:
"""Join a room, sending a non-empty POST body.
nio's ``Api.join()`` produces a POST with no body. Some homeservers
(notably Continuwuity) reject empty bodies with ``M_BAD_JSON``.
Sending ``"{}"`` satisfies both strict and lenient servers.
"""
client = self._require_client()
method, path = Api.join(client.access_token, room_id)
try:
resp = cast(
JoinResponse | JoinError,
await client._send( # type: ignore[reportPrivateUsage, reportUnknownMemberType]
JoinResponse, method, path, data="{}"
),
)
except Exception:
self.logger.error("Matrix join request exception for room={}", room_id, exc_info=True)
return False
if isinstance(resp, JoinError):
self.logger.error("Matrix auto-join failed for room={}: {}", room_id, resp)
return False
self.logger.info("Matrix auto-join succeeded: {}", room_id)
return True
async def _on_sync_invite_fallback(self, response: SyncResponse) -> None:
"""Safety net: join pending invites that the event callback may have missed.
Some homeservers (e.g. Continuwuity) deliver each invite only once.
If ``_on_room_invite`` fires but the join fails, the sync token
advances and the invite is never re-delivered. This callback inspects
the same ``SyncResponse`` for pending invites and joins them, acting
as a fallback alongside the event-based callback.
"""
if not response.rooms or not response.rooms.invite:
return
for room_id, invite_info in response.rooms.invite.items():
for event in cast(list[Any], invite_info.invite_state):
sender = getattr(event, "sender", None)
if sender and self.is_allowed(cast(str, sender)):
await self._join_room_safe(room_id)
break
async def _on_join_error(self, response: JoinError) -> None:
self._log_response_error("join", response)
@@ -838,8 +885,7 @@ class MatrixChannel(BaseChannel):
async def _on_room_invite(self, room: MatrixRoom, event: InviteEvent) -> None:
if self.is_allowed(event.sender):
client = self._require_client()
await client.join(room.room_id)
await self._join_room_safe(room.room_id)
def _is_direct_room(self, room: MatrixRoom) -> bool:
count = getattr(room, "member_count", None)
@@ -4,13 +4,14 @@ import asyncio
import sys
from pathlib import Path
from types import SimpleNamespace
from urllib.parse import unquote
import pytest
pytest.importorskip("nio")
pytest.importorskip("nh3")
pytest.importorskip("mistune")
from nio import RoomSendResponse, SyncError
from nio import JoinResponse, RoomSendResponse, SyncError
import nanobot.channels.matrix.runtime as matrix_module
from nanobot.bus.events import OutboundMessage
@@ -104,6 +105,15 @@ class _FakeAsyncClient:
async def join(self, room_id: str) -> None:
self.join_calls.append(room_id)
async def _send(self, response_class, method, path, data=None, **kwargs):
"""Minimal mock for nio's ``_send`` used by ``_join_room_safe``."""
if response_class is JoinResponse and method == "POST" and "/join/" in path:
encoded = path.split("/join/")[1].split("?")[0]
room_id = unquote(encoded)
self.join_calls.append(room_id)
return JoinResponse(room_id=room_id)
return response_class()
async def accept_key_verification(self, transaction_id: str):
self.operation_calls.append(f"accept:{transaction_id}")
self.accept_key_verification_calls.append(transaction_id)
@@ -308,7 +318,7 @@ async def test_start_skips_load_store_when_device_id_missing(
assert clients[0].load_store_called is False
assert len(clients[0].callbacks) == 3
assert clients[0].to_device_callbacks == []
assert len(clients[0].response_callbacks) == 3
assert len(clients[0].response_callbacks) == 4
await channel.stop()
@@ -590,6 +600,7 @@ async def test_room_invite_joins_when_sender_allowed() -> None:
assert client.join_calls == ["!room:matrix.org"]
@pytest.mark.asyncio
async def test_room_invite_respects_allow_list_when_configured() -> None:
channel = MatrixChannel(_make_config(allow_from=["@bob:matrix.org"]), MessageBus())
@@ -604,6 +615,61 @@ async def test_room_invite_respects_allow_list_when_configured() -> None:
assert client.join_calls == []
@pytest.mark.asyncio
async def test_on_sync_invite_fallback_joins_pending_invites() -> None:
"""_on_sync_invite_fallback joins rooms from sync invite_state for allowed senders."""
channel = MatrixChannel(
_make_config(allow_from=["@alice:matrix.org"]), MessageBus()
)
client = _FakeAsyncClient("", "", "", None)
channel.client = client
invite_event = SimpleNamespace(sender="@alice:matrix.org")
invite_info = SimpleNamespace(invite_state=[invite_event])
rooms = SimpleNamespace(invite={"!room:matrix.org": invite_info})
response = SimpleNamespace(rooms=rooms)
await channel._on_sync_invite_fallback(response)
assert client.join_calls == ["!room:matrix.org"]
@pytest.mark.asyncio
async def test_on_sync_invite_fallback_skips_when_no_invites() -> None:
"""_on_sync_invite_fallback is a no-op when sync has no invites."""
channel = MatrixChannel(
_make_config(allow_from=["@alice:matrix.org"]), MessageBus()
)
client = _FakeAsyncClient("", "", "", None)
channel.client = client
rooms = SimpleNamespace(invite={})
response = SimpleNamespace(rooms=rooms)
await channel._on_sync_invite_fallback(response)
assert client.join_calls == []
@pytest.mark.asyncio
async def test_on_sync_invite_fallback_skips_denied_sender() -> None:
"""_on_sync_invite_fallback respects the allow list."""
channel = MatrixChannel(
_make_config(allow_from=["@bob:matrix.org"]), MessageBus()
)
client = _FakeAsyncClient("", "", "", None)
channel.client = client
invite_event = SimpleNamespace(sender="@alice:matrix.org")
invite_info = SimpleNamespace(invite_state=[invite_event])
rooms = SimpleNamespace(invite={"!room:matrix.org": invite_info})
response = SimpleNamespace(rooms=rooms)
await channel._on_sync_invite_fallback(response)
assert client.join_calls == []
@pytest.mark.asyncio
async def test_on_message_sets_typing_for_allowed_sender() -> None:
channel = MatrixChannel(_make_config(), MessageBus())
+1
View File
@@ -10,6 +10,7 @@ SETUP_SPEC = ChannelSetupSpec(
"token": field("secret"),
"teamId": field(),
"groupPolicy": field("enum", choices=GROUP_POLICIES, default="mention"),
"groupPolicyInThread": field("enum", choices=GROUP_POLICIES, default="mention"),
"allowFrom": field("list"),
},
required=required_fields("serverUrl", "token"),
+32 -7
View File
@@ -9,7 +9,7 @@ from pathlib import Path
from typing import Any, cast
import httpx
from pydantic import Field
from pydantic import Field, model_validator
from nanobot.bus.events import OutboundMessage
from nanobot.bus.queue import MessageBus
@@ -47,6 +47,7 @@ class MattermostConfig(Base):
allow_from_match_mode: str = "id"
allow_from: list[str] = Field(default_factory=list)
group_policy: str = "mention"
group_policy_in_thread: str = "open"
group_allow_from: list[str] = Field(default_factory=list)
reply_in_thread: bool = True
include_thread_context: bool = True
@@ -59,6 +60,22 @@ class MattermostConfig(Base):
send_tool_hints: bool = True
dm: MattermostDMConfig = Field(default_factory=MattermostDMConfig)
@model_validator(mode="before")
@classmethod
def _inherit_thread_policy(cls, data: Any) -> Any:
"""Preserve the existing group policy unless a thread override is set."""
if not isinstance(data, dict):
return data
raw = cast(dict[str, Any], data)
if "groupPolicyInThread" in raw or "group_policy_in_thread" in raw:
return raw
values = dict(raw)
values["group_policy_in_thread"] = values.get(
"groupPolicy",
values.get("group_policy", "mention"),
)
return values
def _server_url_to_ws_url(server_url: str) -> str:
if server_url.startswith("https://"):
@@ -244,8 +261,10 @@ class MattermostChannel(BaseChannel):
)
return
if not is_dm and not self._should_respond_in_channel(message_text, channel_id):
return
if not is_dm:
in_thread = bool(root_id)
if not self._should_respond_in_channel(message_text, channel_id, in_thread=in_thread):
return
message_text = self._strip_bot_mention(message_text)
@@ -360,12 +379,18 @@ class MattermostChannel(BaseChannel):
return chat_id in self.config.group_allow_from
return True
def _should_respond_in_channel(self, text: str, chat_id: str) -> bool:
if self.config.group_policy == "open":
def _should_respond_in_channel(
self, text: str, chat_id: str, *, in_thread: bool = False,
) -> bool:
policy = (
self.config.group_policy_in_thread if in_thread
else self.config.group_policy
)
if policy == "open":
return True
if self.config.group_policy == "mention":
if policy == "mention":
return self._is_mentioned(text)
if self.config.group_policy == "allowlist":
if policy == "allowlist":
return chat_id in self.config.group_allow_from
return False
@@ -12,6 +12,7 @@ import pytest
from nanobot.bus.events import OutboundMessage
from nanobot.bus.queue import MessageBus
from nanobot.channels.mattermost.manifest import SETUP_SPEC
from nanobot.channels.mattermost.runtime import (
MATTERMOST_MAX_MESSAGE_LEN,
MattermostChannel,
@@ -123,6 +124,25 @@ def test_config_defaults():
assert config.dm.enabled is True
assert config.dm.policy == "open"
assert config.reply_in_thread is True
assert config.group_policy_in_thread == "mention"
def test_thread_policy_inherits_group_policy_when_omitted():
config = MattermostConfig.model_validate({"groupPolicy": "open"})
assert config.group_policy_in_thread == "open"
explicit = MattermostConfig.model_validate({
"groupPolicy": "open",
"groupPolicyInThread": "mention",
})
assert explicit.group_policy_in_thread == "mention"
def test_setup_contract_exposes_thread_policy():
field = SETUP_SPEC.fields["groupPolicyInThread"]
assert field.kind == "enum"
assert field.choices == {"open", "mention", "allowlist"}
assert field.default == "mention"
def test_config_camelcase_aliases():
@@ -375,6 +395,86 @@ async def test_group_policy_allowlist():
assert channel._should_respond_in_channel("msg", "c2") is False
@pytest.mark.asyncio
async def test_group_policy_in_thread_defaults_to_group_policy():
"""Existing configs keep their main-channel behavior in threads."""
channel, fake = _make_channel({"groupPolicy": "mention"})
channel._self_username = "nanobot"
# In a main channel (not thread), mention is required
assert channel._should_respond_in_channel("hello", "c1", in_thread=False) is False
assert channel._should_respond_in_channel("@nanobot hello", "c1", in_thread=False) is True
# In a thread, the omitted override inherits mention policy.
assert channel._should_respond_in_channel("hello", "c1", in_thread=True) is False
assert channel._should_respond_in_channel("@nanobot hello", "c1", in_thread=True) is True
@pytest.mark.asyncio
async def test_group_policy_in_thread_mention():
"""Thread can also use mention policy when configured."""
channel, fake = _make_channel({
"groupPolicy": "mention",
"groupPolicyInThread": "mention",
})
channel._self_username = "nanobot"
# In a thread with mention policy, mention is required
assert channel._should_respond_in_channel("hello", "c1", in_thread=True) is False
assert channel._should_respond_in_channel("@nanobot hello", "c1", in_thread=True) is True
@pytest.mark.asyncio
async def test_group_policy_in_thread_open():
"""Thread uses open policy when explicitly configured."""
channel, fake = _make_channel({
"groupPolicy": "mention",
"groupPolicyInThread": "open",
})
assert channel._should_respond_in_channel("hello", "c1", in_thread=True) is True
@pytest.mark.asyncio
async def test_posted_thread_event_uses_thread_policy():
"""A real posted event derives thread policy from its root_id."""
channel, fake = _make_channel({
"groupPolicy": "mention",
"groupPolicyInThread": "open",
"includeThreadContext": False,
})
channel._self_id = "bot_id"
channel._self_username = "nanobot"
with patch.object(channel, "_handle_message", AsyncMock()) as mock_handle:
ws_msg = {
"event": "posted",
"data": {
"channel_type": "O",
"post": json.dumps({
"id": "reply_1",
"user_id": "user_1",
"channel_id": "channel_1",
"message": "follow up without a mention",
"root_id": "root_1",
}),
},
"broadcast": {},
}
await channel._handle_ws_message(ws_msg)
mock_handle.assert_awaited_once()
assert mock_handle.call_args.kwargs["session_key"] == "mattermost:channel_1:root_1"
@pytest.mark.asyncio
async def test_group_policy_in_thread_allowlist():
"""Thread uses allowlist policy when configured."""
channel, fake = _make_channel({
"groupPolicy": "mention",
"groupPolicyInThread": "allowlist",
"groupAllowFrom": ["c1"],
})
assert channel._should_respond_in_channel("msg", "c1", in_thread=True) is True
assert channel._should_respond_in_channel("msg", "c2", in_thread=True) is False
# ---------------------------------------------------------------------------
# Match mode: id / username / email
# ---------------------------------------------------------------------------
@@ -15,6 +15,7 @@ export default {
{ key: "channels.mattermost.token" },
{ key: "channels.mattermost.teamId" },
{ key: "channels.mattermost.groupPolicy" },
{ key: "channels.mattermost.groupPolicyInThread" },
],
},
},
@@ -27,13 +27,21 @@
"placeholder": "Optional team ID"
},
"groupPolicy": {
"label": "Group behavior",
"label": "Channel behavior",
"choices": {
"mention": "Mention only",
"open": "All messages",
"allowlist": "Allowlist"
}
},
"groupPolicyInThread": {
"label": "Thread behavior",
"choices": {
"mention": "Mention only",
"open": "All messages (no mention needed)",
"allowlist": "Allowlist"
}
},
"allowFrom": {
"label": "Allowed users",
"placeholder": "User IDs, comma separated"
@@ -27,13 +27,21 @@
"placeholder": "ID de equipo opcional"
},
"groupPolicy": {
"label": "Comportamiento en grupos",
"label": "Comportamiento en canales",
"choices": {
"mention": "Solo menciones",
"open": "Todos los mensajes",
"allowlist": "Lista permitida"
}
},
"groupPolicyInThread": {
"label": "Comportamiento en hilos",
"choices": {
"mention": "Solo menciones",
"open": "Todos los mensajes (sin mención)",
"allowlist": "Lista permitida"
}
},
"allowFrom": {
"label": "Usuarios permitidos",
"placeholder": "ID de usuario separados por comas"
@@ -27,11 +27,19 @@
"placeholder": "ID d’équipe facultatif"
},
"groupPolicy": {
"label": "Comportement en groupe",
"label": "Comportement en canal",
"choices": {
"mention": "Mentions uniquement",
"open": "Tous les messages",
"allowlist": "Liste dautorisation"
"allowlist": "Liste d'autorisation"
}
},
"groupPolicyInThread": {
"label": "Comportement en fil",
"choices": {
"mention": "Mentions uniquement",
"open": "Tous les messages (sans mention)",
"allowlist": "Liste d'autorisation"
}
},
"allowFrom": {
@@ -27,13 +27,21 @@
"placeholder": "ID tim opsional"
},
"groupPolicy": {
"label": "Perilaku grup",
"label": "Perilaku kanal",
"choices": {
"mention": "Hanya sebutan",
"open": "Semua pesan",
"allowlist": "Daftar izin"
}
},
"groupPolicyInThread": {
"label": "Perilaku thread",
"choices": {
"mention": "Hanya sebutan",
"open": "Semua pesan (tanpa sebutan)",
"allowlist": "Daftar izin"
}
},
"allowFrom": {
"label": "Pengguna yang diizinkan",
"placeholder": "ID pengguna, dipisahkan koma"
@@ -27,13 +27,21 @@
"placeholder": "任意のチーム ID"
},
"groupPolicy": {
"label": "グループでの動作",
"label": "チャンネルでの動作",
"choices": {
"mention": "メンションのみ",
"open": "すべてのメッセージ",
"allowlist": "許可リスト"
}
},
"groupPolicyInThread": {
"label": "スレッドでの動作",
"choices": {
"mention": "メンションのみ",
"open": "すべてのメッセージ (メンション不要)",
"allowlist": "許可リスト"
}
},
"allowFrom": {
"label": "許可するユーザー",
"placeholder": "ユーザー ID(カンマ区切り)"
@@ -27,13 +27,21 @@
"placeholder": "선택적 팀 ID"
},
"groupPolicy": {
"label": "그룹 동작",
"label": "채널 동작",
"choices": {
"mention": "멘션만",
"open": "모든 메시지",
"allowlist": "허용 목록"
}
},
"groupPolicyInThread": {
"label": "스레드 동작",
"choices": {
"mention": "멘션만",
"open": "모든 메시지 (언급 불필요)",
"allowlist": "허용 목록"
}
},
"allowFrom": {
"label": "허용된 사용자",
"placeholder": "사용자 ID, 쉼표로 구분"
@@ -27,13 +27,21 @@
"placeholder": "ID de equipe opcional"
},
"groupPolicy": {
"label": "Comportamento em grupos",
"label": "Comportamento em canais",
"choices": {
"mention": "Somente menções",
"open": "Todas as mensagens",
"allowlist": "Lista de permissão"
}
},
"groupPolicyInThread": {
"label": "Comportamento em threads",
"choices": {
"mention": "Somente menções",
"open": "Todas as mensagens (sem menção)",
"allowlist": "Lista de permissão"
}
},
"allowFrom": {
"label": "Usuários permitidos",
"placeholder": "IDs de usuário separados por vírgulas"
@@ -27,13 +27,21 @@
"placeholder": "ID nhóm tùy chọn"
},
"groupPolicy": {
"label": "Hành vi trong nhóm",
"label": "Hành vi trong nh",
"choices": {
"mention": "Chỉ khi được nhắc",
"open": "Mọi tin nhắn",
"allowlist": "Danh sách cho phép"
}
},
"groupPolicyInThread": {
"label": "Hành vi trong thread",
"choices": {
"mention": "Chỉ khi được nhắc",
"open": "Mọi tin nhắn (không cần nhắc)",
"allowlist": "Danh sách cho phép"
}
},
"allowFrom": {
"label": "Người dùng được phép",
"placeholder": "ID người dùng, phân tách bằng dấu phẩy"
@@ -27,13 +27,21 @@
"placeholder": "可选的团队 ID"
},
"groupPolicy": {
"label": "群组行为",
"label": "频道行为",
"choices": {
"mention": "仅提及时",
"open": "所有消息",
"allowlist": "白名单"
}
},
"groupPolicyInThread": {
"label": "线程行为",
"choices": {
"mention": "仅提及时",
"open": "所有消息(无需提及)",
"allowlist": "白名单"
}
},
"allowFrom": {
"label": "允许的用户",
"placeholder": "用户 ID,用逗号分隔"
@@ -27,13 +27,21 @@
"placeholder": "可選的團隊 ID"
},
"groupPolicy": {
"label": "群組行為",
"label": "頻道行為",
"choices": {
"mention": "僅提及時",
"open": "所有訊息",
"allowlist": "允許清單"
}
},
"groupPolicyInThread": {
"label": "線程行為",
"choices": {
"mention": "僅提及時",
"open": "所有訊息(無需提及)",
"allowlist": "允許清單"
}
},
"allowFrom": {
"label": "允許的使用者",
"placeholder": "使用者 ID,以逗號分隔"
+2
View File
@@ -431,6 +431,7 @@ class SignalChannel(BaseChannel):
session_key: str | None = None,
is_dm: bool = False,
authorization_id: str | None = None,
require_existing_session: bool = False,
) -> None:
"""Handle an inbound message whose policy has already been checked.
@@ -453,6 +454,7 @@ class SignalChannel(BaseChannel):
media=media or [],
metadata=meta,
session_key_override=session_key,
require_existing_session=require_existing_session,
)
)
+2 -2
View File
@@ -166,7 +166,7 @@ def _strip_md_block(text: str) -> str:
markdown syntax while the response is still being generated.
"""
# Code blocks -> just the code
text = re.sub(r'```[\w]*\n?([\s\S]*?)```', r'\1', text)
text = re.sub(r'```(?:[^\n]*\n)?([\s\S]*?)```', r'\1', text)
# Headers -> plain text
text = re.sub(r'^#{1,6}\s+(.+)$', r'\1', text, flags=re.MULTILINE)
# Blockquotes
@@ -232,7 +232,7 @@ def _markdown_to_telegram_html(text: str) -> str:
code_blocks.append(m.group(1))
return f"\x00CB{len(code_blocks) - 1}\x00"
text = re.sub(r'```[\w]*\n?([\s\S]*?)```', save_code_block, text)
text = re.sub(r'```(?:[^\n]*\n)?([\s\S]*?)```', save_code_block, text)
# 1.5. Convert markdown tables to box-drawing (reuse code_block placeholders)
lines = text.split('\n')
@@ -2395,3 +2395,26 @@ async def test_callback_query_handles_inaccessible_message() -> None:
query.answer.assert_awaited_once()
channel._handle_message.assert_awaited_once()
assert channel._handle_message.await_args.kwargs["chat_id"] == "123"
def test_markdown_to_html_code_block_special_chars_language() -> None:
from nanobot.channels.telegram.runtime import _markdown_to_telegram_html, _strip_md_block
text = "```c++\nint main() { return 0; }\n```"
html = _markdown_to_telegram_html(text)
assert html == "<pre><code>int main() { return 0; }\n</code></pre>"
stripped = _strip_md_block(text)
assert stripped == "int main() { return 0; }\n"
def test_markdown_to_html_code_block_same_line_no_newline() -> None:
"""
Locks out the regression where triple-backtick content without a newline
(e.g., Use ```<tag>``` here) was mistaken for a language info string and discarded.
"""
from nanobot.channels.telegram.runtime import _markdown_to_telegram_html, _strip_md_block
text = "Use ```<tag>``` here"
html = _markdown_to_telegram_html(text)
assert html == "Use <pre><code>&lt;tag&gt;</code></pre> here"
stripped = _strip_md_block(text)
assert stripped == "Use <tag> here"
+266 -34
View File
@@ -4,6 +4,7 @@ from __future__ import annotations
import asyncio
import hmac
import ipaddress
import json
import re
import ssl
@@ -12,14 +13,14 @@ from collections.abc import Callable
from contextlib import suppress
from pathlib import Path
from typing import Any, Self, TypeGuard, cast
from urllib.parse import urlsplit, urlunsplit
from pydantic import Field, field_validator, model_validator
from pydantic import Field, PrivateAttr, field_validator, model_validator
from websockets.asyncio.server import ServerConnection, serve, unix_serve
from websockets.exceptions import ConnectionClosed
from websockets.http11 import Request as WsRequest
from nanobot.bus.events import (
INBOUND_META_SESSION_READ_SCOPE,
OUTBOUND_META_AGENT_UI,
OutboundMessage,
)
@@ -51,6 +52,7 @@ from nanobot.security.workspace_access import (
from nanobot.session.goal_state import goal_state_ws_blob
from nanobot.session.webui_turns import (
clear_websocket_turn_if_current,
clear_websocket_turns,
mark_websocket_turn_transcript_persistence_failed,
register_queued_websocket_turn_if_idle,
websocket_turn_id,
@@ -60,6 +62,9 @@ from nanobot.session.webui_turns import (
from nanobot.webui.cli_apps_api import normalize_cli_app_mentions
from nanobot.webui.forking import handle_webui_fork_chat
from nanobot.webui.gateway_services import GatewayServices
from nanobot.webui.http_utils import (
is_trusted_proxy_authenticated_request as _is_trusted_proxy_authenticated_request,
)
from nanobot.webui.http_utils import (
normalize_config_path as _normalize_config_path,
)
@@ -76,11 +81,12 @@ from nanobot.webui.metadata import (
WEBUI_TURN_METADATA_KEY,
)
from nanobot.webui.session_access import (
SessionAccessScope,
SessionMention,
WebuiSessionAccess,
session_mentions_runtime_context,
)
from nanobot.webui.sidebar_state import write_webui_sidebar_state
from nanobot.webui.temporary_chats import TemporaryChatError
from nanobot.webui.transcript import WEBUI_TRANSCRIPT_INCOMPLETE_KEY
from nanobot.webui.transcription_ws import webui_transcription_event
from nanobot.webui.websocket_logging import websockets_server_logger
@@ -89,6 +95,74 @@ from nanobot.webui.websocket_logging import websockets_server_logger
_WEBUI_HTTP_OPEN_TIMEOUT_S = 360.0
_ROUTING_ASSERTION_HEADERS = frozenset(
{
"host",
"forwarded",
"x-forwarded-for",
"x-forwarded-host",
"x-forwarded-proto",
"x-real-ip",
"cf-connecting-ip",
}
)
def _is_routing_assertion_header(value: str) -> bool:
normalized = value.casefold()
return normalized in _ROUTING_ASSERTION_HEADERS or normalized.startswith("x-forwarded-")
class TrustedProxyAuthConfig(Base):
"""Authentication assertions accepted from explicitly trusted proxy peers."""
trusted_peer_cidrs: list[str] = Field(min_length=1)
assertion_header: str = Field(min_length=1)
_trusted_peer_networks: tuple[ipaddress.IPv4Network | ipaddress.IPv6Network, ...] = PrivateAttr(
default=()
)
@field_validator("trusted_peer_cidrs")
@classmethod
def validate_trusted_peer_cidrs(cls, values: list[str]) -> list[str]:
normalized: list[str] = []
for value in values:
value = value.strip()
try:
network = ipaddress.ip_network(value, strict=False)
except ValueError as exc:
raise ValueError(f"invalid trusted proxy CIDR: {value!r}") from exc
if network.prefixlen == 0:
raise ValueError("universal trusted proxy CIDRs are not allowed")
if isinstance(network, ipaddress.IPv6Network):
mapped_start = ipaddress.IPv6Address("::ffff:0:0")
mapped_end = ipaddress.IPv6Address("::ffff:ffff:ffff")
if mapped_start in network and mapped_end in network:
raise ValueError("trusted proxy CIDRs must not cover all IPv4-mapped addresses")
normalized.append(network.with_prefixlen)
return normalized
@field_validator("assertion_header")
@classmethod
def validate_assertion_header(cls, value: str) -> str:
value = value.strip()
if not value or any(char.isspace() or ord(char) < 0x21 for char in value):
raise ValueError("assertion_header must be a valid HTTP header name")
if _is_routing_assertion_header(value):
raise ValueError(
"assertion_header must identify a proxy-generated authentication assertion, "
"not a routing or client metadata header"
)
return value
@model_validator(mode="after")
def compile_trusted_peer_networks(self) -> Self:
self._trusted_peer_networks = tuple(
ipaddress.ip_network(value, strict=False) for value in self.trusted_peer_cidrs
)
return self
class WebSocketConfig(Base):
"""WebSocket server channel configuration.
@@ -103,6 +177,8 @@ class WebSocketConfig(Base):
blocking ``urllib`` or synchronous ``httpx`` from inside a coroutine.
- ``token_issue_secret``: If non-empty, token requests must send ``Authorization: Bearer <secret>`` or
``X-Nanobot-Auth: <secret>``.
- ``public_ws_url``: Optional public WebSocket endpoint returned by WebUI bootstrap instead of
deriving one from proxy request headers. Its path must match ``path``.
- ``websocket_requires_token``: If True, the handshake must include a valid token (static or issued and not expired).
- Each connection has its own session: a unique ``chat_id`` maps to the agent session internally.
- ``media`` field in outbound messages contains local filesystem paths; remote clients need a
@@ -114,9 +190,11 @@ class WebSocketConfig(Base):
port: int = 8765
unix_socket_path: str = ""
path: str = "/"
public_ws_url: str = ""
token: str = ""
token_issue_path: str = ""
token_issue_secret: str = ""
trusted_proxy_auth: TrustedProxyAuthConfig | None = None
token_ttl_s: int = Field(default=300, ge=30, le=86_400)
websocket_requires_token: bool = True
allow_from: list[str] = Field(default_factory=lambda: ["*"])
@@ -161,6 +239,32 @@ class WebSocketConfig(Base):
raise ValueError('token_issue_path must start with "/"')
return _normalize_config_path(value)
@field_validator("public_ws_url")
@classmethod
def public_ws_url_format(cls, value: str) -> str:
value = value.strip()
if not value:
return ""
parsed = urlsplit(value)
if (
parsed.scheme not in {"ws", "wss"}
or not parsed.netloc
or parsed.username is not None
or parsed.password is not None
or parsed.query
or parsed.fragment
):
raise ValueError("public_ws_url must be an absolute ws:// or wss:// URL without credentials")
return urlunsplit(
(parsed.scheme, parsed.netloc, _normalize_config_path(parsed.path or "/"), "", "")
)
@model_validator(mode="after")
def public_ws_url_matches_path(self) -> Self:
if self.public_ws_url and urlsplit(self.public_ws_url).path != _normalize_config_path(self.path):
raise ValueError("public_ws_url path must match path")
return self
@model_validator(mode="after")
def token_issue_path_differs_from_ws_path(self) -> Self:
if not self.token_issue_path:
@@ -173,11 +277,11 @@ class WebSocketConfig(Base):
def wildcard_host_requires_auth(self) -> Self:
if self.host not in ("0.0.0.0", "::"):
return self
if self.token.strip() or self.token_issue_secret.strip():
if self.token.strip() or self.token_issue_secret.strip() or self.trusted_proxy_auth is not None:
return self
raise ValueError(
"host is 0.0.0.0 (all interfaces) but neither token nor "
"token_issue_secret is set — set one to prevent unauthenticated access"
"host is 0.0.0.0 (all interfaces) but neither token, token_issue_secret, "
"nor trusted_proxy_auth is set — set one to prevent unauthenticated access"
)
@@ -295,6 +399,7 @@ class WebSocketChannel(BaseChannel):
self._ingress = gateway.ingress
self._transcripts = gateway.transcripts
self._workspaces = gateway.workspaces
self._temporary_chats = gateway.temporary_chats
self._session_access = (
WebuiSessionAccess(gateway.session_manager)
if gateway.session_manager is not None
@@ -313,6 +418,33 @@ class WebSocketChannel(BaseChannel):
self._subs.setdefault(chat_id, set()).add(connection)
self._conn_chats.setdefault(connection, set()).add(chat_id)
def _detach(self, connection: ServerConnection, chat_id: str) -> None:
chats = self._conn_chats.get(connection)
if chats is not None:
chats.discard(chat_id)
if not chats:
self._conn_chats.pop(connection, None)
subscribers = self._subs.get(chat_id)
if subscribers is not None:
subscribers.discard(connection)
if not subscribers:
self._subs.pop(chat_id, None)
def _clear_stream_buffers(self, chat_id: str) -> None:
for key in tuple(self._stream_text_buffers):
if key[0] == chat_id:
self._stream_text_buffers.pop(key, None)
async def _discard_connection_owned_chat(
self,
connection: ServerConnection,
chat_id: str,
) -> None:
await self._temporary_chats.discard(connection, chat_id)
self._detach(connection, chat_id)
clear_websocket_turns(chat_id)
self._clear_stream_buffers(chat_id)
async def send_webui_protocol_error(
self,
connection: ServerConnection,
@@ -341,16 +473,16 @@ class WebSocketChannel(BaseChannel):
)
await self._hydrate_after_subscribe(fork_id)
def _cleanup_connection(self, connection: ServerConnection) -> None:
async def _cleanup_connection(self, connection: ServerConnection) -> None:
"""Remove *connection* from every subscription set; safe to call multiple times."""
chat_ids = self._conn_chats.pop(connection, set())
chat_ids = tuple(self._conn_chats.get(connection, ()))
for cid in chat_ids:
subs = self._subs.get(cid)
if subs is None:
continue
subs.discard(connection)
if not subs:
self._subs.pop(cid, None)
if self._temporary_chats.owns(connection, cid):
await self._discard_connection_owned_chat(connection, cid)
else:
self._detach(connection, cid)
for cid in self._temporary_chats.chat_ids_for_owner(connection):
await self._discard_connection_owned_chat(connection, cid)
self._conn_default.pop(connection, None)
self._webui_connections.discard(connection)
@@ -403,7 +535,7 @@ class WebSocketChannel(BaseChannel):
try:
await connection.send(raw)
except ConnectionClosed:
self._cleanup_connection(connection)
await self._cleanup_connection(connection)
except Exception as e:
self.logger.warning("failed to send {} event: {}", event, e)
@@ -433,16 +565,16 @@ class WebSocketChannel(BaseChannel):
async def _dispatch_http(self, connection: ServerConnection, request: WsRequest) -> Any:
"""Route an inbound HTTP request to the HTTP handler or WS upgrade."""
got, query = _parse_request_path(request.path)
expected_ws = self._expected_path()
# WebSocket upgrade — channel handles this itself
expected_ws = self._expected_path()
if got == expected_ws and _is_websocket_upgrade(request):
client_id = _query_first(query, "client_id") or ""
if len(client_id) > 128:
client_id = client_id[:128]
if not self.is_allowed(client_id):
return connection.respond(403, "Forbidden")
return self._authorize_websocket_handshake(connection, query)
return self._authorize_websocket_handshake(connection, query, request.headers)
# Everything else goes to the HTTP handler
return await self._http_router.dispatch(connection, request)
@@ -451,7 +583,12 @@ class WebSocketChannel(BaseChannel):
self,
connection: ServerConnection,
query: dict[str, list[str]],
headers: Any = None,
) -> Any:
if _is_trusted_proxy_authenticated_request(connection, headers or {}, self.config):
self._webui_connections.add(connection)
return None
supplied = _query_first(query, "token")
static_token = self.config.token.strip()
@@ -625,7 +762,7 @@ class WebSocketChannel(BaseChannel):
except Exception as e:
self.logger.debug("connection ended: {}", e)
finally:
self._cleanup_connection(connection)
await self._cleanup_connection(connection)
# -- Inbound WebSocket envelopes ---------------------------------------
@@ -660,23 +797,84 @@ class WebSocketChannel(BaseChannel):
)
await self._hydrate_after_subscribe(new_id)
return
if t == "new_temporary_chat":
try:
new_id = self._temporary_chats.create(
connection,
trusted_webui=connection in self._webui_connections,
)
except TemporaryChatError as exc:
await self._send_event(connection, "error", detail=exc.detail)
return
self._attach(connection, new_id)
await self._send_event(
connection,
"attached",
chat_id=new_id,
temporary=True,
)
return
if t == "fork_chat":
await handle_webui_fork_chat(self, connection, envelope)
return
if t == "discard_temporary_chat":
cid = envelope.get("chat_id")
if not _is_valid_chat_id(cid):
await self._send_event(connection, "error", detail="invalid temporary chat_id")
return
try:
await self._discard_connection_owned_chat(connection, cid)
except TemporaryChatError as exc:
await self._send_event(connection, "error", detail=exc.detail, chat_id=cid)
return
if t == "attach":
cid = envelope.get("chat_id")
if not _is_valid_chat_id(cid):
await self._send_event(connection, "error", detail="invalid chat_id")
return
try:
self._temporary_chats.validate_attach(cid)
except TemporaryChatError as exc:
await self._send_event(connection, "error", detail=exc.detail, chat_id=cid)
return
self._attach(connection, cid)
await self._send_event(connection, "attached", chat_id=cid)
await self._hydrate_after_subscribe(cid)
return
if t == "set_sidebar_state":
if connection not in self._webui_connections:
await self._send_event(connection, "error", detail="access_denied")
return
state = envelope.get("state")
if not isinstance(state, dict):
await self._send_event(
connection,
"error",
detail="invalid_sidebar_state",
)
return
try:
await asyncio.to_thread(
write_webui_sidebar_state,
cast(dict[str, Any], state),
)
except (OSError, ValueError):
await self._send_event(
connection,
"error",
detail="invalid_sidebar_state",
)
return
if t == "set_workspace_scope":
cid = envelope.get("chat_id")
if not _is_valid_chat_id(cid):
await self._send_event(connection, "error", detail="invalid chat_id")
return
try:
self._temporary_chats.validate_workspace_update(cid)
except TemporaryChatError as exc:
await self._send_event(connection, "error", detail=exc.detail, chat_id=cid)
return
scope = await self._workspace_scope_or_error(
connection,
lambda: self._workspaces.scope_for_set_request(
@@ -745,6 +943,21 @@ class WebSocketChannel(BaseChannel):
)
return
try:
temporary_policy = self._temporary_chats.message_policy(
connection,
cid,
content,
)
except TemporaryChatError as exc:
await self._send_event(
connection,
"error",
detail=exc.detail,
**rejection_fields,
)
return
raw_media = envelope.get("media")
media_paths: list[str] = []
if raw_media is not None:
@@ -767,6 +980,8 @@ class WebSocketChannel(BaseChannel):
**rejection_fields,
)
return
if temporary_policy is not None:
self._temporary_chats.register_media(connection, cid, media_paths)
# Allow media-only turns (content may be empty when attachments are present).
if not content.strip() and not media_paths:
@@ -779,16 +994,21 @@ class WebSocketChannel(BaseChannel):
return
# Auto-attach on first use so clients can one-shot without a separate attach.
self._attach(connection, cid)
await self._hydrate_after_subscribe(cid)
if temporary_policy is None or temporary_policy.hydrate_transcript:
await self._hydrate_after_subscribe(cid)
# Resolve after hydration so a concurrent downgrade cannot be overwritten.
scope = await self._workspace_scope_or_error(
connection,
lambda: self._workspaces.scope_for_message(
envelope,
chat_id=cid,
chat_running=websocket_turn_wall_started_at(cid) is not None,
controls_available=self._workspace_controls_available(connection),
lambda: (
temporary_policy.workspace_scope
if temporary_policy is not None
else self._workspaces.scope_for_message(
envelope,
chat_id=cid,
chat_running=websocket_turn_wall_started_at(cid) is not None,
controls_available=self._workspace_controls_available(connection),
)
),
chat_id=cid,
turn_id=turn_id,
@@ -813,8 +1033,6 @@ class WebSocketChannel(BaseChannel):
metadata["webui"] = True
metadata.update(self._transcripts.client_turn_metadata(envelope.get("turn_id")))
trusted_webui = metadata.get("webui") is True and connection in self._webui_connections
if trusted_webui:
metadata[INBOUND_META_SESSION_READ_SCOPE] = f"{self.name}:"
cli_apps = normalize_cli_app_mentions(envelope.get("cli_apps"))
if cli_apps:
metadata["cli_apps"] = cli_apps
@@ -829,12 +1047,7 @@ class WebSocketChannel(BaseChannel):
session_mentions = await asyncio.to_thread(
self._session_access.normalize_mentions,
envelope.get("session_mentions"),
SessionAccessScope(
current_session_key=f"{self.name}:{cid}",
session_key_prefix=f"{self.name}:",
project_path=scope.project_path,
restrict_to_workspace=scope.restrict_to_workspace,
),
exclude_session_key=f"{self.name}:{cid}",
)
if session_mentions:
metadata["session_mentions"] = session_mentions
@@ -848,7 +1061,13 @@ class WebSocketChannel(BaseChannel):
metadata[WEBSOCKET_TURN_OWNER_METADATA_KEY] = queued_owner
accepted = False
try:
if is_webui:
if (
is_webui
and (
temporary_policy is None
or temporary_policy.persist_transcript
)
):
self._transcripts.append_user_message(
cid,
content,
@@ -877,6 +1096,16 @@ class WebSocketChannel(BaseChannel):
media=media_paths or None,
metadata=metadata,
is_dm=False,
session_key=(
temporary_policy.session_key
if temporary_policy is not None
else None
),
require_existing_session=(
temporary_policy.require_existing_session
if temporary_policy is not None
else False
),
)
accepted = True
finally:
@@ -937,6 +1166,7 @@ class WebSocketChannel(BaseChannel):
self._conn_default.clear()
self._webui_connections.clear()
self._tokens.clear()
self._temporary_chats.close()
async def _safe_send_to(
self,
@@ -949,7 +1179,7 @@ class WebSocketChannel(BaseChannel):
try:
await connection.send(raw)
except ConnectionClosed:
self._cleanup_connection(connection)
await self._cleanup_connection(connection)
self.logger.warning("connection gone{}", label)
except Exception:
self.logger.exception("send failed{}", label)
@@ -966,6 +1196,8 @@ class WebSocketChannel(BaseChannel):
transcript_overrides: dict[str, Any] | None = None,
) -> bool:
"""Persist one canonical turn event and retain unsafe owners on failure."""
if not self._temporary_chats.should_persist_transcript(chat_id):
return True
persisted = self._transcripts.prepare_and_append(
chat_id,
event,
@@ -13,8 +13,9 @@ from websockets.exceptions import ConnectionClosed
from websockets.frames import Close
from nanobot.bus.events import (
INBOUND_META_SESSION_READ_SCOPE,
INBOUND_META_RUNTIME_CONTROL,
OUTBOUND_META_AGENT_UI,
RUNTIME_CONTROL_SESSION_DISCARD,
OutboundMessage,
)
from nanobot.bus.outbound_events import (
@@ -38,6 +39,7 @@ from nanobot.channels.websocket.runtime import (
from nanobot.config.loader import load_config, save_config
from nanobot.config.schema import Config, ModelPresetConfig
from nanobot.runtime_context import RUNTIME_CONTEXT_INPUT_META, WEBUI_QUOTE_SOURCE
from nanobot.security.workspace_access import WORKSPACE_SCOPE_METADATA_KEY
from nanobot.session import webui_turns as wth
from nanobot.session.manager import SessionManager
from nanobot.webui.gateway_services import GatewayServices, build_gateway_services
@@ -194,6 +196,302 @@ def isolate_webui_workspace_state(tmp_path, monkeypatch) -> None:
wth._WEBSOCKET_TURN_OWNERS.clear()
async def _new_temporary_chat(
channel: WebSocketChannel,
connection: AsyncMock,
) -> str:
channel._webui_connections.add(connection)
await channel._dispatch_envelope(
connection,
"webui-client",
{"type": "new_temporary_chat"},
)
payload = json.loads(connection.send.await_args.args[0])
assert payload["event"] == "attached"
assert payload["temporary"] is True
connection.send.reset_mock()
return payload["chat_id"]
@pytest.mark.asyncio
async def test_temporary_chat_is_transient_and_discarded(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
selected_project = tmp_path / "selected-project"
selected_project.mkdir()
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(
bus,
session_manager=sessions,
workspace_path=tmp_path,
),
)
connection = AsyncMock()
connection.remote_address = ("127.0.0.1", 5000)
chat_id = await _new_temporary_chat(channel, connection)
upload = tmp_path / "temporary-upload.txt"
upload.write_text("private attachment", encoding="utf-8")
channel.gateway.media.store_inbound_attachments = MagicMock(
return_value=([str(upload)], None),
)
await channel._dispatch_envelope(
connection,
"webui-client",
{
"type": "message",
"chat_id": chat_id,
"content": "read this",
"media": [{"data_url": "data:text/plain;base64,cHJpdmF0ZQ=="}],
"cli_apps": [{"name": "drawio"}],
"workspace_scope": {
"project_path": str(selected_project),
"access_mode": "full",
},
"turn_id": "turn-1",
"webui": True,
},
)
inbound = bus.publish_inbound.await_args_list[0].args[0]
assert inbound.session_key == f"websocket:{chat_id}"
assert inbound.session_key_override == f"websocket:{chat_id}"
assert inbound.require_existing_session is True
assert inbound.metadata["cli_apps"] == [{"name": "drawio"}]
assert inbound.metadata[WORKSPACE_SCOPE_METADATA_KEY] == {
"project_path": str(tmp_path.resolve()),
"access_mode": "restricted",
}
session = sessions.get_cached(inbound.session_key)
assert session is not None
assert session.policy.persist is False
assert upload.exists()
assert read_transcript_lines(inbound.session_key) == []
assert [payload["event"] for payload in _sent_ws_payloads(connection)] == [
"message_accepted",
]
await channel._dispatch_envelope(
connection,
"webui-client",
{"type": "discard_temporary_chat", "chat_id": chat_id},
)
control = bus.publish_inbound.await_args_list[1].args[0]
assert bus.publish_inbound.await_count == 2
assert control.session_key == inbound.session_key
assert control.metadata[INBOUND_META_RUNTIME_CONTROL] == (
RUNTIME_CONTROL_SESSION_DISCARD
)
assert sessions.get_cached(inbound.session_key) is None
assert chat_id not in channel._subs
assert chat_id not in channel._conn_chats.get(connection, set())
assert not upload.exists()
assert read_transcript_lines(inbound.session_key) == []
@pytest.mark.asyncio
@pytest.mark.parametrize("content", ["/goal private", "/trigger later", "/dream"])
async def test_temporary_chat_rejects_persistent_commands(bus, tmp_path, content) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
connection = AsyncMock()
connection.remote_address = ("127.0.0.1", 5000)
chat_id = await _new_temporary_chat(channel, connection)
await channel._dispatch_envelope(connection, "webui-client", {
"type": "message",
"chat_id": chat_id,
"content": content,
"webui": True,
})
assert bus.publish_inbound.await_count == 0
assert sessions.get_cached(f"websocket:{chat_id}") is not None
assert json.loads(connection.send.await_args.args[0])["detail"] == (
"temporary_chat_command_rejected"
)
@pytest.mark.asyncio
async def test_disconnect_discards_temporary_chat(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(
bus,
session_manager=sessions,
workspace_path=tmp_path,
),
)
connection = AsyncMock()
chat_id = await _new_temporary_chat(channel, connection)
await channel._dispatch_envelope(
connection,
"webui-client",
{
"type": "message",
"chat_id": chat_id,
"content": "hello",
"webui": True,
},
)
await channel._cleanup_connection(connection)
session_key = f"websocket:{chat_id}"
control = bus.publish_inbound.await_args_list[-1].args[0]
assert control.session_key == session_key
assert control.metadata[INBOUND_META_RUNTIME_CONTROL] == (
RUNTIME_CONTROL_SESSION_DISCARD
)
assert sessions.get_cached(session_key) is None
assert chat_id not in channel._subs
@pytest.mark.asyncio
async def test_temporary_chat_creation_requires_authenticated_webui_connection(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
connection = AsyncMock()
await channel._dispatch_envelope(
connection,
"generic-websocket-client",
{"type": "new_temporary_chat"},
)
assert json.loads(connection.send.await_args.args[0])["detail"] == "access_denied"
assert sessions.list_sessions() == []
@pytest.mark.asyncio
async def test_temporary_chat_cannot_be_claimed_by_another_connection(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
owner = AsyncMock()
other = AsyncMock()
channel._webui_connections.add(other)
chat_id = await _new_temporary_chat(channel, owner)
await channel._dispatch_envelope(
other,
"other-webui-client",
{
"type": "message",
"chat_id": chat_id,
"content": "claim it",
"webui": True,
},
)
assert json.loads(other.send.await_args.args[0])["detail"] == (
"temporary_chat_unavailable"
)
assert bus.publish_inbound.await_count == 0
assert sessions.get_cached(f"websocket:{chat_id}") is not None
@pytest.mark.asyncio
async def test_temporary_chat_cannot_persist_workspace_scope(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
connection = AsyncMock()
chat_id = await _new_temporary_chat(channel, connection)
await channel._dispatch_envelope(
connection,
"webui-client",
{
"type": "set_workspace_scope",
"chat_id": chat_id,
"workspace_scope": {
"project_path": str(tmp_path),
"access_mode": "full",
},
},
)
payload = json.loads(connection.send.await_args.args[0])
assert payload["detail"] == "temporary_chat_workspace_rejected"
session = sessions.get_cached(f"websocket:{chat_id}")
assert session is not None
assert WORKSPACE_SCOPE_METADATA_KEY not in session.metadata
assert sessions.list_sessions() == []
@pytest.mark.asyncio
async def test_temporary_looking_id_does_not_define_session_policy(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
connection = AsyncMock()
channel._webui_connections.add(connection)
await channel._dispatch_envelope(
connection,
"webui-client",
{
"type": "message",
"chat_id": "temporary-looking-but-persistent",
"content": "/goal ordinary chat",
"webui": True,
},
)
inbound = bus.publish_inbound.await_args.args[0]
assert inbound.require_existing_session is False
assert inbound.session_key_override is None
session = sessions.get_cached("websocket:temporary-looking-but-persistent")
assert session is not None
assert session.policy.persist is True
@pytest.mark.asyncio
async def test_discard_temporary_chat_does_not_detach_persistent_chat(bus, tmp_path) -> None:
sessions = SessionManager(tmp_path)
channel = WebSocketChannel(
{"enabled": True, "allowFrom": ["*"]},
bus,
gateway=_basic_handler(bus, session_manager=sessions, workspace_path=tmp_path),
)
connection = AsyncMock()
channel._attach(connection, "ordinary-chat")
await channel._dispatch_envelope(
connection,
"webui-client",
{"type": "discard_temporary_chat", "chat_id": "ordinary-chat"},
)
assert json.loads(connection.send.await_args.args[0])["detail"] == (
"temporary_chat_unavailable"
)
assert connection in channel._subs["ordinary-chat"]
assert "ordinary-chat" in channel._conn_chats[connection]
@pytest.mark.asyncio
async def test_send_session_updated_broadcasts_to_other_webui_connections(bus) -> None:
class Conn:
@@ -416,7 +714,6 @@ async def test_webui_message_envelope_marks_inbound_metadata(bus: MagicMock) ->
assert msg.channel == "websocket"
assert msg.chat_id == "chat-1"
assert msg.metadata["webui"] is True
assert INBOUND_META_SESSION_READ_SCOPE not in msg.metadata
assert msg.metadata["webui_turn_id"] == "turn-1"
assert msg.metadata["_wants_stream"] is True
lines = read_transcript_lines("websocket:chat-1")
@@ -561,6 +858,34 @@ def test_only_bootstrap_tokens_mark_webui_connections(bus: MagicMock) -> None:
assert client_connection not in channel._webui_connections
@pytest.mark.asyncio
async def test_webui_persists_sidebar_state_larger_than_http_request_line(
bus: MagicMock,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.setattr("nanobot.config.paths.get_data_dir", lambda: tmp_path)
channel = _ch(bus)
conn = AsyncMock()
channel._webui_connections.add(conn)
session_order = [f"websocket:{index:04d}-{'x' * 48}" for index in range(160)]
envelope = {
"type": "set_sidebar_state",
"state": {
"session_order": session_order,
"view": {"sort": "manual"},
},
}
assert len(json.dumps(envelope).encode()) > 8_192
await channel._dispatch_envelope(conn, "webui-client", envelope)
saved = json.loads((tmp_path / "webui" / "sidebar-state.json").read_text(encoding="utf-8"))
assert saved["session_order"] == session_order
assert saved["view"]["sort"] == "manual"
conn.send.assert_not_awaited()
@pytest.mark.asyncio
async def test_client_cannot_self_assert_webui_quote_context(bus: MagicMock) -> None:
channel = _ch(bus)
@@ -2547,6 +2872,7 @@ async def test_settings_api_returns_safe_subset_and_updates_whitelist(
)
config.tools.web.search.provider = "brave"
config.tools.web.search.api_key = "brave-secret"
expected_timezone = config.agents.defaults.timezone
save_config(config, config_path)
monkeypatch.setattr("nanobot.config.loader._current_config_path", config_path)
monkeypatch.setattr(
@@ -2587,7 +2913,7 @@ async def test_settings_api_returns_safe_subset_and_updates_whitelist(
assert body["agent"]["provider"] == "openai"
assert body["agent"]["model_preset"] == "default"
assert body["agent"]["max_tokens"] == 8192
assert body["agent"]["timezone"] == "UTC"
assert body["agent"]["timezone"] == expected_timezone
assert "bot_name" not in body["agent"]
assert "bot_icon" not in body["agent"]
assert body["agent"]["tool_hint_max_length"] == 40
@@ -15,11 +15,11 @@ from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from nanobot.bus.events import INBOUND_META_SESSION_READ_SCOPE
from nanobot.channels.websocket.runtime import (
WebSocketChannel,
WebSocketConfig,
)
from nanobot.runtime_context import RUNTIME_CONTEXT_INPUT_META
from nanobot.session import webui_turns as wth
from nanobot.session.manager import SessionManager
from nanobot.webui.gateway_services import build_gateway_services
@@ -219,13 +219,12 @@ async def test_webui_message_forwards_verified_session_mentions(tmp_path) -> Non
channel._handle_message.assert_awaited_once()
metadata = channel._handle_message.call_args.kwargs["metadata"]
assert metadata[INBOUND_META_SESSION_READ_SCOPE] == "websocket:"
assert metadata["session_mentions"] == [{
"name": "pricing",
"session_key": "websocket:pricing",
"title": "Pricing",
}]
[block] = metadata["_runtime_context_blocks"]
[block] = metadata[RUNTIME_CONTEXT_INPUT_META]
assert block.source == "session_mentions"
assert "websocket:pricing" in block.content
@@ -19,11 +19,6 @@ from nanobot.channels.websocket.runtime import WebSocketChannel, WebSocketConfig
from nanobot.cron.service import CronService
from nanobot.cron.types import CronJob, CronPayload, CronSchedule
from nanobot.optional_features import InstallResult
from nanobot.runtime_context import (
RUNTIME_CONTEXT_HISTORY_META,
RuntimeContextBlock,
append_runtime_context,
)
from nanobot.security.workspace_access import WORKSPACE_SCOPE_METADATA_KEY
from nanobot.session.keys import UNIFIED_SESSION_KEY
from nanobot.session.manager import Session, SessionManager
@@ -256,7 +251,7 @@ async def test_bootstrap_returns_token_for_localhost(
@pytest.mark.asyncio
async def test_sessions_routes_require_bearer_token(
async def test_sessions_list_requires_bearer_token(
bus: MagicMock, tmp_path: Path
) -> None:
sm = _seed_session(tmp_path, key="websocket:abc")
@@ -278,14 +273,26 @@ async def test_sessions_routes_require_bearer_token(
# Server stays an opaque source: filesystem paths must not leak to the wire.
assert all("path" not in s for s in listing.json()["sessions"])
msgs = await _http_get(
"http://127.0.0.1:29902/api/sessions/websocket:abc/messages",
headers=auth,
finally:
await channel.stop()
await server_task
@pytest.mark.asyncio
async def test_legacy_session_messages_route_is_not_exposed(
bus: MagicMock, tmp_path: Path
) -> None:
sm = _seed_session(tmp_path, key="websocket:legacy")
channel = _ch(bus, session_manager=sm, port=29919)
server_task = asyncio.create_task(channel.start())
try:
token = channel.gateway.tokens.issue_api_token(300)
response = await _http_get(
"http://127.0.0.1:29919/api/sessions/websocket:legacy/messages",
headers={"Authorization": f"Bearer {token}"},
)
assert msgs.status_code == 200
body = msgs.json()
assert body["key"] == "websocket:abc"
assert [m["role"] for m in body["messages"]] == ["user", "assistant"]
assert response.status_code == 404
finally:
await channel.stop()
await server_task
@@ -2280,6 +2287,7 @@ async def test_webui_sidebar_state_routes_are_config_dir_scoped(
payload = {
"pinned_keys": ["websocket:sidebar"],
"archived_keys": ["websocket:old"],
"session_order": ["websocket:old", "websocket:sidebar"],
"title_overrides": {"websocket:sidebar": "Pinned work"},
"view": {"density": "compact", "show_archived": True},
}
@@ -2291,6 +2299,7 @@ async def test_webui_sidebar_state_routes_are_config_dir_scoped(
assert updated.status_code == 200
body = updated.json()
assert body["pinned_keys"] == ["websocket:sidebar"]
assert body["session_order"] == ["websocket:old", "websocket:sidebar"]
assert body["title_overrides"] == {"websocket:sidebar": "Pinned work"}
assert body["view"]["density"] == "compact"
@@ -2845,7 +2854,7 @@ async def test_session_delete_blocks_origin_automation_when_unified_enabled(
@pytest.mark.asyncio
async def test_session_routes_accept_percent_encoded_websocket_keys(
async def test_session_delete_accepts_percent_encoded_websocket_keys(
bus: MagicMock, tmp_path: Path
) -> None:
sm = _seed_session(tmp_path, key="websocket:encoded-key")
@@ -2855,13 +2864,6 @@ async def test_session_routes_accept_percent_encoded_websocket_keys(
token = channel.gateway.tokens.issue_api_token(300)
auth = {"Authorization": f"Bearer {token}"}
msgs = await _http_get(
"http://127.0.0.1:29910/api/sessions/websocket%3Aencoded-key/messages",
headers=auth,
)
assert msgs.status_code == 200
assert msgs.json()["key"] == "websocket:encoded-key"
path = sm._get_session_path("websocket:encoded-key")
assert path.exists()
deleted = await _http_get(
@@ -2876,41 +2878,6 @@ async def test_session_routes_accept_percent_encoded_websocket_keys(
await server_task
@pytest.mark.asyncio
async def test_session_messages_hide_persisted_runtime_context(
bus: MagicMock, tmp_path: Path
) -> None:
sm = SessionManager(tmp_path)
session = sm.get_or_create("websocket:runtime-context")
content, marker = append_runtime_context(
"visible user text",
[RuntimeContextBlock(source="goal", content="private goal context")],
)
session.add_message(
"user",
content,
**{RUNTIME_CONTEXT_HISTORY_META: marker},
)
sm.save(session)
channel = _ch(bus, session_manager=sm, port=29919)
server_task = asyncio.create_task(channel.start())
try:
token = channel.gateway.tokens.issue_api_token(300)
response = await _http_get(
"http://127.0.0.1:29919/api/sessions/websocket:runtime-context/messages",
headers={"Authorization": f"Bearer {token}"},
)
assert response.status_code == 200
message = response.json()["messages"][0]
assert message["content"] == "visible user text"
assert RUNTIME_CONTEXT_HISTORY_META not in message
assert "private goal context" not in response.text
finally:
await channel.stop()
await server_task
@pytest.mark.asyncio
async def test_webui_thread_resigns_assistant_media_urls(
bus: MagicMock, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
@@ -3114,7 +3081,7 @@ async def test_webui_thread_negotiates_gzip_for_large_payloads(
@pytest.mark.asyncio
async def test_session_routes_reject_non_websocket_keys(
async def test_session_delete_rejects_non_websocket_keys(
bus: MagicMock, tmp_path: Path
) -> None:
sm = _seed_many(
@@ -3131,14 +3098,6 @@ async def test_session_routes_reject_non_websocket_keys(
token = channel.gateway.tokens.issue_api_token(300)
auth = {"Authorization": f"Bearer {token}"}
# The webui list already hides non-websocket sessions; handcrafted URLs
# should hit the same boundary rather than exposing or deleting them.
msgs = await _http_get(
"http://127.0.0.1:29909/api/sessions/cli:direct/messages",
headers=auth,
)
assert msgs.status_code == 404
doomed = sm._get_session_path("slack:C123")
assert doomed.exists()
deny_delete = await _http_get(
@@ -3153,7 +3112,7 @@ async def test_session_routes_reject_non_websocket_keys(
@pytest.mark.asyncio
async def test_session_routes_reject_invalid_key(
async def test_session_delete_rejects_invalid_key(
bus: MagicMock, tmp_path: Path
) -> None:
sm = _seed_session(tmp_path)
@@ -3166,7 +3125,7 @@ async def test_session_routes_reject_invalid_key(
# Invalid characters in the key -> regex match fails -> 404
# (route doesn't match, falls through to channel 404).
resp = await _http_get(
"http://127.0.0.1:29904/api/sessions/bad%20key/messages",
"http://127.0.0.1:29904/api/sessions/bad%20key/delete",
headers=auth,
)
assert resp.status_code in {400, 404}
@@ -3321,6 +3280,168 @@ def test_local_browser_request_requires_loopback_host_and_forwarded_origin() ->
)
def _trusted_proxy_config(
cidrs: list[str] | None = None,
*,
assertion_header: str = "Cf-Access-Jwt-Assertion",
) -> dict[str, Any]:
return {
"trustedProxyAuth": {
"trustedPeerCidrs": cidrs or ["127.0.0.1/32"],
"assertionHeader": assertion_header,
}
}
def test_trusted_proxy_requires_non_empty_assertion(bus: MagicMock) -> None:
channel = _ch(bus, **_trusted_proxy_config())
for assertion in (None, "", " "):
headers = {"Cf-Access-Jwt-Assertion": assertion} if assertion is not None else {}
resp = channel.gateway.http._handle_bootstrap(_LOCAL, _FakeReq(headers))
assert resp.status_code == 403
def test_trusted_proxy_rejects_untrusted_peer_spoof(bus: MagicMock) -> None:
channel = _ch(bus, **_trusted_proxy_config())
resp = channel.gateway.http._handle_bootstrap(
_REMOTE,
_FakeReq({"Cf-Access-Jwt-Assertion": "spoofed"}),
)
assert resp.status_code == 403
def test_trusted_proxy_bootstrap_has_no_tokens(
bus: MagicMock,
) -> None:
assertion = "opaque-upstream-assertion"
channel = _ch(bus, **_trusted_proxy_config())
log = MagicMock()
channel.gateway.http._log = log
resp = channel.gateway.http._handle_bootstrap(
_LOCAL,
_FakeReq(
{
"Host": "nanobot.example",
"X-Forwarded-For": "203.0.113.42",
"Forwarded": "for=203.0.113.42;host=nanobot.example",
"X-Real-IP": "203.0.113.42",
"X-Forwarded-Host": "nanobot.example",
"Cf-Access-Jwt-Assertion": assertion,
}
),
)
assert resp.status_code == 200
body = resp.body.decode()
assert assertion not in body
assert assertion not in repr(log.mock_calls)
payload = json.loads(body)
assert "token" not in payload
assert "api_token" not in payload
assert payload["ws_path"] == "/"
@pytest.mark.asyncio
async def test_trusted_proxy_authorizes_rest_without_api_token(bus: MagicMock) -> None:
channel = _ch(bus, **_trusted_proxy_config())
response = await channel.gateway.http.dispatch(
_LOCAL,
_FakeReq(
{
"Host": "nanobot.example",
"Cf-Access-Jwt-Assertion": "present",
},
path="/api/sessions",
),
)
assert response.status_code == 503
def test_trusted_proxy_authorizes_websocket_without_token(bus: MagicMock) -> None:
channel = _ch(bus, **_trusted_proxy_config())
response = channel._authorize_websocket_handshake(
_LOCAL,
{},
{"Cf-Access-Jwt-Assertion": "present"},
)
assert response is None
assert _LOCAL in channel._webui_connections
def test_forwarding_headers_alone_never_authorize_bootstrap(bus: MagicMock) -> None:
channel = _ch(bus)
resp = channel.gateway.http._handle_bootstrap(
_REMOTE,
_FakeReq(
{
"Host": "nanobot.example",
"X-Forwarded-For": "127.0.0.1",
"Forwarded": "for=127.0.0.1",
"X-Real-IP": "127.0.0.1",
}
),
)
assert resp.status_code == 403
def test_trusted_proxy_bypasses_bootstrap_secret_and_tokens(bus: MagicMock) -> None:
channel = _ch(
bus,
tokenIssueSecret="route-secret",
**_trusted_proxy_config(),
)
resp = channel.gateway.http._handle_bootstrap(
_LOCAL,
_FakeReq({"Cf-Access-Jwt-Assertion": "present"}),
)
assert resp.status_code == 200
payload = json.loads(resp.body)
assert "token" not in payload
assert "api_token" not in payload
@pytest.mark.parametrize(
("peer", "cidr"),
[
("127.0.0.1", "127.0.0.1/32"),
("::1", "::1/128"),
("::ffff:127.0.0.1", "127.0.0.0/24"),
("127.0.0.1", "::ffff:127.0.0.0/120"),
],
)
def test_trusted_proxy_matches_ip_versions_and_mapped_peers(
bus: MagicMock,
peer: str,
cidr: str,
) -> None:
from nanobot.webui.http_utils import is_trusted_proxy_authenticated_request
config = WebSocketConfig.model_validate(_trusted_proxy_config([cidr]))
request = _FakeReq({"Cf-Access-Jwt-Assertion": "present"})
assert is_trusted_proxy_authenticated_request(_FakeConn((peer, 12345)), request.headers, config)
@pytest.mark.parametrize(
"cidr",
["not-a-cidr", "0.0.0.0/0", "::/0", "::/1", "::ffff:0:0/96"],
)
def test_trusted_proxy_rejects_invalid_or_universal_cidrs(
cidr: str,
) -> None:
from pydantic_core import ValidationError
with pytest.raises(ValidationError):
WebSocketConfig.model_validate(_trusted_proxy_config([cidr]))
@pytest.mark.parametrize(
"assertion_header",
["Host", "Forwarded", "X-Forwarded-For", "X-Real-IP", "CF-Connecting-IP"],
)
def test_trusted_proxy_rejects_routing_headers(assertion_header: str) -> None:
from pydantic_core import ValidationError
with pytest.raises(ValidationError, match="proxy-generated"):
WebSocketConfig.model_validate(_trusted_proxy_config(assertion_header=assertion_header))
def test_wildcard_host_without_auth_raises_on_startup(bus: MagicMock) -> None:
import pytest
from pydantic_core import ValidationError
@@ -3339,6 +3460,11 @@ def test_wildcard_host_with_secret_is_valid(bus: MagicMock) -> None:
assert channel.config.host == "0.0.0.0"
def test_wildcard_host_with_trusted_proxy_auth_is_valid(bus: MagicMock) -> None:
channel = _ch(bus, host="0.0.0.0", **_trusted_proxy_config())
assert channel.config.host == "0.0.0.0"
def test_wildcard_ipv6_without_auth_raises(bus: MagicMock) -> None:
import pytest
from pydantic_core import ValidationError
@@ -3385,6 +3511,40 @@ def test_bootstrap_ws_url_uses_forwarded_https_host(bus: MagicMock) -> None:
assert body["ws_url"] == "wss://nanobot.example/"
def test_bootstrap_ws_url_uses_configured_public_url(bus: MagicMock) -> None:
channel = _ch(
bus,
host="127.0.0.1",
port=29931,
tokenIssueSecret="s3cret",
publicWsUrl="wss://claw.wasapi.xyz/",
)
resp = channel.gateway.http._handle_bootstrap(
_LOCAL,
_FakeReq(
{
"Authorization": "Bearer s3cret",
"Host": "127.0.0.1:29931",
"X-Forwarded-Proto": "https",
}
),
)
assert resp.status_code == 200
assert json.loads(resp.body)["ws_url"] == "wss://claw.wasapi.xyz/"
def test_public_ws_url_must_match_configured_path() -> None:
from pydantic_core import ValidationError
with pytest.raises(ValidationError, match="public_ws_url path must match path"):
WebSocketConfig.model_validate(
{
"path": "/socket",
"publicWsUrl": "wss://claw.wasapi.xyz/",
}
)
def test_bootstrap_without_auth_rejects_remote_requests(bus: MagicMock) -> None:
channel = _ch(bus, host="127.0.0.1")
resp = channel.gateway.http._handle_bootstrap(_REMOTE, _NO_HEADERS)
@@ -1,11 +1,8 @@
"""Tests for the signed ``/api/media/<sig>/<payload>`` route and its replay
integration on ``/api/sessions/<key>/messages``.
"""Tests for the signed ``/api/media/<sig>/<payload>`` route and WebUI replay.
The route is the return path for images attached to persisted user turns:
:meth:`WebSocketChannel.gateway.media.sign_media_path` mints URLs during session reads,
and :meth:`GatewayHTTPHandler._handle_media_fetch` serves the bytes back.
These tests cover the two halves end-to-end plus the adversarial edges
(bad signatures, ``..`` traversal, non-existent files, non-image types).
The route is the return path for local media rendered by the WebUI. These tests
cover URL signing and serving end-to-end plus the adversarial edges (bad
signatures, ``..`` traversal, non-existent files, non-image types).
"""
from __future__ import annotations
@@ -20,7 +17,7 @@ from unittest.mock import AsyncMock, MagicMock, patch
import pytest
from nanobot.channels.websocket.runtime import WebSocketChannel, WebSocketConfig
from nanobot.session.manager import Session, SessionManager
from nanobot.session.manager import SessionManager
from nanobot.webui.gateway_services import build_gateway_services
from nanobot.webui.media_api import (
b64url_decode,
@@ -497,91 +494,3 @@ async def test_media_route_serves_svg_with_strict_csp(
assert resp.headers.get("x-content-type-options") == "nosniff"
assert "default-src 'none'" in resp.headers.get("content-security-policy", "")
assert "sandbox" in resp.headers.get("content-security-policy", "")
# ---------------------------------------------------------------------------
# /api/sessions/<key>/messages: media_urls hydration on session read
# ---------------------------------------------------------------------------
@pytest.mark.asyncio
async def test_session_messages_exposes_signed_media_urls(
bus: MagicMock, tmp_path: Path
) -> None:
"""The read path must map persisted ``media`` paths onto signed URLs
and strip the raw path the client never learns the server's layout."""
media = tmp_path / "media"
media.mkdir()
img = media / "u.png"
img.write_bytes(_PNG_BYTES)
sm = SessionManager(tmp_path / "ws_state")
sess = Session(key="websocket:media-hydrate")
sess.add_message("user", "look at this", media=[str(img)])
sess.add_message("assistant", "nice")
sm.save(sess)
channel = _ch(bus, session_manager=sm, port=29925)
with patch("nanobot.webui.media_gateway.get_media_dir", return_value=media):
server_task = asyncio.create_task(channel.start())
try:
token = channel.gateway.tokens.issue_api_token(300)
auth = {"Authorization": f"Bearer {token}"}
resp = await _http_get(
"http://127.0.0.1:29925/api/sessions/websocket:media-hydrate/messages",
headers=auth,
)
body = resp.json()
# The signed URL round-trips end-to-end: fetching it yields the same bytes.
user_msg = next(m for m in body["messages"] if m["role"] == "user")
urls = user_msg["media_urls"]
assert isinstance(urls, list) and len(urls) == 1
assert urls[0]["name"] == "u.png"
assert urls[0]["url"].startswith("/api/media/")
# Raw paths must not leak to the wire.
assert "media" not in user_msg
# And the URL actually works.
fetched = await _http_get(f"http://127.0.0.1:29925{urls[0]['url']}")
assert fetched.status_code == 200
assert fetched.content == _PNG_BYTES
finally:
await channel.stop()
await server_task
@pytest.mark.asyncio
async def test_session_messages_skips_vanished_media(
bus: MagicMock, tmp_path: Path
) -> None:
"""Paths that no longer resolve inside the media root produce no URL —
the message is still delivered, just without the preview."""
media = tmp_path / "media"
media.mkdir()
sm = SessionManager(tmp_path / "ws_state")
sess = Session(key="websocket:vanished")
sess.add_message("user", "missing pic", media=[str(media / "absent.png")])
sm.save(sess)
channel = _ch(bus, session_manager=sm, port=29926)
with patch("nanobot.webui.media_gateway.get_media_dir", return_value=media):
server_task = asyncio.create_task(channel.start())
try:
token = channel.gateway.tokens.issue_api_token(300)
resp = await _http_get(
"http://127.0.0.1:29926/api/sessions/websocket:vanished/messages",
headers={"Authorization": f"Bearer {token}"},
)
user_msg = next(m for m in resp.json()["messages"] if m["role"] == "user")
# absent.png lives inside the media root so it *does* get a signed
# URL (we don't stat the file at signing time — that would slow
# the listing). Fetching the URL is where the 404 surfaces.
urls = user_msg.get("media_urls") or []
assert len(urls) == 1
fetched = await _http_get(f"http://127.0.0.1:29926{urls[0]['url']}")
assert fetched.status_code == 404
assert "media" not in user_msg
finally:
await channel.stop()
await server_task
+9 -8
View File
@@ -30,12 +30,14 @@ WECOM_UPLOAD_MAX_BYTES = 1024 * 1024 * 200 # 200MB
_SAFE_NAME_RE = re.compile(r"[^\w.\-()\[\]()【】\u4e00-\u9fff]+", re.UNICODE)
def _sanitize_filename(name: str) -> str:
def _sanitize_filename(name: str, fallback: str = "unnamed") -> str:
"""Sanitize filename to avoid traversal and problematic chars."""
name = (name or "").strip()
name = Path(name).name
name = _SAFE_NAME_RE.sub("_", name).strip("._ ")
return name
def _clean(value: str) -> str:
value = (value or "").strip()
value = Path(value).name
return _SAFE_NAME_RE.sub("_", value).strip("._ ")
return _clean(name) or _clean(fallback) or "unnamed"
_IMAGE_EXTS = {".jpg", ".jpeg", ".png", ".gif", ".webp", ".bmp"}
@@ -399,9 +401,8 @@ class WecomChannel(BaseChannel):
return None
media_dir = get_media_dir("wecom")
if not filename:
filename = fname or f"{media_type}_{hash(file_url) % 100000}"
filename = _sanitize_filename(cast(str, filename))
fallback_name = fname or f"{media_type}_{hash(file_url) % 100000}"
filename = _sanitize_filename(cast(str, filename or fallback_name), fallback=fallback_name)
file_path = media_dir / filename
await asyncio.to_thread(file_path.write_bytes, data)
@@ -93,7 +93,14 @@ def test_sanitize_filename_keeps_chinese_chars() -> None:
def test_sanitize_filename_empty_input() -> None:
assert _sanitize_filename("") == ""
assert _sanitize_filename("") == "unnamed"
def test_sanitize_filename_empty_or_dots_fallback() -> None:
assert _sanitize_filename("...") == "unnamed"
assert _sanitize_filename("..", fallback="fallback.txt") == "fallback.txt"
assert _sanitize_filename("...", fallback="../../outside.txt") == "outside.txt"
assert _sanitize_filename("") == "unnamed"
def test_guess_wecom_media_type_image() -> None:
@@ -144,6 +151,27 @@ async def test_download_and_save_success() -> None:
os.unlink(path)
@pytest.mark.asyncio
async def test_download_and_save_sanitizes_sdk_fallback(tmp_path: Path) -> None:
"""An unsafe SDK filename cannot escape the channel media directory."""
channel = WecomChannel(WecomConfig(bot_id="b", secret="s", allow_from=["*"]), MessageBus())
client = _FakeWeComClient()
client.download_file.return_value = (b"payload", "../../outside.txt")
channel._client = client
with patch("nanobot.channels.wecom.runtime.get_media_dir", return_value=tmp_path):
path = await channel._download_and_save_media(
"https://example.com/file",
"aes_key",
"file",
"...",
)
assert path is not None
assert Path(path) == tmp_path / "outside.txt"
assert Path(path).read_bytes() == b"payload"
@pytest.mark.asyncio
async def test_download_and_save_oversized_rejected() -> None:
"""Data exceeding 200MB is rejected → returns None."""
+80 -7
View File
@@ -47,7 +47,10 @@ class WeixinConnectStore:
if not session_id:
raise ChannelConnectError("missing WeChat connect session")
if action == "poll":
return await self.poll(session_id)
return await self.poll(
session_id,
verify_code=(query_first(query, "verify_code") or "").strip(),
)
if action == "cancel":
return await self.cancel(session_id)
raise ChannelConnectError(f"unsupported WeChat connect action: {action}", status=404)
@@ -91,7 +94,7 @@ class WeixinConnectStore:
)
return self._start_payload(self._sessions[session_id])
async def poll(self, session_id: str) -> dict[str, Any]:
async def poll(self, session_id: str, *, verify_code: str = "") -> dict[str, Any]:
await self._cleanup()
session = self._sessions.get(session_id)
if session is None:
@@ -105,6 +108,7 @@ class WeixinConnectStore:
status_data = await session.channel.connect_poll_qr_code(
base_url=session.current_poll_base_url,
qrcode_id=session.qrcode_id,
verify_code=verify_code,
)
except Exception as exc:
if session.channel.connect_poll_error_is_retryable(exc):
@@ -120,6 +124,8 @@ class WeixinConnectStore:
status_payload = status_data
status = status_payload.get("status", "")
from nanobot.channels.weixin.runtime import MAX_QR_REFRESH_COUNT
if status == "confirmed":
if self._sessions.get(session_id) is not session:
return {
@@ -157,9 +163,66 @@ class WeixinConnectStore:
)
return self._pending_payload(session)
if status == "expired":
from nanobot.channels.weixin.runtime import MAX_QR_REFRESH_COUNT
if status == "need_verifycode":
return self._pending_payload(
session,
challenge="verify_code",
message=(
"That verification code did not match. Enter the new number shown in WeChat."
if verify_code
else "Enter the number shown in WeChat to continue."
),
verification_failed=bool(verify_code),
)
if status == "verify_code_blocked":
session.refresh_count += 1
if session.refresh_count > MAX_QR_REFRESH_COUNT:
self._sessions.pop(session_id, None)
await self._close_channel(session.channel)
return {
"session_id": session_id,
"status": "failed",
"message": "Too many incorrect verification attempts. Try again later.",
}
try:
session.qrcode_id, session.qr_url = (
await session.channel.connect_fetch_qr_code()
)
except Exception as exc:
self._sessions.pop(session_id, None)
await self._close_channel(session.channel)
return {
"session_id": session_id,
"status": "failed",
"message": f"Could not refresh WeChat QR code: {exc}",
}
session.current_poll_base_url = session.channel.connect_base_url
return self._pending_payload(
session,
message="Verification was blocked. Scan the refreshed QR code to try again.",
)
if status == "binded_redirect":
if not session.channel.connect_load_state():
self._sessions.pop(session_id, None)
await self._close_channel(session.channel)
return {
"session_id": session_id,
"status": "failed",
"message": (
"WeChat reports an existing binding, but no local credentials were found."
),
}
self._sessions.pop(session_id, None)
await self._close_channel(session.channel)
return {
"session_id": session_id,
"status": "succeeded",
"message": "WeChat is already connected to this nanobot instance.",
}
if status == "expired":
session.refresh_count += 1
if session.refresh_count > MAX_QR_REFRESH_COUNT:
self._sessions.pop(session_id, None)
@@ -238,15 +301,25 @@ class WeixinConnectStore:
}
@staticmethod
def _pending_payload(session: WeixinConnectSession) -> dict[str, Any]:
return {
def _pending_payload(
session: WeixinConnectSession,
*,
challenge: str = "",
message: str = "Waiting for WeChat scan.",
verification_failed: bool = False,
) -> dict[str, Any]:
payload: dict[str, Any] = {
"session_id": session.id,
"status": "pending",
"qr_url": session.qr_url,
"interval_ms": 2000,
"expires_at_ms": int((session.created_wall + 600) * 1000),
"message": "Waiting for WeChat scan.",
"message": message,
}
if challenge:
payload["challenge"] = challenge
payload["verification_failed"] = verification_failed
return payload
__all__ = ["WeixinConnectStore"]
+14
View File
@@ -10,6 +10,20 @@ SETUP_SPEC = ChannelSetupSpec(
fields={
"token": field("secret"),
"allowFrom": field("list"),
"baseUrl": field(default="https://ilinkai.weixin.qq.com"),
"cdnBaseUrl": field(default="https://novac2c.cdn.weixin.qq.com/c2c"),
"routeTag": field(),
"stateDir": field(),
"pollTimeout": field("int", default=35),
"sendProgress": field("bool", default=False),
"sendToolHints": field("bool", default=False),
"replyProgressMessages": field("bool", default=False),
"replyProgressMaxMessages": field("int", default=2),
"contextMessageBudget": field("int", default=8),
"streaming": field("bool", default=True),
"blockStreaming": field("bool", default=False),
"blockStreamingMinChars": field("int", default=1200),
"blockStreamingMaxMessages": field("int", default=3),
},
required=(required("token"),),
official_url="https://weixin.qq.com/",
File diff suppressed because it is too large Load Diff
@@ -147,3 +147,129 @@ async def test_weixin_cancel_wins_over_inflight_confirmation(
assert cancelled["status"] == "cancelled"
assert completed["status"] == "cancelled"
assert not (state_dir / "account.json").exists()
@pytest.mark.asyncio
async def test_weixin_connect_store_handles_verification_code(
tmp_path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
state_dir = tmp_path / "weixin-state"
config_path = tmp_path / "config.json"
save_config(
Config.model_validate({"channels": {"weixin": {"stateDir": str(state_dir)}}}),
config_path,
)
monkeypatch.setattr("nanobot.config.loader._current_config_path", config_path)
async def fake_fetch_qr_code(self: WeixinChannel) -> tuple[str, str]:
return "qr-verify", "https://qr.example/verify"
responses = [
{"status": "need_verifycode"},
{
"status": "confirmed",
"bot_token": "verified-token",
"ilink_user_id": "wx-user",
},
]
async def fake_api_get_with_base(
self: WeixinChannel,
*,
params: dict[str, Any],
**_kwargs: Any,
) -> dict[str, str]:
if len(responses) == 1:
assert params == {"qrcode": "qr-verify", "verify_code": "1234"}
return responses.pop(0)
monkeypatch.setattr(WeixinChannel, "_fetch_qr_code", fake_fetch_qr_code)
monkeypatch.setattr(WeixinChannel, "_api_get_with_base", fake_api_get_with_base)
store = WeixinConnectStore()
started = await store.start()
challenged = await store.poll(started["session_id"])
completed = await store.handle(
"poll",
{
"session_id": [started["session_id"]],
"verify_code": ["1234"],
},
)
assert challenged["status"] == "pending"
assert challenged["challenge"] == "verify_code"
assert completed["status"] == "succeeded"
@pytest.mark.asyncio
async def test_weixin_connect_store_treats_existing_binding_as_success(
tmp_path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
state_dir = tmp_path / "weixin-state"
state_dir.mkdir()
(state_dir / "account.json").write_text(
json.dumps({"token": "working-token"}),
encoding="utf-8",
)
config_path = tmp_path / "config.json"
save_config(
Config.model_validate({"channels": {"weixin": {"stateDir": str(state_dir)}}}),
config_path,
)
monkeypatch.setattr("nanobot.config.loader._current_config_path", config_path)
async def fake_fetch_qr_code(self: WeixinChannel) -> tuple[str, str]:
return "qr-existing", "https://qr.example/existing"
async def fake_api_get_with_base(
self: WeixinChannel,
**_kwargs: Any,
) -> dict[str, str]:
return {"status": "binded_redirect"}
monkeypatch.setattr(WeixinChannel, "_fetch_qr_code", fake_fetch_qr_code)
monkeypatch.setattr(WeixinChannel, "_api_get_with_base", fake_api_get_with_base)
store = WeixinConnectStore()
started = await store.start(force=True)
completed = await store.poll(started["session_id"])
assert completed["status"] == "succeeded"
assert "already connected" in completed["message"]
assert json.loads((state_dir / "account.json").read_text())["token"] == "working-token"
@pytest.mark.asyncio
async def test_weixin_connect_store_rejects_existing_binding_without_local_credentials(
tmp_path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
state_dir = tmp_path / "weixin-state"
config_path = tmp_path / "config.json"
save_config(
Config.model_validate({"channels": {"weixin": {"stateDir": str(state_dir)}}}),
config_path,
)
monkeypatch.setattr("nanobot.config.loader._current_config_path", config_path)
async def fake_fetch_qr_code(self: WeixinChannel) -> tuple[str, str]:
return "qr-missing", "https://qr.example/missing"
async def fake_api_get_with_base(
self: WeixinChannel,
**_kwargs: Any,
) -> dict[str, str]:
return {"status": "binded_redirect"}
monkeypatch.setattr(WeixinChannel, "_fetch_qr_code", fake_fetch_qr_code)
monkeypatch.setattr(WeixinChannel, "_api_get_with_base", fake_api_get_with_base)
store = WeixinConnectStore()
started = await store.start(force=True)
completed = await store.poll(started["session_id"])
assert completed["status"] == "failed"
assert "no local credentials" in completed["message"]
@@ -17,6 +17,7 @@ from nanobot.channels.weixin.runtime import (
ITEM_TEXT,
MESSAGE_TYPE_BOT,
WEIXIN_CHANNEL_VERSION,
WeixinAuthError,
WeixinChannel,
WeixinConfig,
_decrypt_aes_ecb,
@@ -67,11 +68,11 @@ def test_make_headers_includes_route_tag_when_configured() -> None:
assert headers["Authorization"] == "Bearer token"
assert headers["SKRouteTag"] == "123"
assert headers["iLink-App-Id"] == "bot"
assert headers["iLink-App-ClientVersion"] == str((2 << 16) | (1 << 8) | 1)
assert headers["iLink-App-ClientVersion"] == str((2 << 16) | (4 << 8) | 6)
def test_channel_version_matches_reference_plugin_version() -> None:
assert WEIXIN_CHANNEL_VERSION == "2.1.1"
assert WEIXIN_CHANNEL_VERSION == "2.4.6"
def test_save_and_load_state_persists_context_tokens(tmp_path) -> None:
@@ -159,6 +160,29 @@ def test_save_state_persists_explicit_config_token_over_stale_state(tmp_path) ->
assert saved["get_updates_buf"] == "current-cursor"
def test_save_state_preserves_qr_replacement_of_configured_token(tmp_path) -> None:
config = WeixinConfig(
enabled=True,
allow_from=["*"],
token="configured-token",
state_dir=str(tmp_path),
)
old_runtime = WeixinChannel(config, MessageBus())
old_runtime._token = "configured-token"
replacement = WeixinChannel(config, MessageBus())
replacement.connect_commit_account(
token="replacement-token",
base_url="https://new.example",
)
old_runtime._save_state()
saved = json.loads((tmp_path / "account.json").read_text())
assert saved["token"] == "replacement-token"
assert saved["base_url"] == "https://new.example"
def test_save_state_with_empty_runtime_token_preserves_persisted_account(tmp_path) -> None:
channel = WeixinChannel(
WeixinConfig(enabled=True, allow_from=["*"], state_dir=str(tmp_path)),
@@ -442,15 +466,15 @@ async def test_send_without_context_token_raises() -> None:
@pytest.mark.asyncio
async def test_send_raises_when_session_is_paused() -> None:
async def test_send_raises_when_authentication_is_required() -> None:
channel, _bus = _make_channel()
channel._client = object()
channel._token = "token"
channel._context_tokens["wx-user"] = "ctx-2"
channel._pause_session(60)
channel._auth_required = True
channel._send_text = AsyncMock()
with pytest.raises(RuntimeError, match="session paused"):
with pytest.raises(WeixinAuthError, match="bot token is stale"):
await channel.send(
type("Msg", (), {"chat_id": "wx-user", "content": "pong", "media": [], "metadata": {}})()
)
@@ -525,20 +549,21 @@ async def test_send_still_sends_text_when_typing_ticket_missing() -> None:
@pytest.mark.asyncio
async def test_poll_once_pauses_session_on_expired_errcode() -> None:
async def test_poll_once_requires_login_on_stale_token() -> None:
channel, _bus = _make_channel()
channel._client = SimpleNamespace(timeout=None)
channel._token = "token"
channel._api_post = AsyncMock(return_value={"ret": 0, "errcode": -14, "errmsg": "expired"})
await channel._poll_once()
with pytest.raises(WeixinAuthError, match="no replacement credentials"):
await channel._poll_once()
assert channel._session_pause_remaining_s() > 0
assert channel._auth_required is True
@pytest.mark.asyncio
async def test_poll_once_reloads_refreshed_state_after_session_pause(
tmp_path, monkeypatch: pytest.MonkeyPatch
async def test_poll_once_reloads_refreshed_state_after_stale_token(
tmp_path,
) -> None:
channel = WeixinChannel(
WeixinConfig(enabled=True, allow_from=["*"], state_dir=str(tmp_path)),
@@ -550,8 +575,13 @@ async def test_poll_once_reloads_refreshed_state_after_session_pause(
json.dumps({"token": "new-token", "base_url": "https://new.example"}),
encoding="utf-8",
)
channel._session_pause_until = time.time() + 10
monkeypatch.setattr(weixin_mod.asyncio, "sleep", AsyncMock())
channel._client = object()
channel._api_post = AsyncMock(
side_effect=[
{"ret": 0, "errcode": -14, "errmsg": "stale"},
{"ret": 0},
]
)
await channel._poll_once()
@@ -560,8 +590,8 @@ async def test_poll_once_reloads_refreshed_state_after_session_pause(
@pytest.mark.asyncio
async def test_poll_once_keeps_explicit_token_after_session_pause(
tmp_path, monkeypatch: pytest.MonkeyPatch
async def test_poll_once_keeps_explicit_token_and_requires_login(
tmp_path,
) -> None:
channel = WeixinChannel(
WeixinConfig(
@@ -577,24 +607,132 @@ async def test_poll_once_keeps_explicit_token_after_session_pause(
json.dumps({"token": "stale-token", "base_url": "https://stale.example"}),
encoding="utf-8",
)
channel._session_pause_until = time.time() + 10
monkeypatch.setattr(weixin_mod.asyncio, "sleep", AsyncMock())
channel._client = object()
channel._api_post = AsyncMock(
return_value={"ret": 0, "errcode": -14, "errmsg": "stale"}
)
await channel._poll_once()
with pytest.raises(WeixinAuthError, match="no replacement credentials"):
await channel._poll_once()
assert channel._token == "configured-token"
assert channel.config.base_url == "https://ilinkai.weixin.qq.com"
@pytest.mark.asyncio
async def test_poll_once_loads_qr_replacement_for_configured_token(tmp_path) -> None:
config = WeixinConfig(
enabled=True,
allow_from=["*"],
token="configured-token",
state_dir=str(tmp_path),
)
replacement = WeixinChannel(config, MessageBus())
replacement.connect_commit_account(
token="replacement-token",
base_url="https://new.example",
)
channel = WeixinChannel(config, MessageBus())
channel._token = "configured-token"
channel._client = object()
channel._api_post = AsyncMock(
side_effect=[
{"ret": 0, "errcode": -14, "errmsg": "stale"},
{"ret": 0},
]
)
await channel._poll_once()
assert channel._token == "replacement-token"
assert channel.config.base_url == "https://new.example"
@pytest.mark.asyncio
async def test_start_uses_qr_replacement_for_configured_token(tmp_path) -> None:
config = WeixinConfig(
enabled=True,
allow_from=["*"],
token="configured-token",
state_dir=str(tmp_path),
)
connector = WeixinChannel(config, MessageBus())
connector.connect_commit_account(
token="replacement-token",
base_url="https://new.example",
)
channel = WeixinChannel(config, MessageBus())
observed_tokens: list[str] = []
async def stop_after_first_poll() -> None:
observed_tokens.append(channel._token)
channel._running = False
channel._notify_lifecycle = AsyncMock() # type: ignore[method-assign]
channel._poll_once = stop_after_first_poll # type: ignore[method-assign]
await channel.start()
await channel.stop()
assert observed_tokens == ["replacement-token"]
assert channel.config.base_url == "https://new.example"
@pytest.mark.asyncio
async def test_manager_surfaces_actionable_weixin_auth_error_without_traceback(
tmp_path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
from nanobot.channels import manager as manager_mod
channel = WeixinChannel(
WeixinConfig(enabled=True, allow_from=["*"], state_dir=str(tmp_path)),
MessageBus(),
)
channel.start = AsyncMock( # type: ignore[method-assign]
side_effect=WeixinAuthError(
"getupdates",
errcode=-14,
errmsg="stale",
)
)
errors: list[str] = []
tracebacks: list[str] = []
monkeypatch.setattr(
manager_mod.logger,
"error",
lambda message, *args: errors.append(message.format(*args)),
)
monkeypatch.setattr(
manager_mod.logger,
"exception",
lambda message, *args: tracebacks.append(message.format(*args)),
)
manager = manager_mod.ChannelManager.__new__(manager_mod.ChannelManager)
manager._channel_errors = {}
await manager._start_channel("weixin", channel)
assert manager._channel_errors["weixin"] == (
"WeChat login expired. Scan again to reconnect."
)
assert errors == [
"Failed to start channel weixin: WeChat login expired. Scan again to reconnect."
]
assert tracebacks == []
@pytest.mark.asyncio
async def test_qr_login_refreshes_expired_qr_and_then_succeeds(
no_qr_poll_delay,
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._api_get = AsyncMock(
channel._api_post = AsyncMock(
side_effect=[
{"qrcode": "qr-1", "qrcode_img_content": "url-1"},
{"qrcode": "qr-2", "qrcode_img_content": "url-2"},
@@ -627,7 +765,7 @@ async def test_qr_login_returns_false_after_too_many_expired_qr_codes(
channel, _bus = _make_channel()
channel._running = True
channel._print_qr_code = lambda url: None
channel._api_get = AsyncMock(
channel._api_post = AsyncMock(
side_effect=[
{"qrcode": "qr-1", "qrcode_img_content": "url-1"},
{"qrcode": "qr-2", "qrcode_img_content": "url-2"},
@@ -655,7 +793,7 @@ async def test_qr_login_switches_polling_base_url_on_redirect_status(
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._fetch_qr_code = AsyncMock(return_value=("qr-1", "url-1"))
@@ -689,7 +827,7 @@ async def test_qr_login_redirect_without_host_keeps_current_polling_base_url(
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._fetch_qr_code = AsyncMock(return_value=("qr-1", "url-1"))
@@ -723,7 +861,7 @@ async def test_qr_login_resets_redirect_base_url_after_qr_refresh(
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._fetch_qr_code = AsyncMock(side_effect=[("qr-1", "url-1"), ("qr-2", "url-2")])
@@ -1015,7 +1153,7 @@ async def test_qr_login_treats_temporary_connect_error_as_wait_and_recovers(
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._fetch_qr_code = AsyncMock(return_value=("qr-1", "url-1"))
@@ -1045,7 +1183,7 @@ async def test_qr_login_treats_5xx_gateway_response_error_as_wait_and_recovers(
) -> None:
channel, _bus = _make_channel()
channel._running = True
channel._save_state = lambda: None
channel._save_state = lambda **_kwargs: None
channel._print_qr_code = lambda url: None
channel._fetch_qr_code = AsyncMock(return_value=("qr-1", "url-1"))
@@ -1080,6 +1218,32 @@ def test_decrypt_aes_ecb_strips_valid_pkcs7_padding() -> None:
assert decrypted == plaintext
def test_missing_aes_dependency_recommends_weixin_plugin(monkeypatch) -> None:
real_import = __import__
def fake_import(name, *args, **kwargs):
if name.startswith(("Crypto", "cryptography")):
raise ImportError("missing AES dependency")
return real_import(name, *args, **kwargs)
warnings: list[str] = []
monkeypatch.setattr("builtins.__import__", fake_import)
monkeypatch.setattr(
weixin_mod.logger,
"warning",
lambda message, *args: warnings.append(message.format(*args)),
)
key_b64 = "MDEyMzQ1Njc4OWFiY2RlZg=="
data = b"unencrypted media"
assert _encrypt_aes_ecb(data, key_b64) == data
assert _decrypt_aes_ecb(data, key_b64) == data
assert warnings == [
"Cannot encrypt media. Run `nanobot plugins enable weixin` to install WeChat support.",
"Cannot decrypt media. Run `nanobot plugins enable weixin` to install WeChat support.",
]
class _DummyDownloadResponse:
def __init__(self, content: bytes, status_code: int = 200) -> None:
self.content = content
@@ -1412,7 +1576,7 @@ async def test_send_text_raises_on_api_error() -> None:
return_value={"errcode": -14, "errmsg": "session expired"}
)
with pytest.raises(RuntimeError, match="WeChat send text error.*-14"):
with pytest.raises(WeixinAuthError, match="WeChat sendmessage failed.*errcode=-14"):
await channel._send_text("wx-user", "hello", "ctx-expired")
channel._api_post.assert_awaited_once()
@@ -1445,7 +1609,7 @@ async def test_send_text_raises_on_nonzero_ret_even_when_errcode_zero() -> None:
return_value={"ret": -100, "errcode": 0, "errmsg": "internal error"}
)
with pytest.raises(RuntimeError, match="WeChat send text error.*ret=-100.*errcode=0"):
with pytest.raises(RuntimeError, match="WeChat sendmessage failed.*ret=-100.*errcode=0"):
await channel._send_text("wx-user", "hello", "ctx-ok")
channel._api_post.assert_awaited_once()
@@ -0,0 +1,441 @@
from __future__ import annotations
import asyncio
import json
import time
from unittest.mock import AsyncMock
import httpx
import pytest
from nanobot.bus.events import OutboundMessage
from nanobot.bus.outbound_events import ProgressEvent
from nanobot.bus.queue import MessageBus
from nanobot.channels.manager import ChannelManager
from nanobot.channels.weixin.manifest import SETUP_SPEC
from nanobot.channels.weixin.runtime import (
ITEM_TOOL_CALL_RESULT,
ITEM_TOOL_CALL_START,
WEIXIN_MAX_MESSAGE_LEN,
WeixinAPIError,
WeixinAuthError,
WeixinChannel,
WeixinConfig,
WeixinQuotaError,
sanitize_weixin_markdown,
split_weixin_message,
)
from nanobot.config.schema import Config
def _channel(**config: object) -> WeixinChannel:
return WeixinChannel(
WeixinConfig.model_validate(
{"enabled": True, "allowFrom": ["*"], **config}
),
MessageBus(),
)
def _ready_channel(**config: object) -> WeixinChannel:
channel = _channel(**config)
channel._client = object()
channel._token = "bot-token"
channel._context_tokens["wx-user"] = "ctx-1"
channel._context_token_at["wx-user"] = time.time()
channel._typing_tickets["wx-user"] = {
"ticket": "",
"next_fetch_at": time.time() + 3600,
}
return channel
def test_weixin_defaults_protect_context_quota() -> None:
config = WeixinConfig()
assert WEIXIN_MAX_MESSAGE_LEN == 1800
assert config.send_progress is False
assert config.send_tool_hints is False
assert config.reply_progress_messages is False
assert config.context_message_budget == 8
assert config.block_streaming is False
def test_weixin_webui_manifest_covers_runtime_configuration() -> None:
runtime_fields = set(WeixinConfig().model_dump(mode="json", by_alias=True))
assert set(SETUP_SPEC.fields) == runtime_fields - {"enabled"}
def test_reply_progress_opt_in_enables_progress_transport() -> None:
config = WeixinConfig(reply_progress_messages=True)
assert config.send_progress is True
assert config.send_tool_hints is True
@pytest.mark.parametrize(
("section", "send_progress", "send_tool_hints"),
[
({"enabled": True}, False, False),
({"enabled": True, "replyProgressMessages": True}, True, True),
({"enabled": True, "sendProgress": True, "sendToolHints": False}, True, False),
],
)
def test_channel_manager_preserves_weixin_quota_defaults(
section: dict[str, object],
send_progress: bool,
send_tool_hints: bool,
) -> None:
manager = ChannelManager.__new__(ChannelManager)
manager.config = Config.model_validate({"channels": {"weixin": section}})
manager.bus = MessageBus()
channel = manager._build_channel("weixin", WeixinChannel, section)
assert channel.send_progress is send_progress
assert channel.send_tool_hints is send_tool_hints
@pytest.mark.asyncio
async def test_channel_manager_does_not_retry_permanent_weixin_error(monkeypatch) -> None:
manager = ChannelManager.__new__(ChannelManager)
manager.config = Config.model_validate({"channels": {"sendMaxRetries": 3}})
manager.bus = MessageBus()
channel = _channel()
channel.send = AsyncMock(
side_effect=WeixinAPIError(
"sendmessage",
errcode=-1,
errmsg="business rejection",
retryable=False,
)
)
sleep = AsyncMock()
monkeypatch.setattr("nanobot.channels.manager.asyncio.sleep", sleep)
await manager._send_with_retry(
channel,
OutboundMessage(channel="weixin", chat_id="wx-user", content="test"),
)
channel.send.assert_awaited_once()
sleep.assert_not_awaited()
@pytest.mark.asyncio
async def test_weixin_http_clients_ignore_system_proxy(tmp_path, monkeypatch) -> None:
captured: list[dict[str, object]] = []
class FakeClient:
async def aclose(self) -> None:
return None
def make_client(**kwargs: object) -> FakeClient:
captured.append(kwargs)
return FakeClient()
monkeypatch.setattr("nanobot.channels.weixin.runtime.httpx.AsyncClient", make_client)
connect_channel = _channel(stateDir=str(tmp_path / "connect"))
connect_channel.connect_open_client()
await connect_channel.connect_close_client()
login_channel = _channel(stateDir=str(tmp_path / "login"))
login_channel._qr_login = AsyncMock(return_value=True)
assert await login_channel.login() is True
start_channel = _channel(token="configured-token", stateDir=str(tmp_path / "start"))
async def stop_after_poll() -> None:
start_channel._running = False
start_channel._notify_lifecycle = AsyncMock()
start_channel._poll_once = AsyncMock(side_effect=stop_after_poll)
await start_channel.start()
await start_channel.stop()
assert len(captured) == 3
assert all(kwargs["trust_env"] is False for kwargs in captured)
def test_markdown_sanitizer_preserves_code_and_escapes_bare_angles() -> None:
content = "before <tag> `x<y>`\n```python\na<b\n```\n![drop](https://x.test/a.png)"
sanitized = sanitize_weixin_markdown(content)
assert "before tag" in sanitized
assert "`x<y>`" in sanitized
assert "a<b" in sanitized
assert "![drop]" not in sanitized
def test_markdown_split_balances_fences_and_stays_within_limit() -> None:
chunks = split_weixin_message("```python\n" + ("x" * 4000) + "\n```")
assert len(chunks) >= 3
assert all(len(chunk) <= WEIXIN_MAX_MESSAGE_LEN for chunk in chunks)
assert all(chunk.count("```") % 2 == 0 for chunk in chunks)
@pytest.mark.asyncio
async def test_qr_fetch_posts_known_local_tokens(tmp_path) -> None:
state_dir = tmp_path / "weixin"
state_dir.mkdir()
(state_dir / "account.json").write_text(
json.dumps({"token": "persisted-token"}),
encoding="utf-8",
)
channel = _channel(stateDir=str(state_dir))
channel._api_post = AsyncMock(
return_value={"qrcode": "qr-1", "qrcode_img_content": "https://qr.test/1"}
)
assert await channel._fetch_qr_code() == ("qr-1", "https://qr.test/1")
channel._api_post.assert_awaited_once_with(
"ilink/bot/get_bot_qrcode?bot_type=3",
{"local_token_list": ["persisted-token"]},
auth=False,
include_base_info=False,
)
@pytest.mark.asyncio
async def test_qr_fetch_retries_without_rejected_local_tokens(tmp_path) -> None:
state_dir = tmp_path / "weixin"
state_dir.mkdir()
(state_dir / "account.json").write_text(
json.dumps({"token": "invalid-token"}),
encoding="utf-8",
)
channel = _channel(stateDir=str(state_dir))
channel._api_post = AsyncMock(
side_effect=[
{"ret": -3},
{"ret": 0, "qrcode": "qr-1", "qrcode_img_content": "https://qr.test/1"},
]
)
assert await channel._fetch_qr_code() == ("qr-1", "https://qr.test/1")
assert [call.args[1] for call in channel._api_post.await_args_list] == [
{"local_token_list": ["invalid-token"]},
{"local_token_list": []},
]
@pytest.mark.asyncio
async def test_qr_fetch_does_not_retry_invalid_request_without_local_tokens(tmp_path) -> None:
channel = _channel(stateDir=str(tmp_path / "weixin"))
channel._api_post = AsyncMock(return_value={"ret": -3})
with pytest.raises(WeixinAPIError, match="get_bot_qrcode failed.*ret=-3"):
await channel._fetch_qr_code()
channel._api_post.assert_awaited_once()
@pytest.mark.asyncio
async def test_lifecycle_notifications_are_best_effort() -> None:
channel = _ready_channel()
channel._api_post = AsyncMock(return_value={"ret": 0})
await channel._notify_lifecycle("start")
await channel._notify_lifecycle("stop")
assert [call.args[0] for call in channel._api_post.await_args_list] == [
"ilink/bot/msg/notifystart",
"ilink/bot/msg/notifystop",
]
def test_business_errors_have_explicit_retry_contracts() -> None:
channel = _channel()
with pytest.raises(WeixinQuotaError) as quota:
channel._raise_for_api_error("sendmessage", {"ret": -2})
with pytest.raises(WeixinAuthError) as auth:
channel._raise_for_api_error("getupdates", {"errcode": -14})
with pytest.raises(WeixinAPIError) as rejected:
channel._raise_for_api_error("sendmessage", {"ret": -100})
assert channel.should_retry_send_error(quota.value) is False
assert channel.should_retry_send_error(auth.value) is False
assert channel.should_retry_send_error(rejected.value) is False
assert channel.should_retry_send_error(httpx.ReadTimeout("slow")) is True
request = httpx.Request("POST", "https://ilinkai.weixin.qq.com/send")
for status_code in (408, 425, 429, 503):
response = httpx.Response(status_code, request=request)
error = httpx.HTTPStatusError(
"retryable response",
request=request,
response=response,
)
assert channel.should_retry_send_error(error) is True
rejected_response = httpx.Response(400, request=request)
rejected_http = httpx.HTTPStatusError(
"bad request",
request=request,
response=rejected_response,
)
assert channel.should_retry_send_error(rejected_http) is False
def test_error_classification_checks_ret_and_errcode_independently() -> None:
channel = _channel()
with pytest.raises(WeixinQuotaError):
channel._raise_for_api_error(
"sendmessage",
{"ret": -2, "errcode": -100},
)
with pytest.raises(WeixinAuthError):
channel._raise_for_api_error(
"getupdates",
{"ret": -14, "errcode": -100},
)
@pytest.mark.asyncio
async def test_stop_cancels_inflight_long_poll() -> None:
channel = _channel(token="configured-token")
poll_started = asyncio.Event()
poll_cancelled = asyncio.Event()
class FakeClient:
async def aclose(self) -> None:
return None
async def blocking_poll() -> None:
poll_started.set()
try:
await asyncio.Event().wait()
except asyncio.CancelledError:
poll_cancelled.set()
raise
channel._new_http_client = lambda _timeout: FakeClient() # type: ignore[method-assign]
channel._notify_lifecycle = AsyncMock()
channel._poll_once = blocking_poll # type: ignore[method-assign]
start_task = asyncio.create_task(channel.start())
await asyncio.wait_for(poll_started.wait(), timeout=1)
await asyncio.wait_for(channel.stop(), timeout=1)
await asyncio.wait_for(start_task, timeout=1)
assert poll_cancelled.is_set()
assert channel._poll_task is None
@pytest.mark.asyncio
async def test_retry_reuses_client_id_and_skips_completed_chunks() -> None:
channel = _ready_channel()
request = httpx.Request("POST", "https://ilinkai.weixin.qq.com/ilink/bot/sendmessage")
channel._api_post = AsyncMock(
side_effect=[
{"ret": 0},
httpx.ReadTimeout("ambiguous timeout", request=request),
{"ret": 0},
]
)
msg = OutboundMessage(
channel="weixin",
chat_id="wx-user",
content="x" * (WEIXIN_MAX_MESSAGE_LEN + 200),
)
with pytest.raises(httpx.ReadTimeout):
await channel.send(msg)
await channel.send(msg)
bodies = [call.args[1] for call in channel._api_post.await_args_list]
client_ids = [body["msg"]["client_id"] for body in bodies]
assert client_ids[0] != client_ids[1]
assert client_ids[1] == client_ids[2]
assert channel._context_send_counts["ctx-1"] == 2
@pytest.mark.asyncio
async def test_quota_rejection_defers_final_until_fresh_context() -> None:
channel = _ready_channel()
channel._api_post = AsyncMock(side_effect=[{"ret": -2}, {"ret": 0}])
msg = OutboundMessage(
channel="weixin",
chat_id="wx-user",
content="deferred answer",
)
with pytest.raises(WeixinQuotaError):
await channel.send(msg)
first_client_id = channel._api_post.await_args_list[0].args[1]["msg"]["client_id"]
assert "wx-user" in channel._deferred_outbound
channel._context_tokens["wx-user"] = "ctx-2"
channel._context_token_at["wx-user"] = time.time()
await channel._retry_deferred_messages("wx-user")
second_client_id = channel._api_post.await_args_list[1].args[1]["msg"]["client_id"]
assert second_client_id == first_client_id
assert "wx-user" not in channel._deferred_outbound
@pytest.mark.asyncio
async def test_local_context_budget_stops_before_extra_api_call() -> None:
channel = _ready_channel(contextMessageBudget=1)
channel._api_post = AsyncMock(return_value={"ret": 0})
await channel._send_text("wx-user", "one", "ctx-1")
with pytest.raises(WeixinQuotaError, match="local safety budget"):
await channel._send_text("wx-user", "two", "ctx-1")
channel._api_post.assert_awaited_once()
@pytest.mark.asyncio
async def test_bounded_block_streaming_reserves_one_final_message() -> None:
channel = _ready_channel(
blockStreaming=True,
blockStreamingMinChars=200,
blockStreamingMaxMessages=3,
)
channel._send_text = AsyncMock()
await channel.send_delta("wx-user", "a" * 250, stream_id="stream-1")
await channel.send_delta("wx-user", "b" * 250, stream_id="stream-1")
await channel.send_delta("wx-user", "c" * 250, stream_id="stream-1")
await channel.send_delta("wx-user", "done", stream_id="stream-1", stream_end=True)
assert channel._send_text.await_count == 3
assert "stream-1" not in channel._stream_buffers
assert "stream-1" not in channel._stream_sent_counts
@pytest.mark.asyncio
async def test_structured_progress_is_capped_and_uses_one_run_id() -> None:
channel = _ready_channel(
replyProgressMessages=True,
replyProgressMaxMessages=2,
)
channel._send_message_item = AsyncMock()
events = [
{"phase": "start", "call_id": "call-1", "name": "read_file"},
{"phase": "end", "call_id": "call-1", "name": "read_file"},
{"phase": "start", "call_id": "call-2", "name": "exec"},
]
await channel.send(
OutboundMessage(
channel="weixin",
chat_id="wx-user",
content="read_file",
event=ProgressEvent(content="read_file", tool_hint=True, tool_events=events),
)
)
assert channel._send_message_item.await_count == 2
first = channel._send_message_item.await_args_list[0]
second = channel._send_message_item.await_args_list[1]
assert first.args[1]["type"] == ITEM_TOOL_CALL_START
assert second.args[1]["type"] == ITEM_TOOL_CALL_RESULT
assert first.kwargs["run_id"] == second.kwargs["run_id"]
@@ -1,25 +1,148 @@
import { useState } from "react";
import { useTranslation } from "react-i18next";
import { channelTranslator } from "@/channel-plugins/i18n";
import {
channelTranslator,
type ChannelTranslator,
} from "@/channel-plugins/i18n";
import type { ChannelPluginConnectFlowProps } from "@/channel-plugins/types";
import { ChannelQrConnectFlow } from "@/components/settings/channels/ChannelQrConnectFlow";
import {
ChannelQrConnectFlow,
type ChannelQrConnectPendingContext,
} from "@/components/settings/channels/ChannelQrConnectFlow";
import { Button } from "@/components/ui/button";
import { Input } from "@/components/ui/input";
import type { ChannelConnectPayload } from "@/lib/types";
type WeixinVerificationPayload = ChannelConnectPayload & {
challenge: "verify_code";
verification_failed?: boolean;
};
export const WEIXIN_AUTH_EXPIRED_MESSAGE =
"WeChat login expired. Scan again to reconnect.";
function isVerificationChallenge(
payload: ChannelConnectPayload,
): payload is WeixinVerificationPayload {
return (
"challenge" in payload
&& payload.challenge === "verify_code"
&& (
!("verification_failed" in payload)
|| typeof payload.verification_failed === "boolean"
)
);
}
function weixinConnectMessage(
payload: ChannelConnectPayload,
tx: ChannelTranslator,
): string {
if (payload.status === "succeeded") {
return tx("custom.connected", "WeChat is connected.");
}
if (payload.status === "expired") {
return tx("custom.expired", WEIXIN_AUTH_EXPIRED_MESSAGE);
}
if (payload.status === "failed") {
return payload.message
?? tx("custom.failed", "Unable to connect WeChat. Try again.");
}
if (payload.status === "cancelled") {
return tx("custom.stopped", "WeChat login stopped.");
}
if (isVerificationChallenge(payload)) {
return payload.verification_failed
? tx(
"custom.verifyMismatch",
"That code did not match. Enter the new number shown in WeChat.",
)
: tx(
"custom.verifyDescription",
"Enter the number shown in WeChat to continue.",
);
}
return tx("custom.waiting", "Waiting for WeChat scan...");
}
export function WeixinConnectFlow({
token,
feature,
idleLabel,
connectRequestId,
onFeaturesUpdate,
}: ChannelPluginConnectFlowProps) {
const { t } = useTranslation();
const tx = channelTranslator(t, "weixin");
const [verificationCode, setVerificationCode] = useState("");
const authExpired = feature.runtime_error === WEIXIN_AUTH_EXPIRED_MESSAGE;
const scanAgainLabel = t("settings.channels.scanAgain", {
defaultValue: "Scan again",
});
const renderVerification = ({
connect,
busy,
poll,
}: ChannelQrConnectPendingContext) => {
if (!isVerificationChallenge(connect)) return null;
return (
<form
className="mt-3 space-y-2"
onSubmit={(event) => {
event.preventDefault();
const code = verificationCode.trim();
if (!code) return;
void poll({ verify_code: code }).then((payload) => {
if (payload && !isVerificationChallenge(payload)) {
setVerificationCode("");
}
});
}}
>
<div className="text-[12px] font-semibold text-foreground">
{tx("custom.verifyTitle", "Verification required")}
</div>
<p className="text-[12px] leading-5 text-muted-foreground">
{weixinConnectMessage(connect, tx)}
</p>
<div className="flex gap-2">
<Input
value={verificationCode}
onChange={(event) => setVerificationCode(event.target.value)}
inputMode="numeric"
autoComplete="one-time-code"
placeholder={tx("custom.verifyPlaceholder", "Code")}
className="h-8 max-w-40"
aria-invalid={connect.verification_failed || undefined}
/>
<Button
type="submit"
size="sm"
className="h-8 rounded-full px-3 text-[12px] font-semibold"
disabled={busy || !verificationCode.trim()}
>
{tx("custom.verifySubmit", "Verify")}
</Button>
</div>
</form>
);
};
return (
<ChannelQrConnectFlow
token={token}
channelName="weixin"
idleLabel={idleLabel}
startOptions={{ force: authExpired }}
idleLabel={authExpired ? scanAgainLabel : idleLabel}
connectRequestId={connectRequestId}
forceOnRepeat
onFeaturesUpdate={onFeaturesUpdate}
pausePolling={isVerificationChallenge}
suppressSucceeded={feature.runtime_status === "failed"}
renderPending={renderVerification}
resolveMessage={(payload) => weixinConnectMessage(payload, tx)}
labels={{
qrAlt: tx("custom.qrAlt", "WeChat login QR code"),
scanTitle: tx("custom.scanTitle", "Scan with WeChat"),
@@ -31,7 +154,7 @@ export function WeixinConnectFlow({
connected: tx("custom.connected", "WeChat is connected."),
stopped: tx("custom.stopped", "WeChat login stopped."),
connecting: tx("custom.connecting", "Connecting..."),
scanAgain: t("settings.channels.scanAgain", { defaultValue: "Scan again" }),
scanAgain: scanAgainLabel,
connect: t("settings.channels.connect", { defaultValue: "Connect" }),
}}
/>
@@ -0,0 +1,553 @@
import { useCallback, useEffect, useMemo, useRef, useState, type ReactNode } from "react";
import { Check, ChevronDown, ExternalLink, Loader2, Plus } from "lucide-react";
import { useTranslation } from "react-i18next";
import { channelFieldMessageKey, channelTranslator } from "@/channel-plugins/i18n";
import { channelLocaleMessages } from "@/channel-plugins/locale-registry";
import type { ChannelPluginPanelProps } from "@/channel-plugins/types";
import { ToggleButton } from "@/components/settings/ToggleButton";
import {
chatAppGuideUrl,
docsUrlWithBase,
type ChannelConfigField,
} from "@/components/settings/channels/catalog";
import {
CredentialForm,
channelValuesForSave,
defaultChannelFieldValues,
} from "@/components/settings/channels/CredentialForm";
import { Button } from "@/components/ui/button";
import { useLogoFallback } from "@/hooks/useLogoFallback";
import { normalizeLocale } from "@/i18n/config";
import { configureChannel } from "@/lib/api";
import { logoFallbackUrls } from "@/lib/provider-brand";
import type {
ChannelRuntimeStatus,
ChannelSetupContractField,
NanobotFeatureInfo,
} from "@/lib/types";
import { cn } from "@/lib/utils";
import {
WEIXIN_AUTH_EXPIRED_MESSAGE,
WeixinConnectFlow,
} from "./WeixinConnectFlow";
export const WEIXIN_PRIMARY_FIELD_KEYS = [
"channels.weixin.sendProgress",
"channels.weixin.sendToolHints",
"channels.weixin.streaming",
] as const;
export const WEIXIN_ADVANCED_FIELD_KEYS = [
"channels.weixin.allowFrom",
"channels.weixin.token",
"channels.weixin.replyProgressMessages",
"channels.weixin.replyProgressMaxMessages",
"channels.weixin.contextMessageBudget",
"channels.weixin.blockStreaming",
"channels.weixin.blockStreamingMinChars",
"channels.weixin.blockStreamingMaxMessages",
"channels.weixin.baseUrl",
"channels.weixin.cdnBaseUrl",
"channels.weixin.routeTag",
"channels.weixin.stateDir",
"channels.weixin.pollTimeout",
] as const;
export function WeixinPanel({
token,
feature,
actionKey,
chatAppsDocsUrl,
showBrandLogos,
onAction,
onFeaturesUpdate,
}: ChannelPluginPanelProps) {
const { t, i18n } = useTranslation();
const tx = (key: string, fallback: string) => t(key, { defaultValue: fallback });
const channelTx = channelTranslator(t, "weixin");
const runtimeError = weixinRuntimeError(feature.runtime_error, channelTx);
const displayName = channelTx("displayName", "WeChat");
const enabledBusy = actionKey === `enable:${feature.name}`;
const disabledBusy = actionKey === `disable:${feature.name}`;
const channelBusy = enabledBusy || disabledBusy;
const channelChecked =
feature.runtime_status === "running" || feature.runtime_status === "starting";
const missingSupport = feature.enabled && !feature.installed;
const alwaysEnabled = feature.capabilities?.includes("always_enabled") ?? false;
const toggleChecked = alwaysEnabled || channelChecked;
const channelToggleDisabled =
alwaysEnabled
|| channelBusy
|| (!feature.install_supported && !feature.installed && !feature.enabled);
const [connectRequestId, setConnectRequestId] = useState(0);
const [visibleSecrets, setVisibleSecrets] = useState<Record<string, boolean>>({});
const [touchedFields, setTouchedFields] = useState<Set<string>>(() => new Set());
const [saving, setSaving] = useState(false);
const [saveRevision, setSaveRevision] = useState(0);
const [attemptedRevision, setAttemptedRevision] = useState(0);
const [saveState, setSaveState] = useState<"idle" | "saved">("idle");
const [saveError, setSaveError] = useState<string | null>(null);
const configValuesKey = JSON.stringify(feature.config_values ?? {});
const setupFieldsKey = JSON.stringify(feature.setup?.fields ?? []);
const configuredFields = useMemo(
() => new Set(feature.configured_fields ?? []),
[feature.configured_fields],
);
const onLabel = tx("settings.values.on", "On");
const offLabel = tx("settings.values.off", "Off");
const setupFields = weixinSetupFields(
feature,
i18n.resolvedLanguage ?? i18n.language,
);
const primaryFields = localizeBooleanFields(setupFields.primary, onLabel, offLabel);
const advancedFields = localizeBooleanFields(setupFields.advanced, onLabel, offLabel);
const editableFields = [...primaryFields, ...advancedFields];
const docsUrl = docsUrlWithBase(chatAppGuideUrl("wechat"), chatAppsDocsUrl)
?? chatAppGuideUrl("wechat");
const [fieldValues, setFieldValues] = useState<Record<string, string>>(() =>
defaultChannelFieldValues(editableFields, feature.config_values),
);
const fieldValuesRef = useRef(fieldValues);
const touchedFieldsRef = useRef(touchedFields);
const editableFieldsRef = useRef(editableFields);
const saveContextRef = useRef({
token,
enabled: feature.enabled,
onFeaturesUpdate,
});
editableFieldsRef.current = editableFields;
saveContextRef.current = {
token,
enabled: feature.enabled,
onFeaturesUpdate,
};
useEffect(() => {
const nextValues = defaultChannelFieldValues(editableFields, feature.config_values);
for (const key of touchedFieldsRef.current) {
nextValues[key] = fieldValuesRef.current[key] ?? "";
}
fieldValuesRef.current = nextValues;
setFieldValues(nextValues);
setVisibleSecrets({});
}, [configValuesKey, setupFieldsKey]);
useEffect(() => {
if (saveState !== "saved") return;
const timeout = window.setTimeout(() => setSaveState("idle"), 1500);
return () => window.clearTimeout(timeout);
}, [saveState]);
const saveSettings = useCallback(async (
values: Record<string, string>,
savedFields: Set<string>,
) => {
const context = saveContextRef.current;
setSaving(true);
setSaveError(null);
setSaveState("idle");
try {
const payload = await configureChannel(
context.token,
"weixin",
channelValuesForSave(editableFieldsRef.current, values),
{ enable: context.enabled },
);
const remainingFields = new Set(touchedFieldsRef.current);
for (const key of savedFields) {
if (fieldValuesRef.current[key] === values[key]) remainingFields.delete(key);
}
touchedFieldsRef.current = remainingFields;
setTouchedFields(remainingFields);
setSaveState(remainingFields.size ? "idle" : "saved");
if (payload.nanobot_features) context.onFeaturesUpdate(payload.nanobot_features);
} catch (err) {
setSaveError((err as Error).message);
} finally {
setSaving(false);
}
}, []);
useEffect(() => {
if (
!editableFields.length
|| !touchedFields.size
|| saving
|| saveRevision <= attemptedRevision
) return;
const timeout = window.setTimeout(() => {
setAttemptedRevision(saveRevision);
void saveSettings(
{ ...fieldValuesRef.current },
new Set(touchedFieldsRef.current),
);
}, 500);
return () => window.clearTimeout(timeout);
}, [
attemptedRevision,
editableFields.length,
saveRevision,
saveSettings,
saving,
touchedFields.size,
]);
const setFieldValue = (key: string, value: string) => {
if (fieldValuesRef.current[key] === value) return;
const nextValues = { ...fieldValuesRef.current, [key]: value };
const nextTouchedFields = new Set(touchedFieldsRef.current).add(key);
fieldValuesRef.current = nextValues;
touchedFieldsRef.current = nextTouchedFields;
setFieldValues(nextValues);
setTouchedFields(nextTouchedFields);
setSaveError(null);
setSaveState("idle");
setSaveRevision((current) => current + 1);
};
const toggleAriaLabel = t("settings.channels.toggleChannel", {
name: displayName,
defaultValue: "{{name}} channel",
});
return (
<aside className="min-h-full rounded-[20px] bg-settings-surface p-5">
<div className="flex items-start justify-between gap-4">
<div className="flex min-w-0 items-start gap-3">
<WeixinLogo showBrandLogos={showBrandLogos} />
<div className="min-w-0 flex-1">
<h3 className="truncate text-[18px] font-semibold leading-6 text-foreground">
{displayName}
</h3>
<p className="mt-1 text-[13px] leading-5 text-muted-foreground">
{channelTx("description", "Use nanobot from WeChat conversations.")}
</p>
{missingSupport && feature.install_supported ? (
<Button
type="button"
size="sm"
variant="secondary"
disabled={enabledBusy}
onClick={() => onAction("enable", feature.name)}
className="mt-2 h-8 rounded-full px-3 text-[12px] font-semibold"
>
{enabledBusy ? (
<Loader2 className="mr-1.5 h-3.5 w-3.5 animate-spin" aria-hidden />
) : (
<Plus className="mr-1.5 h-3.5 w-3.5" aria-hidden />
)}
{tx("settings.nanobotFeatures.installSupport", "Install support")}
</Button>
) : null}
</div>
</div>
<div className="flex shrink-0 items-center gap-2 pt-1">
<WeixinStatusBadge status={feature.runtime_status}>
{weixinStatusLabel(feature, tx)}
</WeixinStatusBadge>
{channelBusy ? (
<Loader2 className="h-3.5 w-3.5 animate-spin text-muted-foreground" aria-hidden />
) : null}
<ToggleButton
checked={toggleChecked}
disabled={channelToggleDisabled}
ariaLabel={toggleAriaLabel}
label={toggleChecked ? onLabel : offLabel}
onChange={(checked) => {
if (checked && !channelChecked && feature.configured === false) {
setConnectRequestId((current) => current + 1);
return;
}
onAction(checked ? "enable" : "disable", feature.name);
}}
/>
</div>
</div>
{runtimeError ? (
<div className="mt-4 rounded-[12px] border border-destructive/20 bg-destructive/5 px-3 py-2 text-[12px] leading-5 text-destructive">
{runtimeError}
</div>
) : null}
<div className="mt-4 space-y-4">
<WeixinConnectFlow
token={token}
feature={feature}
idleLabel={channelTx("setup.primaryAction", "Connect WeChat")}
connectRequestId={connectRequestId}
onFeaturesUpdate={onFeaturesUpdate}
/>
{primaryFields.length ? (
<CredentialForm
fields={primaryFields}
values={fieldValues}
configuredFields={configuredFields}
visibleSecrets={visibleSecrets}
onChange={setFieldValue}
onToggleSecret={(key) => {
setVisibleSecrets((current) => ({ ...current, [key]: !current[key] }));
}}
compact
/>
) : null}
<div
role="status"
aria-live="polite"
aria-atomic="true"
className={cn(
"flex items-center justify-end gap-1.5 text-[11px] leading-4 text-muted-foreground",
!saving && saveState !== "saved" && "sr-only",
)}
>
{saving ? (
<>
<Loader2 className="h-3 w-3 animate-spin" aria-hidden />
{tx("settings.actions.saving", "Saving")}
</>
) : saveState === "saved" ? (
<>
<Check className="h-3 w-3" aria-hidden />
{tx("settings.channels.savedSettings", "Saved settings.")}
</>
) : null}
</div>
{saveError ? (
<div
role="alert"
className="rounded-[12px] border border-destructive/20 bg-destructive/5 px-3 py-2 text-[12px] leading-5 text-destructive"
>
{saveError}
</div>
) : null}
{advancedFields.length ? (
<details className="group text-[12px] leading-5 text-muted-foreground">
<summary className="cursor-pointer list-none text-[12px] font-semibold text-foreground">
<span className="inline-flex items-center gap-1.5">
{tx("settings.channels.advanced", "Advanced")}
<ChevronDown
className="h-3.5 w-3.5 transition-transform group-open:rotate-180"
aria-hidden
/>
</span>
</summary>
<div className="mt-3">
<CredentialForm
fields={advancedFields}
values={fieldValues}
configuredFields={configuredFields}
visibleSecrets={visibleSecrets}
onChange={setFieldValue}
onToggleSecret={(key) => {
setVisibleSecrets((current) => ({ ...current, [key]: !current[key] }));
}}
compact
/>
</div>
</details>
) : null}
<div className="flex justify-end">
<WeixinGuideLink
url={docsUrl}
label={channelTx("setup.docsLabel", "Open WeChat setup")}
/>
</div>
</div>
</aside>
);
}
function weixinSetupFields(
feature: NanobotFeatureInfo,
locale: string,
): { primary: ChannelConfigField[]; advanced: ChannelConfigField[] } {
const fields = feature.setup?.fields ?? [];
const fieldsByKey = new Map(fields.map((field) => [field.key, field]));
const messages = channelLocaleMessages("weixin", normalizeLocale(locale))?.setup;
const knownKeys = new Set<string>([
...WEIXIN_PRIMARY_FIELD_KEYS,
...WEIXIN_ADVANCED_FIELD_KEYS,
]);
const extraKeys = fields
.map((field) => field.key)
.filter((key) => !knownKeys.has(key));
const hydrate = (keys: readonly string[]) => keys.flatMap((key) => {
const field = fieldsByKey.get(key);
if (!field) return [];
const copy = messages?.fields?.[channelFieldMessageKey("weixin", key)];
return [weixinConfigField(field, copy)];
});
return {
primary: hydrate(WEIXIN_PRIMARY_FIELD_KEYS),
advanced: hydrate([...WEIXIN_ADVANCED_FIELD_KEYS, ...extraKeys]),
};
}
function weixinConfigField(
field: ChannelSetupContractField,
copy: { label: string; placeholder?: string; help?: string; choices?: Record<string, string> }
| undefined,
): ChannelConfigField {
const choices = field.kind === "bool" ? ["true", "false"] : field.choices;
return {
key: field.key,
label: copy?.label ?? fieldLabel(field.field),
placeholder: copy?.placeholder,
help: copy?.help,
secret: field.kind === "secret",
optional: !field.required,
inputType: field.kind === "int" ? "number" : undefined,
defaultValue: field.default_value,
options:
field.kind === "enum" || field.kind === "bool"
? choices.map((choice) => ({
value: choice,
label: copy?.choices?.[choice] ?? fieldLabel(choice),
}))
: undefined,
};
}
function fieldLabel(value: string): string {
const spaced = value
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
.replace(/[_-]+/g, " ")
.trim();
return spaced ? spaced[0].toUpperCase() + spaced.slice(1) : value;
}
function WeixinLogo({ showBrandLogos }: { showBrandLogos: boolean }) {
const logoUrls = useMemo(() => logoFallbackUrls("https://weixin.qq.com/favicon.ico"), []);
const { logoUrl, onLogoError, onLogoLoad } = useLogoFallback(logoUrls);
if (showBrandLogos && logoUrl) {
return (
<span className="grid h-10 w-10 shrink-0 place-items-center rounded-[12px] bg-background">
<img
src={logoUrl}
alt=""
decoding="async"
loading="lazy"
className="h-5.5 w-5.5 max-h-6 max-w-6 object-contain"
onLoad={onLogoLoad}
onError={onLogoError}
/>
</span>
);
}
return (
<span
className="flex h-10 w-10 shrink-0 items-center justify-center rounded-[12px] bg-background text-[11px] font-bold"
style={{ color: "#07C160" }}
aria-hidden
>
WX
</span>
);
}
function WeixinGuideLink({ url, label }: { url: string; label: string }) {
const logoUrls = useMemo(() => logoFallbackUrls("https://weixin.qq.com/favicon.ico"), []);
const { logoUrl, onLogoError, onLogoLoad } = useLogoFallback(logoUrls);
return (
<a
href={url}
target="_blank"
rel="noreferrer"
className="inline-flex max-w-full items-center gap-2 rounded-full bg-background/80 py-1 pl-1 pr-2.5 text-[11.5px] font-semibold text-foreground transition-colors hover:bg-background"
>
<span
className="grid h-5 w-5 shrink-0 place-items-center overflow-hidden rounded-full bg-muted/70 text-[9px] font-bold"
style={{ color: "#07C160" }}
aria-hidden
>
{logoUrl ? (
<img
src={logoUrl}
alt=""
decoding="async"
loading="lazy"
className="h-3.5 w-3.5 object-contain"
onLoad={onLogoLoad}
onError={onLogoError}
/>
) : (
"WX"
)}
</span>
<span className="truncate">{label}</span>
<ExternalLink className="h-3.5 w-3.5 shrink-0 text-muted-foreground" aria-hidden />
</a>
);
}
function WeixinStatusBadge({
children,
status,
}: {
children: ReactNode;
status?: ChannelRuntimeStatus;
}) {
return (
<span className={cn(
"shrink-0 rounded-full px-2 py-0.5 text-[11px] font-medium leading-4",
status === "failed"
? "bg-destructive/10 text-destructive"
: status === "running"
? "bg-emerald-500/10 text-emerald-700 dark:text-emerald-200"
: "bg-muted/75 text-muted-foreground",
)}>
{children}
</span>
);
}
function weixinStatusLabel(
feature: NanobotFeatureInfo,
tx: (key: string, fallback: string) => string,
): string {
if (feature.runtime_status === "failed") {
return tx("settings.channels.runtimeFailed", "Failed");
}
if (feature.runtime_status === "starting") {
return tx("settings.channels.runtimeStarting", "Starting");
}
if (feature.runtime_status === "running") return tx("settings.values.on", "On");
if (feature.enabled) return tx("settings.channels.runtimeStopped", "Not running");
return tx("settings.values.off", "Off");
}
function weixinRuntimeError(
error: string | undefined,
tx: (key: string, fallback: string) => string,
): string | undefined {
if (error === WEIXIN_AUTH_EXPIRED_MESSAGE) {
return tx("custom.expired", error);
}
return error;
}
function localizeBooleanFields(
fields: ChannelConfigField[],
onLabel: string,
offLabel: string,
): ChannelConfigField[] {
return fields.map((field) => {
const values = new Set(field.options?.map((option) => option.value));
if (values.size !== 2 || !values.has("true") || !values.has("false")) return field;
return {
...field,
options: field.options?.map((option) => ({
...option,
label: option.value === "true" ? onLabel : offLabel,
})),
};
});
}
+8 -4
View File
@@ -2,8 +2,14 @@ import type { ChannelUiContribution } from "@/channel-plugins/types";
import { chatAppGuideUrl } from "@/components/settings/channels/catalog";
import { WeixinConnectFlow } from "./WeixinConnectFlow";
import {
WEIXIN_ADVANCED_FIELD_KEYS,
WEIXIN_PRIMARY_FIELD_KEYS,
WeixinPanel,
} from "./WeixinPanel";
export default {
Panel: WeixinPanel,
ConnectFlow: WeixinConnectFlow,
canConnectBeforeConfigured: true,
aliases: {
@@ -18,10 +24,8 @@ export default {
mode: "connect",
command: "nanobot channels login weixin",
docsUrl: chatAppGuideUrl("wechat"),
manualFields: [
{ key: "channels.weixin.allowFrom" },
{ key: "channels.weixin.token" },
],
fields: WEIXIN_PRIMARY_FIELD_KEYS.map((key) => ({ key })),
manualFields: WEIXIN_ADVANCED_FIELD_KEYS.map((key) => ({ key })),
},
},
} satisfies ChannelUiContribution;
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "Token",
"placeholder": "Saved by QR login"
}
},
"sendProgress": { "label": "Send progress" },
"sendToolHints": { "label": "Send tool hints" },
"streaming": { "label": "Use streaming API" },
"replyProgressMessages": { "label": "Send structured progress" },
"replyProgressMaxMessages": { "label": "Structured progress limit" },
"contextMessageBudget": { "label": "Context message budget" },
"blockStreaming": { "label": "Send response blocks" },
"blockStreamingMinChars": { "label": "Minimum block size" },
"blockStreamingMaxMessages": { "label": "Block message limit" },
"baseUrl": { "label": "API URL" },
"cdnBaseUrl": { "label": "CDN URL" },
"routeTag": { "label": "Route tag" },
"stateDir": { "label": "State directory" },
"pollTimeout": { "label": "Poll timeout" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "Waiting for WeChat scan...",
"connected": "WeChat is connected.",
"stopped": "WeChat login stopped.",
"connecting": "Connecting..."
"connecting": "Connecting...",
"verifyTitle": "Verification required",
"verifyDescription": "Enter the number shown in WeChat to continue.",
"verifyMismatch": "That code did not match. Enter the new number shown in WeChat.",
"expired": "WeChat login expired. Scan again to reconnect.",
"failed": "Unable to connect WeChat. Try again.",
"verifyPlaceholder": "Code",
"verifySubmit": "Verify"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "Token",
"placeholder": "Guardado al iniciar sesión por QR"
}
},
"sendProgress": { "label": "Enviar progreso" },
"sendToolHints": { "label": "Enviar indicaciones de herramientas" },
"streaming": { "label": "Usar API de streaming" },
"replyProgressMessages": { "label": "Enviar progreso estructurado" },
"replyProgressMaxMessages": { "label": "Límite de progreso estructurado" },
"contextMessageBudget": { "label": "Presupuesto de mensajes por contexto" },
"blockStreaming": { "label": "Enviar respuestas por bloques" },
"blockStreamingMinChars": { "label": "Tamaño mínimo del bloque" },
"blockStreamingMaxMessages": { "label": "Límite de mensajes por bloques" },
"baseUrl": { "label": "URL de la API" },
"cdnBaseUrl": { "label": "URL de la CDN" },
"routeTag": { "label": "Etiqueta de ruta" },
"stateDir": { "label": "Directorio de estado" },
"pollTimeout": { "label": "Tiempo de espera de consulta" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "Esperando el escaneo de WeChat...",
"connected": "WeChat está conectado.",
"stopped": "Inicio de WeChat detenido.",
"connecting": "Conectando..."
"connecting": "Conectando...",
"verifyTitle": "Se requiere verificación",
"verifyDescription": "Introduce el número que aparece en WeChat para continuar.",
"verifyMismatch": "El código no coincide. Introduce el nuevo número que aparece en WeChat.",
"expired": "El inicio de sesión de WeChat caducó. Escanea de nuevo para volver a conectarte.",
"failed": "No se pudo conectar WeChat. Inténtalo de nuevo.",
"verifyPlaceholder": "Código",
"verifySubmit": "Verificar"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "Jeton",
"placeholder": "Enregistré après la connexion QR"
}
},
"sendProgress": { "label": "Envoyer la progression" },
"sendToolHints": { "label": "Envoyer les indications doutils" },
"streaming": { "label": "Utiliser lAPI de streaming" },
"replyProgressMessages": { "label": "Envoyer la progression structurée" },
"replyProgressMaxMessages": { "label": "Limite de progression structurée" },
"contextMessageBudget": { "label": "Budget de messages du contexte" },
"blockStreaming": { "label": "Envoyer la réponse par blocs" },
"blockStreamingMinChars": { "label": "Taille minimale dun bloc" },
"blockStreamingMaxMessages": { "label": "Limite de messages par blocs" },
"baseUrl": { "label": "URL de lAPI" },
"cdnBaseUrl": { "label": "URL du CDN" },
"routeTag": { "label": "Étiquette de routage" },
"stateDir": { "label": "Répertoire d’état" },
"pollTimeout": { "label": "Délai dinterrogation" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "En attente du scan WeChat...",
"connected": "WeChat est connecté.",
"stopped": "Connexion WeChat arrêtée.",
"connecting": "Connexion..."
"connecting": "Connexion...",
"verifyTitle": "Vérification requise",
"verifyDescription": "Saisissez le nombre affiché dans WeChat pour continuer.",
"verifyMismatch": "Le code ne correspond pas. Saisissez le nouveau nombre affiché dans WeChat.",
"expired": "La connexion WeChat a expiré. Scannez à nouveau pour vous reconnecter.",
"failed": "Impossible de connecter WeChat. Réessayez.",
"verifyPlaceholder": "Code",
"verifySubmit": "Vérifier"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "Token",
"placeholder": "Disimpan saat login QR"
}
},
"sendProgress": { "label": "Kirim progres" },
"sendToolHints": { "label": "Kirim petunjuk alat" },
"streaming": { "label": "Gunakan API streaming" },
"replyProgressMessages": { "label": "Kirim progres terstruktur" },
"replyProgressMaxMessages": { "label": "Batas progres terstruktur" },
"contextMessageBudget": { "label": "Anggaran pesan konteks" },
"blockStreaming": { "label": "Kirim respons per blok" },
"blockStreamingMinChars": { "label": "Ukuran blok minimum" },
"blockStreamingMaxMessages": { "label": "Batas pesan blok" },
"baseUrl": { "label": "URL API" },
"cdnBaseUrl": { "label": "URL CDN" },
"routeTag": { "label": "Tag rute" },
"stateDir": { "label": "Direktori status" },
"pollTimeout": { "label": "Batas waktu polling" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "Menunggu pemindaian WeChat...",
"connected": "WeChat sudah terhubung.",
"stopped": "Login WeChat dihentikan.",
"connecting": "Menghubungkan..."
"connecting": "Menghubungkan...",
"verifyTitle": "Verifikasi diperlukan",
"verifyDescription": "Masukkan angka yang ditampilkan di WeChat untuk melanjutkan.",
"verifyMismatch": "Kode tidak cocok. Masukkan angka baru yang ditampilkan di WeChat.",
"expired": "Login WeChat telah kedaluwarsa. Pindai lagi untuk menghubungkan kembali.",
"failed": "Tidak dapat menghubungkan WeChat. Coba lagi.",
"verifyPlaceholder": "Kode",
"verifySubmit": "Verifikasi"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "トークン",
"placeholder": "QR ログインで保存"
}
},
"sendProgress": { "label": "進捗を送信" },
"sendToolHints": { "label": "ツールのヒントを送信" },
"streaming": { "label": "ストリーミング API を使用" },
"replyProgressMessages": { "label": "構造化された進捗を送信" },
"replyProgressMaxMessages": { "label": "構造化進捗の上限" },
"contextMessageBudget": { "label": "コンテキストのメッセージ予算" },
"blockStreaming": { "label": "応答をブロック単位で送信" },
"blockStreamingMinChars": { "label": "最小ブロックサイズ" },
"blockStreamingMaxMessages": { "label": "ブロックメッセージの上限" },
"baseUrl": { "label": "API URL" },
"cdnBaseUrl": { "label": "CDN URL" },
"routeTag": { "label": "ルートタグ" },
"stateDir": { "label": "状態ディレクトリ" },
"pollTimeout": { "label": "ポーリングタイムアウト" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "WeChat のスキャンを待っています...",
"connected": "WeChat に接続しました。",
"stopped": "WeChat ログインを停止しました。",
"connecting": "接続中..."
"connecting": "接続中...",
"verifyTitle": "確認が必要です",
"verifyDescription": "WeChat に表示された数字を入力してください。",
"verifyMismatch": "コードが一致しません。WeChat に表示された新しい数字を入力してください。",
"expired": "WeChat のログイン期限が切れました。再接続するにはもう一度スキャンしてください。",
"failed": "WeChat に接続できません。もう一度お試しください。",
"verifyPlaceholder": "コード",
"verifySubmit": "確認"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "토큰",
"placeholder": "QR 로그인으로 저장됨"
}
},
"sendProgress": { "label": "진행 상황 보내기" },
"sendToolHints": { "label": "도구 힌트 보내기" },
"streaming": { "label": "스트리밍 API 사용" },
"replyProgressMessages": { "label": "구조화된 진행 상황 보내기" },
"replyProgressMaxMessages": { "label": "구조화된 진행 메시지 한도" },
"contextMessageBudget": { "label": "컨텍스트 메시지 예산" },
"blockStreaming": { "label": "응답을 블록으로 보내기" },
"blockStreamingMinChars": { "label": "최소 블록 크기" },
"blockStreamingMaxMessages": { "label": "블록 메시지 한도" },
"baseUrl": { "label": "API URL" },
"cdnBaseUrl": { "label": "CDN URL" },
"routeTag": { "label": "경로 태그" },
"stateDir": { "label": "상태 디렉터리" },
"pollTimeout": { "label": "폴링 제한 시간" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "WeChat 스캔을 기다리는 중...",
"connected": "WeChat이 연결되었습니다.",
"stopped": "WeChat 로그인이 중지되었습니다.",
"connecting": "연결 중..."
"connecting": "연결 중...",
"verifyTitle": "인증 필요",
"verifyDescription": "계속하려면 WeChat에 표시된 숫자를 입력하세요.",
"verifyMismatch": "코드가 일치하지 않습니다. WeChat에 표시된 새 숫자를 입력하세요.",
"expired": "WeChat 로그인이 만료되었습니다. 다시 연결하려면 다시 스캔하세요.",
"failed": "WeChat에 연결할 수 없습니다. 다시 시도하세요.",
"verifyPlaceholder": "코드",
"verifySubmit": "인증"
}
}
@@ -20,7 +20,21 @@
"token": {
"label": "Token",
"placeholder": "Salvo pelo login via QR"
}
},
"sendProgress": { "label": "Enviar progresso" },
"sendToolHints": { "label": "Enviar dicas de ferramentas" },
"streaming": { "label": "Usar API de streaming" },
"replyProgressMessages": { "label": "Enviar progresso estruturado" },
"replyProgressMaxMessages": { "label": "Limite de progresso estruturado" },
"contextMessageBudget": { "label": "Orçamento de mensagens do contexto" },
"blockStreaming": { "label": "Enviar resposta em blocos" },
"blockStreamingMinChars": { "label": "Tamanho mínimo do bloco" },
"blockStreamingMaxMessages": { "label": "Limite de mensagens em blocos" },
"baseUrl": { "label": "URL da API" },
"cdnBaseUrl": { "label": "URL da CDN" },
"routeTag": { "label": "Etiqueta de rota" },
"stateDir": { "label": "Diretório de estado" },
"pollTimeout": { "label": "Tempo limite da consulta" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "Aguardando leitura do WeChat...",
"connected": "WeChat está conectado.",
"stopped": "Login do WeChat interrompido.",
"connecting": "Conectando..."
"connecting": "Conectando...",
"verifyTitle": "Verificação necessária",
"verifyDescription": "Digite o número exibido no WeChat para continuar.",
"verifyMismatch": "O código não corresponde. Digite o novo número exibido no WeChat.",
"expired": "O login do WeChat expirou. Escaneie novamente para reconectar.",
"failed": "Não foi possível conectar o WeChat. Tente novamente.",
"verifyPlaceholder": "Código",
"verifySubmit": "Verificar"
}
}
+23 -2
View File
@@ -20,7 +20,21 @@
"token": {
"label": "Token",
"placeholder": "Được lưu khi đăng nhập QR"
}
},
"sendProgress": { "label": "Gửi tiến trình" },
"sendToolHints": { "label": "Gửi gợi ý công cụ" },
"streaming": { "label": "Sử dụng API phát trực tiếp" },
"replyProgressMessages": { "label": "Gửi tiến trình có cấu trúc" },
"replyProgressMaxMessages": { "label": "Giới hạn tiến trình có cấu trúc" },
"contextMessageBudget": { "label": "Ngân sách tin nhắn ngữ cảnh" },
"blockStreaming": { "label": "Gửi phản hồi theo khối" },
"blockStreamingMinChars": { "label": "Kích thước khối tối thiểu" },
"blockStreamingMaxMessages": { "label": "Giới hạn tin nhắn theo khối" },
"baseUrl": { "label": "URL API" },
"cdnBaseUrl": { "label": "URL CDN" },
"routeTag": { "label": "Thẻ định tuyến" },
"stateDir": { "label": "Thư mục trạng thái" },
"pollTimeout": { "label": "Thời gian chờ thăm dò" }
}
},
"custom": {
@@ -30,6 +44,13 @@
"waiting": "Đang chờ quét WeChat...",
"connected": "WeChat đã kết nối.",
"stopped": "Đăng nhập WeChat đã dừng.",
"connecting": "Đang kết nối..."
"connecting": "Đang kết nối...",
"verifyTitle": "Cần xác minh",
"verifyDescription": "Nhập số hiển thị trong WeChat để tiếp tục.",
"verifyMismatch": "Mã không khớp. Nhập số mới hiển thị trong WeChat.",
"expired": "Đăng nhập WeChat đã hết hạn. Hãy quét lại để kết nối lại.",
"failed": "Không thể kết nối WeChat. Hãy thử lại.",
"verifyPlaceholder": "Mã",
"verifySubmit": "Xác minh"
}
}
@@ -21,7 +21,21 @@
"token": {
"label": "令牌",
"placeholder": "二维码登录后自动保存"
}
},
"sendProgress": { "label": "发送进度消息" },
"sendToolHints": { "label": "发送工具提示" },
"streaming": { "label": "使用流式 API" },
"replyProgressMessages": { "label": "发送结构化进度" },
"replyProgressMaxMessages": { "label": "结构化进度消息上限" },
"contextMessageBudget": { "label": "上下文消息预算" },
"blockStreaming": { "label": "分块发送回复" },
"blockStreamingMinChars": { "label": "最小分块字符数" },
"blockStreamingMaxMessages": { "label": "分块消息上限" },
"baseUrl": { "label": "API 地址" },
"cdnBaseUrl": { "label": "CDN 地址" },
"routeTag": { "label": "路由标签" },
"stateDir": { "label": "状态目录" },
"pollTimeout": { "label": "轮询超时" }
}
},
"custom": {
@@ -31,6 +45,13 @@
"waiting": "正在等待微信扫码...",
"connected": "微信已连接。",
"stopped": "微信登录已停止。",
"connecting": "正在连接..."
"connecting": "正在连接...",
"verifyTitle": "需要验证",
"verifyDescription": "输入手机微信中显示的数字以继续。",
"verifyMismatch": "验证码不匹配,请输入微信中显示的新数字。",
"expired": "微信登录已过期,请重新扫码连接。",
"failed": "无法连接微信,请重试。",
"verifyPlaceholder": "验证码",
"verifySubmit": "验证"
}
}
@@ -21,7 +21,21 @@
"token": {
"label": "權杖",
"placeholder": "二維碼登入後自動儲存"
}
},
"sendProgress": { "label": "傳送進度訊息" },
"sendToolHints": { "label": "傳送工具提示" },
"streaming": { "label": "使用串流 API" },
"replyProgressMessages": { "label": "傳送結構化進度" },
"replyProgressMaxMessages": { "label": "結構化進度訊息上限" },
"contextMessageBudget": { "label": "上下文訊息預算" },
"blockStreaming": { "label": "分塊傳送回覆" },
"blockStreamingMinChars": { "label": "最小分塊字元數" },
"blockStreamingMaxMessages": { "label": "分塊訊息上限" },
"baseUrl": { "label": "API 位址" },
"cdnBaseUrl": { "label": "CDN 位址" },
"routeTag": { "label": "路由標籤" },
"stateDir": { "label": "狀態目錄" },
"pollTimeout": { "label": "輪詢逾時" }
}
},
"custom": {
@@ -31,6 +45,13 @@
"waiting": "正在等待微信掃碼...",
"connected": "微信已連接。",
"stopped": "微信登入已停止。",
"connecting": "正在連接..."
"connecting": "正在連接...",
"verifyTitle": "需要驗證",
"verifyDescription": "輸入手機微信中顯示的數字以繼續。",
"verifyMismatch": "驗證碼不符,請輸入微信中顯示的新數字。",
"expired": "微信登入已過期,請重新掃碼連線。",
"failed": "無法連接微信,請重試。",
"verifyPlaceholder": "驗證碼",
"verifySubmit": "驗證"
}
}
+92 -9
View File
@@ -12,7 +12,9 @@ from collections import OrderedDict
from contextlib import suppress
from pathlib import Path
from typing import Any, Literal, NamedTuple, cast
from urllib.parse import urlparse
import httpx
from pydantic import Field
from nanobot.bus.events import OutboundMessage
@@ -20,6 +22,7 @@ from nanobot.bus.queue import MessageBus
from nanobot.channels.base import BaseChannel
from nanobot.config.paths import get_media_dir, get_runtime_subdir
from nanobot.config.schema import Base
from nanobot.security.network import PinnedDNSAsyncTransport
class WhatsAppConfig(Base):
@@ -39,6 +42,8 @@ class _NeonizeAPI(NamedTuple):
MessageEv: Any
PairStatusEv: Any
build_jid: Any
detect_mime: Any
detect_buffer: Any
class _MediaInfo(NamedTuple):
@@ -52,6 +57,15 @@ class _MediaInfo(NamedTuple):
_NEONIZE_API: _NeonizeAPI | None = None
_JID_RE = re.compile(r"^(?P<user>[^@]+)@(?P<server>[^@]+)$")
_LEGACY_BRIDGE_CONFIG_FIELDS = ("bridgeUrl", "bridgeToken", "bridge_url", "bridge_token")
_REMOTE_MEDIA_MAX_BYTES = 32 * 1024 * 1024
_REMOTE_MEDIA_MAX_REDIRECTS = 5
_REMOTE_MEDIA_TIMEOUT_SECONDS = 120.0
# OGG is intentionally excluded: WhatsApp accepts only mono Opus, which MIME sniffing cannot prove.
_DIRECT_AUDIO_MIMETYPES = {"audio/aac", "audio/amr", "audio/mp4", "audio/mpeg"}
_MIMETYPE_ALIASES = {
"audio/x-hx-aac-adts": "audio/aac",
"audio/x-m4a": "audio/mp4",
}
def _default_database_path() -> Path:
@@ -68,9 +82,15 @@ def _load_neonize() -> _NeonizeAPI:
return _NEONIZE_API
try:
import magic
from neonize.aioze.client import NewAClient
from neonize.aioze.events import ConnectedEv, DisconnectedEv, MessageEv, PairStatusEv
from neonize.utils.jid import build_jid
detect_mime = getattr(magic, "from_file", None)
detect_buffer = getattr(magic, "from_buffer", None)
if not callable(detect_mime) or not callable(detect_buffer):
raise ImportError("python-magic does not expose from_file/from_buffer")
except ImportError as exc:
raise RuntimeError(
"WhatsApp dependencies not installed. Run: nanobot plugins enable whatsapp"
@@ -83,6 +103,8 @@ def _load_neonize() -> _NeonizeAPI:
MessageEv=MessageEv,
PairStatusEv=PairStatusEv,
build_jid=build_jid,
detect_mime=detect_mime,
detect_buffer=detect_buffer,
)
return _NEONIZE_API
@@ -417,23 +439,84 @@ class WhatsAppChannel(BaseChannel):
return api.build_jid(user, server)
async def _send_media(self, client: Any, to: Any, media_path: str) -> None:
path = str(Path(media_path).expanduser())
mime, _ = mimetypes.guess_type(path)
mimetype = mime or "application/octet-stream"
source: str | bytes
if media_path.startswith(("http://", "https://")):
source = await self._fetch_remote_media(media_path)
filename = Path(urlparse(media_path).path).name or "attachment"
else:
source = str(Path(media_path).expanduser())
filename = Path(source).name
mimetype = self._detect_mimetype(source)
if mimetype.startswith("image/"):
await client.send_image(to, path)
await client.send_image(to, source)
elif mimetype.startswith("video/"):
await client.send_video(to, path)
elif mimetype.startswith("audio/"):
await client.send_audio(to, path)
await client.send_video(to, source)
elif mimetype in _DIRECT_AUDIO_MIMETYPES:
await client.send_audio(to, source)
else:
await client.send_document(
to,
path,
filename=Path(path).name,
source,
filename=filename,
mimetype=mimetype,
)
async def _fetch_remote_media(self, url: str) -> bytes:
timeout = httpx.Timeout(_REMOTE_MEDIA_TIMEOUT_SECONDS, connect=10.0)
async with httpx.AsyncClient(
transport=PinnedDNSAsyncTransport(),
follow_redirects=True,
max_redirects=_REMOTE_MEDIA_MAX_REDIRECTS,
timeout=timeout,
trust_env=False,
) as http:
async with http.stream("GET", url) as response:
response.raise_for_status()
declared_size = response.headers.get("content-length")
if (
declared_size
and declared_size.isdigit()
and int(declared_size) > _REMOTE_MEDIA_MAX_BYTES
):
raise ValueError(
f"Remote WhatsApp media exceeds the {_REMOTE_MEDIA_MAX_BYTES}-byte limit"
)
chunks: list[bytes] = []
total = 0
async for chunk in response.aiter_bytes():
total += len(chunk)
if total > _REMOTE_MEDIA_MAX_BYTES:
raise ValueError(
f"Remote WhatsApp media exceeds the {_REMOTE_MEDIA_MAX_BYTES}-byte limit"
)
chunks.append(chunk)
return b"".join(chunks)
def _detect_mimetype(self, source: str | bytes) -> str:
try:
api = _load_neonize()
detected = (
api.detect_buffer(source, mime=True)
if isinstance(source, bytes)
else api.detect_mime(source, mime=True)
)
except Exception as exc:
label = f"{len(source)} downloaded bytes" if isinstance(source, bytes) else source
self.logger.debug("Failed to inspect WhatsApp media {}: {}", label, exc)
detected = None
if isinstance(detected, str) and "/" in detected:
mimetype = detected.partition(";")[0].strip().lower()
return _MIMETYPE_ALIASES.get(mimetype, mimetype)
if isinstance(source, bytes):
return "application/octet-stream"
guessed, _ = mimetypes.guess_type(source)
return guessed or "application/octet-stream"
def _register_handlers(
self,
client: Any,
@@ -1,11 +1,13 @@
from __future__ import annotations
import asyncio
import mimetypes
import sys
import types
from types import SimpleNamespace
from unittest.mock import AsyncMock, MagicMock
import httpx
import pytest
import nanobot.channels.whatsapp.runtime as whatsapp_module
@@ -78,7 +80,21 @@ def _make_channel(config: dict | None = None) -> WhatsAppChannel:
return ch
def _patch_neonize_api(monkeypatch) -> None:
def _make_send_client() -> SimpleNamespace:
return SimpleNamespace(
send_message=AsyncMock(),
send_image=AsyncMock(),
send_video=AsyncMock(),
send_audio=AsyncMock(),
send_document=AsyncMock(),
)
def _patch_neonize_api(monkeypatch, detect_mime=None, detect_buffer=None) -> None:
detect_mime = detect_mime or (
lambda path, *, mime: mimetypes.guess_type(path)[0] or "application/octet-stream"
)
detect_buffer = detect_buffer or (lambda data, *, mime: "application/octet-stream")
monkeypatch.setattr(
whatsapp_module,
"_NEONIZE_API",
@@ -89,6 +105,8 @@ def _patch_neonize_api(monkeypatch) -> None:
MessageEv=object(),
PairStatusEv=object(),
build_jid=lambda user, server="s.whatsapp.net": (user, server),
detect_mime=detect_mime,
detect_buffer=detect_buffer,
),
)
@@ -178,13 +196,7 @@ async def test_login_fails_when_connect_task_fails(monkeypatch) -> None:
@pytest.mark.asyncio
async def test_send_text_uses_neonize_send_message(monkeypatch) -> None:
_patch_neonize_api(monkeypatch)
client = SimpleNamespace(
send_message=AsyncMock(),
send_image=AsyncMock(),
send_video=AsyncMock(),
send_audio=AsyncMock(),
send_document=AsyncMock(),
)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
@@ -197,13 +209,7 @@ async def test_send_text_uses_neonize_send_message(monkeypatch) -> None:
@pytest.mark.asyncio
async def test_send_media_dispatches_by_mimetype(monkeypatch) -> None:
_patch_neonize_api(monkeypatch)
client = SimpleNamespace(
send_message=AsyncMock(),
send_image=AsyncMock(),
send_video=AsyncMock(),
send_audio=AsyncMock(),
send_document=AsyncMock(),
)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
@@ -213,14 +219,14 @@ async def test_send_media_dispatches_by_mimetype(monkeypatch) -> None:
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=["photo.jpg", "clip.mp4", "voice.ogg", "report.pdf"],
media=["photo.jpg", "clip.mp4", "voice.mp3", "report.pdf"],
)
)
jid = ("12345", "s.whatsapp.net")
client.send_image.assert_awaited_once_with(jid, "photo.jpg")
client.send_video.assert_awaited_once_with(jid, "clip.mp4")
client.send_audio.assert_awaited_once_with(jid, "voice.ogg")
client.send_audio.assert_awaited_once_with(jid, "voice.mp3")
client.send_document.assert_awaited_once_with(
jid,
"report.pdf",
@@ -229,6 +235,191 @@ async def test_send_media_dispatches_by_mimetype(monkeypatch) -> None:
)
@pytest.mark.asyncio
async def test_send_mislabeled_audio_as_document(monkeypatch) -> None:
_patch_neonize_api(monkeypatch, detect_mime=lambda path, *, mime: "audio/x-wav")
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=["recording.mpeg"],
)
)
jid = ("12345", "s.whatsapp.net")
client.send_document.assert_awaited_once_with(
jid,
"recording.mpeg",
filename="recording.mpeg",
mimetype="audio/x-wav",
)
client.send_video.assert_not_awaited()
@pytest.mark.asyncio
async def test_send_remote_mislabeled_audio_as_document(monkeypatch) -> None:
payload = b"remote wav payload"
media_url = "https://cdn.example/recording.mpeg?token=secret"
def handle_request(request: httpx.Request) -> httpx.Response:
assert str(request.url) == media_url
return httpx.Response(200, content=payload)
monkeypatch.setattr(
whatsapp_module,
"PinnedDNSAsyncTransport",
lambda: httpx.MockTransport(handle_request),
)
def detect_buffer(data: bytes, *, mime: bool) -> str:
assert data == payload
assert mime is True
return "audio/x-wav"
_patch_neonize_api(
monkeypatch,
detect_buffer=detect_buffer,
)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=[media_url],
)
)
jid = ("12345", "s.whatsapp.net")
client.send_document.assert_awaited_once_with(
jid,
payload,
filename="recording.mpeg",
mimetype="audio/x-wav",
)
client.send_video.assert_not_awaited()
@pytest.mark.asyncio
async def test_send_remote_media_blocks_private_url(monkeypatch) -> None:
_patch_neonize_api(monkeypatch)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
with pytest.raises(httpx.RequestError, match="private/internal"):
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=["http://127.0.0.1/recording.mpeg"],
)
)
client.send_video.assert_not_awaited()
client.send_document.assert_not_awaited()
@pytest.mark.asyncio
async def test_send_remote_media_enforces_download_limit(monkeypatch) -> None:
monkeypatch.setattr(whatsapp_module, "_REMOTE_MEDIA_MAX_BYTES", 3)
monkeypatch.setattr(
whatsapp_module,
"PinnedDNSAsyncTransport",
lambda: httpx.MockTransport(lambda request: httpx.Response(200, content=b"1234")),
)
_patch_neonize_api(monkeypatch)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
with pytest.raises(ValueError, match="exceeds the 3-byte limit"):
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=["https://cdn.example/recording.mpeg"],
)
)
client.send_video.assert_not_awaited()
client.send_document.assert_not_awaited()
@pytest.mark.asyncio
async def test_send_unsupported_ogg_audio_as_document(monkeypatch) -> None:
_patch_neonize_api(monkeypatch, detect_mime=lambda path, *, mime: "audio/ogg")
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=["voice.ogg"],
)
)
jid = ("12345", "s.whatsapp.net")
client.send_document.assert_awaited_once_with(
jid,
"voice.ogg",
filename="voice.ogg",
mimetype="audio/ogg",
)
client.send_audio.assert_not_awaited()
@pytest.mark.parametrize(
("detected_mimetype", "filename"),
[
("audio/x-m4a", "recording.m4a"),
("audio/x-hx-aac-adts", "recording.aac"),
],
)
@pytest.mark.asyncio
async def test_send_supported_audio_magic_aliases_inline(
monkeypatch, detected_mimetype: str, filename: str
) -> None:
_patch_neonize_api(
monkeypatch,
detect_mime=lambda path, *, mime: detected_mimetype,
)
client = _make_send_client()
ch = _make_channel()
ch._client = client
ch._connected = True
await ch.send(
OutboundMessage(
channel="whatsapp",
chat_id="12345@s.whatsapp.net",
content="",
media=[filename],
)
)
client.send_audio.assert_awaited_once_with(("12345", "s.whatsapp.net"), filename)
client.send_document.assert_not_awaited()
@pytest.mark.asyncio
async def test_send_when_disconnected_raises() -> None:
ch = _make_channel()
+2 -1
View File
@@ -32,6 +32,7 @@ from nanobot.cli.models import (
)
from nanobot.config.loader import get_config_path, load_config, resolve_config_env_vars
from nanobot.config.schema import Config, ModelPresetConfig
from nanobot.providers.oauth_guidance import OAUTH_CLI_KIT_MISSING_MESSAGE
console = Console()
@@ -1674,7 +1675,7 @@ def _quick_start_oauth_login(config: Config, provider_name: str) -> bool:
login_oauth_interactive,
)
except ImportError:
console.print("[red]oauth_cli_kit not installed. Run: pip install oauth-cli-kit[/red]")
console.print(f"[red]{OAUTH_CLI_KIT_MISSING_MESSAGE}[/red]")
return False
try:
+6 -5
View File
@@ -12,6 +12,7 @@ import typer
from rich.console import Console
from nanobot import __logo__
from nanobot.providers.oauth_guidance import OAUTH_CLI_KIT_MISSING_MESSAGE
if TYPE_CHECKING:
from nanobot.providers.registry import ProviderSpec
@@ -74,7 +75,7 @@ def _required_module_attribute(module_name: str, attribute: str) -> object:
def _load_openai_oauth_client() -> tuple[_GetOAuthToken, _LoginOAuthInteractive]:
"""Load the optional untyped OAuth client behind a typed boundary."""
"""Load the untyped OAuth client behind a typed boundary."""
return (
cast(_GetOAuthToken, _required_module_attribute("oauth_cli_kit", "get_token")),
cast(
@@ -85,7 +86,7 @@ def _load_openai_oauth_client() -> tuple[_GetOAuthToken, _LoginOAuthInteractive]
def _load_openai_oauth_storage() -> tuple[_OAuthProviderConfig, _FileTokenStorageFactory]:
"""Load the optional untyped OAuth storage API behind a typed boundary."""
"""Load the untyped OAuth storage API behind a typed boundary."""
return (
cast(
_OAuthProviderConfig,
@@ -241,7 +242,7 @@ def _login_openai_codex() -> None:
f"[green]✓ Authenticated with OpenAI Codex[/green] [dim]{token.account_id}[/dim]"
)
except ImportError:
console.print("[red]oauth_cli_kit not installed. Run: pip install oauth-cli-kit[/red]")
console.print(f"[red]{OAUTH_CLI_KIT_MISSING_MESSAGE}[/red]")
raise typer.Exit(1)
@@ -250,7 +251,7 @@ def _logout_openai_codex() -> None:
try:
provider_config, storage_factory = _load_openai_oauth_storage()
except ImportError:
console.print("[red]oauth_cli_kit not installed. Run: pip install oauth-cli-kit[/red]")
console.print(f"[red]{OAUTH_CLI_KIT_MISSING_MESSAGE}[/red]")
raise typer.Exit(1)
storage = storage_factory(token_filename=provider_config.token_filename)
@@ -309,7 +310,7 @@ def _logout_github_copilot() -> None:
try:
from nanobot.providers.github_copilot_provider import get_storage
except ImportError:
console.print("[red]oauth_cli_kit not installed. Run: pip install oauth-cli-kit[/red]")
console.print(f"[red]{OAUTH_CLI_KIT_MISSING_MESSAGE}[/red]")
raise typer.Exit(1)
storage = get_storage()
+20 -2
View File
@@ -2,11 +2,12 @@
from __future__ import annotations
from pathlib import Path
from typing import TYPE_CHECKING, Any, ClassVar, Literal
from typing import TYPE_CHECKING, Any, ClassVar, Literal, cast
from pydantic import AliasChoices, ConfigDict, Field, field_validator, model_validator
from pydantic_settings import BaseSettings, SettingsConfigDict
from nanobot.config.timezone import detect_system_timezone
from nanobot.config_base import Base
from nanobot.cron.types import CronSchedule
@@ -140,7 +141,8 @@ class AgentDefaults(Base):
serialization_alias="toolHintMaxLength",
) # Max characters for tool hint display (e.g. "$ cd …/project && npm test")
reasoning_effort: str | None = None # low / medium / high / xhigh / max / adaptive / none — LLM thinking effort; None preserves the provider default
timezone: str = "UTC" # IANA timezone, e.g. "Asia/Shanghai", "America/New_York"
timezone: str = "UTC" # Effective IANA timezone, e.g. "Asia/Shanghai"
timezone_mode: Literal["auto", "manual"] = "auto"
bot_name: str = "nanobot" # Display name shown in CLI prompts (e.g. "{name} is thinking...")
bot_icon: str = "🐈" # Short icon (emoji or text) shown next to the bot name in CLI; "" to omit
unified_session: bool = False # Share one session across all channels (single-user multi-device)
@@ -164,6 +166,22 @@ class AgentDefaults(Base):
) # Consolidation target ratio (0.5 = 50% of budget retained after compression)
dream: DreamConfig = Field(default_factory=DreamConfig)
@model_validator(mode="before")
@classmethod
def resolve_timezone(cls, value: object) -> object:
"""Detect new defaults server-side while preserving configured timezones."""
if not isinstance(value, dict):
return value
data = dict(cast(dict[str, object], value))
timezone_mode = data.get("timezoneMode", data.get("timezone_mode"))
if timezone_mode is None:
timezone_mode = "manual" if "timezone" in data else "auto"
data["timezoneMode"] = timezone_mode
if timezone_mode == "auto":
data["timezone"] = detect_system_timezone()
return data
@field_validator("timezone")
@classmethod
def validate_timezone(cls, value: str) -> str:
+19
View File
@@ -0,0 +1,19 @@
"""Backend timezone detection for automatic agent defaults."""
from zoneinfo import ZoneInfo
from tzlocal import get_localzone_name
_UTC_ALIASES = frozenset(
{"Etc/GMT", "Etc/UTC", "GMT", "GMT0", "Greenwich", "UCT", "Universal", "Zulu"}
)
def detect_system_timezone() -> str:
"""Return the host's IANA timezone, falling back safely to UTC."""
try:
timezone = get_localzone_name()
ZoneInfo(timezone)
except Exception:
return "UTC"
return "UTC" if timezone in _UTC_ALIASES else timezone
+6
View File
@@ -0,0 +1,6 @@
"""Shared recovery guidance for OAuth dependency failures."""
OAUTH_CLI_KIT_MISSING_MESSAGE = (
"This nanobot installation is missing the required oauth-cli-kit package. "
"Reinstall or upgrade nanobot-ai using the same installation method."
)
+80 -6
View File
@@ -56,6 +56,32 @@ if TYPE_CHECKING:
# that ``unittest.mock.patch`` can find and replace it.
AsyncOpenAI: Any = None
def _is_hosted_web_search_type(value: object) -> bool:
return isinstance(value, str) and (
value == "web_search" or value.startswith("web_search_")
)
def _is_hosted_web_search_tool(tool: object) -> bool:
if not isinstance(tool, dict):
return False
tool_type = cast(dict[object, object], tool).get("type")
return _is_hosted_web_search_type(tool_type)
def _is_named_function_tool(tool: object, name: str) -> bool:
"""Return whether a Responses tool is a function with the given name."""
if not isinstance(tool, dict):
return False
record = cast(dict[object, object], tool)
if record.get("type") != "function":
return False
function = record.get("function")
if isinstance(function, dict):
return cast(dict[object, object], function).get("name") == name
return record.get("name") == name
_ALLOWED_MSG_KEYS = frozenset({
"role", "content", "tool_calls", "tool_call_id", "name",
"reasoning_content", "extra_content",
@@ -469,7 +495,7 @@ class OpenAICompatProvider(LLMProvider):
self.default_model = default_model
self.extra_headers = extra_headers or {}
self._spec = spec
self._extra_body = extra_body or {}
self._extra_body = dict(extra_body or {})
self._api_type = api_type if spec and spec.name == "openai" else "auto"
self._extra_query = extra_query or {}
self._proxy = proxy or None
@@ -560,7 +586,7 @@ class OpenAICompatProvider(LLMProvider):
if os.environ.get("LANGFUSE_SECRET_KEY"):
logger.warning(
"LANGFUSE_SECRET_KEY is set but langfuse is not installed; "
"install with `pip install langfuse` to enable tracing"
"run `nanobot plugins enable langfuse` to enable tracing"
)
from openai import AsyncOpenAI as _AsyncOpenAI
AsyncOpenAI = _AsyncOpenAI
@@ -974,8 +1000,8 @@ class OpenAICompatProvider(LLMProvider):
provider_responses = spec_name in ("openai", "github_copilot")
if not provider_responses and not model_responses:
return False
if self._api_type == "responses":
# Explicit configuration means Responses is mandatory; do not
if self._responses_is_required():
# Explicit Responses-only request fields are mandatory; do not
# consult the circuit breaker or fall back to Chat Completions.
return True
if provider_responses and (self._spec is None or self._spec.name != "github_copilot"):
@@ -994,6 +1020,25 @@ class OpenAICompatProvider(LLMProvider):
return self._responses_circuit_allows_probe(model, reasoning_effort)
def _responses_is_required(self) -> bool:
return self._api_type == "responses" or self._hosted_web_search_enabled()
def _hosted_web_search_enabled(self) -> bool:
extra_body = getattr(self, "_extra_body", {})
configured_tools = extra_body.get("tools")
if "tools" in extra_body:
return isinstance(configured_tools, list) and any(
_is_hosted_web_search_tool(tool)
for tool in cast(list[object], configured_tools)
)
return bool(
self._spec
and any(
_is_hosted_web_search_type(tool_type)
for tool_type in getattr(self._spec, "responses_default_tools", ())
)
)
def _responses_state_provider(self) -> str:
spec_name = self._spec.name if self._spec is not None else "custom"
effective_base = self._effective_base or "https://api.openai.com/v1"
@@ -1157,9 +1202,38 @@ class OpenAICompatProvider(LLMProvider):
body["tool_choice"] = tool_choice or "auto"
extra_body = getattr(self, "_extra_body", {})
default_tools = getattr(self._spec, "responses_default_tools", ())
if "tools" not in extra_body and default_tools:
body["tools"] = [
*cast(list[object], body.get("tools", [])),
*({"type": tool_type} for tool_type in default_tools),
]
if extra_body:
body = _merge_responses_extra_body(body, extra_body)
if self._hosted_web_search_enabled():
configured_tools = body.get("tools")
if isinstance(configured_tools, list):
managed_tools: list[object] = []
hosted_search_seen = False
for tool in cast(list[object], configured_tools):
if _is_named_function_tool(tool, "web_search"):
continue
if _is_hosted_web_search_tool(tool):
if hosted_search_seen:
continue
hosted_search_seen = True
managed_tools.append(tool)
body["tools"] = managed_tools
if self._spec and self._spec.name == "openai":
source_include = "web_search_call.action.sources"
configured_include = body.get("include")
if isinstance(configured_include, list):
if source_include not in configured_include:
body["include"] = [*configured_include, source_include]
else:
body["include"] = [source_include]
return body
async def _create_response_with_compaction_fallback(
@@ -1771,7 +1845,7 @@ class OpenAICompatProvider(LLMProvider):
# falling back to /chat/completions cannot succeed and would
# hide the real error.
raise
if self._api_type == "responses":
if self._responses_is_required():
raise
if not self._should_fallback_from_responses_error(responses_error):
raise
@@ -1867,7 +1941,7 @@ class OpenAICompatProvider(LLMProvider):
# falling back to /chat/completions cannot succeed and would
# hide the real error.
raise
if self._api_type == "responses":
if self._responses_is_required():
raise
if not self._should_fallback_from_responses_error(responses_error):
raise
+79 -2
View File
@@ -89,6 +89,77 @@ def _response_object_list(value: object) -> list[dict[str, Any]]:
]
def _hosted_web_search_event(
event: object,
event_type: object,
) -> dict[str, Any] | None:
"""Map the official web-search output item pair onto normal tool progress."""
if event_type not in {"response.output_item.added", "response.output_item.done"}:
return None
event_object = _response_object(event) or {}
item = _response_object(event_object.get("item")) or {}
if item.get("type") != "web_search_call":
return None
call_id = item.get("id") or item.get("call_id") or event_object.get("item_id")
if not isinstance(call_id, str) or not call_id:
return None
action = _response_object(item.get("action")) or {}
raw_queries = action.get("queries")
queries = (
[
query.strip()
for query in cast(list[object], raw_queries)
if isinstance(query, str) and query.strip()
][:4]
if isinstance(raw_queries, list)
else []
)
query = " · ".join(queries)
if not query:
query = next(
(
value.strip()
for key in ("query", "pattern", "url")
if isinstance((value := action.get(key)), str) and value.strip()
),
"",
)
arguments = {"query": query[:1000]} if query else {}
phase = "start" if event_type == "response.output_item.added" else "end"
result: dict[str, Any] | None = None
if phase == "end":
status = item.get("status")
result = {"status": status if isinstance(status, str) else "completed"}
raw_sources = action.get("sources")
if isinstance(raw_sources, list):
sources: list[dict[str, str]] = []
for raw_source in cast(list[object], raw_sources):
source = _response_object(raw_source) or {}
url = source.get("url")
if not isinstance(url, str) or not url.strip():
continue
visible_source = {"url": url.strip()[:2048]}
title = source.get("title")
if isinstance(title, str) and title.strip():
visible_source["title"] = title.strip()[:300]
sources.append(visible_source)
if len(sources) == 8:
break
if sources:
result["sources"] = sources
return {
"kind": "hosted_tool",
"phase": phase,
"call_id": call_id,
"name": "web_search",
"arguments": arguments,
"result": result,
}
def map_finish_reason(status: str | None) -> str:
"""Map a Responses API status string to a Chat-Completions-style finish_reason."""
return FINISH_REASON_MAP.get(status or "completed", "stop")
@@ -269,11 +340,14 @@ async def consume_sse_with_reasoning(
refusal_seen = False
refusal_deltas: dict[tuple[str | None, int | None], str] = {}
emitted_refusal_text = ""
async for event in iter_sse(response):
if on_response_event:
await on_response_event(event)
event_type = event.get("type")
if on_tool_call_delta and (
hosted_event := _hosted_web_search_event(event, event_type)
):
await on_tool_call_delta(hosted_event)
if event_type == "response.output_item.added":
item = _as_json_object(event.get("item")) or {}
if item.get("type") == "function_call":
@@ -555,10 +629,13 @@ async def consume_sdk_stream(
refusal_seen = False
refusal_deltas: dict[tuple[str | None, int | None], str] = {}
emitted_refusal_text = ""
async for raw_event in stream:
event: Any = raw_event
event_type = getattr(event, "type", None)
if on_tool_call_delta and (
hosted_event := _hosted_web_search_event(event, event_type)
):
await on_tool_call_delta(hosted_event)
if event_type == "response.output_item.added":
item = getattr(event, "item", None)
if item and getattr(item, "type", None) == "function_call":
+5
View File
@@ -116,6 +116,10 @@ class ProviderSpec:
# Flash is supported before V4 Pro).
responses_models: tuple[str, ...] = ()
# Provider-hosted Responses tools sent unless extraBody.tools explicitly
# supplies the hosted-tool selection. Values are raw Responses tool types.
responses_default_tools: tuple[str, ...] = ()
# When the model returns content as a list of {"type":"thinking",...} +
# {"type":"text",...} blocks, extract the thinking text into
# reasoning_content. Mistral's Magistral / reasoning-enabled responses use
@@ -479,6 +483,7 @@ PROVIDERS: tuple[ProviderSpec, ...] = (
default_api_base="https://api.deepseek.com",
thinking_style="thinking_type",
responses_models=("deepseek-v4-flash",),
responses_default_tools=("web_search",),
),
# Gemini: Google's OpenAI-compatible endpoint
ProviderSpec(
+38 -5
View File
@@ -46,6 +46,19 @@ _SENSITIVE_ERROR_KEYS = {
}
def _is_hosted_x_search_tool(value: object) -> bool:
if not isinstance(value, dict):
return False
return cast(dict[object, object], value).get("type") == "x_search"
def _is_named_x_search_tool(value: object) -> bool:
if not isinstance(value, dict):
return False
record = cast(dict[object, object], value)
return record.get("type") == "function" and record.get("name") == "x_search"
class XAIGrokProvider(LLMProvider):
"""Call xAI's subscription proxy and expose supported hosted tools."""
@@ -112,13 +125,27 @@ class XAIGrokProvider(LLMProvider):
stage = "oauth_token"
try:
token = await asyncio.to_thread(get_xai_oauth_token, proxy=self.proxy)
stage = "model_capabilities"
supports_backend_search = await self._supports_backend_search(token, wire_model)
configured_tools = self._extra_body.get("tools")
tools_are_explicit = "tools" in self._extra_body
configured_hosted_search = (
isinstance(configured_tools, list)
and any(
_is_hosted_x_search_tool(tool)
for tool in cast(list[object], configured_tools)
)
)
supports_backend_search = False
if not tools_are_explicit:
stage = "model_capabilities"
supports_backend_search = await self._supports_backend_search(token, wire_model)
converted_tools = convert_tools(tools or [])
if supports_backend_search:
if isinstance(configured_tools, list):
converted_tools.extend(cast(list[dict[str, Any]], configured_tools))
if supports_backend_search or configured_hosted_search:
converted_tools = [
tool for tool in converted_tools if tool.get("name") != "x_search"
tool for tool in converted_tools if not _is_named_x_search_tool(tool)
]
if supports_backend_search:
converted_tools.append({"type": "x_search"})
body: dict[str, Any] = {
@@ -137,7 +164,13 @@ class XAIGrokProvider(LLMProvider):
"reasoning": _build_reasoning_options(reasoning_effort),
}
if self._extra_body:
body.update(self._extra_body)
body.update({
key: value
for key, value in self._extra_body.items()
if key != "tools"
})
if tools_are_explicit and not isinstance(configured_tools, list):
body["tools"] = configured_tools
headers = _build_headers(token.access, wire_model)
stage = "xai_request"
+70 -13
View File
@@ -11,7 +11,7 @@ from copy import deepcopy
from dataclasses import dataclass, field
from datetime import datetime
from pathlib import Path
from typing import Any, Callable, Protocol, TypedDict, cast
from typing import Any, Callable, Collection, Protocol, TypedDict, cast
from weakref import WeakValueDictionary
from loguru import logger
@@ -36,6 +36,7 @@ from nanobot.utils.subagent_channel_display import scrub_subagent_announce_body
FILE_MAX_MESSAGES = 2000
SESSION_CACHE_MAX_SIZE = 128
MIN_REPLAY_MAX_MESSAGES = 120
MIN_COMPACTED_REPLAY_MESSAGES = 8
REPLAY_TOKENS_PER_MESSAGE = 100
_MESSAGE_TIME_PREFIX_RE = re.compile(r"^\[Message Time: [^\]]+\]\n?")
_LOCAL_IMAGE_BREADCRUMB_RE = re.compile(r"^\[image: (?:/|~)[^\]]+\]\s*$")
@@ -146,6 +147,15 @@ class RetentionResult:
already_consolidated_count: int
@dataclass(frozen=True)
class SessionPolicy:
"""Runtime rules that do not belong in durable session data."""
persist: bool = True
log_content: bool = True
disabled_tools: frozenset[str] = frozenset()
@dataclass
class Session:
"""A conversation session."""
@@ -157,6 +167,7 @@ class Session:
metadata: dict[str, Any] = field(default_factory=dict)
last_consolidated: int = 0 # Number of messages already consolidated to files
provider_state: ProviderConversationState | None = field(default=None, repr=False)
policy: SessionPolicy = field(default_factory=SessionPolicy, repr=False, compare=False)
def __post_init__(self) -> None:
if not isinstance(cast(object, self.metadata), dict):
@@ -191,19 +202,37 @@ class Session:
extend_to_user: bool = False,
include_runtime_context: bool = True,
) -> list[dict[str, Any]]:
"""Return unconsolidated messages for LLM input.
"""Return recent replayable messages for LLM input.
History is sliced by message count first (``max_messages``), then by
token budget from the tail (``max_tokens``) when provided.
"""
unconsolidated = self.messages[self.last_consolidated:]
replay_start = self.last_consolidated
if replay_start:
# ``last_consolidated`` is archive progress, not a replay boundary.
# Keep a small raw suffix for continuity, extending back to the user
# that started an assistant/tool sequence when necessary.
recent_start = recent_message_start_index(
self.messages,
MIN_COMPACTED_REPLAY_MESSAGES,
extend_to_user=True,
)
replay_start = min(replay_start, recent_start)
replayable = self.messages[replay_start:]
max_messages = max_messages if max_messages > 0 else FILE_MAX_MESSAGES
start_idx = recent_message_start_index(
unconsolidated,
max_messages,
extend_to_user=extend_to_user,
)
sliced = unconsolidated[start_idx:]
unarchived_count = len(self.messages) - self.last_consolidated
if replay_start < self.last_consolidated and unarchived_count < max_messages:
# The archived replay suffix can exceed the nominal count when one
# tool-heavy turn spans the boundary. Preserve that complete turn.
start_idx = 0
else:
start_idx = recent_message_start_index(
replayable,
max_messages,
extend_to_user=extend_to_user,
)
sliced = replayable[start_idx:]
# Avoid starting mid-turn when possible, except for proactive
# assistant deliveries that the user may be replying to.
@@ -352,17 +381,24 @@ class Session:
start_idx = max(0, len(self.messages) - max_messages)
if extend_to_user:
start_idx = next(
recovered_user = next(
(i for i in range(start_idx, -1, -1) if self.messages[i].get("role") == "user"),
start_idx,
None,
)
if recovered_user is not None:
start_idx = recovered_user
if start_idx > 0 and self.messages[start_idx - 1].get("_channel_delivery"):
start_idx -= 1
retained = self.messages[start_idx:]
# Prefer starting at a user turn when one exists within the retained window.
# Prefer starting at a user turn (or its preceding _channel_delivery) when one exists within the retained window.
first_user = next((i for i, m in enumerate(retained) if m.get("role") == "user"), None)
if first_user is not None:
retained = retained[first_user:]
if first_user > 0 and retained[first_user - 1].get("_channel_delivery"):
retained = retained[first_user - 1:]
else:
retained = retained[first_user:]
elif not extend_to_user:
# If the hard-capped tail is assistant/tool-only, anchor to the
# latest user in the full session and take a capped forward window.
@@ -1053,6 +1089,24 @@ class SessionManager:
self._remember(session)
return session
def get_or_create_transient(
self,
key: str,
*,
disabled_tools: Collection[str] = (),
) -> Session:
"""Return a fresh, non-persistent session without loading history."""
policy = SessionPolicy(
persist=False,
log_content=False,
disabled_tools=frozenset(disabled_tools),
)
session = self.get_cached(key)
if session is None or session.policy != policy:
session = Session(key=key, policy=policy)
self._remember(session)
return session
def _load(self, key: str) -> Session | None:
return self._store.load(key)
@@ -1066,6 +1120,9 @@ class SessionManager:
def save(self, session: Session, *, fsync: bool = False) -> None:
"""Persist a session and retain it in the cache."""
if not session.policy.persist:
return
archiver = self._file_cap_archiver
if archiver is not None:
session.enforce_file_cap(
+6
View File
@@ -334,6 +334,12 @@ def clear_websocket_turn_if_current(
return False
def clear_websocket_turns(chat_id: str) -> None:
"""Forget every in-process turn projection for a discarded chat."""
_WEBSOCKET_ACTIVE_TURNS.pop(chat_id, None)
_sync_websocket_turn_projection(chat_id)
def build_bus_progress_callback(
bus: MessageBus,
msg: InboundMessage,
+4 -18
View File
@@ -3,14 +3,13 @@
Persisted subagent announcements mirror ``agent/subagent_announce.md``: header,
full ``Task:`` assignment (model context), ``Result:``, and a trailing model-only
``Summarize`` instruction. External channels (embedded WebUI, session previews)
should show only the header plus a truncated result body."""
should show only the header plus a truncated result body.
"""
from __future__ import annotations
from typing import Any, cast
# Cap Result section length so WebSocket session replay stays readable; full text
# remains on disk for LLM replay (we only mutate outgoing API copies in websocket).
# Cap the Result section so session previews stay readable; full text remains on
# disk for LLM replay.
_SUBAGENT_CHANNEL_RESULT_MAX_CHARS = 800
@@ -44,16 +43,3 @@ def scrub_subagent_announce_body(content: str) -> str:
if header and body:
return f"{header}\n\n{body}"
return header or body or stripped
def scrub_subagent_messages_for_channel(messages: list[dict[str, Any]]) -> None:
"""Mutate message dicts in place when they carry ``subagent_result`` inject."""
for msg in messages:
if not isinstance(cast(object, msg), dict):
continue
if msg.get("injected_event") != "subagent_result":
continue
raw = msg.get("content")
if not isinstance(raw, str) or not raw.strip():
continue
msg["content"] = scrub_subagent_announce_body(raw)
+9
View File
@@ -11,6 +11,7 @@ from loguru import logger as default_logger
from nanobot.webui.gateway_tokens import GatewayTokenStore
from nanobot.webui.ingress_policy import DEFAULT_WEBUI_INGRESS_POLICY, WebUIIngressPolicy
from nanobot.webui.media_gateway import WebUIMediaGateway
from nanobot.webui.temporary_chats import WebUITemporaryChats
from nanobot.webui.transcript import WebUITranscriptRecorder
from nanobot.webui.workspaces import WebUIWorkspaceController
from nanobot.webui.ws_http import GatewayHTTPHandler
@@ -33,6 +34,7 @@ class GatewayServices:
ingress: WebUIIngressPolicy
transcripts: WebUITranscriptRecorder
workspaces: WebUIWorkspaceController
temporary_chats: WebUITemporaryChats
session_manager: SessionManager | None
cron_service: CronService | None
local_trigger_store: LocalTriggerStore | None
@@ -82,6 +84,12 @@ def build_gateway_services(
default_workspace=workspace_path,
default_restrict_to_workspace=default_restrict_to_workspace,
)
temporary_chats = WebUITemporaryChats(
bus=bus,
session_manager=session_manager,
workspaces=workspaces,
logger=logger,
)
http = GatewayHTTPHandler(
config=config,
session_manager=session_manager,
@@ -112,6 +120,7 @@ def build_gateway_services(
ingress=ingress,
transcripts=transcripts,
workspaces=workspaces,
temporary_chats=temporary_chats,
session_manager=session_manager,
cron_service=cron_service,
local_trigger_store=local_trigger_store,
+46 -2
View File
@@ -75,7 +75,7 @@ def host_for_url(host: str, port: int) -> str:
return f"{host}:{port}"
def _accepts_gzip(value: str) -> bool:
def accepts_gzip(value: str) -> bool:
wildcard_quality: float | None = None
for item in value.split(","):
name, *params = (part.strip() for part in item.split(";"))
@@ -109,7 +109,7 @@ def http_json_response(
]
if accept_encoding is not None:
headers.append(("Vary", "Accept-Encoding"))
if len(body) >= _JSON_GZIP_MIN_BYTES and _accepts_gzip(accept_encoding):
if len(body) >= _JSON_GZIP_MIN_BYTES and accepts_gzip(accept_encoding):
body = gzip.compress(body, compresslevel=_JSON_GZIP_LEVEL, mtime=0)
headers.append(("Content-Encoding", "gzip"))
headers.append(("Content-Length", str(len(body))))
@@ -169,6 +169,50 @@ def is_localhost(connection: Any) -> bool:
return host in {"127.0.0.1", "::1", "localhost"}
def _connection_ip(connection: Any) -> ipaddress.IPv4Address | ipaddress.IPv6Address | None:
addr = getattr(connection, "remote_address", None)
host = cast(Any, addr[0] if isinstance(addr, tuple) else addr)
if not isinstance(host, str):
return None
try:
return ipaddress.ip_address(host)
except ValueError:
return None
def _address_matches_network(
address: ipaddress.IPv4Address | ipaddress.IPv6Address,
network: ipaddress.IPv4Network | ipaddress.IPv6Network,
) -> bool:
if isinstance(address, ipaddress.IPv4Address):
if isinstance(network, ipaddress.IPv4Network):
return address in network
return ipaddress.IPv6Address(f"::ffff:{address}") in network
if isinstance(network, ipaddress.IPv6Network):
return address in network
mapped = address.ipv4_mapped
return mapped is not None and mapped in network
def is_trusted_proxy_authenticated_request(
connection: Any,
headers: Any,
config: Any,
) -> bool:
"""Return True when a configured proxy peer presents a non-empty assertion."""
trusted_proxy_auth = getattr(config, "trusted_proxy_auth", None)
if trusted_proxy_auth is None:
return False
address = _connection_ip(connection)
if address is None:
return False
networks = getattr(trusted_proxy_auth, "_trusted_peer_networks", ())
if not any(_address_matches_network(address, network) for network in networks):
return False
assertion_header = getattr(trusted_proxy_auth, "assertion_header", "")
return bool(case_insensitive_header(headers, assertion_header))
def _host_without_port(value: str) -> str:
value = value.strip().strip('"').strip("'")
if not value:
+1 -33
View File
@@ -13,7 +13,7 @@ import shutil
import uuid
from collections.abc import Callable
from pathlib import Path
from typing import Any, cast
from typing import Any
from websockets.http11 import Request as WsRequest
from websockets.http11 import Response
@@ -32,7 +32,6 @@ from nanobot.webui.http_utils import (
MediaDirProvider = Callable[[str | None], Path]
SignedMediaPath = Callable[[Path], dict[str, str] | None]
SignedMediaUrl = Callable[[Path], str | None]
def b64url_encode(data: bytes) -> str:
@@ -190,37 +189,6 @@ def signed_media_attachments(
return out
def attach_signed_media_urls(
payload: dict[str, Any],
*,
sign_path: SignedMediaUrl,
) -> None:
"""Replace raw media path lists in a WebUI session payload with signed URLs."""
messages = payload.get("messages")
if not isinstance(messages, list):
return
raw_messages = cast(list[Any], messages)
for msg in raw_messages:
if not isinstance(msg, dict):
continue
message = cast(dict[str, Any], msg)
media = message.get("media")
if not isinstance(media, list) or not media:
continue
media_entries = cast(list[Any], media)
urls: list[dict[str, str]] = []
for entry in media_entries:
if not isinstance(entry, str) or not entry:
continue
signed = sign_path(Path(entry))
if signed is None:
continue
urls.append({"url": signed, "name": Path(entry).name})
if urls:
message["media_urls"] = urls
message.pop("media", None)
def serve_signed_media(
sig: str,
payload: str,
-4
View File
@@ -17,7 +17,6 @@ from nanobot.webui.attachment_ingress import (
)
from nanobot.webui.ingress_policy import AttachmentIngressLimits
from nanobot.webui.media_api import (
attach_signed_media_urls,
serve_signed_media,
sign_media_path,
sign_or_stage_media_path,
@@ -99,9 +98,6 @@ class WebUIMediaGateway:
sign_path=self.sign_or_stage_media_path,
)
def augment_media_urls(self, payload: dict[str, Any]) -> None:
attach_signed_media_urls(payload, sign_path=self.sign_media_path)
def augment_transcript_media(self, paths: list[str]) -> list[dict[str, Any]]:
return signed_media_attachments(
paths,
+28 -62
View File
@@ -1,12 +1,10 @@
"""Scoped access to persisted WebUI conversations."""
"""Read and validate persisted conversations for WebUI and session tools."""
from __future__ import annotations
import json
from collections.abc import Mapping
from dataclasses import dataclass
from functools import cache
from pathlib import Path
from typing import Any, TypedDict, cast
from nanobot.runtime_context import (
@@ -14,10 +12,9 @@ from nanobot.runtime_context import (
public_history_message,
wrap_runtime_context_lines,
)
from nanobot.security.workspace_access import WORKSPACE_SCOPE_METADATA_KEY
from nanobot.session.history_visibility import is_hidden_history_message
from nanobot.session.manager import SessionManager
from nanobot.webui.session_list_index import indexed_workspace_scope, list_webui_sessions
from nanobot.webui.session_list_index import list_webui_sessions
from nanobot.webui.transcript import (
build_webui_thread_response,
normalize_session_mentions_metadata,
@@ -46,21 +43,6 @@ class SessionMatch(TypedDict):
messages: list[SessionMessage]
@dataclass(frozen=True)
class SessionAccessScope:
current_session_key: str
session_key_prefix: str
project_path: Path | None = None
restrict_to_workspace: bool = False
def allows(self, session_key: object) -> bool:
return (
isinstance(session_key, str)
and session_key.startswith(self.session_key_prefix)
and session_key != self.current_session_key
)
def _message_text(message: Mapping[str, Any]) -> str:
content = message.get("content")
if isinstance(content, str):
@@ -116,44 +98,21 @@ def _row_title(row: Mapping[str, Any]) -> str:
return _text(row.get("title")) or _text(row.get("preview"))
def _project_path(raw_scope: object, default_workspace: Path) -> Path:
if isinstance(raw_scope, Mapping):
scope = cast(Mapping[str, object], raw_scope)
raw_path = scope.get("project_path") or scope.get("path")
if isinstance(raw_path, str) and raw_path:
return Path(raw_path).expanduser().resolve(strict=False)
return default_workspace.resolve(strict=False)
class WebuiSessionAccess:
"""Own listing, authorization, validation, and history reads for session references."""
"""Own listing, validation, and history reads for session references."""
def __init__(self, sessions: SessionManager) -> None:
self._sessions = sessions
def _allowed_project(self, raw_scope: object, scope: SessionAccessScope) -> bool:
if not scope.restrict_to_workspace or scope.project_path is None:
return True
return _project_path(raw_scope, self._sessions.workspace) == scope.project_path.resolve(
strict=False
)
def _allowed_row(self, row: Mapping[str, Any], scope: SessionAccessScope) -> bool:
key = row.get("key")
if not scope.allows(key):
return False
present, raw_scope = indexed_workspace_scope(cast(dict[str, Any], row))
return self._allowed_project(raw_scope if present else None, scope)
def _metadata(self, session_key: str, scope: SessionAccessScope) -> dict[str, Any] | None:
if not scope.allows(session_key):
def _metadata(
self,
session_key: str,
*,
exclude_session_key: str | None,
) -> dict[str, Any] | None:
if session_key == exclude_session_key:
return None
payload = self._sessions.read_session_metadata(session_key)
if payload is None:
return None
session_metadata = _session_metadata(payload)
raw_scope = session_metadata.get(WORKSPACE_SCOPE_METADATA_KEY)
return payload if self._allowed_project(raw_scope, scope) else None
return self._sessions.read_session_metadata(session_key)
def _messages(self, session_key: str) -> list[SessionMessage]:
@cache
@@ -176,13 +135,19 @@ class WebuiSessionAccess:
return _visible_messages(thread.get("messages"))
return _visible_messages(load_session_messages())
def search(self, scope: SessionAccessScope, query: str, limit: int) -> list[SessionMatch]:
def search(
self,
query: str,
limit: int,
*,
exclude_session_key: str | None = None,
) -> list[SessionMatch]:
needle = query.casefold()
rows = [
row
for row in list_webui_sessions(self._sessions)
if self._allowed_row(row, scope)
]
rows: list[dict[str, Any]] = []
for row in list_webui_sessions(self._sessions):
key = row.get("key")
if isinstance(key, str) and key != exclude_session_key:
rows.append(row)
ranked: list[tuple[int, SessionMatch]] = []
remaining: list[dict[str, Any]] = []
for row in rows:
@@ -230,13 +195,13 @@ class WebuiSessionAccess:
def read(
self,
scope: SessionAccessScope,
session_key: str,
*,
query: str,
limit: int,
exclude_session_key: str | None = None,
) -> SessionMatch | None:
payload = self._metadata(session_key, scope)
payload = self._metadata(session_key, exclude_session_key=exclude_session_key)
if payload is None:
return None
messages = self._messages(session_key)
@@ -254,7 +219,8 @@ class WebuiSessionAccess:
def normalize_mentions(
self,
raw: object,
scope: SessionAccessScope,
*,
exclude_session_key: str | None = None,
) -> list[SessionMention]:
normalized: list[SessionMention] = []
seen_keys: set[str] = set()
@@ -263,7 +229,7 @@ class WebuiSessionAccess:
mention = cast(SessionMention, raw_mention)
key = mention["session_key"]
folded_name = mention["name"].lower()
payload = self._metadata(key, scope)
payload = self._metadata(key, exclude_session_key=exclude_session_key)
if payload is None or key in seen_keys or folded_name in seen_names:
continue
normalized.append({
+10 -15
View File
@@ -4,7 +4,7 @@ The WebSocket channel owns transport/authentication. This module owns the
settings payload shape and the allowlisted config mutations exposed to WebUI.
"""
# oauth-cli-kit is an optional dependency and does not publish type stubs.
# oauth-cli-kit does not publish type stubs.
# pyright: reportMissingTypeStubs=false
from __future__ import annotations
@@ -36,6 +36,7 @@ from nanobot.providers.image_generation import (
get_image_gen_provider,
image_gen_provider_names,
)
from nanobot.providers.oauth_guidance import OAUTH_CLI_KIT_MISSING_MESSAGE
from nanobot.providers.registry import PROVIDERS, create_dynamic_spec, find_by_name
from nanobot.security.network import is_loopback_host
from nanobot.security.workspace_access import workspace_sandbox_status
@@ -1399,10 +1400,12 @@ def update_agent_settings(query: QueryParams) -> dict[str, Any]:
ZoneInfo(timezone)
except Exception:
raise WebUISettingsError("invalid timezone") from None
if defaults.timezone != timezone:
timezone_changed = defaults.timezone != timezone
if timezone_changed or defaults.timezone_mode != "manual":
defaults.timezone = timezone
defaults.timezone_mode = "manual"
changed = True
restart_required = True
restart_required = timezone_changed
tool_hint_max_length = _query_first_alias(
query,
@@ -1792,9 +1795,7 @@ def login_oauth_provider(query: QueryParams) -> dict[str, Any]:
try:
from nanobot.providers.openai_codex_oauth import start_openai_codex_oauth_login
except ImportError:
raise WebUISettingsError(
"oauth_cli_kit not installed. Run: pip install oauth-cli-kit", status=500
) from None
raise WebUISettingsError(OAUTH_CLI_KIT_MISSING_MESSAGE, status=500) from None
try:
proxy = resolve_config_env_vars(load_config()).providers.openai_codex.proxy or None
@@ -1832,9 +1833,7 @@ def login_oauth_provider(query: QueryParams) -> dict[str, Any]:
login_github_copilot,
)
except ImportError:
raise WebUISettingsError(
"oauth_cli_kit not installed. Run: pip install oauth-cli-kit", status=500
) from None
raise WebUISettingsError(OAUTH_CLI_KIT_MISSING_MESSAGE, status=500) from None
token = get_github_copilot_login_status()
if not token:
@@ -1932,18 +1931,14 @@ def logout_oauth_provider(query: QueryParams) -> dict[str, Any]:
from oauth_cli_kit.providers import OPENAI_CODEX_PROVIDER
from oauth_cli_kit.storage import FileTokenStorage
except ImportError:
raise WebUISettingsError(
"oauth_cli_kit not installed. Run: pip install oauth-cli-kit", status=500
) from None
raise WebUISettingsError(OAUTH_CLI_KIT_MISSING_MESSAGE, status=500) from None
_clear_webui_oauth_flows(spec.name)
token_path = FileTokenStorage(token_filename=OPENAI_CODEX_PROVIDER.token_filename).get_token_path()
elif spec.name == "github_copilot":
try:
from nanobot.providers.github_copilot_provider import get_storage
except ImportError:
raise WebUISettingsError(
"oauth_cli_kit not installed. Run: pip install oauth-cli-kit", status=500
) from None
raise WebUISettingsError(OAUTH_CLI_KIT_MISSING_MESSAGE, status=500) from None
token_path = get_storage().get_token_path()
elif spec.name == "xai_grok":
from nanobot.providers.xai_oauth import logout_xai_oauth
+3 -1
View File
@@ -25,7 +25,7 @@ _MAX_KEY_LEN = 512
_MAX_TITLE_LEN = 160
_MAX_TAG_LEN = 40
_ALLOWED_DENSITIES = {"comfortable", "compact"}
_ALLOWED_SORTS = {"updated_desc", "created_desc", "title_asc"}
_ALLOWED_SORTS = {"updated_desc", "created_desc", "title_asc", "manual"}
def webui_sidebar_state_path() -> Path:
@@ -37,6 +37,7 @@ def default_webui_sidebar_state() -> dict[str, Any]:
"schema_version": WEBUI_SIDEBAR_STATE_SCHEMA_VERSION,
"pinned_keys": [],
"archived_keys": [],
"session_order": [],
"title_overrides": {},
"project_name_overrides": {},
"tags_by_key": {},
@@ -138,6 +139,7 @@ def normalize_webui_sidebar_state(raw: Any) -> dict[str, Any]:
state = default_webui_sidebar_state()
state["pinned_keys"] = _clean_string_list(raw.get("pinned_keys"))
state["archived_keys"] = _clean_string_list(raw.get("archived_keys"))
state["session_order"] = _clean_string_list(raw.get("session_order"))
state["title_overrides"] = _clean_title_overrides(raw.get("title_overrides"))
state["project_name_overrides"] = _clean_title_overrides(
raw.get("project_name_overrides")
+218
View File
@@ -0,0 +1,218 @@
"""Connection-owned Temporary Chat behavior for the WebUI."""
from __future__ import annotations
import uuid
from dataclasses import dataclass
from pathlib import Path
from typing import Any
from nanobot.bus.events import (
INBOUND_META_RUNTIME_CONTROL,
RUNTIME_CONTROL_SESSION_DISCARD,
InboundMessage,
)
from nanobot.bus.queue import MessageBus
from nanobot.security.workspace_access import WorkspaceScope
from nanobot.session.manager import Session, SessionManager
from nanobot.webui.workspaces import WebUIWorkspaceController
_TEMPORARY_CHAT_DISABLED_TOOLS = frozenset({
"create_goal",
"update_goal",
"spawn",
"cron",
})
_TEMPORARY_CHAT_COMMANDS = frozenset({"/model", "/stop"})
class TemporaryChatError(ValueError):
"""A stable WebUI protocol error for a Temporary Chat operation."""
def __init__(self, detail: str) -> None:
super().__init__(detail)
self.detail = detail
@dataclass(frozen=True)
class TemporaryChatMessagePolicy:
"""Server-owned message rules for one active Temporary Chat."""
session_key: str
workspace_scope: WorkspaceScope
require_existing_session: bool = True
hydrate_transcript: bool = False
persist_transcript: bool = False
class WebUITemporaryChats:
"""Own Temporary Chat creation, policy, attachments, and disposal."""
def __init__(
self,
*,
bus: MessageBus,
session_manager: SessionManager | None,
workspaces: WebUIWorkspaceController,
logger: Any,
channel_name: str = "websocket",
) -> None:
self._bus = bus
self._sessions = session_manager
self._workspaces = workspaces
self._logger = logger
self._channel_name = channel_name
self._owners: dict[str, object] = {}
self._owner_chat_ids: dict[object, set[str]] = {}
# Keep active sessions alive if the bounded manager cache evicts them
# between WebUI turns. SessionPolicy remains the authority below.
self._active_sessions: dict[str, Session] = {}
# Retain policy-derived tombstones until shutdown so late outbound
# events cannot create a durable transcript after a chat is discarded.
self._known_transient_chat_ids: set[str] = set()
self._media_paths: dict[str, set[str]] = {}
def _session_key(self, chat_id: str) -> str:
return f"{self._channel_name}:{chat_id}"
def _cached_session_is_transient(self, chat_id: str) -> bool:
if self._sessions is None:
return False
session = self._sessions.get_cached(self._session_key(chat_id))
return session is not None and not session.policy.persist
def create(self, owner: object, *, trusted_webui: bool) -> str:
"""Create a server-identified chat owned by one authenticated WebUI connection."""
if not trusted_webui:
raise TemporaryChatError("access_denied")
if self._sessions is None:
raise TemporaryChatError("temporary_chat_unavailable")
chat_id = str(uuid.uuid4())
session = self._sessions.get_or_create_transient(
self._session_key(chat_id),
disabled_tools=_TEMPORARY_CHAT_DISABLED_TOOLS,
)
if session.policy.persist:
raise RuntimeError("Temporary Chat must use a non-persistent session policy")
self._owners[chat_id] = owner
self._owner_chat_ids.setdefault(owner, set()).add(chat_id)
self._active_sessions[chat_id] = session
self._known_transient_chat_ids.add(chat_id)
return chat_id
def message_policy(
self,
owner: object,
chat_id: str,
content: str,
) -> TemporaryChatMessagePolicy | None:
"""Return Temporary Chat rules, or ``None`` for an ordinary chat."""
if not self._cached_session_is_transient(chat_id):
if chat_id in self._known_transient_chat_ids:
raise TemporaryChatError("temporary_chat_unavailable")
return None
if self._owners.get(chat_id) is not owner or self._sessions is None:
raise TemporaryChatError("temporary_chat_unavailable")
session = self._sessions.get_cached(self._session_key(chat_id))
if session is None:
raise TemporaryChatError("temporary_chat_unavailable")
command = content.strip().split(maxsplit=1)[0].lower() if content.strip() else ""
if command.startswith("/") and command not in _TEMPORARY_CHAT_COMMANDS:
raise TemporaryChatError("temporary_chat_command_rejected")
return TemporaryChatMessagePolicy(
session_key=self._session_key(chat_id),
workspace_scope=self._workspaces.restricted_default_scope(),
)
def validate_attach(self, chat_id: str) -> None:
"""Reject attempts to recover a non-persistent session."""
if not self._cached_session_is_transient(chat_id):
if chat_id in self._known_transient_chat_ids:
raise TemporaryChatError("temporary_chat_unavailable")
return
raise TemporaryChatError("temporary_chat_unavailable")
def validate_workspace_update(self, chat_id: str) -> None:
"""Prevent non-persistent sessions from acquiring durable workspace state."""
if self._cached_session_is_transient(chat_id):
raise TemporaryChatError("temporary_chat_workspace_rejected")
if chat_id in self._known_transient_chat_ids:
raise TemporaryChatError("temporary_chat_unavailable")
def register_media(self, owner: object, chat_id: str, paths: list[str]) -> None:
if not paths:
return
if self._owners.get(chat_id) is not owner:
raise TemporaryChatError("temporary_chat_unavailable")
self._media_paths.setdefault(chat_id, set()).update(paths)
def chat_ids_for_owner(self, owner: object) -> tuple[str, ...]:
return tuple(self._owner_chat_ids.get(owner, ()))
def owns(self, owner: object, chat_id: str) -> bool:
return self._owners.get(chat_id) is owner
def should_persist_transcript(self, chat_id: str) -> bool:
"""Apply the session policy and retain it for late events after disposal."""
return (
not self._cached_session_is_transient(chat_id)
and chat_id not in self._known_transient_chat_ids
)
def _discard_media(self, chat_id: str) -> None:
for raw_path in self._media_paths.pop(chat_id, set()):
try:
Path(raw_path).unlink(missing_ok=True)
except OSError:
self._logger.warning("failed to remove a temporary WebUI attachment")
def _forget_owner(self, owner: object, chat_id: str) -> None:
self._owners.pop(chat_id, None)
chat_ids = self._owner_chat_ids.get(owner)
if chat_ids is None:
return
chat_ids.discard(chat_id)
if not chat_ids:
self._owner_chat_ids.pop(owner, None)
async def discard(self, owner: object, chat_id: str) -> None:
"""Forget one owned chat and cancel any active work through the message bus."""
if (
not self._cached_session_is_transient(chat_id)
or self._owners.get(chat_id) is not owner
):
raise TemporaryChatError("temporary_chat_unavailable")
session_key = self._session_key(chat_id)
self._forget_owner(owner, chat_id)
self._active_sessions.pop(chat_id, None)
self._discard_media(chat_id)
if self._sessions is not None:
self._sessions.invalidate(session_key)
await self._bus.publish_inbound(
InboundMessage(
channel=self._channel_name,
sender_id="webui",
chat_id=chat_id,
content="",
metadata={
INBOUND_META_RUNTIME_CONTROL: RUNTIME_CONTROL_SESSION_DISCARD,
},
session_key_override=session_key,
)
)
def close(self) -> None:
"""Release process-local resources during gateway shutdown."""
for chat_id in tuple(self._owners):
self._discard_media(chat_id)
if self._sessions is not None:
self._sessions.invalidate(self._session_key(chat_id))
self._owners.clear()
self._owner_chat_ids.clear()
self._active_sessions.clear()
self._known_transient_chat_ids.clear()
+1 -5
View File
@@ -947,11 +947,7 @@ def normalize_session_mentions_metadata(raw: object) -> list[dict[str, str]]:
continue
name = name.strip()[:80]
session_key = session_key.strip()[:512]
if (
not name
or _SESSION_MENTION_NAME_RE.fullmatch(name) is None
or not session_key.startswith("websocket:")
):
if not name or not session_key or _SESSION_MENTION_NAME_RE.fullmatch(name) is None:
continue
normalized.append({
"name": name,
+8
View File
@@ -191,6 +191,14 @@ class WebUIWorkspaceController:
self._default_restrict_to_workspace,
)
def restricted_default_scope(self) -> WorkspaceScope:
"""Return the default workspace with access restricted for this request."""
return build_workspace_scope(
self._default_workspace,
"restricted",
source_channel=_WEBUI_SCOPE_CHANNEL,
)
def _scope_from_metadata_value(
self,
raw_scope: object,
+69 -48
View File
@@ -26,16 +26,17 @@ from websockets.http11 import Response
from nanobot.command.builtin import builtin_command_palette
from nanobot.cron.session_turns import is_bound_cron_job
from nanobot.cron.types import CronJob, CronSchedule
from nanobot.runtime_context import public_history_messages
from nanobot.security.workspace_access import WorkspaceScope
from nanobot.triggers.local_types import LocalTrigger
from nanobot.utils.subagent_channel_display import scrub_subagent_messages_for_channel
from nanobot.webui.file_preview import (
WebUIFilePreviewError,
file_preview_availability_payload,
file_preview_payload,
)
from nanobot.webui.gateway_tokens import GatewayTokenStore, token_response_payload
from nanobot.webui.http_utils import (
accepts_gzip as _accepts_gzip,
)
from nanobot.webui.http_utils import (
case_insensitive_header as _case_insensitive_header,
)
@@ -60,6 +61,9 @@ from nanobot.webui.http_utils import (
from nanobot.webui.http_utils import (
is_localhost as _is_localhost,
)
from nanobot.webui.http_utils import (
is_trusted_proxy_authenticated_request as _is_trusted_proxy_authenticated_request,
)
from nanobot.webui.http_utils import (
issue_route_secret_matches as _issue_route_secret_matches,
)
@@ -263,6 +267,8 @@ class GatewayHTTPHandler:
# -- Token management ---------------------------------------------------
def check_api_token(self, request: WsRequest) -> bool:
if getattr(request, "_nanobot_trusted_proxy_authenticated", False):
return True
return self.tokens.check_api_token(request)
# -- Main dispatch ------------------------------------------------------
@@ -272,6 +278,11 @@ class GatewayHTTPHandler:
got, _ = _parse_request_path(request.path)
started = time.perf_counter()
response: Any | None = None
setattr(
request,
"_nanobot_trusted_proxy_authenticated",
_is_trusted_proxy_authenticated_request(connection, request.headers, self.config),
)
try:
response = await self._dispatch_resolved(connection, request, got)
@@ -326,7 +337,10 @@ class GatewayHTTPHandler:
# Static SPA serving
if self.static_dist_path is not None:
response = self._serve_static(got)
response = self._serve_static(
got,
accept_encoding=_combined_list_header(request.headers, "Accept-Encoding"),
)
if response is not None:
return response
@@ -372,11 +386,30 @@ class GatewayHTTPHandler:
def _handle_bootstrap(self, connection: Any, request: Any) -> Response:
secret = self.config.token_issue_secret.strip() or self.config.token.strip()
is_local_browser = _is_local_browser_request(connection, request.headers)
if secret:
if not _issue_route_secret_matches(request.headers, secret):
return _http_error(401, "Unauthorized")
elif not is_local_browser:
return _http_error(403, "bootstrap is localhost-only")
is_proxy_authenticated = _is_trusted_proxy_authenticated_request(
connection,
request.headers,
self.config,
)
if not is_proxy_authenticated:
if secret:
if not _issue_route_secret_matches(request.headers, secret):
return _http_error(401, "Unauthorized")
elif not is_local_browser:
return _http_error(403, "bootstrap is localhost-only")
if is_proxy_authenticated:
payload = {
"ws_path": _normalize_config_path(self.config.path),
"ws_url": self._bootstrap_ws_url(request),
"limits": self.ingress.bootstrap_limits(
max_frame_bytes=self.config.max_message_bytes,
),
"model_name": _resolve_bootstrap_model_name(self.runtime_model_name),
"runtime_surface": self._runtime_surface,
"runtime_capabilities": self._capabilities,
}
return _http_json_response(payload)
api_token_allowed = bool(secret) or is_local_browser
if not self.tokens.can_issue(include_api_token=api_token_allowed):
@@ -412,6 +445,8 @@ class GatewayHTTPHandler:
def _bootstrap_ws_url(self, request: Any) -> str:
headers = getattr(request, "headers", {}) or {}
if self.config.public_ws_url:
return self.config.public_ws_url
host = _safe_host_header(_case_insensitive_header(headers, "Host"))
if not host:
host = _host_for_url(self.config.host, self.config.port)
@@ -425,10 +460,6 @@ class GatewayHTTPHandler:
# -- Session routes -----------------------------------------------------
async def _dispatch_session_routes(self, request: WsRequest, got: str) -> Response | None:
m = re.match(r"^/api/sessions/([^/]+)/messages$", got)
if m:
return self._handle_session_messages(request, m.group(1))
m = re.match(r"^/api/sessions/([^/]+)/webui-thread$", got)
if m:
return self._handle_webui_thread_get(request, m.group(1))
@@ -490,34 +521,6 @@ class GatewayHTTPHandler:
cleaned.append(row)
return {"sessions": cleaned}
def _handle_session_messages(self, request: WsRequest, key: str) -> Response:
if not self.check_api_token(request):
return _http_error(401, "Unauthorized")
if self.session_manager is None:
return _http_error(503, "session manager unavailable")
decoded_key = _decode_api_key(key)
if decoded_key is None:
return _http_error(400, "invalid session key")
if not _is_websocket_channel_session_key(decoded_key):
return _http_error(404, "session not found")
data = self.session_manager.read_session_file(decoded_key)
if data is None:
return _http_error(404, "session not found")
messages = data.get("messages")
if isinstance(messages, list):
session_messages = cast(list[dict[str, Any]], messages)
scrub_subagent_messages_for_channel(session_messages)
raw_session_messages = cast(list[Any], messages)
data["messages"] = public_history_messages(
[
cast(dict[str, Any], message)
for message in raw_session_messages
if isinstance(message, dict)
]
)
self.media.augment_media_urls(data)
return _http_json_response(data)
def _handle_webui_thread_get(self, request: WsRequest, key: str) -> Response:
if not self.check_api_token(request):
return _http_error(401, "Unauthorized")
@@ -1112,7 +1115,12 @@ class GatewayHTTPHandler:
# -- Static file serving ------------------------------------------------
def _serve_static(self, request_path: str) -> Response | None:
def _serve_static(
self,
request_path: str,
*,
accept_encoding: str = "",
) -> Response | None:
assert self.static_dist_path is not None
rel = request_path.lstrip("/")
if not rel:
@@ -1130,15 +1138,28 @@ class GatewayHTTPHandler:
candidate = index
else:
return None
try:
body = candidate.read_bytes()
except OSError as e:
self._log.warning("static: failed to read {}: {}", candidate, e)
return _http_error(500, "Internal Server Error")
ctype, _ = mimetypes.guess_type(candidate.name)
if ctype is None:
ctype = "application/octet-stream"
if ctype.startswith("text/") or ctype in {"application/javascript", "application/json"}:
utf8_text = ctype.startswith("text/") or ctype in {
"application/javascript",
"application/json",
}
compressible = utf8_text or ctype == "image/svg+xml"
response_path = candidate
extra_headers: list[tuple[str, str]] = []
if compressible:
extra_headers.append(("Vary", "Accept-Encoding"))
gzip_candidate = candidate.with_name(f"{candidate.name}.gz")
if _accepts_gzip(accept_encoding) and gzip_candidate.is_file():
response_path = gzip_candidate
extra_headers.append(("Content-Encoding", "gzip"))
try:
body = response_path.read_bytes()
except OSError as e:
self._log.warning("static: failed to read {}: {}", response_path, e)
return _http_error(500, "Internal Server Error")
if utf8_text:
ctype = f"{ctype}; charset=utf-8"
if candidate.name == "index.html":
cache = "no-cache"
@@ -1148,7 +1169,7 @@ class GatewayHTTPHandler:
body,
status=200,
content_type=ctype,
extra_headers=[("Cache-Control", cache)],
extra_headers=[("Cache-Control", cache), *extra_headers],
)
+1
View File
@@ -52,6 +52,7 @@ dependencies = [
"watchfiles>=1.1.1,<2.0.0",
"packaging>=24.0",
"tzdata>=2025.2",
"tzlocal>=5.3.1,<6.0.0",
"defusedxml>=0.7.1,<1.0.0",
"pypdf>=5.0.0,<6.0.0",
"python-docx>=1.1.0,<2.0.0",
+9 -28
View File
@@ -80,8 +80,6 @@ def _make_fake_compact(
track_archived: list | None = None,
track_count: bool = False,
):
from nanobot.session.manager import Session as _Session
state = {"count": 0}
async def _fake_compact(key: str, *, runtime, max_suffix: int = 8) -> str:
@@ -92,25 +90,8 @@ def _make_fake_compact(
if not tail:
loop.sessions.save(session)
return ""
probe = _Session(
key=session.key,
messages=tail.copy(),
created_at=session.created_at,
updated_at=session.updated_at,
metadata={},
last_consolidated=0,
)
result = probe.retain_recent_legal_suffix(
max_suffix,
extend_to_user=True,
)
visible_suffix = probe.messages
archive_msgs = result.dropped
if not archive_msgs:
loop.sessions.save(session)
return ""
archive_end = session.last_consolidated + len(tail)
archive_msgs = tail
last_active = session.updated_at
s = summary
@@ -126,7 +107,7 @@ def _make_fake_compact(
"last_active": last_active.isoformat(),
}
session.last_consolidated = len(session.messages) - len(visible_suffix)
session.last_consolidated = archive_end
loop.sessions.save(session)
return s
@@ -365,7 +346,7 @@ class TestAutoCompact:
await loop.close_mcp()
@pytest.mark.asyncio
async def test_auto_compact_archives_prefix_without_deleting_history(self, tmp_path):
async def test_auto_compact_archives_full_tail_without_deleting_history(self, tmp_path):
loop = _make_loop(tmp_path, session_ttl_minutes=15)
session = loop.sessions.get_or_create("cli:test")
_add_turns(session, 6)
@@ -378,7 +359,7 @@ class TestAutoCompact:
await loop.auto_compact._archive("cli:test", runtime=loop.llm_runtime())
assert len(archived_messages) == 4
assert len(archived_messages) == 12
session_after = loop.sessions.get_or_create("cli:test")
assert len(session_after.messages) == 12
assert session_after.messages[0]["content"] == "msg user 0"
@@ -473,7 +454,7 @@ class TestAutoCompact:
await loop.auto_compact._archive("cli:test", runtime=loop.llm_runtime())
assert len(archived_messages) == 2
assert len(archived_messages) == 10
await loop.close_mcp()
@@ -515,7 +496,7 @@ class TestAutoCompactIdleDetection:
await loop._process_message(msg)
session_after = loop.sessions.get_or_create("cli:test")
assert len(archived_messages) == 4
assert len(archived_messages) == 12
assert any(m["content"] == "old user 0" for m in session_after.messages)
assert not any(
m["content"] == "old user 0"
@@ -724,7 +705,7 @@ class TestAutoCompactEdgeCases:
await loop._process_message(msg)
session_after = loop.sessions.get_or_create("cli:test")
assert archived_messages == []
assert [message["content"] for message in archived_messages] == ["previous message"]
assert any(m["content"] == "previous message" for m in session_after.messages)
assert any(m["content"] == "interrupted response" for m in session_after.messages)
@@ -912,7 +893,7 @@ class TestProactiveAutoCompact:
assert len(session_after.get_history(max_messages=10)) == (
loop.auto_compact._RECENT_SUFFIX_MESSAGES
)
assert len(archived_messages) == 2
assert len(archived_messages) == 10
entry = loop.auto_compact._summaries.get("cli:test")
assert entry is not None
assert entry[0] == "User chatted about old things."
+26 -2
View File
@@ -405,13 +405,37 @@ class TestCheckExpired:
scheduler.assert_not_called()
assert "dream:20260602-155256" not in ac._archiving
def test_already_trimmed_session_skips(self):
"""Expired session with no removable tail should not be re-scheduled."""
def test_short_unarchived_session_schedules(self):
"""A short idle session still needs an archive entry for Dream."""
ac = _make_autocompact(ttl=15)
mock_sm = MagicMock(spec=SessionManager)
last_active = datetime(2026, 1, 1, 10, 0, 0)
session = _make_session("cli:short", updated_at=last_active)
_add_turns(session, 2)
mock_sm.list_sessions.return_value = [
{"key": "cli:short", "updated_at": last_active.isoformat()},
]
mock_sm.get_or_create.return_value = session
ac.sessions = mock_sm
scheduled = []
def scheduler(coro):
scheduled.append(coro)
coro.close()
ac.check_expired(scheduler, _runtime)
assert len(scheduled) == 1
assert ac._archiving == {"cli:short"}
def test_fully_archived_session_skips(self):
ac = _make_autocompact(ttl=15)
mock_sm = MagicMock(spec=SessionManager)
last_active = datetime(2026, 1, 1, 10, 0, 0)
session = _make_session("cli:done", updated_at=last_active)
_add_turns(session, 2)
session.last_consolidated = len(session.messages)
mock_sm.list_sessions.return_value = [
{"key": "cli:done", "updated_at": last_active.isoformat()},
]
+110 -11
View File
@@ -391,6 +391,25 @@ class TestConsolidatorTokenBudget:
assert len(captured["history"]) == 160
assert captured["history"][0]["content"].endswith("msg-0")
async def test_estimate_includes_recent_archived_replay(self, consolidator, runtime):
session = Session(key="test:archived-replay")
for i in range(10):
session.add_message("user", f"msg-{i}")
session.last_consolidated = len(session.messages)
captured: dict[str, list[dict]] = {}
def build_messages(**kwargs):
captured["history"] = kwargs["history"]
return kwargs["history"]
consolidator._build_messages = build_messages
consolidator.estimate_session_prompt_tokens(session, runtime=runtime)
assert len(captured["history"]) == 8
assert captured["history"][0]["content"] == "msg-2"
async def test_replay_window_overflow_is_archived_even_under_token_budget(
self,
consolidator,
@@ -620,7 +639,7 @@ class TestCompactIdleSession:
)
@pytest.mark.asyncio
async def test_archives_prefix_preserves_messages_and_hides_prefix(
async def test_archives_full_tail_preserves_messages_and_replays_recent_suffix(
self, real_consolidator, mock_provider, runtime
):
mock_provider.chat_with_retry.return_value = MagicMock(
@@ -645,7 +664,7 @@ class TestCompactIdleSession:
reloaded = sessions.get_or_create("cli:test")
assert len(reloaded.messages) == 40
assert reloaded.messages[0]["content"] == "user msg 0"
assert reloaded.last_consolidated == 32
assert reloaded.last_consolidated == 40
assert reloaded.provider_state is None
visible = reloaded.get_history(max_messages=40)
assert len(visible) == 8
@@ -657,6 +676,82 @@ class TestCompactIdleSession:
assert "last_active" in meta
assert reloaded.updated_at == old_ts
@pytest.mark.asyncio
async def test_short_idle_session_archives_once(
self, real_consolidator, mock_provider, store, runtime
):
mock_provider.chat_with_retry.return_value = MagicMock(
content="Short summary.", finish_reason="stop"
)
sessions = real_consolidator.sessions
session = sessions.get_or_create("cli:short")
session.add_message("user", "hello")
session.add_message("assistant", "hi")
sessions.save(session)
first = await real_consolidator.compact_idle_session("cli:short", runtime=runtime)
second = await real_consolidator.compact_idle_session("cli:short", runtime=runtime)
assert first == "Short summary."
assert second == ""
mock_provider.chat_with_retry.assert_awaited_once()
assert len(store.read_unprocessed_history(since_cursor=0)) == 1
reloaded = sessions.get_or_create("cli:short")
assert reloaded.last_consolidated == 2
assert [message["content"] for message in reloaded.get_history()] == ["hello", "hi"]
@pytest.mark.asyncio
async def test_new_messages_advance_existing_archive_progress(
self, real_consolidator, mock_provider, runtime
):
mock_provider.chat_with_retry.return_value = MagicMock(
content="Summary.", finish_reason="stop"
)
sessions = real_consolidator.sessions
session = sessions.get_or_create("cli:incremental")
session.add_message("user", "first user")
session.add_message("assistant", "first assistant")
sessions.save(session)
await real_consolidator.compact_idle_session("cli:incremental", runtime=runtime)
current = sessions.get_or_create("cli:incremental")
current.add_message("user", "second user")
current.add_message("assistant", "second assistant")
sessions.save(current)
await real_consolidator.compact_idle_session("cli:incremental", runtime=runtime)
assert mock_provider.chat_with_retry.await_count == 2
latest_prompt = mock_provider.chat_with_retry.await_args_list[-1].kwargs["messages"][1][
"content"
]
assert "second user" in latest_prompt
assert "first user" not in latest_prompt
assert sessions.get_or_create("cli:incremental").last_consolidated == 4
@pytest.mark.asyncio
async def test_concurrent_append_remains_unarchived(
self, real_consolidator, mock_provider, runtime
):
sessions = real_consolidator.sessions
session = sessions.get_or_create("cli:concurrent")
session.add_message("user", "captured user")
session.add_message("assistant", "captured assistant")
sessions.save(session)
async def append_during_archive(**_kwargs):
current = sessions.get_or_create("cli:concurrent")
current.add_message("user", "late user")
current.add_message("assistant", "late assistant")
return LLMResponse(content="Summary.", finish_reason="stop")
mock_provider.chat_with_retry.side_effect = append_during_archive
await real_consolidator.compact_idle_session("cli:concurrent", runtime=runtime)
reloaded = sessions.get_or_create("cli:concurrent")
assert len(reloaded.messages) == 4
assert reloaded.last_consolidated == 2
@pytest.mark.asyncio
async def test_summarizes_retained_suffix_not_just_dropped_prefix(
self, real_consolidator, mock_provider, runtime
@@ -686,10 +781,10 @@ class TestCompactIdleSession:
assert "CORRECTED_FINAL_RESULT_alpha" in summarized
@pytest.mark.asyncio
async def test_raw_dumps_only_dropped_messages_on_llm_failure(
async def test_raw_dumps_full_archive_batch_on_llm_failure(
self, real_consolidator, mock_provider, store, runtime
):
"""Extra summary context must not enter raw fallback. Regression for #4264."""
"""The fallback covers the same full range as successful idle archival."""
mock_provider.chat_with_retry.side_effect = RuntimeError("LLM unavailable")
sessions = real_consolidator.sessions
session = sessions.get_or_create("cli:rawdrop")
@@ -707,7 +802,7 @@ class TestCompactIdleSession:
raw = "\n".join(e["content"] for e in store.read_unprocessed_history(since_cursor=0))
assert "[RAW]" in raw
assert "user msg 0" in raw
assert "RETAINED_SUFFIX_marker" not in raw
assert "RETAINED_SUFFIX_marker" in raw
reloaded = sessions.get_or_create("cli:rawdrop")
assert len(reloaded.messages) == 38
assert reloaded.messages[-1]["content"] == "RETAINED_SUFFIX_marker"
@@ -805,8 +900,12 @@ class TestCompactIdleSession:
reloaded = sessions.get_or_create("cli:fail")
assert len(reloaded.messages) == 20
assert reloaded.messages[0]["content"] == "u0"
assert reloaded.last_consolidated == 16
assert reloaded.last_consolidated == 20
assert [m["content"] for m in reloaded.get_history(max_messages=20)] == [
"u6",
"a6",
"u7",
"a7",
"u8",
"a8",
"u9",
@@ -835,10 +934,10 @@ class TestCompactIdleSession:
assert result == "Tail summary."
reloaded = sessions.get_or_create("cli:offset")
assert len(reloaded.messages) == 60
assert reloaded.last_consolidated == 56
assert reloaded.last_consolidated == 60
# Verify only the unconsolidated tail was processed:
# 10 unconsolidated messages (50-59), keep suffix of 4 → archive 6
# All 10 unconsolidated messages (50-59) are archived exactly once.
archived_call = mock_provider.chat_with_retry.call_args
user_content = archived_call.kwargs["messages"][1]["content"]
# Should contain only tail messages, not early ones
@@ -846,7 +945,7 @@ class TestCompactIdleSession:
assert "u25" in user_content or "a25" in user_content
@pytest.mark.asyncio
async def test_extended_suffix_archives_only_hidden_prefix(
async def test_full_archive_keeps_extended_legal_replay_suffix(
self,
real_consolidator,
mock_provider,
@@ -870,7 +969,7 @@ class TestCompactIdleSession:
reloaded = sessions.get_or_create("cli:noncontiguous")
assert len(reloaded.messages) == 25
assert reloaded.last_consolidated == 14
assert reloaded.last_consolidated == 25
assert [m["content"] for m in reloaded.get_history(max_messages=25)] == [
"user-14",
"assistant-00",
@@ -1034,7 +1133,7 @@ class TestConsolidatorSessionRefresh:
session_after = sessions.get_or_create("cli:test")
assert len(session_after.messages) == 40
assert session_after.last_consolidated == 32
assert session_after.last_consolidated == 40
assert len(session_after.get_history(max_messages=40)) == 8
+2 -3
View File
@@ -1074,9 +1074,8 @@ async def test_process_message_persists_media_paths_on_user_turn(tmp_path: Path)
"""User turns that attach images must record the media paths alongside
the text so the webui can rehydrate previews on session replay.
This is the producer half of the signed-media-URL round-trip: paths are
stored here, then :meth:`WebSocketChannel._augment_media_urls` maps them
onto signed URLs on the way out.
The WebUI transcript replay can use these paths to restore attachment
previews when it backfills from canonical session history.
"""
img_a = tmp_path / "uuid-1.png"
img_a.write_bytes(_PNG_1X1)
+158
View File
@@ -0,0 +1,158 @@
import asyncio
from unittest.mock import AsyncMock, MagicMock
import pytest
from nanobot.agent.loop import AgentLoop
from nanobot.bus.events import (
INBOUND_META_RUNTIME_CONTROL,
RUNTIME_CONTROL_SESSION_DISCARD,
InboundMessage,
)
from nanobot.bus.queue import MessageBus
from nanobot.providers.base import GenerationSettings, LLMResponse
from nanobot.session.keys import UNIFIED_SESSION_KEY
def _message(key: str, content: str) -> InboundMessage:
return InboundMessage(
channel="websocket",
sender_id="user",
chat_id=key.removeprefix("websocket:"),
content=content,
session_key_override=key,
require_existing_session=True,
)
def _loop(tmp_path, responses: list[str], **kwargs) -> AgentLoop:
provider = MagicMock()
provider.get_default_model.return_value = "test-model"
provider.generation = GenerationSettings()
provider.chat_with_retry = AsyncMock(
side_effect=[LLMResponse(content=response, usage={}) for response in responses]
)
return AgentLoop(
bus=MessageBus(),
provider=provider,
workspace=tmp_path,
model="test-model",
cron_service=MagicMock(),
**kwargs,
)
@pytest.mark.asyncio
async def test_transient_session_keeps_history_without_persisting_or_durable_tools(tmp_path) -> None:
loop = _loop(tmp_path, ["first answer", "second answer"])
loop.context.memory.write_memory("private durable memory")
loop.consolidator.maybe_consolidate_by_tokens = AsyncMock()
key = "websocket:transient-test"
loop.sessions.get_or_create_transient(
key,
disabled_tools={"create_goal", "update_goal", "spawn", "cron"},
)
await loop._process_message(_message(key, "first question"))
await loop._process_message(_message(key, "second question"))
calls = loop.provider.chat_with_retry.await_args_list
assert "private durable memory" not in str(calls[0].kwargs["messages"])
tool_names = {item["function"]["name"] for item in calls[0].kwargs["tools"]}
assert "read_session" in tool_names
assert {"create_goal", "update_goal", "spawn", "cron"}.isdisjoint(tool_names)
assert "first answer" in str(calls[1].kwargs["messages"])
session = loop.sessions.get_cached(key)
assert session is not None
assert [message["role"] for message in session.messages] == [
"user",
"assistant",
"user",
"assistant",
]
assert loop.sessions.read_session_file(key) is None
loop.consolidator.maybe_consolidate_by_tokens.assert_not_awaited()
@pytest.mark.asyncio
async def test_transient_session_stays_outside_unified_session(tmp_path) -> None:
loop = _loop(tmp_path, ["private answer"], unified_session=True)
durable = loop.sessions.get_or_create(UNIFIED_SESSION_KEY)
durable.add_message("user", "durable question")
loop.sessions.save(durable)
key = "websocket:transient-unified"
transient = loop.sessions.get_or_create_transient(key)
await loop._dispatch(_message(key, "private question"))
assert [message["content"] for message in transient.messages] == [
"private question",
"private answer",
]
assert [message["content"] for message in durable.messages] == ["durable question"]
assert loop.sessions.read_session_file(key) is None
@pytest.mark.asyncio
async def test_missing_required_session_cannot_fall_back_to_disk(tmp_path) -> None:
loop = _loop(tmp_path, [])
key = "websocket:transient-stale"
loop.sessions.get_or_create_transient(key)
loop.sessions.invalidate(key)
with pytest.raises(RuntimeError, match="required session is not active"):
await loop._process_message(_message(key, "stale private message"))
loop.provider.chat_with_retry.assert_not_awaited()
assert loop.sessions.read_session_file(key) is None
@pytest.mark.asyncio
async def test_session_discard_control_cancels_active_turn(tmp_path, monkeypatch) -> None:
provider_started = asyncio.Event()
async def block_provider(**_kwargs: object) -> LLMResponse:
provider_started.set()
await asyncio.Event().wait()
raise AssertionError("provider blocker unexpectedly released")
loop = _loop(tmp_path, [])
async def wait_for_discard(key: str) -> None:
while loop.sessions.get_cached(key) is not None:
await asyncio.sleep(0)
loop.provider.chat_with_retry = AsyncMock(side_effect=block_provider)
monkeypatch.setattr(loop, "_connect_mcp", AsyncMock())
monkeypatch.setattr(loop, "close_mcp", AsyncMock())
key = "websocket:transient-cancelled"
loop.sessions.get_or_create_transient(
key,
disabled_tools={"create_goal", "update_goal", "spawn", "cron"},
)
run_task = asyncio.create_task(loop.run())
await loop.bus.publish_inbound(_message(key, "private"))
await asyncio.wait_for(provider_started.wait(), timeout=2)
active_task = next(iter(loop._active_tasks[key]))
await loop.bus.publish_inbound(
InboundMessage(
channel="websocket",
sender_id="webui",
chat_id="transient-cancelled",
content="",
metadata={
INBOUND_META_RUNTIME_CONTROL: RUNTIME_CONTROL_SESSION_DISCARD,
},
session_key_override=key,
)
)
with pytest.raises(asyncio.CancelledError):
await asyncio.wait_for(active_task, timeout=2)
await asyncio.wait_for(wait_for_discard(key), timeout=2)
assert loop.sessions.get_cached(key) is None
loop.stop()
await loop.bus.publish_inbound(_message(key, "wake"))
await asyncio.wait_for(run_task, timeout=2)
+17
View File
@@ -1092,6 +1092,23 @@ class TestMainMenuUpdate:
assert config.providers.openai.api_key == "${UNRELATED_MISSING_KEY}"
assert config.providers.openai_codex.proxy == "${CODEX_PROXY}"
def test_quick_start_openai_codex_reports_incomplete_installation(self, monkeypatch):
import oauth_cli_kit
messages: list[str] = []
monkeypatch.delattr(oauth_cli_kit, "get_token")
monkeypatch.setattr(
onboard_wizard.console,
"print",
lambda message, *args, **kwargs: messages.append(str(message)),
)
assert onboard_wizard._quick_start_oauth_login(Config(), "openai_codex") is False
assert messages == [
"[red]This nanobot installation is missing the required oauth-cli-kit package. "
"Reinstall or upgrade nanobot-ai using the same installation method.[/red]"
]
def test_quick_start_openai_codex_runs_interactive_login_for_bad_cached_token(
self, monkeypatch
):
@@ -208,6 +208,71 @@ def test_orphan_trim_with_last_consolidated():
assert all(m.get("role") != "tool" or m["tool_call_id"].startswith("new_") for m in history)
def test_get_history_replays_recent_messages_after_full_archive():
session = Session(key="test:fully-archived")
for i in range(10):
session.messages.append({"role": "user", "content": f"u{i}"})
session.messages.append({"role": "assistant", "content": f"a{i}"})
session.last_consolidated = len(session.messages)
history = session.get_history(max_messages=100)
assert [message["content"] for message in history] == [
"u6",
"a6",
"u7",
"a7",
"u8",
"a8",
"u9",
"a9",
]
def test_get_history_extends_compacted_replay_to_preceding_user():
session = Session(key="test:compacted-tool-turn")
session.messages.extend(
[
{"role": "user", "content": "old"},
{"role": "assistant", "content": "old answer"},
{"role": "user", "content": "run tools"},
*_tool_turn("keep", 0),
*_tool_turn("keep", 1),
*_tool_turn("keep", 2),
{"role": "assistant", "content": "done"},
]
)
session.last_consolidated = len(session.messages)
history = session.get_history(max_messages=100)
assert history[0]["content"] == "run tools"
assert history[-1]["content"] == "done"
_assert_no_orphans(history)
def test_compacted_tool_turn_can_extend_past_message_cap():
session = Session(key="test:long-compacted-tool-turn")
session.messages.extend(
[
{"role": "user", "content": "old"},
{"role": "assistant", "content": "old answer"},
{"role": "user", "content": "run many tools"},
]
)
for i in range(50):
session.messages.extend(_tool_turn("keep", i))
session.messages.append({"role": "assistant", "content": "done"})
session.last_consolidated = len(session.messages)
history = session.get_history(max_messages=120)
assert len(history) > 120
assert history[0]["content"] == "run many tools"
assert history[-1]["content"] == "done"
_assert_no_orphans(history)
# --- Edge: no tool messages at all ---
def test_no_tool_messages_unchanged():
+259
View File
@@ -0,0 +1,259 @@
from nanobot.session.manager import Session
def _assert_no_orphans(history: list[dict]) -> None:
declared = {
tc["id"]
for m in history
if m.get("role") == "assistant"
for tc in (m.get("tool_calls") or [])
}
orphans = [
m.get("tool_call_id")
for m in history
if m.get("role") == "tool" and m.get("tool_call_id") not in declared
]
assert orphans == [], f"orphan tool_call_ids: {orphans}"
def _delivery(content: str) -> dict:
return {"role": "assistant", "content": content, "_channel_delivery": True}
def _tool_turn(prefix: str, idx: int) -> list[dict]:
return [
{
"role": "assistant",
"content": None,
"tool_calls": [
{
"id": f"{prefix}_{idx}_a",
"type": "function",
"function": {"name": "x", "arguments": "{}"},
},
{
"id": f"{prefix}_{idx}_b",
"type": "function",
"function": {"name": "y", "arguments": "{}"},
},
],
},
{"role": "tool", "tool_call_id": f"{prefix}_{idx}_a", "name": "x", "content": "ok"},
{"role": "tool", "tool_call_id": f"{prefix}_{idx}_b", "name": "y", "content": "ok"},
]
def _contents(messages: list[dict]) -> list[str]:
return [m.get("content") for m in messages]
def _has_delivery(messages: list[dict]) -> bool:
return any(m.get("_channel_delivery") for m in messages)
# --- Hard-cap trimming must preserve a proactive delivery the user replied to ---
def test_retain_hard_cap_keeps_delivery_before_user():
session = Session(key="test:cap-delivery")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("Remember to drink water"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "great"})
session.retain_recent_legal_suffix(3)
assert _has_delivery(session.messages), "delivery dropped by hard-cap trim"
assert _contents(session.messages) == [
"Remember to drink water",
"ok",
"great",
]
def test_retain_hard_cap_matches_get_history_boundary():
"""The trimmed suffix must start on the same message as get_history()."""
session = Session(key="test:cap-boundary")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("You have 3 pending tasks"))
session.messages.append({"role": "user", "content": "show them"})
session.messages.append({"role": "assistant", "content": "done"})
expected = session.get_history(max_messages=3)
session.retain_recent_legal_suffix(3)
assert _contents(session.messages) == _contents(expected)
def test_retain_extend_to_user_keeps_delivery_before_recovered_user():
session = Session(key="test:extend-delivery")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append({"role": "assistant", "content": "work"})
session.messages.append(_delivery("Reminder: deploy at 17:00"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "a1"})
session.messages.append({"role": "assistant", "content": "a2"})
session.messages.append({"role": "assistant", "content": "a3"})
session.retain_recent_legal_suffix(3, extend_to_user=True)
assert _has_delivery(session.messages), "delivery dropped by extend_to_user trim"
assert session.messages[0]["content"] == "Reminder: deploy at 17:00"
assert session.messages[-1]["content"] == "a3"
def test_retain_extend_to_user_matches_get_history_boundary():
session = Session(key="test:extend-boundary")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append({"role": "assistant", "content": "work"})
session.messages.append(_delivery("Reminder: review the draft"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "a1"})
session.messages.append({"role": "assistant", "content": "a2"})
session.messages.append({"role": "assistant", "content": "a3"})
expected = session.get_history(max_messages=3, extend_to_user=True)
session.retain_recent_legal_suffix(3, extend_to_user=True)
assert _contents(session.messages) == _contents(expected)
def test_retain_extend_to_user_does_not_extend_delivery_only_tail():
session = Session(key="test:extend-no-user")
for i in range(4):
session.messages.append(_delivery(f"notification {i}"))
session.retain_recent_legal_suffix(3, extend_to_user=True)
assert _contents(session.messages) == [
"notification 1",
"notification 2",
"notification 3",
]
# --- Only the immediately-preceding delivery is part of the anchor ---
def test_retain_keeps_only_immediate_delivery():
session = Session(key="test:multi-delivery")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("old scheduled note"))
session.messages.append(_delivery("new scheduled note"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "great"})
session.retain_recent_legal_suffix(3)
kept = _contents(session.messages)
assert kept == ["new scheduled note", "ok", "great"], kept
def test_retain_drops_delivery_not_adjacent_to_anchor_user():
"""A delivery that does not immediately precede the retained user turn is
not part of the anchor and should not be force-retained."""
session = Session(key="test:nonadjacent")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("unrelated scheduled note"))
session.messages.append({"role": "assistant", "content": "reply"})
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "great"})
session.retain_recent_legal_suffix(2)
assert not _has_delivery(session.messages)
assert _contents(session.messages) == ["ok", "great"]
# --- Delivery preservation through the production entry points ---
def test_enforce_file_cap_keeps_delivery_in_session():
session = Session(key="test:cap-delivery")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("Remember to drink water"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "great"})
archived: list[list[dict]] = []
session.enforce_file_cap(on_archive=archived.append, limit=3)
archived_flat = [m for chunk in archived for m in chunk]
assert _has_delivery(session.messages)
assert not any(m.get("_channel_delivery") for m in archived_flat)
def test_enforce_file_cap_archives_only_prefix():
session = Session(key="test:cap-prefix")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append({"role": "assistant", "content": "first reply"})
session.messages.append(_delivery("Remember to drink water"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "great"})
archived: list[list[dict]] = []
session.enforce_file_cap(on_archive=archived.append, limit=3)
archived_flat = [m for chunk in archived for m in chunk]
assert _has_delivery(session.messages)
assert _contents(archived_flat) == ["setup", "first reply"]
def test_compact_probe_keeps_delivery_in_visible_suffix():
"""compact_idle_session() trims a probe copy with extend_to_user=True; the
visible suffix it keeps must still contain the delivery message."""
tail = [
{"role": "user", "content": "setup"},
{"role": "assistant", "content": "work"},
_delivery("Reminder: deploy at 17:00"),
{"role": "user", "content": "ok"},
{"role": "assistant", "content": "a1"},
{"role": "assistant", "content": "a2"},
{"role": "assistant", "content": "a3"},
]
probe = Session(key="test:probe", messages=tail, last_consolidated=0)
probe.retain_recent_legal_suffix(3, extend_to_user=True)
assert _has_delivery(probe.messages)
assert probe.messages[0]["content"] == "Reminder: deploy at 17:00"
# --- Trimming must stay coherent with the rest of replay ---
def test_retain_then_replay_keeps_delivery_and_no_orphans():
session = Session(key="test:replay-after-trim")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append(_delivery("You have 3 pending tasks"))
session.messages.append({"role": "user", "content": "show them"})
session.messages.extend(_tool_turn("cur", 0))
session.messages.append({"role": "assistant", "content": "done"})
session.retain_recent_legal_suffix(6)
assert _has_delivery(session.messages)
history = session.get_history(max_messages=500)
_assert_no_orphans(history)
assert any(m.get("content") == "You have 3 pending tasks" for m in history)
def test_retain_keeps_delivery_when_user_inside_window():
"""When the capped window already contains a user, its immediately
preceding delivery must stay attached to it."""
session = Session(key="test:window-user")
session.messages.append({"role": "user", "content": "setup"})
session.messages.append({"role": "assistant", "content": "a0"})
session.messages.append(_delivery("Reminder"))
session.messages.append({"role": "user", "content": "ok"})
session.messages.append({"role": "assistant", "content": "a1"})
session.messages.append({"role": "assistant", "content": "a2"})
expected = session.get_history(max_messages=4)
session.retain_recent_legal_suffix(4)
assert _has_delivery(session.messages)
assert _contents(session.messages) == _contents(expected)
+37 -39
View File
@@ -12,7 +12,6 @@ from nanobot.agent.tools.context import RequestContext, request_context
from nanobot.agent.tools.loader import ToolLoader
from nanobot.agent.tools.registry import ToolRegistry
from nanobot.agent.tools.sessions import ReadSessionTool, SearchSessionsTool
from nanobot.bus.events import INBOUND_META_SESSION_READ_SCOPE
from nanobot.runtime_context import RuntimeContextBlock, append_runtime_context
from nanobot.session.manager import SessionManager
from nanobot.webui.transcript import append_transcript_object
@@ -46,7 +45,6 @@ def _webui_request(
channel="websocket",
chat_id=session_key.removeprefix("websocket:"),
session_key=session_key,
metadata={INBOUND_META_SESSION_READ_SCOPE: "websocket:"},
))
@@ -56,22 +54,29 @@ def test_session_tools_are_discovered() -> None:
assert {"ReadSessionTool", "SearchSessionsTool"} <= names
def test_session_tools_are_visible_only_in_an_authorized_request(tmp_path) -> None:
def test_session_tools_stay_visible_when_enabled(tmp_path) -> None:
manager = SessionManager(tmp_path)
registry = ToolRegistry()
registry.register(SearchSessionsTool(manager))
registry.register(ReadSessionTool(manager))
assert registry.get_definitions() == []
with _webui_request():
names = {
definition["function"]["name"]
for definition in registry.get_definitions()
}
names = {
definition["function"]["name"]
for definition in registry.get_definitions()
}
assert names == {"read_session", "search_sessions"}
def test_session_tools_do_not_own_runtime_context(tmp_path) -> None:
manager = SessionManager(tmp_path)
registry = ToolRegistry()
registry.register(SearchSessionsTool(manager))
registry.register(ReadSessionTool(manager))
assert registry.get_runtime_context_providers() == []
@pytest.mark.asyncio
async def test_search_sessions_reads_the_full_webui_transcript_after_compaction(
tmp_path,
@@ -242,7 +247,7 @@ async def test_read_session_reports_invalid_requests(tmp_path):
@pytest.mark.asyncio
async def test_session_tools_reject_unscoped_and_out_of_scope_sessions(tmp_path):
async def test_session_tools_read_persisted_sessions_from_any_channel(tmp_path):
manager = SessionManager(tmp_path)
_save_session(
manager,
@@ -252,8 +257,14 @@ async def test_session_tools_reject_unscoped_and_out_of_scope_sessions(tmp_path)
)
_save_session(
manager,
"slack:private",
title="Private",
"slack:history",
title="Slack history",
messages=[{"role": "user", "content": "needle"}],
)
_save_session(
manager,
"telegram:external",
title="Current",
messages=[{"role": "user", "content": "needle"}],
)
tools = SearchSessionsTool(manager), ReadSessionTool(manager)
@@ -263,31 +274,22 @@ async def test_session_tools_reject_unscoped_and_out_of_scope_sessions(tmp_path)
chat_id="external",
session_key="telegram:external",
)):
search = await tools[0].execute(query="needle")
read = await tools[1].execute(session_key="websocket:visible")
assert search.is_error
assert read.is_error
with request_context(RequestContext(
channel="websocket",
chat_id="spoofed",
session_key="websocket:spoofed",
metadata={"webui": True},
)):
spoofed = await tools[0].execute(query="needle")
with _webui_request():
search = _decode(await tools[0].execute(query="needle"))
read = await tools[1].execute(session_key="slack:private")
websocket_read = _decode(await tools[1].execute(session_key="websocket:visible"))
slack_read = _decode(await tools[1].execute(session_key="slack:history"))
current_read = await tools[1].execute(session_key="telegram:external")
assert spoofed.is_error
assert [row["session_key"] for row in search["results"]] == ["websocket:visible"]
assert read.is_error
assert {row["session_key"] for row in search["results"]} == {
"websocket:visible",
"slack:history",
}
assert websocket_read["session_key"] == "websocket:visible"
assert slack_read["session_key"] == "slack:history"
assert current_read.is_error and "session not found" in str(current_read)
@pytest.mark.asyncio
async def test_session_tools_use_the_scope_granted_by_the_channel(tmp_path):
async def test_session_tools_work_without_request_context(tmp_path):
manager = SessionManager(tmp_path)
_save_session(
manager,
@@ -296,12 +298,8 @@ async def test_session_tools_use_the_scope_granted_by_the_channel(tmp_path):
messages=[{"role": "user", "content": "custom needle"}],
)
with request_context(RequestContext(
channel="custom",
chat_id="current",
session_key="custom:current",
metadata={INBOUND_META_SESSION_READ_SCOPE: "custom:"},
)):
result = _decode(await SearchSessionsTool(manager).execute(query="needle"))
result = _decode(await SearchSessionsTool(manager).execute(query="needle"))
read = _decode(await ReadSessionTool(manager).execute(session_key="custom:history"))
assert [row["session_key"] for row in result["results"]] == ["custom:history"]
assert read["session_key"] == "custom:history"
+4 -1
View File
@@ -686,7 +686,10 @@ def test_provider_login_openai_codex_handles_missing_oauth_symbol(monkeypatch):
result = runner.invoke(app, ["provider", "login", "openai-codex"])
assert result.exit_code == 1
assert "oauth_cli_kit not installed" in result.stdout
assert (
"This nanobot installation is missing the required oauth-cli-kit package. "
"Reinstall or upgrade nanobot-ai using the same installation method."
) in re.sub(r"\s+", " ", result.stdout)
assert result.exception is not None
+123
View File
@@ -0,0 +1,123 @@
from __future__ import annotations
import json
from nanobot.config.loader import load_config, save_config
from nanobot.config.schema import Config
from nanobot.config.timezone import detect_system_timezone
def test_new_config_detects_backend_timezone(monkeypatch) -> None:
monkeypatch.setattr(
"nanobot.config.timezone.get_localzone_name",
lambda: "Asia/Shanghai",
)
config = Config()
assert config.agents.defaults.timezone == "Asia/Shanghai"
assert config.agents.defaults.timezone_mode == "auto"
def test_legacy_config_preserves_explicit_timezone(tmp_path, monkeypatch) -> None:
monkeypatch.setattr(
"nanobot.config.timezone.get_localzone_name",
lambda: "Asia/Shanghai",
)
config_path = tmp_path / "config.json"
config_path.write_text(
json.dumps({"agents": {"defaults": {"timezone": "America/New_York"}}}),
encoding="utf-8",
)
config = load_config(config_path)
assert config.agents.defaults.timezone == "America/New_York"
assert config.agents.defaults.timezone_mode == "manual"
def test_auto_timezone_is_detected_by_backend_on_load(tmp_path, monkeypatch) -> None:
monkeypatch.setattr(
"nanobot.config.timezone.get_localzone_name",
lambda: "Asia/Shanghai",
)
config_path = tmp_path / "config.json"
config_path.write_text(
json.dumps(
{
"agents": {
"defaults": {
"timezone": "UTC",
"timezoneMode": "auto",
}
}
}
),
encoding="utf-8",
)
config = load_config(config_path)
assert config.agents.defaults.timezone == "Asia/Shanghai"
assert config.agents.defaults.timezone_mode == "auto"
def test_manual_timezone_serializes_explicit_provenance(tmp_path) -> None:
config_path = tmp_path / "config.json"
config = Config.model_validate(
{"agents": {"defaults": {"timezone": "America/New_York"}}}
)
save_config(config, config_path)
saved = json.loads(config_path.read_text(encoding="utf-8"))
assert saved["agents"]["defaults"]["timezone"] == "America/New_York"
assert saved["agents"]["defaults"]["timezoneMode"] == "manual"
def test_onboard_refresh_materializes_manual_timezone_mode(tmp_path, monkeypatch) -> None:
config_path = tmp_path / "config.json"
workspace = tmp_path / "workspace"
config_path.write_text(
json.dumps({"agents": {"defaults": {"timezone": "America/New_York"}}}),
encoding="utf-8",
)
monkeypatch.setattr("nanobot.config.loader.get_config_path", lambda: config_path)
monkeypatch.setattr(
"nanobot.cli.commands.get_workspace_path",
lambda _workspace=None: workspace,
)
monkeypatch.setattr("nanobot.cli.commands._onboard_plugins", lambda _path: None)
from typer.testing import CliRunner
from nanobot.cli.commands import app
result = CliRunner().invoke(app, ["onboard", "--refresh"])
assert result.exit_code == 0, result.output
saved = json.loads(config_path.read_text(encoding="utf-8"))
defaults = saved["agents"]["defaults"]
assert defaults["timezone"] == "America/New_York"
assert defaults["timezoneMode"] == "manual"
def test_backend_timezone_detection_falls_back_to_utc(monkeypatch) -> None:
def unavailable_timezone() -> str:
raise OSError("timezone unavailable")
monkeypatch.setattr(
"nanobot.config.timezone.get_localzone_name",
unavailable_timezone,
)
assert detect_system_timezone() == "UTC"
def test_backend_timezone_detection_normalizes_utc_aliases(monkeypatch) -> None:
monkeypatch.setattr(
"nanobot.config.timezone.get_localzone_name",
lambda: "Etc/UTC",
)
assert detect_system_timezone() == "UTC"

Some files were not shown because too many files have changed in this diff Show More