serverless-ircd 0.1.0

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

@@ -0,0 +1,452 @@
+import { describe, expect, it } from 'vitest';
+import { listReducer } from '../../src/commands/list';
+import { Effect } from '../../src/effects';
+import type { Effect as EffectType, RawLine } from '../../src/effects';
+import { EmptyMotdProvider, FakeClock, SequentialIdFactory } from '../../src/ports';
+import {
+  type ChanSnapshot,
+  type ChannelState,
+  createChannel,
+  toSnapshot,
+} from '../../src/state/channel';
+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,
+  overrides: Partial<ServerConfig> = {},
+  clock = new FakeClock(1_000),
+): Ctx {
+  return buildCtx({
+    serverConfig: { ...serverConfig, ...overrides },
+    clock,
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: conn,
+  });
+}
+
+function makeConn(id = 'c1', nick = 'alice'): ConnectionState {
+  const s = createConnection({ id, connectedSince: 0 });
+  s.nick = nick;
+  s.user = nick;
+  s.host = 'example.com';
+  s.realname = nick.charAt(0).toUpperCase() + nick.slice(1);
+  s.registration = 'registered';
+  return s;
+}
+
+function makeChan(name = '#foo'): ChannelState {
+  return createChannel({ name, nameLower: name.toLowerCase(), createdAt: 0 });
+}
+
+function addMember(
+  chan: ChannelState,
+  connId: string,
+  nick: string,
+  op = false,
+  voice = false,
+): void {
+  chan.members.set(connId, { conn: connId, nick, op, voice });
+}
+
+function snapshot(chan: ChannelState): ChanSnapshot {
+  return toSnapshot(chan);
+}
+
+const L = (text: string): RawLine => ({ text });
+
+// ============================================================================
+// listReducer — LIST with no args
+// ============================================================================
+
+describe('listReducer — no args (enumerate visible channels)', () => {
+  it('emits 321, one 322 per public channel ordered by snapshot order, then 323', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const bar = makeChan('#bar');
+    addMember(bar, 'c3', 'carol');
+    const channels = [snapshot(foo), snapshot(bar)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 321 alice Channel :Users  Name')]),
+      Effect.send('c1', [
+        L(':irc.example.com 322 alice #foo 1 :'),
+        L(':irc.example.com 322 alice #bar 1 :'),
+      ]),
+      Effect.send('c1', [L(':irc.example.com 323 alice :End of /LIST')]),
+    ]);
+  });
+
+  it('includes the topic text in the 322 trailing when a topic is set', () => {
+    const foo = makeChan('#foo');
+    foo.topic = { text: 'Welcome to foo', setter: 'bob', setAt: 0 };
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #foo 1 :Welcome to foo');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('hides secret (+s) channels the requester has not joined', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const secret = makeChan('#secret');
+    secret.modes.secret = true;
+    addMember(secret, 'c3', 'carol');
+    const channels = [snapshot(foo), snapshot(secret)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toHaveLength(1);
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #foo 1 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('reveals secret (+s) channels the requester HAS joined', () => {
+    const secret = makeChan('#secret');
+    secret.modes.secret = true;
+    addMember(secret, 'c1', 'alice');
+    addMember(secret, 'c2', 'bob');
+    const channels = [snapshot(secret)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #secret 2 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('emits 321 then 323 with no 322s when there are no visible channels', () => {
+    const channels: ChanSnapshot[] = [];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 321 alice Channel :Users  Name')]),
+      Effect.send('c1', [L(':irc.example.com 323 alice :End of /LIST')]),
+    ]);
+  });
+});
+
+// ============================================================================
+// listReducer — LIST with explicit channel list
+// ============================================================================
+
+describe('listReducer — explicit channel list', () => {
+  it('emits a 322 only for the requested channels', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const bar = makeChan('#bar');
+    addMember(bar, 'c3', 'carol');
+    const baz = makeChan('#baz');
+    addMember(baz, 'c4', 'dave');
+    const channels = [snapshot(foo), snapshot(bar), snapshot(baz)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#foo,#baz'], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([
+        L(':irc.example.com 322 alice #foo 1 :'),
+        L(':irc.example.com 322 alice #baz 1 :'),
+      ]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('handles a single-channel argument', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#foo'], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('silently skips requested channels that do not exist', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#foo,#nope'], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('silently skips requested channels with invalid names', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(
+      channels,
+      { command: 'LIST', params: ['#foo,bogus,#foo,bar'], tags: {} },
+      ctx,
+    );
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('silently skips requested channels whose names exceed the configured length cap', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    // channelLen is 50 by default; supply an over-long name alongside a valid one.
+    const longName = `#${'x'.repeat(60)}`;
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(
+      channels,
+      { command: 'LIST', params: [`#foo,${longName}`], tags: {} },
+      ctx,
+    );
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('still filters secret channels when explicitly named by a non-member', () => {
+    const secret = makeChan('#secret');
+    secret.modes.secret = true;
+    addMember(secret, 'c2', 'bob');
+    const channels = [snapshot(secret)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#secret'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 321 alice Channel :Users  Name')]),
+      Effect.send('c1', [L(':irc.example.com 323 alice :End of /LIST')]),
+    ]);
+  });
+
+  it('performs case-insensitive channel-name matching', () => {
+    const foo = makeChan('#Foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#foo'], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #Foo 1 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('preserves the original channel name in the 322 line (preserved-case)', () => {
+    const foo = makeChan('#Foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['#FOO'], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #Foo 1 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+});
+
+// ============================================================================
+// listReducer — result cap (thundering-herd mitigation)
+// ============================================================================
+
+describe('listReducer — result cap', () => {
+  it('caps the number of 322 entries at serverConfig.maxListEntries (no args)', () => {
+    const chans: ChanSnapshot[] = [];
+    for (let i = 0; i < 10; i++) {
+      const c = makeChan(`#c${i}`);
+      addMember(c, `cx${i}`, `user${i}`);
+      chans.push(snapshot(c));
+    }
+    const conn = makeConn();
+    const ctx = makeCtx(conn, { maxListEntries: 3 });
+
+    const out = listReducer(chans, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toHaveLength(3);
+      // Iteration order preserved: first three channels.
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #c0 1 :');
+      expect(list.lines[2]?.text).toBe(':irc.example.com 322 alice #c2 1 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('caps the number of 322 entries when the explicit list exceeds the cap', () => {
+    const chans: ChanSnapshot[] = [];
+    for (let i = 0; i < 5; i++) {
+      const c = makeChan(`#c${i}`);
+      addMember(c, `cx${i}`, `user${i}`);
+      chans.push(snapshot(c));
+    }
+    const conn = makeConn();
+    const ctx = makeCtx(conn, { maxListEntries: 2 });
+
+    const out = listReducer(
+      chans,
+      { command: 'LIST', params: ['#c0,#c1,#c2,#c3,#c4'], tags: {} },
+      ctx,
+    );
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toHaveLength(2);
+      expect(list.lines[0]?.text).toBe(':irc.example.com 322 alice #c0 1 :');
+      expect(list.lines[1]?.text).toBe(':irc.example.com 322 alice #c1 1 :');
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+});
+
+// ============================================================================
+// listReducer — bookkeeping
+// ============================================================================
+
+describe('listReducer — bookkeeping', () => {
+  it('updates the connection lastSeen to ctx.clock.now()', () => {
+    const conn = makeConn();
+    const clock = new FakeClock(7_700);
+    const ctx = makeCtx(conn, {}, clock);
+
+    listReducer([], { command: 'LIST', params: [], tags: {} }, ctx);
+
+    expect(conn.lastSeen).toBe(7_700);
+  });
+
+  it('returns the same state reference (read-only reducer)', () => {
+    const channels: ChanSnapshot[] = [];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [], tags: {} }, ctx);
+
+    expect(out.state).toBe(channels);
+  });
+
+  it('uses * in numeric replies when the connection has no nick (defensive)', () => {
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+
+    const out = listReducer([], { command: 'LIST', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 321 * Channel :Users  Name')]),
+      Effect.send('c1', [L(':irc.example.com 323 * :End of /LIST')]),
+    ]);
+  });
+
+  it('treats an empty trailing param as no args', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: [''], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+
+  it('treats a whitespace-only trailing param as no args', () => {
+    const foo = makeChan('#foo');
+    addMember(foo, 'c2', 'bob');
+    const channels = [snapshot(foo)];
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = listReducer(channels, { command: 'LIST', params: ['   '], tags: {} }, ctx);
+
+    const list = out.effects[1];
+    if (list?.tag === 'Send') {
+      expect(list.lines).toEqual<RawLine[]>([L(':irc.example.com 322 alice #foo 1 :')]);
+    } else {
+      throw new Error('expected Send effect for RPL_LIST');
+    }
+  });
+});