serverless-ircd 0.3.0 → 0.5.0

package/packages/irc-core/tests/commands/server-info.test.ts

@@ -0,0 +1,274 @@
+import { describe, expect, it } from 'vitest';
+import {
+  adminReducer,
+  infoReducer,
+  timeReducer,
+  versionReducer,
+} from '../../src/commands/server-info';
+import { DEFAULT_SERVER_VERSION } from '../../src/config';
+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 baseServerConfig: ServerConfig = {
+  serverName: 'irc.example.com',
+  networkName: 'ExampleNet',
+  maxChannelsPerUser: 30,
+  maxTargetsPerCommand: 10,
+  maxListEntries: 50,
+  nickLen: 30,
+  channelLen: 50,
+  topicLen: 390,
+  quitMessage: 'Client Quit',
+};
+
+function makeCtx(state: ConnectionState, clockMs = 5_000): Ctx {
+  return buildCtx({
+    serverConfig: baseServerConfig,
+    clock: new FakeClock(clockMs),
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: state,
+  });
+}
+
+function makeState(): ConnectionState {
+  const s = createConnection({ id: 'c1', connectedSince: 0 });
+  s.nick = 'alice';
+  s.user = 'alice';
+  s.host = 'example.com';
+  s.realname = 'Alice';
+  s.registration = 'registered';
+  return s;
+}
+
+const L = (text: string): RawLine => ({ text });
+
+const version = (server?: string) =>
+  ({ command: 'VERSION', params: server === undefined ? [] : [server], tags: {} }) as const;
+
+const time = (server?: string) =>
+  ({ command: 'TIME', params: server === undefined ? [] : [server], tags: {} }) as const;
+
+const admin = (server?: string) =>
+  ({ command: 'ADMIN', params: server === undefined ? [] : [server], tags: {} }) as const;
+
+const info = (server?: string) =>
+  ({ command: 'INFO', params: server === undefined ? [] : [server], tags: {} }) as const;
+
+// ---------------------------------------------------------------------------
+// VERSION
+// ---------------------------------------------------------------------------
+
+describe('versionReducer', () => {
+  it('emits 351 RPL_VERSION with the server version and name', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = versionReducer(state, version(), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(`:irc.example.com 351 alice ${DEFAULT_SERVER_VERSION} irc.example.com :ExampleNet`),
+      ]),
+    ]);
+  });
+
+  it('updates lastSeen to ctx.clock.now()', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 9_999);
+
+    versionReducer(state, version(), ctx);
+
+    expect(state.lastSeen).toBe(9_999);
+  });
+
+  it('uses * as nick placeholder for unregistered connections', () => {
+    const state = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(state);
+
+    const out = versionReducer(state, version(), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [
+        L(`:irc.example.com 351 * ${DEFAULT_SERVER_VERSION} irc.example.com :ExampleNet`),
+      ]),
+    );
+  });
+
+  it('ignores the optional server target parameter (single-server deployment)', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = versionReducer(state, version('other.server'), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [
+        L(`:irc.example.com 351 alice ${DEFAULT_SERVER_VERSION} irc.example.com :ExampleNet`),
+      ]),
+    );
+  });
+
+  it('returns the same state reference', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = versionReducer(state, version(), ctx);
+
+    expect(out.state).toBe(state);
+  });
+});
+
+// ---------------------------------------------------------------------------
+// TIME
+// ---------------------------------------------------------------------------
+
+describe('timeReducer', () => {
+  it('emits 391 RPL_TIME with a human-readable timestamp from the clock', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 1_700_000_000_000);
+
+    const out = timeReducer(state, time(), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [
+        L(':irc.example.com 391 alice irc.example.com :2023-11-14T22:13:20.000Z'),
+      ]),
+    ]);
+  });
+
+  it('updates lastSeen to ctx.clock.now()', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 42_000);
+
+    timeReducer(state, time(), ctx);
+
+    expect(state.lastSeen).toBe(42_000);
+  });
+
+  it('uses * as nick placeholder for unregistered connections', () => {
+    const state = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(state, 1_700_000_000_000);
+
+    const out = timeReducer(state, time(), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [L(':irc.example.com 391 * irc.example.com :2023-11-14T22:13:20.000Z')]),
+    );
+  });
+
+  it('ignores the optional server target parameter', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 1_700_000_000_000);
+
+    const out = timeReducer(state, time('elsewhere'), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [
+        L(':irc.example.com 391 alice irc.example.com :2023-11-14T22:13:20.000Z'),
+      ]),
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// ADMIN
+// ---------------------------------------------------------------------------
+
+describe('adminReducer', () => {
+  it('emits 256 RPL_ADMINME with the server name', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = adminReducer(state, admin(), ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 256 alice irc.example.com :Administrative info')]),
+    ]);
+  });
+
+  it('updates lastSeen to ctx.clock.now()', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 7_777);
+
+    adminReducer(state, admin(), ctx);
+
+    expect(state.lastSeen).toBe(7_777);
+  });
+
+  it('uses * as nick placeholder for unregistered connections', () => {
+    const state = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(state);
+
+    const out = adminReducer(state, admin(), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [L(':irc.example.com 256 * irc.example.com :Administrative info')]),
+    );
+  });
+
+  it('ignores the optional server target parameter', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = adminReducer(state, admin('foo'), ctx);
+
+    expect(out.effects[0]).toEqual<EffectType>(
+      Effect.send('c1', [L(':irc.example.com 256 alice irc.example.com :Administrative info')]),
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// INFO
+// ---------------------------------------------------------------------------
+
+describe('infoReducer', () => {
+  it('emits 371 RPL_INFO lines followed by 374 RPL_ENDOFINFO', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = infoReducer(state, info(), ctx);
+
+    const lines = (out.effects[0] as { lines: RawLine[] }).lines;
+    expect(lines[0]).toEqual(
+      L(`:irc.example.com 371 alice :ServerlessIRCd - version ${DEFAULT_SERVER_VERSION}`),
+    );
+    expect(lines[1]).toEqual(L(':irc.example.com 371 alice :Running on network ExampleNet'));
+    expect(lines[lines.length - 1]).toEqual(L(':irc.example.com 374 alice :End of INFO list'));
+  });
+
+  it('includes at least one 371 line and the 374 terminator', () => {
+    const state = makeState();
+    const ctx = makeCtx(state);
+
+    const out = infoReducer(state, info(), ctx);
+
+    const texts = (out.effects[0] as { lines: RawLine[] }).lines.map((l) => l.text);
+    const rpl371Count = texts.filter((t) => / 371 /.test(t)).length;
+    const rpl374Count = texts.filter((t) => / 374 /.test(t)).length;
+    expect(rpl371Count).toBeGreaterThanOrEqual(1);
+    expect(rpl374Count).toBe(1);
+  });
+
+  it('updates lastSeen to ctx.clock.now()', () => {
+    const state = makeState();
+    const ctx = makeCtx(state, 3_333);
+
+    infoReducer(state, info(), ctx);
+
+    expect(state.lastSeen).toBe(3_333);
+  });
+
+  it('uses * as nick placeholder for unregistered connections', () => {
+    const state = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(state);
+
+    const out = infoReducer(state, info(), ctx);
+
+    const texts = (out.effects[0] as { lines: RawLine[] }).lines.map((l) => l.text);
+    expect(texts.every((t) => t.includes(' * '))).toBe(true);
+  });
+});

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

@@ -0,0 +1,225 @@
+import { describe, expect, it } from 'vitest';
+import { setnameReducer } from '../../src/commands/setname';
+import { whoisReducer } from '../../src/commands/whois';
+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(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 = 'Alice';
+  s.registration = 'registered';
+  return s;
+}
+
+const L = (text: string): RawLine => ({ text });
+
+// ============================================================================
+// setnameReducer — happy path
+// ============================================================================
+
+describe('setnameReducer — happy path', () => {
+  it('updates state.realname from SETNAME :<realname>', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: ['New Name'], tags: {} }, ctx);
+
+    expect(conn.realname).toBe('New Name');
+    expect(out.effects).toEqual<EffectType[]>([]);
+  });
+
+  it('emits no broadcast (silent update)', () => {
+    const conn = makeConn();
+    conn.joinedChannels.add('#foo');
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: ['New Name'], tags: {} }, ctx);
+
+    const broadcasts = out.effects.filter((e) => e.tag === 'Broadcast');
+    expect(broadcasts).toHaveLength(0);
+  });
+
+  it('overwrites a previously stored realname', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    setnameReducer(conn, { command: 'SETNAME', params: ['Second'], tags: {} }, ctx);
+    setnameReducer(conn, { command: 'SETNAME', params: ['Third'], tags: {} }, ctx);
+
+    expect(conn.realname).toBe('Third');
+  });
+
+  it('stamps lastSeen with ctx.clock.now()', () => {
+    const conn = makeConn();
+    const clock = new FakeClock(9_900);
+    const ctx = makeCtx(conn, clock);
+
+    setnameReducer(conn, { command: 'SETNAME', params: ['X'], tags: {} }, ctx);
+
+    expect(conn.lastSeen).toBe(9_900);
+  });
+});
+
+// ============================================================================
+// setnameReducer — WHOIS reflects the new realname
+// ============================================================================
+
+describe('setnameReducer — WHOIS reflects the new realname', () => {
+  it('a subsequent WHOIS returns the updated realname in 311 RPL_WHOISUSER', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    setnameReducer(conn, { command: 'SETNAME', params: ['Alice Wonderland'], tags: {} }, ctx);
+
+    const out = whoisReducer(conn, [], { command: 'WHOIS', params: ['alice'] }, ctx);
+    const firstBatch = out.effects[0];
+    expect(firstBatch?.tag).toBe('Send');
+    if (firstBatch?.tag === 'Send') {
+      expect(firstBatch.lines[0]?.text).toBe(
+        ':irc.example.com 311 alice alice alice example.com * :Alice Wonderland',
+      );
+    }
+  });
+});
+
+// ============================================================================
+// setnameReducer — validation
+// ============================================================================
+
+describe('setnameReducer — validation', () => {
+  it('emits 461 ERR_NEEDMOREPARAMS when no realname param is given', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 alice SETNAME :Not enough parameters')]),
+    ]);
+    expect(conn.realname).toBe('Alice');
+  });
+
+  it('emits 461 ERR_NEEDMOREPARAMS when the realname param is empty', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: [''], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 461 alice SETNAME :Not enough parameters')]),
+    ]);
+    expect(conn.realname).toBe('Alice');
+  });
+
+  it('emits 451 ERR_NOTREGISTERED when the connection is not registered', () => {
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    conn.nick = 'alice';
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: ['New Name'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 451 alice :You have not registered')]),
+    ]);
+    expect(conn.realname).toBeUndefined();
+  });
+
+  it('uses * in the numeric reply when the connection has no nick', () => {
+    const conn = createConnection({ id: 'c1', connectedSince: 0 });
+    const ctx = makeCtx(conn);
+
+    const out = setnameReducer(conn, { command: 'SETNAME', params: ['New Name'], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 451 * :You have not registered')]),
+    ]);
+  });
+});
+
+// ============================================================================
+// setnameReducer — length cap
+// ============================================================================
+
+describe('setnameReducer — length cap', () => {
+  it('rejects an over-cap realname with 432 and leaves state.realname unchanged', () => {
+    const conn = makeConn();
+    const cap = 5;
+    const ctx: Ctx = buildCtx({
+      serverConfig: { ...serverConfig, realnameLen: cap },
+      clock: new FakeClock(1_000),
+      ids: new SequentialIdFactory(),
+      motd: EmptyMotdProvider,
+      connection: conn,
+    });
+
+    const out = setnameReducer(
+      conn,
+      { command: 'SETNAME', params: ['Way Too Long'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 432 alice :Erroneous realname')]),
+    ]);
+    expect(conn.realname).toBe('Alice');
+  });
+
+  it('accepts a realname exactly at the cap', () => {
+    const conn = makeConn();
+    const cap = 5;
+    const ctx: Ctx = buildCtx({
+      serverConfig: { ...serverConfig, realnameLen: cap },
+      clock: new FakeClock(1_000),
+      ids: new SequentialIdFactory(),
+      motd: EmptyMotdProvider,
+      connection: conn,
+    });
+
+    setnameReducer(conn, { command: 'SETNAME', params: ['seven'], tags: {} }, ctx);
+
+    expect(conn.realname).toBe('seven');
+  });
+
+  it('applies the default cap when ServerConfig.realnameLen is unset', () => {
+    const conn = makeConn();
+    const ctx = makeCtx(conn);
+
+    const atDefault = 'x'.repeat(50);
+    setnameReducer(conn, { command: 'SETNAME', params: [atDefault], tags: {} }, ctx);
+    expect(conn.realname).toBe(atDefault);
+
+    conn.realname = 'Alice';
+    const overDefault = 'x'.repeat(51);
+    const out = setnameReducer(conn, { command: 'SETNAME', params: [overDefault], tags: {} }, ctx);
+    expect(out.effects[0]?.tag).toBe('Send');
+    expect(conn.realname).toBe('Alice');
+  });
+});