create-nexwire 4.0.0

package/express/src/framework/realtime/socket-cookie.ts

@@ -0,0 +1,71 @@
+import { signedCookie } from "cookie-parser";
+import type { Socket } from "socket.io";
+import { cookieConfig } from "@/config/index.js";
+import type { RealtimeAuthContext } from "@/framework/realtime/types.js";
+import { jwt } from "@/framework/support/jwt.js";
+
+export function unauthenticatedRealtimeAuth(): RealtimeAuthContext {
+  return { isAuthenticated: false, userId: null, roles: [], payload: null };
+}
+
+function parseCookieHeader(header: string | undefined) {
+  if (!header) return {} as Record<string, string>;
+
+  const cookies: Record<string, string> = {};
+  for (const part of header.split(";")) {
+    const [rawName, ...rawValue] = part.trim().split("=");
+    if (!rawName || rawValue.length === 0) continue;
+    cookies[rawName] = decodeURIComponent(rawValue.join("="));
+  }
+
+  return cookies;
+}
+
+function userIdFromPayload(payload: Record<string, unknown>) {
+  const candidate = payload.userId ?? payload.id ?? payload.sub;
+  if (candidate === null || candidate === undefined) return null;
+  return String(candidate);
+}
+
+function rolesFromPayload(payload: Record<string, unknown>) {
+  const direct = payload.roles;
+  if (Array.isArray(direct)) return direct.map((role) => String(role));
+
+  const single = payload.role;
+  if (single === null || single === undefined) return [];
+  return [String(single)];
+}
+
+/**
+ * Why: Resolves auth context for websocket connections from cookies.
+ * When: Socket.IO handshake middleware executes.
+ * Where: Realtime server auth pipeline.
+ * How: Parses access cookie, verifies JWT, then normalizes user/role claims.
+ */
+export async function authFromSocketHandshake(socket: Socket): Promise<RealtimeAuthContext> {
+  const cookies = parseCookieHeader(socket.handshake.headers.cookie);
+  const rawToken = cookies[`${cookieConfig.name}_access`];
+
+  if (!rawToken) {
+    return unauthenticatedRealtimeAuth();
+  }
+
+  const token = signedCookie(rawToken, cookieConfig.secret);
+  if (!token) {
+    return unauthenticatedRealtimeAuth();
+  }
+
+  const payload = await jwt.verifyToken(token, "access");
+  if (!payload) {
+    return unauthenticatedRealtimeAuth();
+  }
+
+  const normalizedPayload = payload as Record<string, unknown>;
+
+  return {
+    isAuthenticated: true,
+    userId: userIdFromPayload(normalizedPayload),
+    roles: rolesFromPayload(normalizedPayload),
+    payload: normalizedPayload
+  };
+}

package/express/src/framework/realtime/socket.ts

@@ -0,0 +1,119 @@
+import { createAdapter } from "@socket.io/redis-adapter";
+import { Server as SocketIOServer } from "socket.io";
+import { appConfig, realtimeConfig, redisConfig } from "@/config/index.js";
+import { authFromSocketHandshake, unauthenticatedRealtimeAuth } from "@/framework/realtime/socket-cookie.js";
+import type { RealtimeAuthContext } from "@/framework/realtime/types.js";
+import { redisClientIfReady } from "@/framework/redis/client.js";
+import { logger } from "@/framework/support/logger.js";
+
+export type RealtimeServeWebSocket = Record<string, never>;
+
+export type RealtimeInit = {
+  io: SocketIOServer;
+  websocketServe: RealtimeServeWebSocket;
+};
+
+export const WS_PATH = "/socket.io";
+
+let io: SocketIOServer | null = null;
+let adapterSubClient: ReturnType<typeof redisClientIfReady> | null = null;
+
+function socketAllowedOrigins() {
+  const origins = [appConfig.url, appConfig.frontendUrl].filter(Boolean) as string[];
+  if (realtimeConfig.enabled) origins.push("https://admin.socket.io");
+  return [...new Set(origins)];
+}
+
+async function attachRedisAdapter() {
+  if (!redisConfig.enabled) return;
+
+  const pubClient = redisClientIfReady();
+  if (!pubClient) return;
+
+  adapterSubClient = pubClient.duplicate();
+  await adapterSubClient.connect();
+  io?.adapter(createAdapter(pubClient, adapterSubClient));
+}
+
+function registerAuthAndRooms() {
+  io?.use(async (socket, next) => {
+    const auth = await authFromSocketHandshake(socket);
+    socket.data.auth = auth as RealtimeAuthContext;
+
+    if (auth.isAuthenticated) {
+      socket.join("auth");
+      if (auth.userId) socket.join(`user:${auth.userId}`);
+      for (const role of auth.roles) socket.join(`role:${role}`);
+    } else {
+      socket.join("guest");
+    }
+
+    next();
+  });
+
+  io?.on("connection", (socket) => {
+    const auth = (socket.data.auth || unauthenticatedRealtimeAuth()) as RealtimeAuthContext;
+
+    logger.debug("Socket connected", {
+      socketId: socket.id,
+      authenticated: auth.isAuthenticated,
+      userId: auth.userId
+    });
+
+    socket.on("join", (room) => socket.join(String(room)));
+    socket.on("disconnect", (reason) => {
+      logger.info("Socket disconnected", {
+        socketId: socket.id,
+        reason,
+        authenticated: auth.isAuthenticated,
+        userId: auth.userId
+      });
+    });
+  });
+}
+
+export async function initRealtime(target: { httpServer: any }): Promise<RealtimeInit | null> {
+  if (!realtimeConfig.enabled) {
+    logger.info("Socket.IO disabled (disabled in config)");
+    return null;
+  }
+
+  if (io) return { io, websocketServe: {} };
+
+  io = new SocketIOServer(target.httpServer, {
+    cors: { origin: socketAllowedOrigins(), credentials: true }
+  });
+
+  await attachRedisAdapter();
+  registerAuthAndRooms();
+
+  logger.info(`Socket.IO enabled at ${WS_PATH}`);
+  return { io, websocketServe: {} };
+}
+
+export function socketServer() {
+  return io;
+}
+
+export function ioServer() {
+  return io;
+}
+
+export async function closeRealtime() {
+  if (!io) return;
+
+  await new Promise<void>((resolve) => {
+    io?.close(() => resolve());
+  });
+
+  if (adapterSubClient) {
+    try {
+      await adapterSubClient.quit();
+    } catch {
+      adapterSubClient.disconnect();
+    }
+    adapterSubClient = null;
+  }
+
+  io = null;
+}

package/express/src/framework/realtime/types.ts

@@ -0,0 +1,6 @@
+export type RealtimeAuthContext = {
+  isAuthenticated: boolean;
+  userId: string | null;
+  roles: string[];
+  payload: Record<string, unknown> | null;
+};

package/express/src/framework/realtime/ui.ts

@@ -0,0 +1,16 @@
+import { instrument } from "@socket.io/admin-ui";
+import type { Server as SocketIOServer } from "socket.io";
+import { appConfig, realtimeConfig } from "@/config/index.js";
+
+export function setupSocketAdminUI(io: SocketIOServer | null) {
+  if (!io || !realtimeConfig.enabled || appConfig.environment === "production") {
+    return { enabled: false };
+  }
+
+  instrument(io, {
+    auth: false,
+    mode: "development"
+  });
+
+  return { enabled: true };
+}

package/express/src/framework/redis/client.ts

@@ -0,0 +1,151 @@
+import { Redis } from "ioredis";
+import { redisConfig } from "@/config/index.js";
+import { CircuitBreaker } from "@/framework/circuit-breaker/cb.js";
+import { logger } from "@/framework/support/logger.js";
+
+export type redis = Redis;
+
+let client: redis | null = null;
+let ready = false;
+let lastError: string | null = null;
+let redisBreaker: CircuitBreaker | null = null;
+
+if (redisConfig.enabled) {
+  redisBreaker = new CircuitBreaker();
+}
+
+function safeRedisUrl() {
+  try {
+    const url = new URL(redisConfig.url);
+    if (url.password) url.password = "***";
+    return url.toString();
+  } catch {
+    return redisConfig.url;
+  }
+}
+
+/**
+ * Why: Initializes shared Redis connection for cache/queue/events/session.
+ * When: Runtime bootstrap before Redis-backed features are used.
+ * Where: Server, worker, scheduler startup paths.
+ * How: Connects once, tracks readiness, and degrades gracefully if unavailable.
+ */
+export async function initRedis() {
+  if (client) return client;
+
+  if (!redisConfig.enabled) {
+    ready = false;
+    lastError = "redis disabled in config";
+    logger.info("Redis disabled; cache, session storage, queue, events, and cockpit unavailable");
+    return null;
+  }
+
+  if (redisBreaker?.getState() === "open") {
+    lastError = "redis circuit breaker is open";
+    logger.warn("Redis circuit breaker is open; skipping connection");
+    return null;
+  }
+
+  try {
+    client = new Redis(redisConfig.url, {
+      lazyConnect: true,
+      enableReadyCheck: true,
+      maxRetriesPerRequest: 0,
+      retryStrategy: () => null
+    });
+
+    client.on("error", (error) => {
+      lastError = error.message;
+      if (ready) {
+        logger.warn("Redis connection error", {
+          redisUrl: safeRedisUrl(),
+          error: error.message
+        });
+      }
+    });
+
+    await client.connect();
+    await client.ping();
+    ready = true;
+    redisBreaker?.onSuccess();
+    return client;
+  } catch (error) {
+    lastError ||= error instanceof Error ? error.message : String(error);
+    client?.disconnect();
+    client = null;
+    ready = false;
+    redisBreaker?.onFailure();
+    logger.warn(`Redis unavailable; continuing without Redis features (${lastError})`);
+    return null;
+  }
+}
+
+/**
+ * Why: Returns the current Redis client instance.
+ * When: Internal helpers need direct Redis operations.
+ * Where: Cache/session/queue/events modules.
+ * How: Returns nullable singleton without creating a new connection.
+ */
+export function redis() {
+  return client;
+}
+
+/**
+ * Why: Indicates whether Redis is connected and usable.
+ * When: Features need to branch on Redis availability.
+ * Where: Cache/session/queue/event internals.
+ * How: Combines readiness flag with client presence.
+ */
+export function redisReady() {
+  return ready && client !== null;
+}
+
+/**
+ * Why: Provides a single ready-checked Redis client accessor.
+ * When: Redis-backed modules need quick availability guard.
+ * Where: Cache/session/queue/events/BullBoard internals.
+ * How: Returns connected client or null when Redis is unavailable.
+ */
+export function redisClientIfReady() {
+  if (redisBreaker?.getState() === "open") return null;
+  return redisReady() ? client : null;
+}
+
+/**
+ * Why: Exposes last Redis error for diagnostics.
+ * When: Startup or health logs need failure detail.
+ * Where: Runtime status output.
+ * How: Returns cached error message string.
+ */
+export function redisError() {
+  return lastError;
+}
+
+/**
+ * Why: Returns the Redis circuit breaker instance or null when disabled.
+ * When: Health checks and diagnostics need breaker state.
+ * Where: Runtime status and monitoring paths.
+ * How: Returns the breaker if Redis is enabled, null otherwise.
+ */
+export function getRedisBreaker() {
+  return redisBreaker;
+}
+
+/**
+ * Why: Closes Redis connection during graceful shutdown.
+ * When: Process stop hooks for server/worker/scheduler.
+ * Where: Runtime lifecycle files.
+ * How: Attempts quit, falls back to disconnect, then resets state.
+ */
+export async function closeRedis() {
+  if (!client) return;
+
+  try {
+    await client.quit();
+  } catch {
+    client.disconnect();
+  } finally {
+    client = null;
+    ready = false;
+  }
+}

package/express/src/framework/runtime/runtime.ts

@@ -0,0 +1,23 @@
+export type Runtime = "node" | "bun" | "unknown";
+
+const runtimeGlobals = globalThis as Record<string, unknown>;
+
+/**
+ * Why: Select the correct driver/flavor when a runtime has specialized packages.
+ * When: Loading DB clients, web servers, and queues that vary per runtime.
+ * Where: Framework bootstrap and driver resolution layers.
+ * How: Inspects global runtime markers (Bun) and falls back to Node/unknown.
+ */
+export function runtime(): Runtime {
+  if (runtimeGlobals.Bun !== undefined) return "bun";
+  if (typeof process !== "undefined" && process.versions?.node) return "node";
+  return "unknown";
+}
+
+export function isBun(): boolean {
+  return runtime() === "bun";
+}
+
+export function isNode(): boolean {
+  return runtime() === "node";
+}

package/express/src/framework/runtime/server-adapter.ts

@@ -0,0 +1,34 @@
+import type { AddressInfo } from "node:net";
+import type { Express } from "express";
+import type { RealtimeServeWebSocket } from "@/framework/realtime/socket.js";
+import { runtime } from "@/framework/runtime/runtime.js";
+
+export type HttpServerHandle = {
+  address(): string | AddressInfo | null;
+  close(): Promise<void>;
+  native: unknown;
+};
+
+async function startNode(app: Express, port: number, _websocket?: RealtimeServeWebSocket): Promise<HttpServerHandle> {
+  const { createServer } = await import("node:http");
+
+  const server = createServer(app);
+  await new Promise<void>((resolve) => server.listen(port, resolve));
+
+  return {
+    native: server,
+    address: () => server.address(),
+    close: () => new Promise<void>((resolve) => server.close(() => resolve()))
+  };
+}
+
+async function startBun(app: Express, port: number, _websocket?: RealtimeServeWebSocket): Promise<HttpServerHandle> {
+  const server = await startNode(app, port);
+  return server;
+}
+
+export async function startHttpServer(app: Express, port: number, websocket?: RealtimeServeWebSocket): Promise<HttpServerHandle> {
+  const activeRuntime = runtime();
+  if (activeRuntime === "bun") return startBun(app, port, websocket);
+  return startNode(app, port, websocket);
+}

package/express/src/framework/scheduler/lock.ts

@@ -0,0 +1,116 @@
+import { randomUUID } from "node:crypto";
+import { redisConfig } from "@/config/index.js";
+import { databaseDialect, databasePool } from "@/framework/database/connection.js";
+import { redis, redisReady } from "@/framework/redis/client.js";
+
+type LockOptions = { ttlMs?: number; tableName?: string };
+
+function table(name?: string) {
+  return name || "scheduler_locks";
+}
+
+async function ensureTable(tableName?: string) {
+  const pool = databasePool();
+  const dialect = databaseDialect();
+  const lockTable = table(tableName);
+
+  if (dialect === "mysql") {
+    await pool.query(
+      `CREATE TABLE IF NOT EXISTS \`${lockTable}\` (name VARCHAR(191) PRIMARY KEY, owner VARCHAR(191) NOT NULL, expires_at BIGINT NOT NULL)`
+    );
+    return;
+  }
+
+  if (dialect === "postgresql") {
+    await pool.unsafe(
+      `CREATE TABLE IF NOT EXISTS "${lockTable}" (name VARCHAR(191) PRIMARY KEY, owner VARCHAR(191) NOT NULL, expires_at BIGINT NOT NULL)`
+    );
+    return;
+  }
+
+  await pool.execute(`CREATE TABLE IF NOT EXISTS "${lockTable}" (name TEXT PRIMARY KEY, owner TEXT NOT NULL, expires_at INTEGER NOT NULL)`);
+}
+
+async function acquireDbLock(name: string, owner: string, ttlMs: number, tableName?: string) {
+  await ensureTable(tableName);
+  const pool = databasePool();
+  const dialect = databaseDialect();
+  const lockTable = table(tableName);
+  const now = Date.now();
+  const expiresAt = now + ttlMs;
+
+  if (dialect === "postgresql") {
+    const rows = await pool.unsafe(
+      `INSERT INTO "${lockTable}" (name, owner, expires_at) VALUES ($1, $2, $3) ON CONFLICT (name) DO UPDATE SET owner = EXCLUDED.owner, expires_at = EXCLUDED.expires_at WHERE "${lockTable}".expires_at < $4 RETURNING owner`,
+      [name, owner, expiresAt, now]
+    );
+    return rows?.[0]?.owner === owner;
+  }
+
+  if (dialect === "mysql") {
+    await pool.query(
+      `INSERT INTO \`${lockTable}\` (name, owner, expires_at) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE owner = IF(expires_at < ?, VALUES(owner), owner), expires_at = IF(expires_at < ?, VALUES(expires_at), expires_at)`,
+      [name, owner, expiresAt, now, now]
+    );
+    const [rows] = await pool.query(`SELECT owner FROM \`${lockTable}\` WHERE name = ?`, [name]);
+    return rows?.[0]?.owner === owner;
+  }
+
+  await pool.execute({
+    sql: `INSERT INTO "${lockTable}" (name, owner, expires_at) VALUES (?, ?, ?) ON CONFLICT(name) DO UPDATE SET owner = excluded.owner, expires_at = excluded.expires_at WHERE "${lockTable}".expires_at < ?`,
+    args: [name, owner, expiresAt, now]
+  });
+  const result = await pool.execute({
+    sql: `SELECT owner FROM "${lockTable}" WHERE name = ?`,
+    args: [name]
+  });
+  return result.rows?.[0]?.owner === owner;
+}
+
+async function releaseDbLock(name: string, owner: string, tableName?: string) {
+  const pool = databasePool();
+  const dialect = databaseDialect();
+  const lockTable = table(tableName);
+
+  if (dialect === "postgresql") return await pool.unsafe(`DELETE FROM "${lockTable}" WHERE name = $1 AND owner = $2`, [name, owner]);
+  if (dialect === "mysql") return await pool.query(`DELETE FROM \`${lockTable}\` WHERE name = ? AND owner = ?`, [name, owner]);
+  await pool.execute({
+    sql: `DELETE FROM "${lockTable}" WHERE name = ? AND owner = ?`,
+    args: [name, owner]
+  });
+}
+
+/**
+ * Why: Runs a handler with distributed lock to prevent duplicate execution.
+ * When: Scheduled tasks may run across multiple processes/instances.
+ * Where: Scheduler runtime around each cron job.
+ * How: Uses Redis NX lock when available, otherwise falls back to DB lock table.
+ */
+export async function runWithLock<T>(name: string, handler: () => Promise<T>, options: LockOptions = {}) {
+  const owner = randomUUID();
+  const ttlMs = options.ttlMs || 60_000;
+  const client = redis();
+
+  if (redisReady() && client) {
+    const key = `${redisConfig.prefix}:lock:${name}`;
+    const ok = await client.set(key, owner, "PX", ttlMs, "NX");
+    if (!ok) return { ran: false, backend: "redis" as const };
+
+    try {
+      const result = await handler();
+      return { ran: true, backend: "redis" as const, result };
+    } finally {
+      await client.del(key);
+    }
+  }
+
+  const ok = await acquireDbLock(name, owner, ttlMs, options.tableName);
+  if (!ok) return { ran: false, backend: "db" as const };
+
+  try {
+    const result = await handler();
+    return { ran: true, backend: "db" as const, result };
+  } finally {
+    await releaseDbLock(name, owner, options.tableName);
+  }
+}

package/express/src/framework/scheduler/run.ts

@@ -0,0 +1,48 @@
+import { initDatabase } from "@/framework/database/connection.js";
+import { bootQueueJobs, stopQueueRuntime } from "@/framework/queue/queue.js";
+import { closeRedis, initRedis } from "@/framework/redis/client.js";
+import { startScheduler, stopScheduler } from "@/framework/scheduler/scheduler.js";
+import { registerShutdownSignals, type ShutdownSignal } from "@/framework/support/lifecycle.js";
+import { logger } from "@/framework/support/logger.js";
+
+export interface SchedulerHandle {
+  count: number;
+  shutdown: (signal: ShutdownSignal) => Promise<void>;
+}
+
+/**
+ * Why: Starts the scheduler and wires DB/Redis/queue shutdown.
+ * When: CLI `schedule:work` command or E2E test bootstrap.
+ * Where: Scheduler entrypoint.
+ * How: Inits DB/Redis, boots queue jobs, starts scheduler, registers signals.
+ *      When called as the main module, also prints the startup banner.
+ */
+export async function startSchedulerRuntime(): Promise<SchedulerHandle> {
+  await initDatabase();
+  await initRedis();
+  await bootQueueJobs();
+  const count = await startScheduler();
+  console.log(`Scheduler started [${count} schedule(s)]`);
+
+  let shuttingDown = false;
+
+  async function shutdown(signal: ShutdownSignal) {
+    if (shuttingDown) return;
+    shuttingDown = true;
+
+    logger.info("Scheduler shutdown signal received", { signal });
+    await Promise.allSettled([Promise.resolve(stopScheduler()), stopQueueRuntime()]);
+    await closeRedis();
+
+    process.exit(0);
+  }
+
+  registerShutdownSignals(shutdown);
+
+  return { count, shutdown };
+}
+
+const isMain = process.argv[1]?.endsWith("run.ts") || process.argv[1]?.endsWith("run.js");
+if (isMain) {
+  await startSchedulerRuntime();
+}