serverless-ircd 0.1.0

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

@@ -0,0 +1,337 @@
+import { describe, expect, it } from 'vitest';
+import { topicReducer } from '../../src/commands/topic';
+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'): 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): void {
+  chan.members.set(connId, { conn: connId, nick, op, voice: false });
+}
+
+const L = (text: string): RawLine => ({ text });
+
+// ============================================================================
+// topicReducer — reads
+// ============================================================================
+
+describe('topicReducer — reads', () => {
+  it('emits 331 RPL_NOTOPIC when the channel has no topic', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 331 alice #foo :No topic is set')]),
+    ]);
+  });
+
+  it('emits 332 RPL_TOPIC and 333 RPL_TOPICWHOTIME when the channel has a topic', () => {
+    const chan = makeChan('#foo');
+    chan.topic = { text: 'hello world', setter: 'alice!alice@example.com', setAt: 5_000 };
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(':irc.example.com 332 alice #foo :hello world'),
+        L(':irc.example.com 333 alice #foo alice!alice@example.com 5000'),
+      ]),
+    ]);
+  });
+
+  it('updates the connection lastSeen to ctx.clock.now() on a read', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const clock = new FakeClock(11_000);
+    const ctx = makeCtx(conn, clock);
+
+    topicReducer(chan, { command: 'TOPIC', params: ['#foo'], tags: {} }, ctx);
+
+    expect(conn.lastSeen).toBe(11_000);
+  });
+});
+
+// ============================================================================
+// topicReducer — writes
+// ============================================================================
+
+describe('topicReducer — writes', () => {
+  it('sets the topic and broadcasts TOPIC to the channel when a member writes', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(
+      chan,
+      { command: 'TOPIC', params: ['#foo', 'new topic'], tags: {} },
+      ctx,
+    );
+
+    expect(out.state.topic).toEqual({
+      text: 'new topic',
+      setter: 'alice!alice@example.com',
+      setAt: 1_000,
+    });
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.applyChannelDelta('#foo', {
+        topic: { text: 'new topic', setter: 'alice!alice@example.com', setAt: 1_000 },
+      }),
+      Effect.broadcast('#foo', [L(':alice!alice@example.com TOPIC #foo :new topic')]),
+    ]);
+  });
+
+  it('clears the topic when an empty topic is supplied', () => {
+    const chan = makeChan('#foo');
+    chan.topic = { text: 'old', setter: 'alice!alice@example.com', setAt: 1_000 };
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', ''], tags: {} }, ctx);
+
+    expect(out.state.topic).toBeUndefined();
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.applyChannelDelta('#foo', { topic: null }),
+      Effect.broadcast('#foo', [L(':alice!alice@example.com TOPIC #foo :')]),
+    ]);
+  });
+
+  it('uses ctx.clock.now() as the setAt timestamp', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const clock = new FakeClock(99_999);
+    const ctx = makeCtx(conn, clock);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'hi'], tags: {} }, ctx);
+
+    expect(out.state.topic?.setAt).toBe(99_999);
+  });
+
+  it('truncates the topic to serverConfig.topicLen bytes', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const longTopic = 'a'.repeat(serverConfig.topicLen + 10);
+    const out = topicReducer(
+      chan,
+      { command: 'TOPIC', params: ['#foo', longTopic], tags: {} },
+      ctx,
+    );
+
+    expect(out.state.topic?.text).toBe('a'.repeat(serverConfig.topicLen));
+  });
+
+  it('emits 482 ERR_CHANOPRIVSNEEDED when +t is set and the writer is a non-op member', () => {
+    const chan = makeChan('#foo');
+    chan.modes.topicLock = true;
+    addMember(chan, 'c1', 'alice', false);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'new'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(":irc.example.com 482 alice #foo :You're not channel operator")]),
+    ]);
+    expect(out.state.topic).toBeUndefined();
+  });
+
+  it('allows a non-op member to write when +t is NOT set (default)', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice', false);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'new'], tags: {} }, ctx);
+
+    expect(out.state.topic?.text).toBe('new');
+  });
+
+  it('allows an op to write when +t is set', () => {
+    const chan = makeChan('#foo');
+    chan.modes.topicLock = true;
+    addMember(chan, 'c1', 'alice', true);
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'new'], tags: {} }, ctx);
+
+    expect(out.state.topic?.text).toBe('new');
+  });
+
+  it('falls back to ? as the TOPIC source when the writer has no nick (defensive)', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', '?');
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'new'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.applyChannelDelta('#foo', {
+        topic: { text: 'new', setter: '?', setAt: 1_000 },
+      }),
+      Effect.broadcast('#foo', [L(':? TOPIC #foo :new')]),
+    ]);
+  });
+});
+
+// ============================================================================
+// topicReducer — rejections
+// ============================================================================
+
+describe('topicReducer — rejections', () => {
+  it('emits 461 ERR_NEEDMOREPARAMS when no channel is supplied', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 alice TOPIC :Not enough parameters')]),
+    ]);
+  });
+
+  it('emits 403 ERR_NOSUCHCHANNEL for a channel name without a valid prefix', () => {
+    const chan = makeChan('foo');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['foo'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 403 alice foo :No such channel')]),
+    ]);
+  });
+
+  it('emits 403 ERR_NOSUCHCHANNEL for a channel name containing a comma', () => {
+    const chan = makeChan('#foo');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo,bar'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 403 alice #foo,bar :No such channel')]),
+    ]);
+  });
+
+  it('emits 403 ERR_NOSUCHCHANNEL for an empty channel name', () => {
+    const chan = makeChan('#foo');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: [''], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 403 alice  :No such channel')]),
+    ]);
+  });
+
+  it('emits 442 ERR_NOTONCHANNEL when reading a channel the connection has not joined', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(":irc.example.com 442 alice #foo :You're not on that channel")]),
+    ]);
+  });
+
+  it('emits 442 ERR_NOTONCHANNEL when writing a channel the connection has not joined', () => {
+    const chan = makeChan('#foo');
+    addMember(chan, 'c2', 'bob');
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo', 'new'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(":irc.example.com 442 alice #foo :You're not on that channel")]),
+    ]);
+  });
+
+  it('uses * in numeric replies when the connection has no nick (defensive)', () => {
+    const chan = makeChan('#foo');
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 * TOPIC :Not enough parameters')]),
+    ]);
+  });
+
+  it('uses * in 332/333 read replies when the reading member has no nick (defensive)', () => {
+    const chan = makeChan('#foo');
+    chan.topic = { text: 'hello', setter: 'alice!alice@example.com', setAt: 5_000 };
+    addMember(chan, 'c1', '?');
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+
+    const out = topicReducer(chan, { command: 'TOPIC', params: ['#foo'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(':irc.example.com 332 * #foo :hello'),
+        L(':irc.example.com 333 * #foo alice!alice@example.com 5000'),
+      ]),
+    ]);
+  });
+});