nav/Fabric.Backend.Guild

Go to file

hzhang 80ee9082f3 feat(guild): announce channel type + agent-presence + busy-discard

Phase 1 of DIALECTIC-V2 — adds Fabric infrastructure for
system-broadcast channels with HF-status-aware delivery filtering.

New channel x_type 'announce':
- channels.entity.ts + channels.service.ts + realtime.gateway.ts
  enum + union extended.
- computeDelivery() adds an 'announce' case: recipient with
  presence='busy' → 'skip' (discarded silently); other presences →
  'observer' (delivered, no wake). System-broadcast semantics —
  agents proactively check their announce inbox when they're ready,
  not interrupted out of band.
- messaging.controller POST guard: announce-type channels reject
  posts that don't present x-fabric-system-key header matching
  FABRIC_BACKEND_GUILD_SYSTEM_API_KEY env. Empty env = no system
  caller is valid (closed-by-default).

New entity + module agent_presences:
- agent-presence.entity.ts: per-user (userId PK) status enum
  (idle/on_call/busy/exhausted/offline/unknown), source tag, updatedAt
- agent-presence.service.ts: getStatus/getStatusMap (bulk for
  delivery-time fanout) + setStatus (upsert)
- agent-presence.controller.ts: GET + PUT /agents/:userId/presence
- agent-presence.module.ts: TypeORM forFeature + wired into AppModule
- buildTypeOrmConfig() entities list extended

RealtimeGateway wiring:
- New optional  field on the gateway (typed loosely to avoid
  circular import). RealtimeModule.onModuleInit() assigns from the
  injected AgentPresenceService — degrades gracefully (no busy-discard,
  treat all as 'unknown') if presence wiring is ever removed.
- emitMessageCreated pre-loads presence per fanout only when xType is
  'announce' (other xTypes bypass the lookup entirely).

Note: actual presence data writes come from Fabric.OpenclawPlugin's
presence-sync loop (separate commit on that submodule); without it,
all rows are 'unknown' and announce delivery falls through to the
default observer behavior (no busy filtering). System-only POST gate
is independent and works immediately.

See /home/hzhang/arch/DIALECTIC-V2-DESIGN.md sections 7 + 10 Phase 1.

2026-05-23 11:31:47 +01:00

src

feat(guild): announce channel type + agent-presence + busy-discard

2026-05-23 11:31:47 +01:00

.env.example

refactor(guild): prefix environment variables with FABRIC_BACKEND_GUILD

2026-05-13 12:58:32 +00:00

.gitignore

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

Dockerfile

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

eslint.config.mjs

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

package-lock.json

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

package.json

feat(ops): CLI to print the commands-sync key (Guild C-2)

2026-05-16 18:28:23 +01:00

README.md

docs: slash-command registry section

2026-05-16 16:15:04 +01:00

tsconfig.build.json

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

tsconfig.json

refactor: migrate to ES modules

2026-05-15 18:47:36 +01:00

vitest.config.ts

feat: bootstrap from Fabric monorepo

2026-05-13 07:06:03 +00:00

README.md

Fabric.Backend.Guild

A guild node for Fabric (NestJS, ES modules, MySQL/TypeORM, socket.io). Default port 7002, global prefix /api. Many independent guild nodes can run; each registers with Fabric.Backend.Center and introspects the user/guild tokens Center issues.

Responsibilities

Guilds / channels / messaging — per-channel seq ordering, edit window, soft delete, reply, <@id> mentions (backtick-aware) plus <@user.name:NAME> → <@userId> translation via Center.
Channel x_type (required on create): general, work, report, discuss, triage, custom. Plus isPublic and closed (closed → history readable, posting returns 409).
wake_mapping — explicit wake list for triage (on-duty) and custom (listeners) channels.
Per-recipient wakeup — message.created is emitted per socket with its own wakeup flag (author=false; general→all; report→none; triage/custom→wake_mapping; discuss/work→the current speaker only). This is push-only metadata for the OpenClaw plugin; UIs ignore it.
discuss/work turn engine (channel_turn_state): speaking order and a disjoint bypass list (bypass members aren't woken unless @-mentioned); activation from idle, queue-jump, cross-round /no-reply pause, /force-proceed, end-of-round shuffle, guild /ack, and a mention sub-frame stack with a 5-level nesting cap (root + 4). moveToBypass mid-rotation.
Files — POST /files (multipart, configurable max size, default 100 MB), GET /files/:id (Bearer or ?access_token= for browser <img>/<a>), automatic retention sweep (default 7 days). Messages carry attachments[].
Channel canvas — one pinned document per channel (md/html/text), re-share replaces, only the original sharer may update/remove; emits canvas.updated / canvas.removed.
Slash-command registry — guild-global catalog: PUT /api/commands (the OpenClaw plugin syncs OpenClaw's native-command specs here), GET /api/commands (frontend / autocomplete). Stored verbatim; execution is unchanged (a /<cmd> message flows normally to the plugin → OpenClaw command system; only /no-reply,/force-proceed are server-intercepted).
Realtime — socket.io /realtime; join_channel/leave_channel, message.created/updated/deleted, canvas.*, presence, typing.

Required env (hard-checked at startup)

FABRIC_BACKEND_GUILD_CENTER_BASE_URL
FABRIC_BACKEND_GUILD_CENTER_API_KEY
FABRIC_BACKEND_GUILD_NODE_ID

Missing any of these aborts startup.

Other env

FABRIC_BACKEND_GUILD_PORT (default 7002)
FABRIC_BACKEND_GUILD_DB_*, FABRIC_BACKEND_GUILD_DB_SYNC
FABRIC_BACKEND_GUILD_FILE_DIR (storage root), FABRIC_BACKEND_GUILD_FILE_MAX_BYTES (default 100 MB), FABRIC_BACKEND_GUILD_FILE_TTL_DAYS (default 7)
FABRIC_BACKEND_GUILD_CORS_ORIGINS (empty = allow all; null origin — file:// desktop — is always allowed)

Run

npm install
npm run build && npm start          # or: npm run start:dev

Usually run via the root docker-compose.local.yml (backend-guild1 test-guild1 :7002, backend-guild2 test-guild2 :7003). Schema is auto-managed (DB_SYNC). ES modules (NodeNext).