Compare commits

...

1 Commits

Author SHA1 Message Date
aefcc9b5c0 feat(fleet): F4 Phase 2a — Matrix CS-API connector client + factory (#616)
Some checks are pending
ci/woodpecker/push/ci Pipeline is pending
ci/woodpecker/pr/ci Pipeline is pending
Implements the Matrix connector behind the F4 abstraction (stacked on #617).
Speaks the Matrix client-server API directly over HTTPS (injectable fetch, no
SDK) so it is homeserver-agnostic (Conduit default, Synapse alt).

- MatrixConnector implements OrchestratorConnector:
  - send  → PUT /_matrix/client/v3/rooms/{room}/send/m.room.message/{txn}
            (thread-aware via m.thread relation), returns event_id.
  - subscribe → /sync long-poll loop driven by the pure parseSyncResponse
            (skips the orchestrator's own echoes; carries threadId).
  - health → /_matrix/client/versions (reachable) + /account/whoami (authed).
- Pure helpers buildMessageBody + parseSyncResponse → send/receive unit-testable.
- registerMatrixConnector(env) registers the factory; the access token comes from
  MATRIX_ACCESS_TOKEN, never the roster.

Verified: 13 Matrix + 7 registry = 20 connector tests green; tsc/eslint/prettier
clean. Still a self-contained connectors/ module (no fleet.ts changes).

Stacked on #617 (F4 Phase 1). Merge order: #617 -> this; rebases onto main after.

Refs #616, #613

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EsgTQzV5YUGk1JtCLP4B83
2026-06-22 03:17:58 -05:00
4 changed files with 442 additions and 1 deletions

View File

@@ -61,4 +61,4 @@ Active workstream is **W1 — Federation v1**. Workers should:
## F4 — Orchestrator chat connector + Matrix (#616) — feat/f4-matrix-connector
- Status: Phase 1 done (abstraction + scaffold). Connector interface (send/subscribe/health) + registry + roster connector schema + design doc; tmux default/back-compat; matrix/discord factories are Phase 2. 7 tests green; no fleet.ts changes (independent of #615). Detail: scratchpads/f4-matrix-connector.md.
- Status: Phase 1 done (abstraction + scaffold). Connector interface (send/subscribe/health) + registry + roster connector schema + design doc; tmux default/back-compat; matrix factory + CS-API client landed (Phase 2a, #617-stacked); 20 connector tests green; no fleet.ts changes (independent of #615). Detail: scratchpads/f4-matrix-connector.md.

View File

@@ -17,3 +17,14 @@
## Phase 2+ (follow-ups, in the doc)
Matrix CS-API client (fetch send/sync/health) + factory; init/configure connector-selection UX + roster-parse wiring; systemd launch wiring; Conduit deploy guide; first-party Mosaic Discord (threads) as a connector.
## Phase 2a (feat/f4-matrix-client, stacked on #617) — Matrix CS-API client
- `src/fleet/connectors/matrix.ts`: `MatrixConnector implements OrchestratorConnector` over the Matrix
client-server API (injectable fetch, no SDK). `send` → PUT m.room.message (thread-aware); `subscribe`
→ /sync long-poll loop using the pure `parseSyncResponse`; `health` → /versions + /whoami.
`registerMatrixConnector(env)` registers the factory (token from MATRIX_ACCESS_TOKEN, never roster).
- Pure helpers `buildMessageBody` + `parseSyncResponse` make send/receive unit-testable.
- 13 Matrix tests + 7 registry = 20 connector tests green; tsc/eslint/prettier clean.
- Remaining Phase 2: init/configure connector-selection UX + roster-parse wiring (touches fleet.ts —
after #615); systemd launch wiring; Conduit deploy guide.

View File

@@ -0,0 +1,184 @@
import { describe, it, expect, beforeEach } from 'vitest';
import {
MatrixConnector,
buildMessageBody,
parseSyncResponse,
registerMatrixConnector,
type FetchLike,
} from './matrix.js';
import { createConnector, _resetConnectorRegistry } from './registry.js';
import type { MatrixConnectorConfig } from './types.js';
const CONFIG: MatrixConnectorConfig = {
homeserverUrl: 'https://matrix.internal/',
userId: '@mos:internal',
roomId: '!room:internal',
};
/** A fetch mock that returns queued responses and records calls. */
function mockFetch(responses: Array<{ ok?: boolean; status?: number; body?: unknown }>): {
fetchImpl: FetchLike;
calls: Array<{ url: string; method?: string; body?: string }>;
} {
const calls: Array<{ url: string; method?: string; body?: string }> = [];
let i = 0;
const fetchImpl: FetchLike = async (url, init) => {
calls.push({ url, method: init?.method, body: init?.body });
const r = responses[Math.min(i, responses.length - 1)] ?? {};
i += 1;
return {
ok: r.ok ?? true,
status: r.status ?? 200,
json: async () => r.body ?? {},
text: async () => JSON.stringify(r.body ?? {}),
};
};
return { fetchImpl, calls };
}
describe('buildMessageBody', () => {
it('builds an m.text event', () => {
expect(buildMessageBody({ text: 'hi' })).toEqual({ msgtype: 'm.text', body: 'hi' });
});
it('adds an m.thread relation when threadId is set', () => {
expect(buildMessageBody({ text: 'hi', threadId: '$evt' })).toEqual({
msgtype: 'm.text',
body: 'hi',
'm.relates_to': { rel_type: 'm.thread', event_id: '$evt' },
});
});
});
describe('parseSyncResponse', () => {
it('extracts operator messages and skips the orchestrators own echoes', () => {
const data = {
next_batch: 's2',
rooms: {
join: {
'!room:internal': {
timeline: {
events: [
{
type: 'm.room.message',
sender: '@jason:internal',
origin_server_ts: 1_700_000_000_000,
content: { body: 'status?' },
},
{
type: 'm.room.message',
sender: '@mos:internal', // self — skipped
origin_server_ts: 1_700_000_001_000,
content: { body: 'working on it' },
},
{ type: 'm.reaction', sender: '@jason:internal', content: {} }, // non-message
],
},
},
},
},
};
const msgs = parseSyncResponse(data, '!room:internal', '@mos:internal');
expect(msgs).toHaveLength(1);
expect(msgs[0]).toMatchObject({ text: 'status?', sender: '@jason:internal' });
expect(msgs[0]!.ts).toBe(new Date(1_700_000_000_000).toISOString());
});
it('carries threadId through thread-relments', () => {
const data = {
rooms: {
join: {
'!room:internal': {
timeline: {
events: [
{
type: 'm.room.message',
sender: '@jason:internal',
origin_server_ts: 1,
content: {
body: 'in thread',
'm.relates_to': { rel_type: 'm.thread', event_id: '$root' },
},
},
],
},
},
},
},
};
expect(parseSyncResponse(data, '!room:internal', '@mos:internal')[0]!.threadId).toBe('$root');
});
it('returns [] for an empty/foreign sync', () => {
expect(parseSyncResponse({}, '!room:internal', '@mos:internal')).toEqual([]);
});
});
describe('MatrixConnector', () => {
it('throws without an access token', () => {
expect(() => new MatrixConnector(CONFIG, { accessToken: '' })).toThrow(/access token/i);
});
it('send PUTs an m.text event and returns the event id', async () => {
const { fetchImpl, calls } = mockFetch([{ body: { event_id: '$abc' } }]);
const c = new MatrixConnector(CONFIG, { accessToken: 'tok', fetchImpl });
const res = await c.send({ text: 'pong' }, 1234);
expect(res).toEqual({ delivered: true, messageId: '$abc' });
expect(calls[0]!.method).toBe('PUT');
expect(calls[0]!.url).toContain(
'/_matrix/client/v3/rooms/!room%3Ainternal/send/m.room.message/mosaic-1234-1',
);
expect(JSON.parse(calls[0]!.body!)).toEqual({ msgtype: 'm.text', body: 'pong' });
});
it('send reports not-delivered on a non-2xx', async () => {
const { fetchImpl } = mockFetch([{ ok: false, status: 403 }]);
const c = new MatrixConnector(CONFIG, { accessToken: 'tok', fetchImpl });
const res = await c.send({ text: 'x' });
expect(res.delivered).toBe(false);
expect(res.error).toContain('403');
});
it('health reports reachable + authenticated when whoami matches', async () => {
const { fetchImpl } = mockFetch([
{ body: { versions: ['v1.11'] } }, // /versions
{ body: { user_id: '@mos:internal' } }, // /whoami
]);
const c = new MatrixConnector(CONFIG, { accessToken: 'tok', fetchImpl });
const h = await c.health();
expect(h.reachable).toBe(true);
expect(h.authenticated).toBe(true);
});
it('health flags auth mismatch', async () => {
const { fetchImpl } = mockFetch([
{ body: {} },
{ body: { user_id: '@someone-else:internal' } },
]);
const c = new MatrixConnector(CONFIG, { accessToken: 'tok', fetchImpl });
const h = await c.health();
expect(h.reachable).toBe(true);
expect(h.authenticated).toBe(false);
});
it('health reports unreachable when /versions fails', async () => {
const { fetchImpl } = mockFetch([{ ok: false, status: 502 }]);
const c = new MatrixConnector(CONFIG, { accessToken: 'tok', fetchImpl });
const h = await c.health();
expect(h.reachable).toBe(false);
});
});
describe('registerMatrixConnector', () => {
beforeEach(() => _resetConnectorRegistry());
it('registers a matrix factory createConnector can build', () => {
registerMatrixConnector({ MATRIX_ACCESS_TOKEN: 'tok' } as NodeJS.ProcessEnv);
const c = createConnector({ kind: 'matrix', matrix: CONFIG });
expect(c.kind).toBe('matrix');
});
it('the factory rejects config missing the matrix block', () => {
registerMatrixConnector({ MATRIX_ACCESS_TOKEN: 'tok' } as NodeJS.ProcessEnv);
expect(() => createConnector({ kind: 'matrix' })).toThrow(/missing the .matrix. block/i);
});
});

View File

@@ -0,0 +1,246 @@
/**
* Matrix connector (F4 Phase 2) — speaks the Matrix client-server API directly
* over HTTPS so it is homeserver-agnostic (Conduit default, Synapse alt). No
* SDK: a small injectable fetch keeps it dependency-light and unit-testable.
*
* The access token is supplied by the caller (from the environment —
* MATRIX_ACCESS_TOKEN — per the gateway secret pattern), never the roster.
*/
import {
type OrchestratorConnector,
type OutboundMessage,
type InboundMessage,
type SendResult,
type ConnectorHealth,
type MatrixConnectorConfig,
type Unsubscribe,
} from './types.js';
import { registerConnector } from './registry.js';
/** Minimal fetch surface — avoids a lib.dom dependency and is trivial to mock. */
export interface FetchLike {
(
url: string,
init?: { method?: string; headers?: Record<string, string>; body?: string },
): Promise<{
ok: boolean;
status: number;
json: () => Promise<unknown>;
text: () => Promise<string>;
}>;
}
export interface MatrixConnectorOptions {
accessToken: string;
/** Injectable fetch (defaults to global fetch). */
fetchImpl?: FetchLike;
/** Long-poll timeout for /sync, ms. */
syncTimeoutMs?: number;
}
/** Build the `m.room.message` event content, threading when a threadId is set. */
export function buildMessageBody(message: OutboundMessage): Record<string, unknown> {
const content: Record<string, unknown> = {
msgtype: 'm.text',
body: message.text,
};
if (message.threadId) {
content['m.relates_to'] = { rel_type: 'm.thread', event_id: message.threadId };
}
return content;
}
/** Shape of the bits of a /sync response we consume. */
interface SyncResponse {
next_batch?: string;
rooms?: {
join?: Record<
string,
{
timeline?: {
events?: Array<{
type?: string;
sender?: string;
origin_server_ts?: number;
content?: {
body?: string;
['m.relates_to']?: { rel_type?: string; event_id?: string };
};
}>;
};
}
>;
};
}
/**
* Extract inbound operator messages from a /sync response for one room,
* skipping the orchestrator's own echoes. Pure — the testable core of receive.
*/
export function parseSyncResponse(
data: unknown,
roomId: string,
selfUserId: string,
): InboundMessage[] {
const sync = data as SyncResponse;
const events = sync.rooms?.join?.[roomId]?.timeline?.events ?? [];
const out: InboundMessage[] = [];
for (const ev of events) {
if (ev.type !== 'm.room.message') continue;
if (!ev.sender || ev.sender === selfUserId) continue; // skip our own messages
const body = ev.content?.body;
if (typeof body !== 'string') continue;
const rel = ev.content?.['m.relates_to'];
out.push({
text: body,
sender: ev.sender,
ts: new Date(ev.origin_server_ts ?? 0).toISOString(),
...(rel?.rel_type === 'm.thread' && rel.event_id ? { threadId: rel.event_id } : {}),
});
}
return out;
}
export class MatrixConnector implements OrchestratorConnector {
readonly kind = 'matrix' as const;
private readonly fetchImpl: FetchLike;
private readonly token: string;
private readonly syncTimeoutMs: number;
private txnCounter = 0;
private stopped = false;
constructor(
private readonly config: MatrixConnectorConfig,
opts: MatrixConnectorOptions,
) {
this.token = opts.accessToken;
this.fetchImpl = opts.fetchImpl ?? (globalThis.fetch as unknown as FetchLike);
this.syncTimeoutMs = opts.syncTimeoutMs ?? 30_000;
if (!this.token) {
throw new Error('MatrixConnector requires an access token (set MATRIX_ACCESS_TOKEN).');
}
}
private url(path: string): string {
return `${this.config.homeserverUrl.replace(/\/$/, '')}${path}`;
}
private authHeaders(): Record<string, string> {
return { Authorization: `Bearer ${this.token}`, 'Content-Type': 'application/json' };
}
/** Monotonic, unique-per-instance transaction id for idempotent sends. */
private nextTxnId(nowMs: number): string {
this.txnCounter += 1;
return `mosaic-${nowMs}-${this.txnCounter}`;
}
async send(message: OutboundMessage, nowMs = Date.now()): Promise<SendResult> {
const txnId = this.nextTxnId(nowMs);
const path = `/_matrix/client/v3/rooms/${encodeURIComponent(
this.config.roomId,
)}/send/m.room.message/${encodeURIComponent(txnId)}`;
try {
const res = await this.fetchImpl(this.url(path), {
method: 'PUT',
headers: this.authHeaders(),
body: JSON.stringify(buildMessageBody(message)),
});
if (!res.ok) {
return { delivered: false, error: `Matrix send failed: HTTP ${res.status}` };
}
const json = (await res.json()) as { event_id?: string };
return { delivered: true, ...(json.event_id ? { messageId: json.event_id } : {}) };
} catch (err) {
return { delivered: false, error: err instanceof Error ? err.message : String(err) };
}
}
subscribe(handler: (message: InboundMessage) => void): Unsubscribe {
this.stopped = false;
let since: string | undefined;
const loop = async (): Promise<void> => {
while (!this.stopped) {
try {
const q = new URLSearchParams({ timeout: String(this.syncTimeoutMs) });
if (since) q.set('since', since);
const res = await this.fetchImpl(this.url(`/_matrix/client/v3/sync?${q.toString()}`), {
method: 'GET',
headers: this.authHeaders(),
});
if (!res.ok) {
await this.backoff();
continue;
}
const data = await res.json();
since = (data as SyncResponse).next_batch ?? since;
for (const msg of parseSyncResponse(data, this.config.roomId, this.config.userId)) {
handler(msg);
}
} catch {
await this.backoff();
}
}
};
void loop();
return () => {
this.stopped = true;
};
}
private backoff(): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, 2_000));
}
async health(): Promise<ConnectorHealth> {
try {
const versions = await this.fetchImpl(this.url('/_matrix/client/versions'), {
method: 'GET',
});
if (!versions.ok) {
return {
reachable: false,
authenticated: false,
detail: `versions HTTP ${versions.status}`,
};
}
const who = await this.fetchImpl(this.url('/_matrix/client/v3/account/whoami'), {
method: 'GET',
headers: this.authHeaders(),
});
if (!who.ok) {
return { reachable: true, authenticated: false, detail: `whoami HTTP ${who.status}` };
}
const json = (await who.json()) as { user_id?: string };
const authenticated = json.user_id === this.config.userId;
return {
reachable: true,
authenticated,
lastSeen: new Date().toISOString(),
...(authenticated
? {}
: { detail: `whoami user ${json.user_id} != ${this.config.userId}` }),
};
} catch (err) {
return {
reachable: false,
authenticated: false,
detail: err instanceof Error ? err.message : String(err),
};
}
}
}
/**
* Register the Matrix connector factory. The token is read from the environment
* (MATRIX_ACCESS_TOKEN) at build time, never the roster.
*/
export function registerMatrixConnector(env: NodeJS.ProcessEnv = process.env): void {
registerConnector('matrix', (config) => {
if (!config.matrix) {
throw new Error('Matrix connector config missing the `matrix` block (homeserver/user/room).');
}
return new MatrixConnector(config.matrix, { accessToken: env['MATRIX_ACCESS_TOKEN'] ?? '' });
});
}