serverless-ircd 0.5.0 → 0.7.0

package/packages/irc-core/tests/commands/cap.test.ts

@@ -142,6 +142,32 @@ describe('capReducer — LS', () => {
     }
   });
 
+  it('advertises draft/multiline=4096 with the default byte budget', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('draft/multiline=4096');
+    }
+  });
+
+  it('advertises the configured multiline byte budget when overridden', () => {
+    const state = makeState();
+    const cfg: ServerConfig = { ...serverConfig, multilineMaxBytes: 8192 };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('draft/multiline=8192');
+      expect(body).not.toContain('draft/multiline=4096');
+    }
+  });
+
   it('marks the connection as in CAP negotiation so the welcome is deferred', () => {
     const state = makeState();
     const ctx = makeCtx(state);
@@ -529,3 +555,142 @@ describe('capReducer — unknown subcommands', () => {
     ]);
   });
 });
+
+// ============================================================================
+// capReducer — IRCv3 `sts` (Strict Transport Security) advertisement
+// ============================================================================
+
+describe('capReducer — STS advertisement', () => {
+  it('omits the sts cap when no STS policy is configured', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).not.toContain('sts=');
+      expect(body).not.toContain(' sts ');
+    }
+  });
+
+  it('advertises sts=duration=…,port=… on a plaintext connection', () => {
+    const state = makeState();
+    state.secure = false;
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 600, port: 6697 },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('sts=duration=600,port=6697');
+    }
+  });
+
+  it('reads duration and port from ServerConfig (not literals)', () => {
+    const state = makeState();
+    state.secure = false;
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 12345, port: 7000 },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('sts=duration=12345,port=7000');
+      expect(body).not.toContain('sts=duration=600');
+      expect(body).not.toContain('port=6697');
+    }
+  });
+
+  it('appends preload when configured on a plaintext connection', () => {
+    const state = makeState();
+    state.secure = false;
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 600, port: 6697, preload: true },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('sts=duration=600,port=6697,preload');
+    }
+  });
+
+  it('advertises only duration on a TLS connection (wss / irc+tls)', () => {
+    const state = makeState();
+    state.secure = true;
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 600, port: 6697 },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('sts=duration=600');
+      expect(body).not.toContain('port=');
+      expect(body).not.toContain('preload');
+    }
+  });
+
+  it('omits preload on a TLS connection even when configured', () => {
+    const state = makeState();
+    state.secure = true;
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 600, port: 6697, preload: true },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['LS'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('sts=duration=600');
+      expect(body).not.toContain('preload');
+    }
+  });
+
+  it('ACKs CAP REQ sts when configured', () => {
+    const state = readyState();
+    const cfg: ServerConfig = {
+      ...serverConfig,
+      sts: { duration: 600, port: 6697 },
+    };
+    const ctx = makeCtx(state, cfg);
+    const out = capReducer(state, { command: 'CAP', params: ['REQ', 'sts'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('ACK :sts');
+    }
+    expect(out.state.caps.has('sts')).toBe(true);
+  });
+
+  it('NAKs CAP REQ sts when no STS policy is configured', () => {
+    const state = readyState();
+    const ctx = makeCtx(state);
+    const out = capReducer(state, { command: 'CAP', params: ['REQ', 'sts'], tags: {} }, ctx);
+    const send = out.effects[0];
+    expect(send).toBeDefined();
+    if (send?.tag === 'Send') {
+      const body = send.lines[0]?.text ?? '';
+      expect(body).toContain('NAK :sts');
+    }
+    expect(out.state.caps.has('sts')).toBe(false);
+  });
+});

package/packages/irc-core/tests/commands/chathistory.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { chathistoryReducer } from '../../src/commands/chathistory';
+import { chathistoryReducer, formatReplayLine } from '../../src/commands/chathistory';
 import { Effect } from '../../src/effects';
 import type { Effect as EffectType, RawLine } from '../../src/effects';
 import {
@@ -396,6 +396,113 @@ describe('chathistoryReducer — BEFORE / AFTER / AROUND / BETWEEN', () => {
   });
 });
 
+// ============================================================================
+// BEFORE — draft/read-marker fallback (no explicit pivot)
+// ============================================================================
+//
+// IRCv3 draft/read-marker integration: when a cap-enabled client omits the
+// pivot msgid on CHATHISTORY BEFORE, the reducer falls back to the
+// connection's per-channel last-read marker. This lets a client resume
+// reading "everything before my last read position" without re-supplying the
+// msgid. When no marker is recorded either, the reducer keeps the legacy
+// 461 ERR_NEEDMOREPARAMS behaviour.
+// ============================================================================
+
+describe('chathistoryReducer — BEFORE read-marker fallback', () => {
+  it('falls back to the last-read marker when BEFORE omits the pivot', () => {
+    const store = new InMemoryMessageStore();
+    const seeded = seed(store, '#foo', 5);
+    const conn = makeConn();
+    conn.lastReadMarkers = new Map<string, string>([['#foo', 'm4']]);
+    const chan = makeChan();
+    chan.members.set('c1', { conn: 'c1', nick: 'alice', op: false, voice: false });
+    const ctx = makeCtx(conn, store);
+
+    const out = chathistoryReducer(
+      chan,
+      { command: 'CHATHISTORY', params: ['BEFORE', '#foo'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>(
+      expectedBatch(
+        [
+          replayLine(seeded[0] as StoredMessage, '#foo'),
+          replayLine(seeded[1] as StoredMessage, '#foo'),
+          replayLine(seeded[2] as StoredMessage, '#foo'),
+        ],
+        'batch-0',
+        '#foo',
+      ),
+    );
+  });
+
+  it('honours an explicit pivot over the marker when both are supplied', () => {
+    const store = new InMemoryMessageStore();
+    const seeded = seed(store, '#foo', 5);
+    const conn = makeConn();
+    // Marker points at m4, but the client explicitly asks for messages before m3.
+    conn.lastReadMarkers = new Map<string, string>([['#foo', 'm4']]);
+    const chan = makeChan();
+    chan.members.set('c1', { conn: 'c1', nick: 'alice', op: false, voice: false });
+    const ctx = makeCtx(conn, store);
+
+    const out = chathistoryReducer(
+      chan,
+      { command: 'CHATHISTORY', params: ['BEFORE', '#foo', 'm3', '10'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>(
+      expectedBatch(
+        [
+          replayLine(seeded[0] as StoredMessage, '#foo'),
+          replayLine(seeded[1] as StoredMessage, '#foo'),
+        ],
+        'batch-0',
+        '#foo',
+      ),
+    );
+  });
+
+  it('returns 461 when BEFORE omits the pivot and no marker is recorded', () => {
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const conn = makeConn(); // no marker
+    const chan = makeChan();
+    chan.members.set('c1', { conn: 'c1', nick: 'alice', op: false, voice: false });
+    const ctx = makeCtx(conn, store);
+
+    const out = chathistoryReducer(
+      chan,
+      { command: 'CHATHISTORY', params: ['BEFORE', '#foo'], tags: {} },
+      ctx,
+    );
+
+    expect((out.effects[0] as { lines: RawLine[] }).lines[0]?.text).toContain('461');
+  });
+
+  it('returns an empty batch when the marker points at an evicted msgid', () => {
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const conn = makeConn();
+    // Marker references a message the store no longer retains; BEFORE must
+    // not surface an INVALID_PARAMS error, just an empty result.
+    conn.lastReadMarkers = new Map<string, string>([['#foo', 'evicted']]);
+    const chan = makeChan();
+    chan.members.set('c1', { conn: 'c1', nick: 'alice', op: false, voice: false });
+    const ctx = makeCtx(conn, store);
+
+    const out = chathistoryReducer(
+      chan,
+      { command: 'CHATHISTORY', params: ['BEFORE', '#foo'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual([]);
+  });
+});
+
 // ============================================================================
 // TARGETS
 // ============================================================================
@@ -994,3 +1101,43 @@ describe('chathistoryReducer — unregistered connection', () => {
     );
   });
 });
+
+// ===========================================================================
+// formatReplayLine — clientTags on chathistory replay
+//
+// A stored message carrying `clientTags` (e.g. `+draft/multiline` from a
+// multi-line batch) must surface those tags in the chathistory replay so
+// message-tags-aware clients can recognise the message kind.
+// ===========================================================================
+
+describe('formatReplayLine — clientTags', () => {
+  const baseMsg: StoredMessage = {
+    msgid: 'abc123',
+    time: 1_700_000_000_000,
+    chan: '#foo',
+    command: 'PRIVMSG',
+    nick: 'alice',
+    user: 'alice',
+    host: 'example.com',
+    text: 'line one\nline two',
+  };
+
+  it('appends +draft/multiline to the tag section when clientTags are present', () => {
+    const out = formatReplayLine({ ...baseMsg, clientTags: ['+draft/multiline'] }, '#foo');
+    expect(out.text).toBe(
+      '@time=2023-11-14T22:13:20.000Z;msgid=abc123;+draft/multiline :alice!alice@example.com PRIVMSG #foo :line one\nline two',
+    );
+  });
+
+  it('omits the client-tag section entirely when clientTags is undefined', () => {
+    const out = formatReplayLine(baseMsg, '#foo');
+    expect(out.text).toBe(
+      '@time=2023-11-14T22:13:20.000Z;msgid=abc123 :alice!alice@example.com PRIVMSG #foo :line one\nline two',
+    );
+  });
+
+  it('omits the client-tag section when clientTags is empty', () => {
+    const out = formatReplayLine({ ...baseMsg, clientTags: [] }, '#foo');
+    expect(out.text).not.toContain('+draft/multiline');
+  });
+});

package/packages/irc-core/tests/commands/echo-message.test.ts

@@ -73,7 +73,9 @@ describe('echo-message — channel PRIVMSG', () => {
     );
 
     expect(out.effects).toEqual<EffectType[]>([
-      Effect.broadcast('#foo', [L(':alice!alice@example.com PRIVMSG #foo :hi')], 'c1'),
+      Effect.broadcast('#foo', [L(':alice!alice@example.com PRIVMSG #foo :hi')], 'c1', 'msgid', [
+        L('@msgid=nonce-0 :alice!alice@example.com PRIVMSG #foo :hi'),
+      ]),
     ]);
   });
 
@@ -90,7 +92,9 @@ describe('echo-message — channel PRIVMSG', () => {
     );
 
     expect(out.effects).toEqual<EffectType[]>([
-      Effect.broadcast('#foo', [L(':alice!alice@example.com PRIVMSG #foo :hi')], 'c1'),
+      Effect.broadcast('#foo', [L(':alice!alice@example.com PRIVMSG #foo :hi')], 'c1', 'msgid', [
+        L('@msgid=nonce-0 :alice!alice@example.com PRIVMSG #foo :hi'),
+      ]),
       Effect.send('c1', [L(':alice!alice@example.com PRIVMSG #foo :hi')]),
     ]);
   });
@@ -108,7 +112,9 @@ describe('echo-message — channel PRIVMSG', () => {
     );
 
     expect(out.effects).toEqual<EffectType[]>([
-      Effect.broadcast('#foo', [L(':alice!alice@example.com NOTICE #foo :hi')], 'c1'),
+      Effect.broadcast('#foo', [L(':alice!alice@example.com NOTICE #foo :hi')], 'c1', 'msgid', [
+        L('@msgid=nonce-0 :alice!alice@example.com NOTICE #foo :hi'),
+      ]),
       Effect.send('c1', [L(':alice!alice@example.com NOTICE #foo :hi')]),
     ]);
   });

package/packages/irc-core/tests/commands/isupport.test.ts

@@ -140,6 +140,12 @@ describe('generateIsupport — token values', () => {
     const allNoCap = linesNoCap.flatMap((l) => l.text.split(' '));
     expect(allNoCap).toContain('SAFELIST');
   });
+
+  it('advertises MONITOR=<n> with the default monitor cap ceiling', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('MONITOR=30');
+  });
 });
 
 // ============================================================================
@@ -207,3 +213,77 @@ describe('generateIsupport — capability-aware tokens', () => {
     expect(lines.length).toBeGreaterThan(0);
   });
 });
+
+// ============================================================================
+// generateIsupport — cap/mode-derived ISUPPORT tokens
+// ============================================================================
+
+describe('generateIsupport — MONITOR token (config-derived)', () => {
+  it('derives MONITOR=<n> from serverConfig.monitorLimit when set', () => {
+    const lines = generateIsupport(makeConfig({ monitorLimit: 50 }), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('MONITOR=50');
+  });
+
+  it('falls back to the default monitor ceiling when monitorLimit is unset', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('MONITOR=30');
+  });
+});
+
+describe('generateIsupport — STATUSMSG token', () => {
+  it('advertises STATUSMSG=@+ (status-msg prefixes mirror PREFIX)', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('STATUSMSG=@+');
+  });
+});
+
+describe('generateIsupport — EXTBAN token (config-derived prefix)', () => {
+  it('advertises EXTBAN=<prefix>,q with the default extban prefix', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('EXTBAN=~,q');
+  });
+
+  it('derives the EXTBAN prefix from serverConfig.extbanPrefix', () => {
+    const lines = generateIsupport(makeConfig({ extbanPrefix: '$' }), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('EXTBAN=$,q');
+  });
+});
+
+describe('generateIsupport — ACCOUNTEXTBAN token (services-gated)', () => {
+  it('omits ACCOUNTEXTBAN when services are not enabled', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all.some((t) => t.startsWith('ACCOUNTEXTBAN'))).toBe(false);
+  });
+
+  it('advertises ACCOUNTEXTBAN=a when services are enabled', () => {
+    const lines = generateIsupport(makeConfig({ servicesEnabled: true }), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('ACCOUNTEXTBAN=a');
+  });
+});
+
+describe('generateIsupport — draft cap advertisement tokens', () => {
+  it('advertises the TYPING token (draft/typing is supported)', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('TYPING');
+  });
+
+  it('derives MULTILINE=<n> from serverConfig.multilineMaxBytes (draft/multiline)', () => {
+    const lines = generateIsupport(makeConfig({ multilineMaxBytes: 8192 }), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('MULTILINE=8192');
+  });
+
+  it('falls back to the default multiline byte budget when multilineMaxBytes is unset', () => {
+    const lines = generateIsupport(makeConfig(), new Set<string>());
+    const all = lines.flatMap((l) => l.text.split(' '));
+    expect(all).toContain('MULTILINE=4096');
+  });
+});

package/packages/irc-core/tests/commands/mode.test.ts

@@ -1103,3 +1103,75 @@ describe('userModeReducer — write', () => {
     expect(conn.lastSeen).toBe(11_000);
   });
 });
+
+// ============================================================================
+// userModeReducer — read-only mode `S` (TLS connected)
+// ============================================================================
+
+describe('userModeReducer — read-only mode `S` (TLS connected)', () => {
+  it('emits 221 with +S when the connection has the tls user mode set', () => {
+    const conn = makeConn();
+    conn.userModes.tls = true;
+    const ctx = makeCtx(conn);
+
+    const out = userModeReducer(conn, { command: 'MODE', params: ['alice'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 221 alice +S')]),
+    ]);
+  });
+
+  it('emits 221 with +iS when invisible and tls are both set', () => {
+    const conn = makeConn();
+    conn.userModes.invisible = true;
+    conn.userModes.tls = true;
+    const ctx = makeCtx(conn);
+
+    const out = userModeReducer(conn, { command: 'MODE', params: ['alice'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 221 alice +iS')]),
+    ]);
+  });
+
+  it('rejects MODE nick +S with 501 ERR_UMODEUNKNOWNFLAG (read-only)', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = userModeReducer(conn, { command: 'MODE', params: ['alice', '+S'], tags: {} }, ctx);
+
+    expect(conn.userModes.tls).toBe(false);
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 501 alice :Unknown MODE flag')]),
+    ]);
+  });
+
+  it('rejects MODE nick -S with 501 ERR_UMODEUNKNOWNFLAG even when tls is set', () => {
+    const conn = makeConn();
+    conn.userModes.tls = true;
+    const ctx = makeCtx(conn);
+
+    const out = userModeReducer(conn, { command: 'MODE', params: ['alice', '-S'], tags: {} }, ctx);
+
+    // The mode stays set: a client cannot clear a transport-owned mode.
+    expect(conn.userModes.tls).toBe(true);
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 501 alice :Unknown MODE flag')]),
+    ]);
+  });
+
+  it('does not echo a MODE line when only +S was supplied (rejected, no-op)', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = userModeReducer(conn, { command: 'MODE', params: ['alice', '+iS'], tags: {} }, ctx);
+
+    // `i` is applied (and echoed), `S` is rejected with 501. The echo only
+    // carries the applied `+i`; the 501 is emitted alongside it.
+    expect(conn.userModes.invisible).toBe(true);
+    expect(conn.userModes.tls).toBe(false);
+    const texts = out.effects.flatMap((e) => (e.tag === 'Send' ? e.lines : []));
+    expect(texts).toContainEqual(L(':alice!alice@example.com MODE alice +i'));
+    expect(texts).toContainEqual(L(':irc.example.com 501 alice :Unknown MODE flag'));
+  });
+});