serverless-ircd 0.4.0 → 0.5.0

package/packages/aws-adapter/src/handlers/connect.ts

@@ -14,7 +14,13 @@
 
 import type { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
 import { PutCommand, ScanCommand } from '@aws-sdk/lib-dynamodb';
-import type { ParsedServerConfig } from '@serverless-ircd/irc-core';
+import {
+  type ParsedServerConfig,
+  type WsSubprotocol,
+  parseSecWsProtocolOffers,
+  selectSubprotocol,
+  wsFrameModeFor,
+} from '@serverless-ircd/irc-core';
 import { type AdmissionOutcome, decideConnectAdmission } from '../admission.js';
 import { marshalConnection } from '../serialize.js';
 import type { TablesConfig } from '../tables.js';
@@ -29,10 +35,24 @@ export interface ConnectParams {
   now?: number;
   /** Server config — consulted for the `maxClients` admission cap. */
   serverConfig: ParsedServerConfig;
+  /**
+   * Raw `Sec-WebSocket-Protocol` header offered by the client on the
+   * `$connect` upgrade, if present. Parsed into an ordered offer list and
+   * the first supported IRCv3 subprotocol is agreed (legacy fallback when
+   * none match or the header is absent).
+   */
+  secWebSocketProtocol?: string | null;
 }
 
-/** Re-exported so the dispatcher imports the outcome type from one place. */
-export type { AdmissionOutcome as ConnectOutcome } from '../admission.js';
+/**
+ * Outcome of a `$connect`. Mirrors {@link AdmissionOutcome} on the rejection
+ * branch and carries the negotiated IRCv3 {@link WsSubprotocol} on success so
+ * the dispatcher can echo it back to the client in the integration response.
+ * `subprotocol === null` signals a legacy (no-subprotocol) connection.
+ */
+export type ConnectOutcome =
+  | { readonly admitted: true; readonly subprotocol: WsSubprotocol | null }
+  | { readonly admitted: false; readonly statusCode: number; readonly reason: string };
 
 /**
  * Enforces the `maxClients` admission cap, then inserts the Connections
@@ -58,20 +78,31 @@ export type { AdmissionOutcome as ConnectOutcome } from '../admission.js';
  * into {@link decideConnectAdmission}'s `perIp` branch. That schema
  * change is tracked as a follow-up; the pure policy already supports it.
  */
-export async function handleConnect(params: ConnectParams): Promise<AdmissionOutcome> {
+export async function handleConnect(params: ConnectParams): Promise<ConnectOutcome> {
   const now = params.now ?? Date.now();
   const total = await countConnections(params.dynamo, params.tables.Connections);
   const outcome = decideConnectAdmission({ total }, { maxClients: params.serverConfig.maxClients });
   if (!outcome.admitted) return outcome;
+  // IRCv3 WebSocket subprotocol negotiation: parse the offered
+  // `Sec-WebSocket-Protocol` list, select the first supported entry, and
+  // persist the resulting frame mode so every subsequent `$default`
+  // invocation recovers it (a Lambda `$connect` has no live socket to
+  // tag, unlike the CF adapter's hibernation tags). `null` means no
+  // supported subprotocol was offered → legacy framing, no mode column.
+  const chosen = selectSubprotocol(parseSecWsProtocolOffers(params.secWebSocketProtocol));
+  const mode = wsFrameModeFor(chosen ?? undefined);
   const state = createInitialConnectionState(params.connectionId, now);
   const row = marshalConnection(state, now);
+  if (mode !== 'legacy') {
+    row.wsMode = mode;
+  }
   await params.dynamo.send(
     new PutCommand({
       TableName: params.tables.Connections,
       Item: row,
     }),
   );
-  return outcome;
+  return { admitted: true, subprotocol: chosen };
 }
 
 /**

package/packages/aws-adapter/src/handlers/default.ts

@@ -22,9 +22,12 @@ import {
   type MtlsIdentityProvider,
   type NickHistoryStore,
   type ParsedServerConfig,
+  type ServerConfig,
   SystemClock,
   UuidIdFactory,
+  type WsFrameMode,
   createConnection,
+  frameToLines,
 } from '@serverless-ircd/irc-core';
 import { type ActorChannelAccess, ConnectionActor } from '@serverless-ircd/irc-server';
 import { AwsRuntime, type AwsRuntimeHandlers, type PostToConnection } from '../aws-runtime.js';
@@ -33,8 +36,18 @@ import {
   type MarshalledConnection,
   unmarshalConnection,
 } from '../serialize.js';
+import { AwsStats } from '../stats.js';
 import type { TablesConfig } from '../tables.js';
 
+/**
+ * Wall-clock timestamp captured at this Lambda isolate's first module load
+ * (cold start). Used as the `uptimeStartedAt` anchor for {@link AwsStats}
+ * so `STATS u` reports uptime for the current isolate. A deployment-wide
+ * uptime would require a persistent record (future work); for now each
+ * isolate reports its own.
+ */
+const LAMBDA_STARTUP_AT = Date.now();
+
 /** Parameters accepted by {@link handleDefault}. */
 export interface DefaultParams {
   dynamo: DynamoDBDocumentClient;
@@ -86,6 +99,12 @@ export interface DefaultParams {
   ids?: IdFactory;
   /** Optional management endpoint URL used when constructing a default client. */
   managementEndpoint?: string;
+  /**
+   * Config-reload source for `REHASH`. When omitted the runtime's
+   * `reloadConfig` rejects so the actor emits a graceful error-suffixed
+   * `382` and retains the prior config.
+   */
+  configLoader?: () => Promise<ServerConfig>;
 }
 
 /**
@@ -112,6 +131,12 @@ export async function handleDefault(params: DefaultParams): Promise<{ statusCode
   const persisted = result.Item as unknown as MarshalledConnection;
   const state = unmarshalConnection(persisted);
 
+  // Recover the IRCv3 WebSocket frame mode persisted at `$connect`.
+  // Absent = legacy (no subprotocol negotiated). Drives both the inbound
+  // line-framing transport (spec: one IRC message per frame, never split)
+  // and the outbound delivery shape (spec: one postToConnection per line).
+  const wsMode: WsFrameMode = persisted.wsMode ?? 'legacy';
+
   // Mark this frame's activity.
   state.lastSeen = clock.now();
 
@@ -141,6 +166,7 @@ export async function handleDefault(params: DefaultParams): Promise<{ statusCode
     handlers,
     managementApi: params.managementApi,
     clock,
+    ...(params.configLoader !== undefined ? { configLoader: params.configLoader } : {}),
   });
 
   const channelAccess = new LambdaChannelAccess(runtime, clock.now());
@@ -150,9 +176,20 @@ export async function handleDefault(params: DefaultParams): Promise<{ statusCode
     runtime,
     channels: channelAccess,
     serverConfig: params.serverConfig,
+    configSource: 'Secrets Manager',
     clock,
     ids,
     motd: params.motd,
+    transport: { feed: (chunk) => frameToLines(chunk, wsMode) },
+    // AwsStats Scans Connections + ChannelMeta for LUSERS/STATS.
+    // `uptimeStartedAt` is captured at the Lambda's cold start so `STATS u`
+    // reports per-isolate uptime; a deployment-wide uptime would require a
+    // persistent record (future work).
+    stats: new AwsStats({
+      dynamo: params.dynamo,
+      tables: params.tables,
+      uptimeStartedAt: LAMBDA_STARTUP_AT,
+    }),
     ...(params.messages !== undefined ? { messages: params.messages } : {}),
     ...(params.accounts !== undefined ? { accounts: params.accounts } : {}),
     ...(params.mtlsIdentity !== undefined ? { mtlsIdentity: params.mtlsIdentity } : {}),
@@ -172,13 +209,12 @@ export async function handleDefault(params: DefaultParams): Promise<{ statusCode
   await persistState(params.dynamo, params.tables, params.connectionId, state, clock.now());
 
   // In production, deliver outbound bytes back to the caller via APIGW.
+  // Spec-mode connections (text/binary.ircv3.net) receive exactly one IRC
+  // line per `postToConnection` (no trailing CRLF); legacy connections
+  // receive every line CRLF-joined in a single message.
   if (params.managementApi !== null && outbound.length > 0) {
-    const data = outbound.join('\r\n');
     try {
-      await params.managementApi.postToConnection({
-        ConnectionId: params.connectionId,
-        Data: data,
-      });
+      await postOutbound(params.managementApi, params.connectionId, outbound, wsMode);
     } catch {
       // The handler still returns 200 — the actor's mutations are
       // persisted; the caller just didn't see the reply this frame.
@@ -187,6 +223,28 @@ export async function handleDefault(params: DefaultParams): Promise<{ statusCode
   return { statusCode: 200 };
 }
 
+/**
+ * Delivers `lines` to `connectionId` via APIGW according to `mode`:
+ *   - `legacy` — all lines joined with `\r\n` in a single `postToConnection`.
+ *   - `spec-text` / `spec-binary` — one `postToConnection` per line, no
+ *     trailing CRLF (the IRCv3 WebSocket contract: one IRC message per
+ *     WebSocket message).
+ */
+async function postOutbound(
+  api: ApiGatewayManagementApi | PostToConnection,
+  connectionId: string,
+  lines: string[],
+  mode: WsFrameMode,
+): Promise<void> {
+  if (mode === 'legacy') {
+    await api.postToConnection({ ConnectionId: connectionId, Data: lines.join('\r\n') });
+    return;
+  }
+  for (const line of lines) {
+    await api.postToConnection({ ConnectionId: connectionId, Data: line });
+  }
+}
+
 /**
  * Writes the actor's mutated `state` back to the Connections row.
  *

package/packages/aws-adapter/src/handlers/index.ts

@@ -21,6 +21,7 @@ import {
   type MotdProvider,
   type NickHistoryStore,
   type ParsedServerConfig,
+  type ServerConfig,
   StaticMotdProvider,
   SystemClock,
 } from '@serverless-ircd/irc-core';
@@ -68,6 +69,12 @@ export interface WebSocketEvent {
      */
     identity?: { sourceIp?: string };
   };
+  /**
+   * Request headers. APIGW populates `event.headers` on every route; the
+   * `$connect` upgrade carries the client's `Sec-WebSocket-Protocol` offer
+   * here so the handler can negotiate the IRCv3 subprotocol.
+   */
+  headers?: Record<string, string>;
   body?: string;
 }
 
@@ -75,6 +82,12 @@ export interface WebSocketEvent {
 export interface LambdaResponse {
   statusCode: number;
   body?: string;
+  /**
+   * Response headers. The `$connect` route sets `Sec-WebSocket-Protocol`
+   * to echo the agreed IRCv3 subprotocol back to the client; the CDK
+   * integration-response maps it onto the WebSocket handshake.
+   */
+  headers?: Record<string, string>;
 }
 
 /** Injectable dependencies. Tests construct one of these to bypass env loading. */
@@ -105,13 +118,24 @@ export interface HandlerDeps {
    * variant is a documented follow-up.
    */
   history?: NickHistoryStore;
+  /**
+   * Config-reload source for `REHASH` — re-invokes the Lambda env config
+   * loader (Secrets Manager / SSM / env vars). Bound once per cold start;
+   * each `REHASH` re-reads the live env so rotated oper creds / MOTD take
+   * effect without a redeploy. When omitted the actor's graceful failure
+   * path applies (error-suffixed `382`).
+   */
+  configLoader?: () => Promise<ServerConfig>;
 }
 
 /**
  * Strongly-typed event discriminated by routeKey. Useful for tests that
  * construct events directly.
  */
-export type ConnectEvent = { requestContext: { routeKey: '$connect'; connectionId: string } };
+export type ConnectEvent = {
+  requestContext: { routeKey: '$connect'; connectionId: string };
+  headers?: Record<string, string>;
+};
 export type DisconnectEvent = {
   requestContext: { routeKey: '$disconnect'; connectionId: string };
 };
@@ -162,8 +186,17 @@ export async function dispatch(event: WebSocketEvent, deps: HandlerDeps): Promis
         tables: deps.tables,
         connectionId: connId,
         serverConfig: deps.serverConfig,
+        secWebSocketProtocol: event.headers?.['Sec-WebSocket-Protocol'] ?? null,
       });
-      if (outcome.admitted) return { statusCode: 200 };
+      if (outcome.admitted) {
+        if (outcome.subprotocol !== null) {
+          return {
+            statusCode: 200,
+            headers: { 'Sec-WebSocket-Protocol': outcome.subprotocol },
+          };
+        }
+        return { statusCode: 200 };
+      }
       return { statusCode: outcome.statusCode, body: outcome.reason };
     }
 
@@ -192,6 +225,7 @@ export async function dispatch(event: WebSocketEvent, deps: HandlerDeps): Promis
           messages: deps.messages,
           ...(deps.accounts !== undefined ? { accounts: deps.accounts } : {}),
           ...(deps.history !== undefined ? { history: deps.history } : {}),
+          ...(deps.configLoader !== undefined ? { configLoader: deps.configLoader } : {}),
           managementApi: deps.managementApi,
         });
         return result;
@@ -333,6 +367,10 @@ export async function buildDepsFromEnv(env: NodeJS.ProcessEnv = process.env): Pr
   const messages = bindMessageStore(cfg);
   const history = new InMemoryNickHistoryStore(SystemClock);
   const accounts = await resolveAccountStore(dynamo, tables.Accounts, cfg);
+  // REHASH reload source: re-read the live env so a rotated oper password
+  // or MOTD takes effect on the next REHASH without a redeploy.
+  const configLoader = async (): Promise<ServerConfig> =>
+    loadServerConfigFromLambdaEnv(env as LambdaConfigEnv);
   return {
     dynamo,
     tables,
@@ -341,6 +379,7 @@ export async function buildDepsFromEnv(env: NodeJS.ProcessEnv = process.env): Pr
     managementApi,
     messages,
     history,
+    configLoader,
     ...(accounts !== undefined ? { accounts } : {}),
   };
 }

package/packages/aws-adapter/src/handlers/nlb-stream.ts

@@ -53,6 +53,7 @@ import {
   type MotdProvider,
   type NickHistoryStore,
   type ParsedServerConfig,
+  type ServerConfig,
   SystemClock,
   UuidIdFactory,
 } from '@serverless-ircd/irc-core';
@@ -151,6 +152,12 @@ export interface NlbStreamParams {
   clock?: Clock;
   /** Injected for tests; defaults to {@link UuidIdFactory}. */
   ids?: IdFactory;
+  /**
+   * Config-reload source for `REHASH` (same as the wss `$default` path).
+   * When omitted the runtime's `reloadConfig` rejects so the actor emits a
+   * graceful error-suffixed `382`.
+   */
+  configLoader?: () => Promise<ServerConfig>;
 }
 
 /**
@@ -225,6 +232,7 @@ export async function handleNlbStream(
     handlers,
     managementApi: params.managementApi,
     clock,
+    ...(params.configLoader !== undefined ? { configLoader: params.configLoader } : {}),
   });
 
   const channelAccess = new NlbChannelAccess(runtime, now);
@@ -234,6 +242,7 @@ export async function handleNlbStream(
     runtime,
     channels: channelAccess,
     serverConfig: params.serverConfig,
+    configSource: 'Secrets Manager',
     clock,
     ids,
     motd: params.motd,

package/packages/aws-adapter/src/index.ts

@@ -23,6 +23,8 @@ export {
   loadDynamoAccountStore,
 } from './dynamo-account-store.js';
 export { bindAccountStore, putAccountCredential, resolveAccountStore } from './account-store.js';
+export { AwsStats } from './stats.js';
+export type { AwsStatsOptions } from './stats.js';
 export {
   loadServerConfigFromLambdaEnv,
   type LambdaConfigEnv,

package/packages/aws-adapter/src/serialize.ts

@@ -30,6 +30,7 @@ import type {
   RegistrationState,
   RosterEntry,
   UserModes,
+  WsFrameMode,
 } from '@serverless-ircd/irc-core';
 
 // ---------------------------------------------------------------------------
@@ -76,6 +77,15 @@ export interface MarshalledConnection {
   away?: string;
   saslMech?: string;
   saslBuffer?: string;
+  /**
+   * Negotiated IRCv3 WebSocket frame mode persisted at `$connect` time.
+   * Absent (`undefined`) on legacy connections (no subprotocol agreed) so
+   * the DynamoDB column is null by default — mirroring the CF adapter's
+   * hibernation-tag default. Set once and never mutated: `$default` uses
+   * `UpdateCommand` for its partial writes, so this field survives every
+   * subsequent frame.
+   */
+  wsMode?: WsFrameMode;
 }
 
 /**
@@ -118,7 +128,7 @@ export function marshalConnection(state: ConnectionState, idleSince: number): Ma
 /**
  * Materialises a {@link ConnectionState} from a stored row. Rehydrates
  * `caps` and `joinedChannels` into Sets. Throws on unrecognised
- * `version` values (forward migrations live in a future ticket).
+ * `version` values (forward migrations are not yet implemented).
  */
 export function unmarshalConnection(row: MarshalledConnection): ConnectionState {
   if (row.version > CONNECTION_VERSION) {

package/packages/aws-adapter/src/stats.ts

@@ -0,0 +1,80 @@
+/**
+ * AWS-flavoured {@link ServerStats} backend.
+ *
+ * Aggregates the network-wide counts the `LUSERS` / `STATS` reducers need
+ * directly from DynamoDB: a single `Scan` over `Connections` (the source
+ * of truth for every live connection) and one over `ChannelMeta` (one row
+ * per channel). Classification (oper / invisible / unknown) is delegated
+ * to the shared {@link computeStatsSnapshot} helper in irc-core so the
+ * classification rules live in exactly one place.
+ *
+ * Constructed per `LUSERS` / `STATS` invocation alongside the
+ * {@link AwsRuntime}; cheap to build, no caching. `uptimeStartedAt` is
+ * supplied by the caller (typically the Lambda's cold-start timestamp,
+ * stashed in module scope at first import).
+ */
+
+import type { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { ScanCommand } from '@aws-sdk/lib-dynamodb';
+import { type ServerStatsSnapshot, computeStatsSnapshot } from '@serverless-ircd/irc-core';
+import type { MarshalledConnection } from './serialize.js';
+import { unmarshalConnection } from './serialize.js';
+import type { TablesConfig } from './tables.js';
+
+export interface AwsStatsOptions {
+  /** DynamoDB DocumentClient (the same client used by {@link AwsRuntime}). */
+  readonly dynamo: DynamoDBDocumentClient;
+  /** Logical→physical table-name map. */
+  readonly tables: TablesConfig;
+  /** Epoch-ms the deployment counts uptime from (Lambda cold start). */
+  readonly uptimeStartedAt: number;
+  /**
+   * Optional high-water marks for `265 RPL_LOCALUSERS` / `266
+   * RPL_GLOBALUSERS`. When omitted the live count is reported as the max
+   * (so the wire numeric never claims a max below the current count).
+   */
+  readonly maxLocalConns?: number;
+  readonly maxGlobalConns?: number;
+}
+
+export class AwsStats {
+  private readonly dynamo: DynamoDBDocumentClient;
+  private readonly tables: TablesConfig;
+  private readonly uptimeStartedAt: number;
+  private readonly maxLocalConns: number | undefined;
+  private readonly maxGlobalConns: number | undefined;
+
+  constructor(opts: AwsStatsOptions) {
+    this.dynamo = opts.dynamo;
+    this.tables = opts.tables;
+    this.uptimeStartedAt = opts.uptimeStartedAt;
+    this.maxLocalConns = opts.maxLocalConns;
+    this.maxGlobalConns = opts.maxGlobalConns;
+  }
+
+  async getStats(): Promise<ServerStatsSnapshot> {
+    // Scan Connections in a single request. DynamoDB Local + production
+    // both paginate at 1MB; for the serverless-IRC scale (≤ tens of
+    // thousands of connections per deployment) a single page covers the
+    // realistic ceiling. A deployment that outgrows this should maintain
+    // rolling count records (updated on connect/disconnect) rather than
+    // Scan — a tracked follow-up.
+    const connResult = await this.dynamo.send(
+      new ScanCommand({ TableName: this.tables.Connections }),
+    );
+    const connItems = (connResult.Items ?? []) as unknown as MarshalledConnection[];
+    const connections = connItems.map(unmarshalConnection);
+
+    // Channel count: one row per channel in `ChannelMeta`, again in a
+    // single page (channel counts are small).
+    const chanResult = await this.dynamo.send(
+      new ScanCommand({ TableName: this.tables.ChannelMeta, Select: 'COUNT' }),
+    );
+    const channelCount = chanResult.Count ?? 0;
+
+    return computeStatsSnapshot(connections, channelCount, this.uptimeStartedAt, {
+      ...(this.maxLocalConns !== undefined ? { maxLocalConns: this.maxLocalConns } : {}),
+      ...(this.maxGlobalConns !== undefined ? { maxGlobalConns: this.maxGlobalConns } : {}),
+    });
+  }
+}

package/packages/aws-adapter/tests/aws-integration.test.ts

@@ -8,7 +8,7 @@
  *
  * Gated on `process.env.DDB_AVAILABLE`: the suite is skipped when
  * DynamoDB Local cannot be booted (no Docker, no Java). When available,
- * every scenario MUST pass — that is the 040 acceptance criterion.
+ * every scenario MUST pass — that is the acceptance criterion.
  */
 
 import { runIrcScenarios } from '@serverless-ircd/irc-test-support';

package/packages/aws-adapter/tests/aws-runtime.test.ts

@@ -12,6 +12,7 @@ import {
   type Clock,
   type ConnectionState,
   type RawLine,
+  type ServerConfig,
   createConnection,
 } from '@serverless-ircd/irc-core';
 import { afterEach, beforeEach, describe, expect, it } from 'vitest';
@@ -652,3 +653,63 @@ function handlersSink(sink: string[], snapshot?: ConnectionState): AwsRuntimeHan
     snapshot: () => snapshot,
   };
 }
+
+// ---------------------------------------------------------------------------
+// reloadConfig (REHASH) — no DynamoDB access, so this group runs unconditionally.
+// ---------------------------------------------------------------------------
+
+describe('AwsRuntime — reloadConfig (REHASH)', () => {
+  const baseConfig: ServerConfig = {
+    serverName: 'irc.example.com',
+    networkName: 'ExampleNet',
+    maxChannelsPerUser: 30,
+    maxTargetsPerCommand: 10,
+    maxListEntries: 50,
+    nickLen: 30,
+    channelLen: 50,
+    topicLen: 390,
+    quitMessage: 'Client Quit',
+  };
+
+  function makeReloadRuntime(loader?: () => Promise<ServerConfig>): AwsRuntime {
+    return new AwsRuntime({
+      // reloadConfig never touches DynamoDB; a default client + empty tables
+      // suffice for the no-IO reload path.
+      dynamo: createDynamoDocumentClient({}),
+      tables: {} as TablesConfig,
+      connId: 'c1',
+      handlers: noopHandlers(),
+      managementApi: null,
+      ...(loader !== undefined ? { configLoader: loader } : {}),
+    });
+  }
+
+  it('re-invokes the bound loader and returns the fresh config', async () => {
+    let password = 'old';
+    const rt = makeReloadRuntime(async () => ({
+      ...baseConfig,
+      operCreds: [{ user: 'admin', password }],
+    }));
+
+    const first = await rt.reloadConfig();
+    expect(first.operCreds).toEqual([{ user: 'admin', password: 'old' }]);
+
+    password = 'rotated';
+    const second = await rt.reloadConfig();
+    expect(second.operCreds).toEqual([{ user: 'admin', password: 'rotated' }]);
+  });
+
+  it('propagates a loader rejection so the actor applies the graceful 382', async () => {
+    const rt = makeReloadRuntime(async () => {
+      throw new Error('Secrets Manager unreachable');
+    });
+
+    await expect(rt.reloadConfig()).rejects.toThrow('Secrets Manager unreachable');
+  });
+
+  it('rejects when no loader was bound at construction', async () => {
+    const rt = makeReloadRuntime();
+
+    await expect(rt.reloadConfig()).rejects.toThrow('no config loader bound');
+  });
+});