Compare commits
2 Commits
ab126825ef
...
92945b777d
| Author | SHA1 | Date | |
|---|---|---|---|
| 92945b777d | |||
| 8774cfd7cc |
@@ -72,6 +72,12 @@ Two ways, both write the same identity registry the transport reads:
|
||||
`FABRIC_BACKEND_GUILD_COMMANDS_SYNC_KEY` (Guild C-2). Read it from the
|
||||
guild with `docker exec fabric-backend-guild node dist/cli/print-commands-sync-key.js`.
|
||||
Sourced from config only — never from the environment.
|
||||
- `channels.fabric.coalesce` — default `true`. OpenClaw splits one agent
|
||||
turn whose blocks are `text → thinking/tool → text` into multiple
|
||||
`deliver()` calls; this buffers them and posts ONE Fabric message at the
|
||||
deterministic turn boundary (right after the inbound reply dispatch
|
||||
resolves — no hooks, no timers, no idle guessing). `false` = raw
|
||||
per-segment posting.
|
||||
- `channels.fabric.accounts.<agentId>` = `{ fabricApiKey, enabled }`
|
||||
(**agent = account**; the account id is the OpenClaw agentId)
|
||||
- plugin `identityFilePath` — default `~/.openclaw/fabric-identity.json`
|
||||
|
||||
6
dist/fabric/index.js
vendored
6
dist/fabric/index.js
vendored
@@ -5,6 +5,7 @@
|
||||
// the OpenClawPluginApi for runtime startup (transport + tools).
|
||||
import { defineChannelPluginEntry } from 'openclaw/plugin-sdk/core';
|
||||
import { fabricChannelPlugin } from './src/channel.js';
|
||||
import { flushAllFabric } from './src/coalesce.js';
|
||||
import { FabricInbound } from './src/inbound.js';
|
||||
import { listEnabledFabricAccounts } from './src/accounts.js';
|
||||
import { registerFabricTools } from './src/tools.js';
|
||||
@@ -60,7 +61,12 @@ export default defineChannelPluginEntry({
|
||||
api.logger.info(`fabric: inbound started for ${accounts.length} account(s)`);
|
||||
void syncFabricCommands(client, cfg, accounts, api.logger);
|
||||
});
|
||||
// Note: the per-turn coalesce flush happens deterministically in
|
||||
// inbound.ts right after dispatchInboundReplyWithBase resolves (that
|
||||
// is the real "all deliveries done" boundary; the agent_end hook fires
|
||||
// BEFORE deliver()). gateway_stop only flushes any leftover buffer.
|
||||
api.on('gateway_stop', () => {
|
||||
void flushAllFabric();
|
||||
inbound?.stop();
|
||||
inbound = null;
|
||||
});
|
||||
|
||||
5
dist/fabric/src/accounts.js
vendored
5
dist/fabric/src/accounts.js
vendored
@@ -13,6 +13,11 @@ function section(cfg) {
|
||||
export function resolveCommandsSyncKey(cfg) {
|
||||
return (section(cfg).commandsSyncKey ?? '').trim();
|
||||
}
|
||||
// Whether to coalesce a split agent turn into one Fabric message
|
||||
// (channel-level). Default true.
|
||||
export function resolveCoalesce(cfg) {
|
||||
return (cfg.channels?.fabric ?? {}).coalesce !== false;
|
||||
}
|
||||
export function listFabricAccountIds(cfg) {
|
||||
const accts = section(cfg).accounts ?? {};
|
||||
const ids = Object.keys(accts);
|
||||
|
||||
5
dist/fabric/src/channel.js
vendored
5
dist/fabric/src/channel.js
vendored
@@ -137,7 +137,10 @@ export const fabricChannelPlugin = createChatChannelPlugin({
|
||||
attachedResults: {
|
||||
channel: 'fabric',
|
||||
sendText: async (ctx) => {
|
||||
// openclaw passes config under cfg or config depending on path
|
||||
// openclaw passes config under cfg or config depending on path.
|
||||
// Note: inbound agent replies go through inbound.ts `deliver`
|
||||
// (where turn coalescing happens). This path is for any direct
|
||||
// outbound sends and posts immediately.
|
||||
const cfg = (ctx.cfg ?? ctx.config ?? {});
|
||||
try {
|
||||
const r = await sendToFabric(cfg, ctx.accountId ?? null, ctx.to, ctx.text);
|
||||
|
||||
75
dist/fabric/src/coalesce.js
vendored
Normal file
75
dist/fabric/src/coalesce.js
vendored
Normal file
@@ -0,0 +1,75 @@
|
||||
// Deterministic turn coalescer.
|
||||
//
|
||||
// OpenClaw calls the Fabric `deliver` callback once per assistant text
|
||||
// segment; a thinking/tool block between two text blocks is a delivery
|
||||
// boundary, so one agent turn of `text → thinking/tool → text` arrives as
|
||||
// multiple deliver() calls. There is no turn id on the delivery, so we
|
||||
// BUFFER segments by Fabric channelId and post the merged message when the
|
||||
// turn truly ends. The flush is driven by inbound.ts right after
|
||||
// `dispatchInboundReplyWithBase` resolves — that only happens AFTER every
|
||||
// deliver() of the turn, a deterministic boundary (NOT a timer, NOT the
|
||||
// agent_end hook, which fires before deliver()). `coalesce=false` posts
|
||||
// each segment immediately.
|
||||
const SAFETY_FLUSH_MS = 120_000; // leak-guard only; not the flush mechanism
|
||||
export function normChannelId(x) {
|
||||
const s = String(x ?? '');
|
||||
return s.startsWith('fabric:') ? s.slice('fabric:'.length) : s;
|
||||
}
|
||||
const pendingByChannel = new Map();
|
||||
async function flushChannel(channelId, reason) {
|
||||
const p = pendingByChannel.get(channelId);
|
||||
if (!p)
|
||||
return;
|
||||
pendingByChannel.delete(channelId);
|
||||
clearTimeout(p.safety);
|
||||
const text = p.parts.join('\n\n').trim();
|
||||
if (!text)
|
||||
return;
|
||||
try {
|
||||
await p.post(text);
|
||||
p.log?.(`fabric: flushed ${p.parts.length} segment(s) channel=${channelId} (${reason})`);
|
||||
}
|
||||
catch (e) {
|
||||
p.log?.(`fabric: flush FAILED channel=${channelId} (${reason}): ${String(e)}`);
|
||||
}
|
||||
}
|
||||
// Buffer one delivered segment (or send immediately when coalesce=false).
|
||||
// `post` performs the real Fabric postMessage with the caller's already
|
||||
// resolved guild/token; on flush it is called once with the merged text.
|
||||
export async function enqueueDelivery(params) {
|
||||
const cid = normChannelId(params.channelId);
|
||||
const text = (params.text ?? '').trim();
|
||||
if (!text)
|
||||
return;
|
||||
if (!params.coalesce) {
|
||||
await params.post(text);
|
||||
return;
|
||||
}
|
||||
const existing = pendingByChannel.get(cid);
|
||||
if (existing) {
|
||||
existing.parts.push(text);
|
||||
existing.post = params.post; // freshest guild/token closure
|
||||
existing.log = params.log;
|
||||
}
|
||||
else {
|
||||
pendingByChannel.set(cid, {
|
||||
parts: [text],
|
||||
post: params.post,
|
||||
log: params.log,
|
||||
safety: setTimeout(() => void flushChannel(cid, 'safety-timeout'), SAFETY_FLUSH_MS),
|
||||
});
|
||||
}
|
||||
}
|
||||
// Called by the agent_end hook with the hook ctx's channelId (bare or
|
||||
// fabric:-prefixed). Deterministic per-turn boundary.
|
||||
export async function flushFabricForChannel(rawChannelId) {
|
||||
const cid = normChannelId(rawChannelId);
|
||||
if (cid)
|
||||
await flushChannel(cid, 'dispatch-end');
|
||||
}
|
||||
// gateway_stop: flush anything still buffered.
|
||||
export async function flushAllFabric() {
|
||||
for (const cid of [...pendingByChannel.keys()]) {
|
||||
await flushChannel(cid, 'gateway_stop');
|
||||
}
|
||||
}
|
||||
27
dist/fabric/src/inbound.js
vendored
27
dist/fabric/src/inbound.js
vendored
@@ -3,6 +3,8 @@ import { tmpdir } from 'node:os';
|
||||
import { join } from 'node:path';
|
||||
import { io } from 'socket.io-client';
|
||||
import { dispatchInboundReplyWithBase } from 'openclaw/plugin-sdk/inbound-reply-dispatch';
|
||||
import { resolveCoalesce } from './accounts.js';
|
||||
import { enqueueDelivery, flushFabricForChannel } from './coalesce.js';
|
||||
export class FabricInbound {
|
||||
core;
|
||||
cfg;
|
||||
@@ -199,7 +201,11 @@ export class FabricInbound {
|
||||
// the woken speaker emits a normal message or /no-reply). We still
|
||||
// record the message into the agent's session so it has the full
|
||||
// channel conversation as context whenever it IS later woken.
|
||||
if (m.wakeup !== true) {
|
||||
//
|
||||
// Exception: dm channels are 1:1 — there is no turn/wakeup gating;
|
||||
// any message that isn't the agent's own (already filtered above) is
|
||||
// always delivered to the model.
|
||||
if (m.xType !== 'dm' && m.wakeup !== true) {
|
||||
const ctxPayload = core.channel.reply.finalizeInboundContext(baseCtx);
|
||||
await core.channel.session.recordInboundSession({
|
||||
storePath,
|
||||
@@ -244,8 +250,16 @@ export class FabricInbound {
|
||||
this.log.info(`fabric: deliver agent=${agentId} channel=${channelId} len=${text.length}`);
|
||||
if (!text || !gt)
|
||||
return;
|
||||
await this.client.postMessage(guild.endpoint, gt, channelId, text, session.user.id);
|
||||
this.log.info(`fabric: posted reply agent=${agentId} channel=${channelId}`);
|
||||
// Buffer segments; the merged message is posted right after
|
||||
// dispatch returns (the deterministic turn boundary, see the
|
||||
// finally below). Disable per channel: channels.fabric.coalesce.
|
||||
await enqueueDelivery({
|
||||
channelId,
|
||||
text,
|
||||
coalesce: resolveCoalesce(this.cfg),
|
||||
post: (t) => this.client.postMessage(guild.endpoint, gt, channelId, t, session.user.id),
|
||||
log: (m) => this.log.info(m),
|
||||
});
|
||||
},
|
||||
onRecordError: (err) => this.log.warn(`fabric: session record failed agent=${agentId}: ${String(err)}`),
|
||||
onDispatchError: (err, info) => this.log.warn(`fabric: ${info.kind} dispatch failed agent=${agentId}: ${String(err)}`),
|
||||
@@ -270,5 +284,12 @@ export class FabricInbound {
|
||||
catch (err) {
|
||||
this.log.warn(`fabric: dispatch failed agent=${agentId} channel=${channelId}: ${String(err)}`);
|
||||
}
|
||||
finally {
|
||||
// Deterministic per-turn boundary: dispatchInboundReplyWithBase only
|
||||
// resolves AFTER every deliver() call of this turn has run, so the
|
||||
// buffer now holds all segments — flush them as ONE Fabric message.
|
||||
// No hooks, no timers, no idle guessing.
|
||||
await flushFabricForChannel(channelId);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
8
index.ts
8
index.ts
@@ -6,6 +6,7 @@
|
||||
import { defineChannelPluginEntry } from 'openclaw/plugin-sdk/core';
|
||||
import type { OpenClawPluginApi } from 'openclaw/plugin-sdk/core';
|
||||
import { fabricChannelPlugin } from './src/channel.js';
|
||||
import { flushAllFabric } from './src/coalesce.js';
|
||||
import { FabricInbound } from './src/inbound.js';
|
||||
import { listEnabledFabricAccounts } from './src/accounts.js';
|
||||
import { registerFabricTools } from './src/tools.js';
|
||||
@@ -37,7 +38,7 @@ export default defineChannelPluginEntry({
|
||||
config?: unknown;
|
||||
pluginConfig?: { identityFilePath?: string };
|
||||
logger: { info: (m: string) => void; warn: (m: string) => void };
|
||||
on: (ev: string, fn: () => void) => void;
|
||||
on: (ev: string, fn: (...args: unknown[]) => unknown) => void;
|
||||
registerTool: (d: unknown) => void;
|
||||
};
|
||||
const cfg = (api.config ?? {}) as { channels?: { fabric?: { centerApiBase?: string } } };
|
||||
@@ -86,7 +87,12 @@ export default defineChannelPluginEntry({
|
||||
void syncFabricCommands(client, cfg, accounts, api.logger);
|
||||
});
|
||||
|
||||
// Note: the per-turn coalesce flush happens deterministically in
|
||||
// inbound.ts right after dispatchInboundReplyWithBase resolves (that
|
||||
// is the real "all deliveries done" boundary; the agent_end hook fires
|
||||
// BEFORE deliver()). gateway_stop only flushes any leftover buffer.
|
||||
api.on('gateway_stop', () => {
|
||||
void flushAllFabric();
|
||||
inbound?.stop();
|
||||
inbound = null;
|
||||
});
|
||||
|
||||
@@ -44,6 +44,10 @@
|
||||
"minLength": 1,
|
||||
"description": "Shared secret that must equal the guild's FABRIC_BACKEND_GUILD_COMMANDS_SYNC_KEY. Required to register the slash-command catalog (Guild C-2). Read it from the guild via: docker exec fabric-backend-guild node dist/cli/print-commands-sync-key.js"
|
||||
},
|
||||
"coalesce": {
|
||||
"type": "boolean",
|
||||
"description": "Merge a split agent turn (text → thinking/tool → text) into ONE Fabric message. Flushed deterministically on the agent_end hook. Default true; false = raw per-segment posting."
|
||||
},
|
||||
"dmSecurity": { "type": "string" },
|
||||
"dmPolicy": { "type": "string" },
|
||||
"enabled": { "type": "boolean" },
|
||||
|
||||
@@ -18,6 +18,11 @@ export type FabricChannelConfig = {
|
||||
// (Guild C-2). Required by the channel config schema; sourced from config
|
||||
// only — never from the environment.
|
||||
commandsSyncKey?: string;
|
||||
// Coalesce an agent turn that OpenClaw split into multiple deliveries
|
||||
// (text → thinking/tool → text => N sendText calls) into ONE Fabric
|
||||
// message. The flush boundary is the deterministic `agent_end` hook (not
|
||||
// a timer). Default true; set false for raw per-segment posting.
|
||||
coalesce?: boolean;
|
||||
accounts?: Record<string, FabricAccountConfig>;
|
||||
defaultAccount?: string;
|
||||
} & FabricAccountConfig;
|
||||
@@ -46,6 +51,12 @@ export function resolveCommandsSyncKey(cfg: Cfg): string {
|
||||
return (section(cfg).commandsSyncKey ?? '').trim();
|
||||
}
|
||||
|
||||
// Whether to coalesce a split agent turn into one Fabric message
|
||||
// (channel-level). Default true.
|
||||
export function resolveCoalesce(cfg: Cfg): boolean {
|
||||
return (cfg.channels?.fabric ?? {}).coalesce !== false;
|
||||
}
|
||||
|
||||
export function listFabricAccountIds(cfg: Cfg): string[] {
|
||||
const accts = section(cfg).accounts ?? {};
|
||||
const ids = Object.keys(accts);
|
||||
|
||||
@@ -159,7 +159,10 @@ export const fabricChannelPlugin = createChatChannelPlugin<ResolvedFabricAccount
|
||||
cfg?: unknown;
|
||||
config?: unknown;
|
||||
}) => {
|
||||
// openclaw passes config under cfg or config depending on path
|
||||
// openclaw passes config under cfg or config depending on path.
|
||||
// Note: inbound agent replies go through inbound.ts `deliver`
|
||||
// (where turn coalescing happens). This path is for any direct
|
||||
// outbound sends and posts immediately.
|
||||
const cfg = (ctx.cfg ?? ctx.config ?? {}) as AnyCfg;
|
||||
try {
|
||||
const r = await sendToFabric(cfg, ctx.accountId ?? null, ctx.to, ctx.text);
|
||||
|
||||
93
src/coalesce.ts
Normal file
93
src/coalesce.ts
Normal file
@@ -0,0 +1,93 @@
|
||||
// Deterministic turn coalescer.
|
||||
//
|
||||
// OpenClaw calls the Fabric `deliver` callback once per assistant text
|
||||
// segment; a thinking/tool block between two text blocks is a delivery
|
||||
// boundary, so one agent turn of `text → thinking/tool → text` arrives as
|
||||
// multiple deliver() calls. There is no turn id on the delivery, so we
|
||||
// BUFFER segments by Fabric channelId and post the merged message when the
|
||||
// turn truly ends. The flush is driven by inbound.ts right after
|
||||
// `dispatchInboundReplyWithBase` resolves — that only happens AFTER every
|
||||
// deliver() of the turn, a deterministic boundary (NOT a timer, NOT the
|
||||
// agent_end hook, which fires before deliver()). `coalesce=false` posts
|
||||
// each segment immediately.
|
||||
|
||||
const SAFETY_FLUSH_MS = 120_000; // leak-guard only; not the flush mechanism
|
||||
|
||||
export function normChannelId(x: string | null | undefined): string {
|
||||
const s = String(x ?? '');
|
||||
return s.startsWith('fabric:') ? s.slice('fabric:'.length) : s;
|
||||
}
|
||||
|
||||
type Pending = {
|
||||
parts: string[];
|
||||
post: (text: string) => Promise<void>;
|
||||
log?: (m: string) => void;
|
||||
safety: ReturnType<typeof setTimeout>;
|
||||
};
|
||||
const pendingByChannel = new Map<string, Pending>();
|
||||
|
||||
async function flushChannel(channelId: string, reason: string): Promise<void> {
|
||||
const p = pendingByChannel.get(channelId);
|
||||
if (!p) return;
|
||||
pendingByChannel.delete(channelId);
|
||||
clearTimeout(p.safety);
|
||||
const text = p.parts.join('\n\n').trim();
|
||||
if (!text) return;
|
||||
try {
|
||||
await p.post(text);
|
||||
p.log?.(`fabric: flushed ${p.parts.length} segment(s) channel=${channelId} (${reason})`);
|
||||
} catch (e) {
|
||||
p.log?.(`fabric: flush FAILED channel=${channelId} (${reason}): ${String(e)}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Buffer one delivered segment (or send immediately when coalesce=false).
|
||||
// `post` performs the real Fabric postMessage with the caller's already
|
||||
// resolved guild/token; on flush it is called once with the merged text.
|
||||
export async function enqueueDelivery(params: {
|
||||
channelId: string;
|
||||
text: string;
|
||||
coalesce: boolean;
|
||||
post: (text: string) => Promise<void>;
|
||||
log?: (m: string) => void;
|
||||
}): Promise<void> {
|
||||
const cid = normChannelId(params.channelId);
|
||||
const text = (params.text ?? '').trim();
|
||||
if (!text) return;
|
||||
if (!params.coalesce) {
|
||||
await params.post(text);
|
||||
return;
|
||||
}
|
||||
const existing = pendingByChannel.get(cid);
|
||||
if (existing) {
|
||||
existing.parts.push(text);
|
||||
existing.post = params.post; // freshest guild/token closure
|
||||
existing.log = params.log;
|
||||
} else {
|
||||
pendingByChannel.set(cid, {
|
||||
parts: [text],
|
||||
post: params.post,
|
||||
log: params.log,
|
||||
safety: setTimeout(
|
||||
() => void flushChannel(cid, 'safety-timeout'),
|
||||
SAFETY_FLUSH_MS,
|
||||
),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Called by the agent_end hook with the hook ctx's channelId (bare or
|
||||
// fabric:-prefixed). Deterministic per-turn boundary.
|
||||
export async function flushFabricForChannel(
|
||||
rawChannelId: string | null | undefined,
|
||||
): Promise<void> {
|
||||
const cid = normChannelId(rawChannelId);
|
||||
if (cid) await flushChannel(cid, 'dispatch-end');
|
||||
}
|
||||
|
||||
// gateway_stop: flush anything still buffered.
|
||||
export async function flushAllFabric(): Promise<void> {
|
||||
for (const cid of [...pendingByChannel.keys()]) {
|
||||
await flushChannel(cid, 'gateway_stop');
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,8 @@ import { io, type Socket } from 'socket.io-client';
|
||||
import { dispatchInboundReplyWithBase } from 'openclaw/plugin-sdk/inbound-reply-dispatch';
|
||||
import type { FabricClient, FabricSession } from './fabric-client.js';
|
||||
import type { IdentityRegistry } from './identity.js';
|
||||
import { resolveCoalesce } from './accounts.js';
|
||||
import { enqueueDelivery, flushFabricForChannel } from './coalesce.js';
|
||||
|
||||
// COMPAT NOTE (openclaw v2026.5.7): the inbound path mirrors how bundled
|
||||
// channels (nextcloud-talk) drive the kernel:
|
||||
@@ -42,6 +44,9 @@ type FabricMessage = {
|
||||
channelId?: string;
|
||||
attachments?: FabricAttachment[];
|
||||
wakeup?: boolean;
|
||||
// x-type of the channel (sent on message.created). 'dm' bypasses the
|
||||
// wakeup gate: any message that isn't the agent's own is delivered.
|
||||
xType?: string;
|
||||
};
|
||||
|
||||
export class FabricInbound {
|
||||
@@ -250,7 +255,11 @@ export class FabricInbound {
|
||||
// the woken speaker emits a normal message or /no-reply). We still
|
||||
// record the message into the agent's session so it has the full
|
||||
// channel conversation as context whenever it IS later woken.
|
||||
if (m.wakeup !== true) {
|
||||
//
|
||||
// Exception: dm channels are 1:1 — there is no turn/wakeup gating;
|
||||
// any message that isn't the agent's own (already filtered above) is
|
||||
// always delivered to the model.
|
||||
if (m.xType !== 'dm' && m.wakeup !== true) {
|
||||
const ctxPayload = core.channel.reply.finalizeInboundContext(baseCtx);
|
||||
await core.channel.session.recordInboundSession({
|
||||
storePath,
|
||||
@@ -301,8 +310,17 @@ export class FabricInbound {
|
||||
const text = (payload?.text ?? '').trim();
|
||||
this.log.info(`fabric: deliver agent=${agentId} channel=${channelId} len=${text.length}`);
|
||||
if (!text || !gt) return;
|
||||
await this.client.postMessage(guild.endpoint, gt, channelId, text, session.user.id);
|
||||
this.log.info(`fabric: posted reply agent=${agentId} channel=${channelId}`);
|
||||
// Buffer segments; the merged message is posted right after
|
||||
// dispatch returns (the deterministic turn boundary, see the
|
||||
// finally below). Disable per channel: channels.fabric.coalesce.
|
||||
await enqueueDelivery({
|
||||
channelId,
|
||||
text,
|
||||
coalesce: resolveCoalesce(this.cfg as never),
|
||||
post: (t) =>
|
||||
this.client.postMessage(guild.endpoint, gt, channelId, t, session.user.id) as Promise<void>,
|
||||
log: (m) => this.log.info(m),
|
||||
});
|
||||
},
|
||||
onRecordError: (err: unknown) =>
|
||||
this.log.warn(`fabric: session record failed agent=${agentId}: ${String(err)}`),
|
||||
@@ -327,6 +345,12 @@ export class FabricInbound {
|
||||
this.log.info(`fabric: dispatch returned agent=${agentId} channel=${channelId}`);
|
||||
} catch (err) {
|
||||
this.log.warn(`fabric: dispatch failed agent=${agentId} channel=${channelId}: ${String(err)}`);
|
||||
} finally {
|
||||
// Deterministic per-turn boundary: dispatchInboundReplyWithBase only
|
||||
// resolves AFTER every deliver() call of this turn has run, so the
|
||||
// buffer now holds all segments — flush them as ONE Fabric message.
|
||||
// No hooks, no timers, no idle guessing.
|
||||
await flushFabricForChannel(channelId);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user