serverless-ircd 0.1.0

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

@@ -0,0 +1,441 @@
+import { describe, expect, it } from 'vitest';
+import { whoReducer } from '../../src/commands/who';
+import { Effect } from '../../src/effects';
+import type { Effect as EffectType, RawLine } from '../../src/effects';
+import { EmptyMotdProvider, FakeClock, SequentialIdFactory } from '../../src/ports';
+import { type ChannelState, createChannel } 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, clock = new FakeClock(1_000)): Ctx {
+  return buildCtx({
+    serverConfig,
+    clock,
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: conn,
+  });
+}
+
+function makeConn(id = 'c1', nick = 'alice', caps: ReadonlyArray<string> = []): 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';
+  for (const c of caps) s.caps.add(c);
+  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 makeConnState(
+  id: string,
+  nick: string,
+  opts: {
+    op?: boolean;
+    away?: string;
+    invisible?: boolean;
+    oper?: boolean;
+    realname?: string;
+  } = {},
+): ConnectionState {
+  const s = createConnection({ id, connectedSince: 1_000 });
+  s.nick = nick;
+  s.user = nick;
+  s.host = 'example.com';
+  s.realname = opts.realname ?? nick;
+  s.registration = 'registered';
+  if (opts.away !== undefined) s.away = opts.away;
+  if (opts.invisible !== undefined) s.userModes.invisible = opts.invisible;
+  if (opts.oper !== undefined) s.userModes.oper = opts.oper;
+  return s;
+}
+
+const L = (text: string): RawLine => ({ text });
+
+// ============================================================================
+// whoReducer — channel target
+// ============================================================================
+
+describe('whoReducer — channel target', () => {
+  it('emits one 352 per channel member then 315 RPL_ENDOFWHO', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob', true);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob', { op: true })],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(':irc.example.com 352 alice #foo alice example.com irc.example.com alice H :0 alice'),
+        L(':irc.example.com 352 alice #foo bob example.com irc.example.com bob H@ :0 bob'),
+      ]),
+      Effect.send('c1', [L(':irc.example.com 315 alice #foo :End of /WHO list')]),
+    ]);
+  });
+
+  it('marks the away flag as G (gone) for away members', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice', { away: 'brb' })],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      expect(send.lines[0]?.text).toContain(' G ');
+    }
+  });
+
+  it('marks the oper flag with * for IRC operators', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice', { oper: true })],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      // Oper flag appears between hops and the away flag: `<hops> <awayFlag>[*]<prefixes>`
+      // The 352 layout: `<chan> <user> <host> <server> <nick> <H|G>[*][~|&|@|%|+] :<hops> <real>`
+      expect(send.lines[0]?.text).toContain(' H* ');
+    }
+  });
+
+  it('includes the @ prefix for ops and + prefix for voice', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob', true, true);
+    addMember(chan, 'c3', 'carol', false, true);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob')],
+      ['c3', makeConnState('c3', 'carol')],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      const bob = send.lines[1]?.text ?? '';
+      const carol = send.lines[2]?.text ?? '';
+      expect(bob).toContain('H@');
+      expect(carol).toContain('H+');
+    }
+  });
+
+  it('shows only the highest-priority prefix in 352 when multi-prefix is NOT negotiated', () => {
+    // Legacy client: op+voice user appears as `H@` only, NOT `H@+`.
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob', true, true); // op AND voice
+    const conn = makeConn('c1', 'alice'); // no multi-prefix cap
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob')],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      const bob = send.lines[1]?.text ?? '';
+      // Flag field is the token before the trailing ` :0 real` segment.
+      // We expect exactly `H@` (with the space after), not `H@+`.
+      expect(bob).toContain(' H@ ');
+      expect(bob).not.toContain('H@+');
+    }
+  });
+
+  it('shows every applicable prefix in 352 when multi-prefix IS negotiated', () => {
+    // Cap-enabled client: op+voice user appears as `H@+`.
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob', true, true); // op AND voice
+    const conn = makeConn('c1', 'alice', ['multi-prefix']);
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob')],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      const bob = send.lines[1]?.text ?? '';
+      expect(bob).toContain('H@+');
+    }
+  });
+
+  it('uses * for the server name (single-server v1)', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([['c1', makeConnState('c1', 'alice')]]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    // The 352 server field is the configured server name; single-server v1
+    // reports the local server for every member.
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      expect(send.lines[0]?.text).toContain(' irc.example.com alice ');
+    }
+  });
+
+  it('emits only 315 when the channel has no members', () => {
+    const chan = makeChan('#foo');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>();
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 315 alice #foo :End of /WHO list')]),
+    ]);
+  });
+
+  it('hides +s channel members from a non-member requester', () => {
+    const chan = makeChan('#secret');
+    chan.modes.secret = true;
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([['c2', makeConnState('c2', 'bob')]]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#secret'] }, ctx);
+
+    // Non-member of a +s channel gets empty list + end.
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 315 alice #secret :End of /WHO list')]),
+    ]);
+  });
+
+  it('shows +s channel members to a member requester', () => {
+    const chan = makeChan('#secret');
+    chan.modes.secret = true;
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob')],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#secret'] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      expect(send.lines.length).toBe(2);
+    }
+  });
+
+  it('skips +i (invisible) user-mode members unless the requester shares a channel', () => {
+    // In v1, the requester IS on the channel (they sent WHO #foo), so invisible
+    // members of #foo are still listed: they're visible by virtue of shared
+    // channel membership. This test confirms that behavior.
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob', { invisible: true })],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      // Both members are listed: requester shares the channel with the
+      // invisible user, so they're visible.
+      expect(send.lines.length).toBe(2);
+    }
+  });
+
+  it('hides members whose connection state is missing from the registry', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'ghost'); // no ConnectionState entry for c2
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([['c1', makeConnState('c1', 'alice')]]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      expect(send.lines.length).toBe(1);
+    }
+  });
+});
+
+// ============================================================================
+// whoReducer — `o` filter (operators only)
+// ============================================================================
+
+describe('whoReducer — operators-only filter', () => {
+  it('with `o` flag lists only IRC operators (channel members)', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([
+      ['c1', makeConnState('c1', 'alice')],
+      ['c2', makeConnState('c2', 'bob', { oper: true })],
+    ]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo', 'o'] }, ctx);
+
+    const send = out.effects[0];
+    if (send?.tag === 'Send') {
+      expect(send.lines.length).toBe(1);
+      expect(send.lines[0]?.text).toContain(' bob ');
+    }
+  });
+});
+
+// ============================================================================
+// whoReducer — errors
+// ============================================================================
+
+describe('whoReducer — errors', () => {
+  it('emits 403 ERR_NOSUCHCHANNEL for an invalid channel name', () => {
+    const chan = makeChan('foo');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>();
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['foo'] }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 403 alice foo :No such channel')]),
+    ]);
+  });
+
+  it('rejects an empty channel name with 403', () => {
+    const chan = makeChan('');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>();
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: [''] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      expect(send.lines[0]?.text).toContain(' 403 ');
+    }
+  });
+
+  it('rejects a too-long channel name with 403', () => {
+    const long = `#${'x'.repeat(serverConfig.channelLen)}`;
+    const chan = makeChan(long);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>();
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: [long] }, ctx);
+
+    const send = out.effects[0];
+    expect(send?.tag).toBe('Send');
+    if (send?.tag === 'Send') {
+      expect(send.lines[0]?.text).toContain(' 403 ');
+    }
+  });
+
+  it('emits only 315 with an empty mask when no params are supplied', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([['c1', makeConnState('c1', 'alice')]]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: [] }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 315 alice :End of /WHO list')]),
+    ]);
+  });
+
+  it('uses * in replies when the connection has no nick', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+    const connStates = new Map<string, ConnectionState>([['c1', makeConnState('c1', 'alice')]]);
+
+    const out = whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    const end = out.effects.at(-1);
+    if (end?.tag === 'Send') {
+      expect(end.lines[0]?.text).toBe(':irc.example.com 315 * #foo :End of /WHO list');
+    }
+  });
+
+  it('updates the connection lastSeen to ctx.clock.now()', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const clock = new FakeClock(5_500);
+    const ctx = makeCtx(conn, clock);
+    const connStates = new Map<string, ConnectionState>([['c1', makeConnState('c1', 'alice')]]);
+
+    whoReducer(chan, connStates, { command: 'WHO', params: ['#foo'] }, ctx);
+
+    expect(conn.lastSeen).toBe(5_500);
+  });
+});