serverless-ircd 0.6.0 → 0.8.0

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

@@ -0,0 +1,361 @@
+import { describe, expect, it } from 'vitest';
+import { markreadChannelReducer } from '../../src/commands/markread';
+import { Effect } from '../../src/effects';
+import type { Effect as EffectType, RawLine } from '../../src/effects';
+import {
+  EmptyMotdProvider,
+  FakeClock,
+  InMemoryMessageStore,
+  InMemoryServicesStore,
+  type MessageStore,
+  SequentialIdFactory,
+  type ServicesStore,
+  type StoredMessage,
+} from '../../src/ports';
+import { formatServerTime } from '../../src/protocol/outbound';
+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(10_000),
+  messages?: MessageStore,
+  services?: ServicesStore,
+): Ctx {
+  return buildCtx({
+    serverConfig,
+    clock,
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: conn,
+    ...(messages !== undefined ? { messages } : {}),
+    ...(services !== undefined ? { services } : {}),
+  });
+}
+
+function makeConn(id = 'c1', nick = 'alice', account?: 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';
+  s.caps.add('draft/read-marker');
+  if (account !== undefined) s.account = account;
+  return s;
+}
+
+function makeChan(name = '#foo'): ChannelState {
+  const chan = createChannel({ name, nameLower: name.toLowerCase(), createdAt: 0 });
+  return chan;
+}
+
+function addMember(chan: ChannelState, connId: string, nick: string): void {
+  chan.members.set(connId, { conn: connId, nick, op: false, voice: false });
+}
+
+/** Seeds N chronological messages at 1s, 2s, … into `store` for `chan`. */
+function seed(store: MessageStore, chan: string, count: number): StoredMessage[] {
+  const out: StoredMessage[] = [];
+  for (let i = 1; i <= count; i++) {
+    const m: StoredMessage = {
+      msgid: `m${i}`,
+      time: i * 1_000,
+      chan: chan.toLowerCase(),
+      command: 'PRIVMSG',
+      nick: 'bob',
+      user: 'bob',
+      host: 'ex.org',
+      text: `msg ${i}`,
+    };
+    store.record(m);
+    out.push(m);
+  }
+  return out;
+}
+
+const L = (text: string): RawLine => ({ text });
+const ts = (ms: number): string => `timestamp=${formatServerTime(ms)}`;
+const READ_MARKER_FAIL = (code: string, desc: string): RawLine =>
+  L(`:irc.example.com FAIL MARKREAD ${code} :${desc}`);
+const MARKREAD_REPLY = (target: string, timestamp: string): RawLine =>
+  L(`:irc.example.com MARKREAD ${target} ${timestamp}`);
+
+// ============================================================================
+// cap gating
+// ============================================================================
+describe('markreadChannelReducer — cap gating', () => {
+  it('emits 421 ERR_UNKNOWNCOMMAND when draft/read-marker was not negotiated', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    conn.caps.delete('draft/read-marker');
+    const ctx = makeCtx(conn);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 421 alice MARKREAD :Unknown command')]),
+    ]);
+  });
+});
+
+// ============================================================================
+// missing / invalid parameters
+// ============================================================================
+describe('markreadChannelReducer — parameter errors', () => {
+  it('FAILs with NEED_MORE_PARAMS when the target is missing', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const ctx = makeCtx(makeConn());
+
+    const out = markreadChannelReducer(chan, { command: 'MARKREAD', params: [], tags: {} }, ctx);
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [READ_MARKER_FAIL('NEED_MORE_PARAMS', 'Missing parameters')]),
+    ]);
+  });
+
+  it('FAILs with INVALID_PARAMS when the set timestamp is the literal *', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const ctx = makeCtx(makeConn(), new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', '*'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [READ_MARKER_FAIL('INVALID_PARAMS', 'Invalid parameters')]),
+    ]);
+  });
+
+  it('FAILs with INVALID_PARAMS when the timestamp param is malformed', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const ctx = makeCtx(makeConn(), new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', 'not-a-timestamp'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [READ_MARKER_FAIL('INVALID_PARAMS', 'Invalid parameters')]),
+    ]);
+  });
+});
+
+// ============================================================================
+// GET command (MARKREAD <target>)
+// ============================================================================
+describe('markreadChannelReducer — GET command', () => {
+  it('replies with * when no marker is stored for the channel', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const ctx = makeCtx(makeConn(), new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([Effect.send('c1', [MARKREAD_REPLY('#foo', '*')])]);
+  });
+
+  it('replies with the stored marker message timestamp', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const conn = makeConn();
+    conn.lastReadMarkers = new Map([['#foo', 'm2']]);
+    const ctx = makeCtx(conn, new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo'], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [MARKREAD_REPLY('#foo', ts(2_000))]),
+    ]);
+  });
+});
+
+// ============================================================================
+// SET command (MARKREAD <target> <timestamp>)
+// ============================================================================
+describe('markreadChannelReducer — SET command', () => {
+  it('translates the timestamp to a msgid, persists it, and echoes the resolved timestamp', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const conn = makeConn();
+    const ctx = makeCtx(conn, new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [MARKREAD_REPLY('#foo', ts(2_000))]),
+    ]);
+    expect(conn.lastReadMarkers?.get('#foo')).toBe('m2');
+  });
+
+  it('resolves an in-between timestamp to the most recent message at or before it', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3); // m1=1s, m2=2s, m3=3s
+    const conn = makeConn();
+    const ctx = makeCtx(conn, new FakeClock(10_000), store);
+
+    // 2.5s sits between m2 and m3; resolves to m2.
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_500)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [MARKREAD_REPLY('#foo', ts(2_000))]),
+    ]);
+    expect(conn.lastReadMarkers?.get('#foo')).toBe('m2');
+  });
+
+  it('never moves the marker backwards: an older-or-equal timestamp replies with the stored value', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const conn = makeConn();
+    conn.lastReadMarkers = new Map([['#foo', 'm3']]); // already read up to 3s
+    const ctx = makeCtx(conn, new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} }, // older
+      ctx,
+    );
+
+    // Replies with the newer stored value; marker is not regressed.
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [MARKREAD_REPLY('#foo', ts(3_000))]),
+    ]);
+    expect(conn.lastReadMarkers?.get('#foo')).toBe('m3');
+  });
+
+  it('replies with the current marker (no advance) when the timestamp matches no retained message', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3); // earliest retained is 1s
+    const conn = makeConn();
+    conn.lastReadMarkers = new Map([['#foo', 'm2']]);
+    const ctx = makeCtx(conn, new FakeClock(10_000), store);
+
+    // 500ms predates every retained message; cannot translate.
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(500)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [MARKREAD_REPLY('#foo', ts(2_000))]),
+    ]);
+    expect(conn.lastReadMarkers?.get('#foo')).toBe('m2');
+  });
+
+  it('persists the marker through ServicesStore for an identified connection', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const services = new InMemoryServicesStore();
+    const conn = makeConn('c1', 'alice', 'alice');
+    const ctx = makeCtx(conn, new FakeClock(10_000), store, services);
+
+    markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} },
+      ctx,
+    );
+
+    expect(services.listReadMarkers('alice')).toEqual([
+      { account: 'alice', channel: '#foo', msgid: 'm2' },
+    ]);
+  });
+});
+
+// ============================================================================
+// graceful degradation + membership
+// ============================================================================
+describe('markreadChannelReducer — degradation + membership', () => {
+  it('SET without a bound MessageStore replies with the current marker (no advance)', () => {
+    const chan = makeChan();
+    addMember(chan, 'c1', 'alice');
+    const conn = makeConn();
+    // No messages store: no way to translate timestamp -> msgid.
+    const ctx = makeCtx(conn);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([Effect.send('c1', [MARKREAD_REPLY('#foo', '*')])]);
+    expect(conn.lastReadMarkers).toBeUndefined();
+  });
+
+  it('is silent (no reply, no state change) for a non-member on a +n channel', () => {
+    const chan = makeChan();
+    chan.modes.noExternal = true;
+    // c1 is NOT a member.
+    const store = new InMemoryMessageStore();
+    seed(store, '#foo', 3);
+    const ctx = makeCtx(makeConn(), new FakeClock(10_000), store);
+
+    const out = markreadChannelReducer(
+      chan,
+      { command: 'MARKREAD', params: ['#foo', ts(2_000)], tags: {} },
+      ctx,
+    );
+
+    expect(out.effects).toEqual<EffectType[]>([]);
+  });
+});