cleaned comments - more concise

server/db/sqlite/driver.ts

@@ -13,22 +13,13 @@ export const exists = checkFileExists(location);
 bootstrapVolume();
 
 /**
- * Wrap a better-sqlite3 Statement so that the native sqlite3_stmt handle
+ * Wraps better-sqlite3 Statement to call `finalize()` immediately after
- * is released immediately after the first execution instead of waiting
+ * execution, freeing native sqlite3_stmt memory deterministically instead
- * for V8 garbage collection.
+ * of waiting for GC. Fixes steady off-heap growth under load (#2120).
- *
- * Background: drizzle-orm creates a **new** native prepared statement for
- * every query execution (`session.prepareQuery` → `this.client.prepare`).
- * Each native `sqlite3_stmt` consumes 8-32 KB of off-heap memory and is
- * only freed when V8's GC collects the JS wrapper.  Under sustained load
- * (e.g. Uptime Kuma polling verify-session), statement creation outpaces
- * GC, causing steady native memory growth — the root cause of #2120.
- *
- * By calling `stmt.finalize()` right after `.all()` / `.get()` / `.run()`
- * returns, the native memory is freed deterministically.  This is safe
- * because drizzle's one-time queries only invoke each statement once.
  */
-function autoFinalizeStatement(stmt: BetterSqlite3.Statement): BetterSqlite3.Statement {
+function autoFinalizeStatement(
+    stmt: BetterSqlite3.Statement
+): BetterSqlite3.Statement {
     const wrapExec = <T extends (...args: any[]) => any>(fn: T): T => {
         return function (this: any, ...args: any[]) {
             try {
@@ -55,39 +46,27 @@ function autoFinalizeStatement(stmt: BetterSqlite3.Statement): BetterSqlite3.Sta
 function createDb() {
     const sqlite = new Database(location);
 
-    // Enable WAL mode for dramatically better concurrent read/write
+    // Enable WAL mode — allows concurrent readers + single writer, preventing
-    // performance. Without this, readers block writers and vice versa,
+    // contention across subsystems (verifySession, Traefik, audit, ping).
-    // causing severe contention when multiple subsystems (verifySession,
-    // TraefikConfigManager, audit log flushes, ping flushes) all share
-    // this single connection. WAL mode allows concurrent readers with a
-    // single writer, which is the typical access pattern.
     sqlite.pragma("journal_mode = WAL");
 
-    // Wait up to 5 seconds when the database is locked instead of
+    // Wait up to 5s on SQLITE_BUSY instead of failing — prevents audit log
-    // failing immediately with SQLITE_BUSY. This prevents transient
+    // retry loops that accumulate memory.
-    // write failures from causing audit log buffer re-queues and retry
-    // loops that accumulate memory.
     sqlite.pragma("busy_timeout = 5000");
 
-    // NORMAL synchronous mode is safe with WAL and significantly reduces
+    // NORMAL sync mode: safe with WAL, reduces write lock hold time.
-    // the time each write holds the database lock.
     sqlite.pragma("synchronous = NORMAL");
 
-    // Increase the page cache to 64 MB (negative value = KB). The
+    // 64 MB page cache (default 2 MB) — reduces I/O round-trips on large
-    // default (2 MB) causes frequent I/O round-trips on the large JOIN
+    // TraefikConfigManager JOINs that block the event loop.
-    // queries used by TraefikConfigManager, which block the event loop
-    // for longer than necessary.
     sqlite.pragma("cache_size = -65536");
 
-    // Enable memory-mapped I/O for reads (256 MB). This allows the OS
+    // 256 MB memory-mapped I/O — OS serves reads from page cache directly,
-    // to serve read queries from the page cache without going through
+    // reducing event-loop blocking.
-    // SQLite's own cache, reducing event-loop blocking time.
     sqlite.pragma("mmap_size = 268435456");
 
-    // Intercept prepare() so every statement produced by drizzle-orm is
+    // Wrap prepare() so every drizzle-orm statement is auto-finalized after
-    // automatically finalized after its first (and only) execution.
+    // first use, preventing sqlite3_stmt accumulation between GC cycles.
-    // This prevents the native sqlite3_stmt objects from accumulating
-    // until the next GC cycle.
     const originalPrepare = sqlite.prepare.bind(sqlite);
     (sqlite as any).prepare = function autoFinalizePrepare(source: string) {
         return autoFinalizeStatement(originalPrepare(source));
@@ -103,7 +82,7 @@ export default db;
 export const primaryDb = db;
 export type Transaction = Parameters<
     Parameters<(typeof db)["transaction"]>[0]
-    >[0];
+>[0];
 export const DB_TYPE: "pg" | "sqlite" = "sqlite";
 
 function checkFileExists(filePath: string): boolean {

server/private/routers/ws/ws.ts

@@ -22,7 +22,7 @@ import {
     Olm,
     olms,
     RemoteExitNode,
-    remoteExitNodes,
+    remoteExitNodes
 } from "@server/db";
 import { eq } from "drizzle-orm";
 import { db } from "@server/db";
@@ -194,8 +194,6 @@ const connectedClients: Map<string, AuthenticatedWebSocket[]> = new Map();
 // Config version tracking map (local to this node, resets on server restart)
 const clientConfigVersions: Map<string, number> = new Map();
 
-
-
 // Recovery tracking
 let isRedisRecoveryInProgress = false;
 
@@ -406,9 +404,8 @@ const removeClient = async (
     const updatedClients = existingClients.filter((client) => client !== ws);
     if (updatedClients.length === 0) {
         connectedClients.delete(mapKey);
-        // Clean up config version tracking to prevent unbounded memory
+        // Remove clientId from clientConfigVersions on disconnect — prevents
-        // growth. Without this, every unique clientId that ever connects
+        // unbounded memory growth from stale entries.
-        // leaves a permanent entry in clientConfigVersions.
         clientConfigVersions.delete(clientId);
 
         if (redisManager.isRedisEnabled()) {
@@ -417,8 +414,7 @@ const removeClient = async (
                 await redisManager.del(
                     getNodeConnectionsKey(NODE_ID, clientId)
                 );
-                // Also clean up the Redis config version key so it doesn't
+                // Remove Redis config version key to prevent indefinite accumulation.
-                // accumulate indefinitely in Redis either.
                 await redisManager.del(getConfigVersionKey(clientId));
             } catch (error) {
                 logger.error(
@@ -1104,9 +1100,8 @@ const disconnectClient = async (clientId: string): Promise<boolean> => {
         }
     });
 
-    // Eagerly clean up tracking maps. The close event handlers will also
+    // Eagerly remove client — close event may not fire if socket is already
-    // call removeClient, but if the socket is already in CLOSING state
+    // CLOSING, leaving zombie entries.
-    // the close event may never fire, leaving zombie entries.
     connectedClients.delete(mapKey);
     clientConfigVersions.delete(clientId);
 

server/routers/ws/ws.ts

@@ -3,7 +3,15 @@ import zlib from "zlib";
 import { Server as HttpServer } from "http";
 import { WebSocket, WebSocketServer } from "ws";
 import { Socket } from "net";
-import { Newt, newts, NewtSession, olms, Olm, OlmSession, sites } from "@server/db";
+import {
+    Newt,
+    newts,
+    NewtSession,
+    olms,
+    Olm,
+    OlmSession,
+    sites
+} from "@server/db";
 import { eq } from "drizzle-orm";
 import { db } from "@server/db";
 import { recordPing } from "@server/routers/newt/pingAccumulator";
@@ -80,9 +88,8 @@ const removeClient = async (
     const updatedClients = existingClients.filter((client) => client !== ws);
     if (updatedClients.length === 0) {
         connectedClients.delete(mapKey);
-        // Clean up config version tracking to prevent unbounded memory
+        // Remove clientId from clientConfigVersions — prevents unbounded growth
-        // growth. Without this, every unique clientId that ever connects
+        // from stale entries.
-        // leaves a permanent entry in clientConfigVersions.
         clientConfigVersions.delete(clientId);
 
         logger.info(
@@ -222,9 +229,13 @@ const hasActiveConnections = async (clientId: string): Promise<boolean> => {
 };
 
 // Get the current config version for a client
-const getClientConfigVersion = async (clientId: string): Promise<number | undefined> => {
+const getClientConfigVersion = async (
+    clientId: string
+): Promise<number | undefined> => {
     const version = clientConfigVersions.get(clientId);
-    logger.debug(`getClientConfigVersion called for clientId: ${clientId}, returning: ${version} (type: ${typeof version})`);
+    logger.debug(
+        `getClientConfigVersion called for clientId: ${clientId}, returning: ${version} (type: ${typeof version})`
+    );
     return version;
 };
 
@@ -511,9 +522,8 @@ const disconnectClient = async (clientId: string): Promise<boolean> => {
         }
     });
 
-    // Eagerly clean up tracking maps. The close event handlers will also
+    // Eagerly remove client — close event may not fire if socket already
-    // call removeClient, but if the socket is already in CLOSING state
+    // CLOSING, leaving zombie entries.
-    // the close event may never fire, leaving zombie entries.
     connectedClients.delete(mapKey);
     clientConfigVersions.delete(clientId);