serverless-ircd 0.4.0 → 0.6.0

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/kill.test.ts

@@ -0,0 +1,243 @@
+import { describe, expect, it } from 'vitest';
+import { killReducer } from '../../src/commands/kill';
+import { Effect } from '../../src/effects';
+import type { Effect as EffectType, RawLine } from '../../src/effects';
+import { EmptyMotdProvider, FakeClock, SequentialIdFactory } from '../../src/ports';
+import { type ConnectionState, createConnection } from '../../src/state/connection';
+import { type Ctx, type ServerConfig, buildCtx } from '../../src/types';
+
+const serverConfig: ServerConfig = {
+  serverName: 'irc.example.com',
+  networkName: 'ExampleNet',
+  maxChannelsPerUser: 30,
+  maxTargetsPerCommand: 10,
+  maxListEntries: 50,
+  nickLen: 30,
+  channelLen: 50,
+  topicLen: 390,
+  quitMessage: 'Client Quit',
+};
+
+function makeCtx(conn: ConnectionState, clock = new FakeClock(5_000)): Ctx {
+  return buildCtx({
+    serverConfig,
+    clock,
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: conn,
+  });
+}
+
+function makeOper(id = 'c1', nick = 'alice'): ConnectionState {
+  const s = createConnection({ id, connectedSince: 0 });
+  s.nick = nick;
+  s.user = nick;
+  s.host = 'example.com';
+  s.realname = 'Alice';
+  s.registration = 'registered';
+  s.userModes.oper = true;
+  return s;
+}
+
+function makeTarget(id = 'c2', nick = 'bob'): ConnectionState {
+  const s = createConnection({ id, connectedSince: 0 });
+  s.nick = nick;
+  s.user = nick;
+  s.host = 'example.com';
+  s.realname = 'Bob';
+  s.registration = 'registered';
+  return s;
+}
+
+const L = (text: string): RawLine => ({ text });
+
+const kill = (nick?: string, comment?: string) =>
+  ({
+    command: 'KILL',
+    params: nick === undefined ? [] : comment === undefined ? [nick] : [nick, comment],
+    tags: {},
+  }) as const;
+
+describe('killReducer — oper happy path', () => {
+  it('emits a Disconnect effect for the target with a kill-formatted reason', () => {
+    const oper = makeOper();
+    const target = makeTarget();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'flooding'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.disconnect('c2', 'Killed (alice (flooding))'),
+    ]);
+  });
+
+  it('uses the oper display nick in the reason, not the target nick', () => {
+    const oper = makeOper('c1', 'theOper');
+    const target = makeTarget('c2', 'bob');
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'bye'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([Effect.disconnect('c2', 'Killed (theOper (bye))')]);
+  });
+
+  it('formats multi-word comments verbatim inside the inner parens', () => {
+    const oper = makeOper();
+    const target = makeTarget();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'stop flooding the channel'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.disconnect('c2', 'Killed (alice (stop flooding the channel))'),
+    ]);
+  });
+
+  it('updates the oper lastSeen to ctx.clock.now()', () => {
+    const oper = makeOper();
+    expect(oper.lastSeen).toBe(0);
+    const ctx = makeCtx(oper);
+
+    killReducer(makeTarget(), kill('bob', 'flooding'), ctx);
+
+    expect(oper.lastSeen).toBe(5_000);
+  });
+
+  it('falls back to "*" for the oper nick in the reason when the oper has none', () => {
+    const oper = createConnection({ id: 'c1', connectedSince: 0 });
+    oper.userModes.oper = true;
+    const target = makeTarget();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'x'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([Effect.disconnect('c2', 'Killed (* (x))')]);
+  });
+});
+
+describe('killReducer — self-kill (RFC-permitted)', () => {
+  it('allows an oper to KILL themselves, disconnecting their own connection', () => {
+    const oper = makeOper('c1', 'alice');
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(oper, kill('alice', 'self-terminate'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.disconnect('c1', 'Killed (alice (self-terminate))'),
+    ]);
+  });
+});
+
+describe('killReducer — non-oper (481 ERR_NOPRIVILEGES)', () => {
+  it('emits 481 when the sender is not an oper', () => {
+    const oper = makeOper();
+    oper.userModes.oper = false;
+    const target = makeTarget();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'flooding'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(":irc.example.com 481 alice :Permission Denied - You're not an IRC operator"),
+      ]),
+    ]);
+  });
+
+  it('does not disconnect the target when the sender is not an oper', () => {
+    const oper = makeOper();
+    oper.userModes.oper = false;
+    const target = makeTarget();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(target, kill('bob', 'flooding'), ctx);
+
+    expect(out.effects.some((e) => e.tag === 'Disconnect')).toBe(false);
+  });
+
+  it('gates before param validation: a non-oper with missing params still gets 481', () => {
+    const oper = makeOper();
+    oper.userModes.oper = false;
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill(), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(":irc.example.com 481 alice :Permission Denied - You're not an IRC operator"),
+      ]),
+    ]);
+  });
+
+  it('uses "*" as the nick in 481 when the connection has no nick', () => {
+    const oper = createConnection({ id: 'c1', connectedSince: 0 });
+    oper.userModes.oper = false;
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill('bob', 'x'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(":irc.example.com 481 * :Permission Denied - You're not an IRC operator"),
+      ]),
+    ]);
+  });
+});
+
+describe('killReducer — missing parameters (461 ERR_NEEDMOREPARAMS)', () => {
+  it('emits 461 when no parameters are supplied', () => {
+    const oper = makeOper();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill(), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 alice KILL :Not enough parameters')]),
+    ]);
+  });
+
+  it('emits 461 when only the nick is supplied (no comment)', () => {
+    const oper = makeOper();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(makeTarget(), kill('bob'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 alice KILL :Not enough parameters')]),
+    ]);
+  });
+
+  it('uses "*" as the nick in 461 when the connection has no nick', () => {
+    const oper = createConnection({ id: 'c1', connectedSince: 0 });
+    oper.userModes.oper = true;
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill('bob'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 * KILL :Not enough parameters')]),
+    ]);
+  });
+});
+
+describe('killReducer — unknown nick (401 ERR_NOSUCHNICK)', () => {
+  it('emits 401 when the target resolves to undefined', () => {
+    const oper = makeOper();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill('ghost', 'flooding'), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 401 alice ghost :No such nick/channel')]),
+    ]);
+  });
+
+  it('does not emit a Disconnect when the target is unknown', () => {
+    const oper = makeOper();
+    const ctx = makeCtx(oper);
+
+    const out = killReducer(undefined, kill('ghost', 'flooding'), ctx);
+
+    expect(out.effects.some((e) => e.tag === 'Disconnect')).toBe(false);
+  });
+});