@nxtedition/nxt-undici 7.3.6 → 7.3.8

package/lib/sqlite-cache-store.js

@@ -1,8 +1,8 @@
 import { DatabaseSync } from 'node:sqlite'
-import assert from 'node:assert'
 import { parseRangeHeader, getFastNow } from './utils.js'
 
-const VERSION = 7
+// Bump version when the URL key format or schema changes to invalidate old caches.
+const VERSION = 9
 
 /** @typedef {{ purgeStale: () => void } } */
 const stores = new Set()
@@ -12,11 +12,7 @@ const stores = new Set()
   offPeakBC.unref()
   offPeakBC.onmessage = () => {
     for (const store of stores) {
-      try {
-        store.purgeStale()
-      } catch (err) {
-        process.emitWarning(err)
-      }
+      store.purgeStale()
     }
   }
 }
@@ -63,27 +59,31 @@ export class SqliteCacheStore {
   #deleteExpiredValuesQuery
 
   /**
-   * @type {number}
+   * @type {import('node:sqlite').StatementSync}
    */
-  #deleteExpiredValuesTime = getFastNow()
+  #evictQuery
 
   /**
    * @param {import('undici-types/cache-interceptor.d.ts').default.SqliteCacheStoreOpts & { maxSize?: number } | undefined} opts
    */
   constructor(opts) {
-    this.#db = new DatabaseSync(opts?.location ?? ':memory:', { timeout: 40, ...opts?.db })
+    this.#db = new DatabaseSync(opts?.location ?? ':memory:', { timeout: 20, ...opts?.db })
 
+    const maxSize = opts?.maxSize ?? 256 * 1024 * 1024
     this.#db.exec(`
       PRAGMA journal_mode = WAL;
-      PRAGMA synchronous = NORMAL;
-      PRAGMA temp_store = memory;
+      PRAGMA synchronous = OFF;
+      PRAGMA wal_autocheckpoint = 10000;
+      PRAGMA cache_size = -${Math.ceil(maxSize / 1024 / 8)};
+      PRAGMA mmap_size = ${maxSize};
+      PRAGMA max_page_count = ${Math.ceil(maxSize / 4096)};
       PRAGMA optimize;
 
       CREATE TABLE IF NOT EXISTS cacheInterceptorV${VERSION} (
         id INTEGER PRIMARY KEY AUTOINCREMENT,
         url TEXT NOT NULL,
         method TEXT NOT NULL,
-        body BUF NULL,
+        body BLOB NULL,
         start INTEGER NOT NULL,
         end INTEGER NOT NULL,
         deleteAt INTEGER NOT NULL,
@@ -101,12 +101,6 @@ export class SqliteCacheStore {
       CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_deleteExpiredValuesQuery ON cacheInterceptorV${VERSION}(deleteAt);
     `)
 
-    const maxSize = opts?.maxSize ?? 256 * 1024 * 1024
-    {
-      const { page_size: pageSize } = this.#db.prepare('PRAGMA page_size').get()
-      this.#db.exec(`PRAGMA max_page_count = ${Math.ceil(maxSize / pageSize)}`)
-    }
-
     this.#getValuesQuery = this.#db.prepare(`
       SELECT
         id,
@@ -127,6 +121,7 @@ export class SqliteCacheStore {
         url = ?
         AND method = ?
         AND start <= ?
+        AND deleteAt > ?
       ORDER BY
         deleteAt ASC
     `)
@@ -154,11 +149,23 @@ export class SqliteCacheStore {
       `DELETE FROM cacheInterceptorV${VERSION} WHERE deleteAt <= ?`,
     )
 
+    // Evict the N entries expiring soonest. Used on SQLITE_FULL to free space
+    // without requiring expired entries to already exist.
+    this.#evictQuery = this.#db.prepare(
+      `DELETE FROM cacheInterceptorV${VERSION} WHERE id IN (SELECT id FROM cacheInterceptorV${VERSION} ORDER BY deleteAt ASC LIMIT ?)`,
+    )
+
     stores.add(this)
   }
 
   purgeStale() {
-    this.#prune()
+    try {
+      this.#deleteExpiredValuesQuery.run(getFastNow())
+      this.#db.exec('PRAGMA wal_checkpoint(TRUNCATE)')
+      this.#db.exec('PRAGMA optimize')
+    } catch (err) {
+      process.emitWarning(err)
+    }
   }
 
   close() {
@@ -187,18 +194,44 @@ export class SqliteCacheStore {
 
     const body = Array.isArray(value.body) ? Buffer.concat(value.body) : value.body
 
-    assert(Number.isFinite(value.start))
-    assert(Number.isFinite(value.end))
-    assert(!body || body?.byteLength === value.end - value.start)
+    if (typeof value.start !== 'number') {
+      throw new TypeError(
+        `expected value.start to be a number, got ${printType(value.start)} [${value.start}]`,
+      )
+    }
+    if (!Number.isFinite(value.start) || value.start < 0) {
+      throw new RangeError(
+        `expected value.start to be a non-negative finite number, got ${value.start}`,
+      )
+    }
+    if (typeof value.end !== 'number') {
+      throw new TypeError(
+        `expected value.end to be a number, got ${printType(value.end)} [${value.end}]`,
+      )
+    }
+    if (!Number.isFinite(value.end) || value.end < value.start) {
+      throw new RangeError(
+        `expected value.end to be a finite number >= start (${value.start}), got ${value.end}`,
+      )
+    }
+    if (body && body.byteLength !== value.end - value.start) {
+      throw new RangeError(
+        `body length ${body.byteLength} does not match end - start (${value.end} - ${value.start} = ${value.end - value.start})`,
+      )
+    }
 
     try {
       this.#insert(key, value, body)
     } catch (err) {
       if (err?.errcode === 13 /* SQLITE_FULL */) {
-        this.#prune()
-        this.#insert(key, value, body)
+        try {
+          this.#evictQuery.run(256)
+          this.#insert(key, value, body)
+        } catch (evictErr) {
+          process.emitWarning(evictErr)
+        }
       } else {
-        throw err
+        process.emitWarning(err)
       }
     }
   }
@@ -210,11 +243,11 @@ export class SqliteCacheStore {
       body,
       value.start,
       value.end,
-      value.deleteAt ?? Date.now() + 3600e3,
+      value.deleteAt,
       value.statusCode,
       value.statusMessage,
       value.headers ? JSON.stringify(value.headers) : null,
-      value.etag ? value.etag : null,
+      value.etag != null ? value.etag : null,
       value.cacheControlDirectives ? JSON.stringify(value.cacheControlDirectives) : null,
       value.vary ? JSON.stringify(value.vary) : null,
       value.cachedAt,
@@ -222,20 +255,11 @@ export class SqliteCacheStore {
     )
   }
 
-  #prune() {
-    const now = getFastNow()
-    if (now > this.#deleteExpiredValuesTime) {
-      this.#deleteExpiredValuesQuery.run(now)
-      this.#deleteExpiredValuesTime = now + 60e3
-    }
-  }
-
   /**
    * @param {import('undici-types/cache-interceptor.d.ts').default.CacheKey} key
-   * @param {boolean} [canBeExpired=false]
    * @returns {SqliteStoreValue | undefined}
    */
-  #findValue(key, canBeExpired = false) {
+  #findValue(key) {
     const { headers, method } = key
 
     if (Array.isArray(headers?.range)) {
@@ -251,20 +275,18 @@ export class SqliteCacheStore {
     /**
      * @type {SqliteStoreValue[]}
      */
-    const values = this.#getValuesQuery.all(makeValueUrl(key), method, range?.start ?? 0)
+    const values = this.#getValuesQuery.all(
+      makeValueUrl(key),
+      method,
+      range?.start ?? 0,
+      getFastNow(),
+    )
 
     if (values.length === 0) {
       return undefined
     }
 
-    const now = getFastNow()
     for (const value of values) {
-      if (now >= value.deleteAt && !canBeExpired) {
-        return undefined
-      }
-
-      let matches = true
-
       // TODO (fix): Allow full and partial match?
       if (range && (range.start !== value.start || range.end !== value.end)) {
         continue
@@ -272,6 +294,7 @@ export class SqliteCacheStore {
 
       if (value.vary) {
         const vary = JSON.parse(value.vary)
+        let matches = true
 
         for (const header in vary) {
           if (!headerValueEquals(headers?.[header], vary[header])) {
@@ -279,11 +302,13 @@ export class SqliteCacheStore {
             break
           }
         }
-      }
 
-      if (matches) {
-        return value
+        if (!matches) {
+          continue
+        }
       }
+
+      return value
     }
 
     return undefined
@@ -320,7 +345,7 @@ function headerValueEquals(lhs, rhs) {
  * @returns {string}
  */
 function makeValueUrl(key) {
-  return `${key.origin}/${key.path}`
+  return `${key.origin}${key.path}`
 }
 
 function makeResult(value) {
@@ -331,7 +356,7 @@ function makeResult(value) {
     statusCode: value.statusCode,
     statusMessage: value.statusMessage,
     headers: value.headers ? JSON.parse(value.headers) : undefined,
-    etag: value.etag ? value.etag : undefined,
+    etag: value.etag != null ? value.etag : undefined,
     vary: value.vary ? JSON.parse(value.vary) : undefined,
     cacheControlDirectives: value.cacheControlDirectives
       ? JSON.parse(value.cacheControlDirectives)
@@ -351,7 +376,7 @@ function printType(val) {
  */
 function assertCacheKey(key) {
   if (typeof key !== 'object' || key == null) {
-    throw new TypeError(`expected key to be object, got ${typeof printType(key)} [${key}]`)
+    throw new TypeError(`expected key to be object, got ${printType(key)} [${key}]`)
   }
 
   for (const property of ['origin', 'method', 'path']) {
@@ -364,7 +389,7 @@ function assertCacheKey(key) {
 
   if (key.headers !== undefined && typeof key.headers !== 'object') {
     throw new TypeError(
-      `expected headers to be object, got ${typeof printType(key)} [${key.headers}]`,
+      `expected headers to be object, got ${printType(key.headers)} [${key.headers}]`,
     )
   }
 }
@@ -374,7 +399,7 @@ function assertCacheKey(key) {
  */
 function assertCacheValue(value) {
   if (typeof value !== 'object' || value == null) {
-    throw new TypeError(`expected value to be object, got ${typeof printType(value)}`)
+    throw new TypeError(`expected value to be object, got ${printType(value)}`)
   }
 
   for (const property of ['statusCode', 'cachedAt', 'staleAt', 'deleteAt']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/nxt-undici",
-  "version": "7.3.6",
+  "version": "7.3.8",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "main": "lib/index.js",