@adecore/agents 0.21.0 → 0.21.1

package/src/chat/ui-queries.ts

@@ -7,10 +7,9 @@ import type {
     ChatInfo,
     ChatUiChoicePayload,
     ChatUiQueryPayload,
-    ChatUiQueryReading,
-    ChatUiQueryState
+    ChatUiQueryReading
 } from '@adecore/agent-contracts';
-import { copyUiValue, UiBudget, type UiValue } from '@adecore/intelligent-ui';
+import { copyUiValue, UI_HOST_LIMITS, UiBudget, uiMayReferenceHost, type UiValue } from '@adecore/intelligent-ui';
 import { UiLinkResolutionSchema, uiLinkTargets, type UiLinkTarget } from '@adecore/intelligent-ui/links';
 import { uiQueryArguments, uiQueryFallback } from '@adecore/intelligent-ui/query';
 import type { UiBlock } from '@adecore/intelligent-ui/compiler';
@@ -36,17 +35,42 @@ interface CachedReading {
     reading: ChatUiQueryReading;
 }
 
+/*
+ * A failure a client can say in its own words: `reason` is a code that stays the same across versions,
+ * the message is the fallback for a client that does not know the code.
+ */
+class UiQueryError extends ChatError<string> {
+    readonly reason: string;
+
+    constructor(code: string, reason: string, message: string) {
+        super(code, message);
+        this.reason = reason;
+    }
+}
+
+/*
+ * What a host's `authorize`, `read` or `link` throws to say why with a code: `code` reaches the reading's
+ * `code` and should stay the same across versions, `reason` is the plain sentence a client shows without it.
+ */
+export class ChatUiRefusal extends UiQueryError {
+    constructor(code: string, reason: string) {
+        super('refused-query', code, reason);
+    }
+}
+
 const MAX_QUERY_BYTES = 64 * 1024;
 const MAX_SNAPSHOT_BYTES = 128 * 1024;
-const MAX_QUERIES = 8;
-const REFRESH_MS = 10_000;
 const READ_TIMEOUT_MS = 8_000;
+// A changed input reads at once, but a query never reads more often than this across its inputs.
+const INPUT_READ_MS = 250;
 
 export class ChatUiQueries {
     readonly schemas: Record<string, z.ZodType>;
-    private readonly captures = new Map<string, Promise<ChatUiQueryState>>();
+    private readonly captures = new Map<string, Promise<unknown>>();
     private readonly freezing = new Set<string>();
     private readonly cache = new Map<string, CachedReading>();
+    // The read id of the newest reading per cache key, which a remount or a second client is answered with.
+    private readonly latest = new Map<string, string>();
     private readonly reading = new Map<string, Promise<ChatUiQueryReading>>();
     private readonly attempts = new Map<string, number>();
     private readonly active = new Map<string, number>();
@@ -60,14 +84,16 @@ export class ChatUiQueries {
     }
 
     observe(session: ChatSession, item: ChatAssistantItem, final: boolean): void {
-        if (!item.text.includes('@Query') && !/<(?:File|Diff|Commit|Node)\b/.test(item.text) && !item.ui?.some((block) => Object.keys(block.queries).length)) {
+        const key = `${session.id}:${item.id}`;
+        // Once a capture started, every delta of a streaming reply would scan its whole text again for nothing.
+        const captured = this.captures.has(key) || item.uiQueries?.authorChatId === session.id;
+        if (!captured && !uiMayReferenceHost(item.text) && !item.ui?.some((block) => Object.keys(block.queries).length)) {
             return;
         }
         const capture = this.access(session, item);
         if (!final || !item.ui?.length) {
             return;
         }
-        const key = `${session.id}:${item.id}`;
         if (this.freezing.has(key)) {
             return;
         }
@@ -84,7 +110,7 @@ export class ChatUiQueries {
                     }
                     const readings: Record<string, ChatUiQueryReading> = Object.create(null);
                     const values: Record<string, unknown> = Object.create(null);
-                    for (const name of Object.keys(block.queries).slice(0, MAX_QUERIES)) {
+                    for (const name of Object.keys(block.queries).slice(0, UI_HOST_LIMITS.queries)) {
                         const reading = await this.query(session, {
                             chatId: session.id,
                             itemId: item.id,
@@ -101,11 +127,11 @@ export class ChatUiQueries {
                     if (this.host.link) {
                         const targets = uiLinkTargets(block, {}, values);
                         const access = await this.access(session, current);
-                        for (const [id, target] of Object.entries(targets).slice(0, 64)) {
+                        for (const [id, target] of Object.entries(targets).slice(0, UI_HOST_LIMITS.links)) {
                             try {
-                                links[id] = this.linkReading(await this.host.link(session.info, access.access, target));
+                                links[id] = this.linkReading(await this.host.link(session.info, access, target));
                             } catch (error) {
-                                links[id] = { state: 'plain', reason: this.reason(error) };
+                                links[id] = { state: 'plain', ...this.failure(error) };
                             }
                         }
                     }
@@ -131,10 +157,12 @@ export class ChatUiQueries {
                         frozen.readings = Object.fromEntries(
                             Object.keys(readings).map((name) => [
                                 name,
-                                { state: 'failed', readAt: Date.now(), reason: 'The frozen query values are too large.' }
+                                { state: 'failed', readAt: Date.now(), code: 'snapshot-too-large', reason: 'The frozen query values are too large.' }
                             ])
                         );
-                        frozen.links = Object.fromEntries(Object.keys(links).map((id) => [id, { state: 'plain', reason: 'This link must be checked again.' }]));
+                        frozen.links = Object.fromEntries(
+                            Object.keys(links).map((id) => [id, { state: 'plain', code: 'link-unchecked', reason: 'This link must be checked again.' }])
+                        );
                         frozen.fallback = `${block.fallback.slice(0, 2048)}\nSources: ${names}\nThe frozen query values are too large.`;
                     }
                     if (Buffer.byteLength(JSON.stringify(blocks)) > MAX_SNAPSHOT_BYTES) {
@@ -147,17 +175,19 @@ export class ChatUiQueries {
             .finally(() => this.freezing.delete(key));
     }
 
-    private access(session: ChatSession, item: ChatAssistantItem): Promise<ChatUiQueryState> {
+    /* The writer's access for a reply, captured once; null where it was denied or is unavailable. */
+    private access(session: ChatSession, item: ChatAssistantItem): Promise<unknown> {
         const key = `${session.id}:${item.id}`;
         const existing = this.captures.get(key);
         if (existing) {
             return existing;
         }
         if (item.uiQueries?.authorChatId === session.id) {
-            return Promise.resolve(item.uiQueries);
+            return Promise.resolve(session.uiAccess(item.id) ?? null);
         }
         // A pending capture is persisted as denied, so a restart cannot widen the writer's rights.
-        session.updateUiQueries(item.id, { authorChatId: session.id, access: null, blocks: {} });
+        session.setUiAccess(item.id, null);
+        session.updateUiQueries(item.id, { authorChatId: session.id, blocks: {} });
         const captured = this.host
             .capture(session.info)
             .then((access) => {
@@ -165,11 +195,10 @@ export class ChatUiQueries {
                 if (Buffer.byteLength(JSON.stringify(captured)) > 32 * 1024) {
                     throw new Error('The UI access snapshot is too large.');
                 }
-                const state: ChatUiQueryState = { authorChatId: session.id, access: captured, blocks: {} };
-                session.updateUiQueries(item.id, state);
-                return state;
+                session.setUiAccess(item.id, captured);
+                return captured as unknown;
             })
-            .catch(() => ({ authorChatId: session.id, access: null, blocks: {} }))
+            .catch(() => null)
             .finally(() => this.captures.delete(key));
         this.captures.set(key, captured);
         return captured;
@@ -183,19 +212,19 @@ export class ChatUiQueries {
         const block =
             item?.kind === 'assistant' && !item.streaming && !item.parentToolUseId ? item.ui?.find((entry) => entry.id === payload.blockId) : undefined;
         if (item?.kind !== 'assistant' || !block?.complete || block.revision !== payload.revision) {
-            throw new ChatError('stale-ui-block', 'This completed UI block is no longer available.');
+            throw new UiQueryError('stale-ui-block', 'block-stale', 'This completed UI block is no longer available.');
         }
         return { item, block };
     }
 
     private stored(session: ChatSession, payload: ChatUiQueryPayload): { item: ChatAssistantItem; block: UiBlock; source: ChatUiSource } {
         const { item, block } = this.storedBlock(session, payload);
-        if (!Object.hasOwn(block.queries, payload.query) || Object.keys(block.queries).length > MAX_QUERIES) {
-            throw new ChatError('refused-query', 'This block does not declare an allowed query.');
+        if (!Object.hasOwn(block.queries, payload.query) || Object.keys(block.queries).length > UI_HOST_LIMITS.queries) {
+            throw new UiQueryError('refused-query', 'query-undeclared', 'This block does not declare an allowed query.');
         }
         const name = block.queries[payload.query].source;
         if (!Object.hasOwn(this.host.sources, name)) {
-            throw new ChatError('refused-query', 'This query source is not registered.');
+            throw new UiQueryError('refused-query', 'source-unregistered', 'This query source is not registered.');
         }
         return { item, block, source: this.host.sources[name] };
     }
@@ -210,18 +239,17 @@ export class ChatUiQueries {
             ({ source, block, item } = this.stored(session, payload));
             args = uiQueryArguments(block, payload.query, payload.values);
             args = source.args.parse(args) as Record<string, UiValue>;
-            const access = await this.access(session, item);
-            if (access.access === null) {
-                throw new ChatError('refused-query', 'The writer’s original access is unavailable.');
+            authorAccess = await this.access(session, item);
+            if (authorAccess === null) {
+                throw new UiQueryError('refused-query', 'access-unavailable', 'The writer’s original access is unavailable.');
             }
-            authorAccess = access.access;
             await source.authorize(session.info, authorAccess, args);
         } catch (error) {
-            return { state: 'refused', readAt: Date.now(), reason: this.reason(error) };
+            return { state: 'refused', readAt: Date.now(), ...this.failure(error) };
         }
         const key = JSON.stringify([session.id, item.id, block.id, block.revision, payload.query, args]);
-        const cached = [...this.cache.values()].find((entry) => entry.key === key);
-        if (cached && Date.now() - cached.reading.readAt < REFRESH_MS) {
+        const cached = this.cache.get(this.latest.get(key) ?? '');
+        if (cached && Date.now() - cached.reading.readAt < UI_HOST_LIMITS.refreshMilliseconds) {
             return cached.reading;
         }
         const pending = this.reading.get(key);
@@ -229,14 +257,19 @@ export class ChatUiQueries {
             return pending;
         }
         const identity = JSON.stringify([session.id, item.id, block.id, block.revision, payload.query]);
-        if (Date.now() - (this.attempts.get(identity) ?? 0) < REFRESH_MS) {
-            return { state: 'failed', readAt: Date.now(), reason: 'This query may refresh once every ten seconds.' };
+        const now = Date.now();
+        if (
+            now - (this.attempts.get(key) ?? -Infinity) < UI_HOST_LIMITS.refreshMilliseconds ||
+            now - (this.attempts.get(identity) ?? -Infinity) < INPUT_READ_MS
+        ) {
+            return { state: 'failed', readAt: now, code: 'refresh-limit', reason: 'This query may refresh once every ten seconds.' };
         }
         if ((this.active.get(session.id) ?? 0) >= 2 || this.totalActive >= 16) {
-            return { state: 'failed', readAt: Date.now(), reason: 'Too many UI queries are being read.' };
+            return { state: 'failed', readAt: now, code: 'busy', reason: 'Too many UI queries are being read.' };
         }
-        this.attempts.set(identity, Date.now());
-        while (this.attempts.size > 128) {
+        this.attempts.set(key, now);
+        this.attempts.set(identity, now);
+        while (this.attempts.size > 256) {
             this.attempts.delete(this.attempts.keys().next().value!);
         }
         this.active.set(session.id, (this.active.get(session.id) ?? 0) + 1);
@@ -247,21 +280,26 @@ export class ChatUiQueries {
         timeout.unref?.();
         const read = Promise.race([
             work,
-            new Promise<never>((_, reject) => controller.signal.addEventListener('abort', () => reject(new Error('The UI query timed out.')), { once: true }))
+            new Promise<never>((_, reject) =>
+                controller.signal.addEventListener('abort', () => reject(new UiQueryError('refused-query', 'timed-out', 'The UI query timed out.')), {
+                    once: true
+                })
+            )
         ])
             .then((result): ChatUiQueryReading => {
                 const value = copyUiValue(source.result.parse(result), new UiBudget());
                 if (Buffer.byteLength(JSON.stringify(value)) > MAX_QUERY_BYTES) {
-                    throw new Error('The UI query result is too large.');
+                    throw new UiQueryError('refused-query', 'result-too-large', 'The UI query result is too large.');
                 }
                 const reading: ChatUiQueryReading = { state: 'fresh', value, readId: randomUUID(), readAt: Date.now() };
                 this.cache.set(reading.readId!, { key, chatId: session.id, reading });
+                this.latest.set(key, reading.readId!);
                 while (this.cache.size > 128) {
-                    this.cache.delete(this.cache.keys().next().value!);
+                    this.evict(this.cache.keys().next().value!);
                 }
                 return reading;
             })
-            .catch((error): ChatUiQueryReading => ({ state: 'failed', readAt: Date.now(), reason: this.reason(error) }))
+            .catch((error): ChatUiQueryReading => ({ state: 'failed', readAt: Date.now(), ...this.failure(error) }))
             .finally(() => {
                 clearTimeout(timeout);
                 this.reading.delete(key);
@@ -282,32 +320,41 @@ export class ChatUiQueries {
         return read;
     }
 
+    /* The issued value of every query the block declares, each checked against the read id the person saw. */
     async choiceValues(session: ChatSession, payload: ChatUiChoicePayload | ChatUiLinkPayload): Promise<Record<string, unknown>> {
         const item = session.thread.get(payload.itemId);
         const block = item?.kind === 'assistant' ? item.ui?.find((entry) => entry.id === payload.blockId) : undefined;
         if (!block || item?.kind !== 'assistant' || ('choiceId' in payload && item.uiAnswers?.[block.id]?.revision === payload.revision)) {
             return {};
         }
+        const names = Object.keys(block.queries);
         const values: Record<string, unknown> = Object.create(null);
-        for (const name of Object.keys(payload.reads ?? {})) {
-            const identity = { ...payload, query: name };
-            const { source } = this.stored(session, identity);
+        if (names.length === 0) {
+            return values;
+        }
+        const access = await this.access(session, item);
+        if (access === null) {
+            throw new UiQueryError('refused-query', 'access-unavailable', 'The writer’s original access is unavailable.');
+        }
+        for (const name of names) {
+            const { source } = this.stored(session, { ...payload, query: name });
             const args = source.args.parse(uiQueryArguments(block, name, payload.values)) as Record<string, UiValue>;
-            const access = await this.access(session, item);
-            await source.authorize(session.info, access.access, args);
+            await source.authorize(session.info, access, args);
+            const readId = payload.reads !== undefined && Object.hasOwn(payload.reads, name) ? payload.reads[name] : undefined;
             const key = JSON.stringify([session.id, item.id, block.id, block.revision, name, args]);
-            const readId = payload.reads![name];
-            const cached = this.cache.get(readId);
+            const cached = readId === undefined ? undefined : this.cache.get(readId);
             const frozen = item.uiQueries?.blocks[block.id];
             const snapshot = frozen?.revision === block.revision ? frozen?.readings[name] : undefined;
             const reading =
-                cached?.key === key
-                    ? cached.reading
-                    : snapshot?.readId === readId && JSON.stringify(args) === JSON.stringify(source.args.parse(uiQueryArguments(block, name)))
-                      ? snapshot
-                      : undefined;
+                readId === undefined
+                    ? undefined
+                    : cached?.key === key
+                      ? cached.reading
+                      : snapshot?.readId === readId && JSON.stringify(args) === JSON.stringify(source.args.parse(uiQueryArguments(block, name)))
+                        ? snapshot
+                        : undefined;
             if (!reading || reading.state !== 'fresh') {
-                throw new ChatError('stale-ui-query', 'Refresh this query before sending its choice.');
+                throw new UiQueryError('stale-ui-query', 'stale-read', 'Refresh this query before sending its choice.');
             }
             values[name] = reading.value;
         }
@@ -317,35 +364,43 @@ export class ChatUiQueries {
     async link(session: ChatSession, payload: ChatUiLinkPayload): Promise<ChatUiLinkReading> {
         try {
             if (!this.host.link) {
-                throw new ChatError('refused-query', 'This host does not provide UI links.');
+                throw new UiQueryError('refused-query', 'links-unsupported', 'This host does not provide UI links.');
             }
             const { item, block } = this.storedBlock(session, payload);
             if (!item.uiQueries) {
-                throw new ChatError('refused-query', 'The writer’s original access is unavailable.');
+                throw new UiQueryError('refused-query', 'access-unavailable', 'The writer’s original access is unavailable.');
             }
             const access = await this.access(session, item);
-            if (access.access === null) {
-                throw new ChatError('refused-query', 'The writer’s original access is unavailable.');
+            if (access === null) {
+                throw new UiQueryError('refused-query', 'access-unavailable', 'The writer’s original access is unavailable.');
             }
             const queries = await this.choiceValues(session, payload);
             const target = uiLinkTargets(block, payload.values, queries)[payload.nodeId];
             if (!target) {
-                throw new ChatError('refused-query', 'This visible node is not a supported link.');
+                throw new UiQueryError('refused-query', 'link-unsupported', 'This visible node is not a supported link.');
             }
-            return this.linkReading(await this.host.link(session.info, access.access, target));
+            return this.linkReading(await this.host.link(session.info, access, target));
         } catch (error) {
-            return { state: 'plain', reason: this.reason(error) };
+            return { state: 'plain', ...this.failure(error) };
         }
     }
 
     forget(chatId: string): void {
         for (const [id, cached] of this.cache) {
             if (cached.chatId === chatId) {
-                this.cache.delete(id);
+                this.evict(id);
             }
         }
     }
 
+    private evict(readId: string): void {
+        const cached = this.cache.get(readId);
+        this.cache.delete(readId);
+        if (cached && this.latest.get(cached.key) === readId) {
+            this.latest.delete(cached.key);
+        }
+    }
+
     private linkReading(value: unknown): ChatUiLinkReading {
         const reading = UiLinkResolutionSchema.parse(copyUiValue(value, new UiBudget()));
         if (reading.state === 'chip' && !reading.target) {
@@ -354,7 +409,8 @@ export class ChatUiQueries {
         return reading;
     }
 
-    private reason(error: unknown): string {
-        return (error instanceof Error ? error.message : 'This query could not be read.').slice(0, 240);
+    private failure(error: unknown): { reason: string; code?: string } {
+        const reason = (error instanceof Error ? error.message : 'This query could not be read.').slice(0, 240);
+        return error instanceof UiQueryError ? { reason, code: error.reason } : { reason };
     }
 }

package/src/host/handlers.ts

@@ -66,7 +66,7 @@ export function chatHandlers(chats: ChatCore, providers: ProviderRegistry): { [T
                 { delivery: payload.delivery, mentions: payload.mentions, skills: payload.skills, chats: payload.chats },
                 payload.attachments
             ),
-        'chat.uiChoice': (payload) => chats.choose(payload),
+        'chat.uiChoice': (payload, clientId) => chats.choose(payload, clientId),
         'ui.link': (payload, clientId) => chats.linkUi(payload, clientId),
         'ui.query': (payload, clientId) => chats.queryUi(payload, clientId),
         'chat.unqueue': (payload) => ({ message: chats.unqueue(payload.chatId, payload.messageId) }),

package/src/tasks/task-coordinator.ts

@@ -1,6 +1,7 @@
 import type { ChatBackgroundTask, ChatItem, ChatTurnItem, Task, TaskResult } from '@adecore/agent-contracts';
 import { abortedByMachine, clipText } from '@adecore/agent-contracts';
 import { BACKGROUND_COMMAND_LIMIT_MS, commandLabel, isBackgroundWork, runningInBackground, runsInBackground } from '../chat/background-work.ts';
+import { readableAssistantText } from '../chat/readable-text.ts';
 import { errorText } from '../error-text.ts';
 import type { AgentEvent } from '../events.ts';
 import type { TaskStore } from './task-store.ts';
@@ -40,8 +41,11 @@ export interface TaskCoordinatorDeps {
 function answerOf(items: readonly ChatItem[], turnId: string): string | null {
     for (let i = items.length - 1; i >= 0; i--) {
         const item = items[i]!;
-        if (item.kind === 'assistant' && item.turnId === turnId && !item.parentToolUseId && item.text.trim() !== '') {
-            return item.text.trim();
+        if (item.kind === 'assistant' && item.turnId === turnId && !item.parentToolUseId) {
+            const text = readableAssistantText(item).trim();
+            if (text !== '') {
+                return text;
+            }
         }
     }
     return null;