@nxtedition/nxt-undici 6.2.9 → 6.2.10

package/lib/index.js

@@ -1,6 +1,7 @@
 import undici from '@nxtedition/undici'
 import { parseHeaders } from './utils.js'
 import { request as _request } from './request.js'
+import { SqliteCacheStore } from './sqlite-cache-store.js'
 
 const dispatcherCache = new WeakMap()
 
@@ -19,7 +20,7 @@ export const interceptors = {
 }
 
 export const cache = {
-  SqliteCacheStore: undici.cacheStores.SqliteCacheStore,
+  SqliteCacheStore,
 }
 
 export { parseHeaders } from './utils.js'

package/lib/interceptor/cache.js

@@ -1,7 +1,8 @@
 import undici from '@nxtedition/undici'
 import { DecoratorHandler, parseCacheControl, parseContentRange } from '../utils.js'
+import { SqliteCacheStore, assertCacheKey } from '../sqlite-cache-store.js'
 
-const DEFAULT_STORE = new undici.cacheStores.SqliteCacheStore({ location: ':memory:' })
+const DEFAULT_STORE = new SqliteCacheStore({ location: ':memory:' })
 const DEFAULT_MAX_ENTRY_SIZE = 128 * 1024
 const NOOP = () => {}
 
@@ -12,7 +13,7 @@ class CacheHandler extends DecoratorHandler {
   #maxEntrySize
 
   constructor(key, { store, handler, maxEntrySize }) {
-    undici.util.cache.assertCacheKey(key)
+    assertCacheKey(key)
 
     super(handler)
 
@@ -26,7 +27,7 @@ class CacheHandler extends DecoratorHandler {
     this.#value = null
 
     super.onConnect((reason) => {
-      // TODO (fix): Can we cache partial results?
+      // TODO (fix): Cache partial results?
       abort(reason)
     })
   }
@@ -41,19 +42,26 @@ class CacheHandler extends DecoratorHandler {
       return super.onHeaders(statusCode, headers, resume)
     }
 
-    if (statusCode === 206 && !parseContentRange(headers['content-range'])) {
-      // We don't support caching range responses without content-range...
-      return super.onHeaders(statusCode, headers, resume)
+    let contentRange
+    if (headers['content-range']) {
+      contentRange = parseContentRange(headers['content-range'])
+      if (contentRange === null) {
+        // We don't support caching responses with invalid content-range...
+        return super.onHeaders(statusCode, headers, resume)
+      }
     }
 
-    if (statusCode === 206) {
-      // TODO (fix): enable range requests
-      return super.onHeaders(statusCode, headers, resume)
+    let contentLength
+    if (headers['content-length']) {
+      contentLength = Number(headers['content-length'])
+      if (!Number.isFinite(contentLength) || contentLength <= 0) {
+        // We don't support caching responses with invalid content-length...
+        return super.onHeaders(statusCode, headers, resume)
+      }
     }
 
-    const contentLength = headers['content-length'] ? Number(headers['content-length']) : Infinity
-    if (Number.isFinite(contentLength) && contentLength > DEFAULT_MAX_ENTRY_SIZE) {
-      // We don't support caching responses with body...
+    if (statusCode === 206 && !contentRange) {
+      // We don't support caching range responses without content-range...
       return super.onHeaders(statusCode, headers, resume)
     }
 
@@ -107,19 +115,27 @@ class CacheHandler extends DecoratorHandler {
       return super.onHeaders(statusCode, headers, resume)
     }
 
-    const cachedAt = Date.now()
-    this.#value = {
-      body: [],
-      size: 0,
-      deleteAt: cachedAt + ttl * 1e3,
-      statusCode,
-      statusMessage: '',
-      headers,
-      cacheControlDirectives,
-      etag: isEtagUsable(headers.etag) ? headers.etag : '',
-      vary,
-      cachedAt,
-      staleAt: 0,
+    const start = contentRange ? contentRange.start : 0
+    const end = contentRange ? contentRange.end : contentLength
+
+    if (end == null || end - start < this.#maxEntrySize) {
+      const cachedAt = Date.now()
+      this.#value = {
+        body: [],
+        start,
+        end,
+        deleteAt: cachedAt + ttl * 1e3,
+        statusCode,
+        statusMessage: '',
+        headers,
+        cacheControlDirectives,
+        etag: isEtagUsable(headers.etag) ? headers.etag : '',
+        vary,
+        cachedAt,
+        staleAt: 0,
+        // Handler state.
+        size: 0,
+      }
     }
 
     return super.onHeaders(statusCode, headers, resume)
@@ -141,6 +157,7 @@ class CacheHandler extends DecoratorHandler {
 
   onComplete(trailers) {
     if (this.#value && (!trailers || Object.keys(trailers).length === 0)) {
+      this.#value.end ??= this.#value.start + this.#value.size
       this.#store.set(this.#key, this.#value)
       this.#value = null
     }
@@ -178,76 +195,8 @@ export default () => (dispatch) => (opts, handler) => {
   const store = opts.cache.store ?? DEFAULT_STORE
 
   // TODO (fix): enable range requests
-  const entry = store.get(opts)
 
-  // let entry
-  // if (opts.headers.range) {
-  //   const range = parseRangeHeader(opts.headers.range)
-  //   if (!range) {
-  //     // Invalid range header...
-  //     return dispatch(opts, handler)
-  //   }
-
-  //   // TODO (perf): This is not optimal as all range bodies will be loaded...
-  //   // Make sure it only returns valid ranges by passing/parsing content range...
-  //   const entries = store.getAll(opts)
-
-  //   for (const x of entries) {
-  //     const { statusCode, headers, body } = x
-
-  //     if (!body) {
-  //       continue
-  //     }
-
-  //     let contentRange
-  //     if (statusCode === 200) {
-  //       // TODO (fix): Implement this...
-  //       // contentRange = { start: 0, end: body.byteLength }
-  //       // x = {
-  //       //   ...x,
-  //       //   headers: {
-  //       //     ...x,
-  //       //     'content-md5': undefined
-  //       //     // TODO (fix): What other headers need to be modified? accept-ranges? etag?
-  //       //   }
-  //       // }
-  //     } else if (statusCode === 206) {
-  //       contentRange = parseContentRange(headers?.['content-range'])
-  //     }
-
-  //     if (!contentRange) {
-  //       continue
-  //     }
-
-  //     if (contentRange.start === range.start && contentRange.end === range.end) {
-  //       entry = x
-  //       break
-  //     }
-
-  //     // TODO (fix): Implement this...
-  //     // const start = 0
-  //     // const end = contentRange.end - contentRange.start
-  //     // x = {
-  //     //   ...x,
-  //     //   body: body.subarray(start, end),
-  //     //   headers: {
-  //     //     ...headers,
-  //     //     'content-range': `bytes ${start}-${end - 1}/${contentRange.size ?? '*'}`
-  //     //     'content-md5': undefined
-  //     //      // TODO (fix): What other headers need to be modified? etag?
-  //     //   }
-  //     // }
-  //     // TODO (fix): Pick best entry... i.e. what ever fullfills most of the range
-  //   }
-  // } else {
-  //   entry = store.get(opts)
-
-  //   // TODO (fix): store.get is not optimal as it can return partial (206) responses.
-  //   // Make sure it only returns valid statusCodes.
-  //   if (entry?.statusCode === 206) {
-  //     return dispatch(opts, handler)
-  //   }
-  // }
+  const entry = store.get(opts)
 
   if (!entry && !cacheControlDirectives['only-if-cached']) {
     return dispatch(

package/lib/sqlite-cache-store.js

@@ -1,6 +1,8 @@
 import { DatabaseSync } from 'node:sqlite'
+import assert from 'node:assert'
+import { parseRangeHeader } from './utils.js'
 
-const VERSION = 4
+const VERSION = 5
 
 // 2gb
 const MAX_ENTRY_SIZE = 2 * 1000 * 1000 * 1000
@@ -12,6 +14,8 @@ const MAX_ENTRY_SIZE = 2 * 1000 * 1000 * 1000
  * @typedef {{
  *  id: Readonly<number>,
  *  body?: Uint8Array
+ *  start: number
+ *  end: number
  *  statusCode: number
  *  statusMessage: string
  *  headers?: string
@@ -112,6 +116,8 @@ export class SqliteCacheStore {
         url TEXT NOT NULL,
         method TEXT NOT NULL,
         body BUF NULL,
+        start INTEGER NOT NULL,
+        end INTEGER NOT NULL,
         deleteAt INTEGER NOT NULL,
         statusCode INTEGER NOT NULL,
         statusMessage TEXT NOT NULL,
@@ -126,6 +132,8 @@ export class SqliteCacheStore {
       CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_url ON cacheInterceptorV${VERSION}(url);
       CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_method ON cacheInterceptorV${VERSION}(method);
       CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_deleteAt ON cacheInterceptorV${VERSION}(deleteAt);
+      CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_start ON cacheInterceptorV${VERSION}(start);
+      CREATE INDEX IF NOT EXISTS idx_cacheInterceptorV${VERSION}_end ON cacheInterceptorV${VERSION}(end);
     `)
 
     this.#getValuesQuery = this.#db.prepare(`
@@ -145,6 +153,8 @@ export class SqliteCacheStore {
       WHERE
         url = ?
         AND method = ?
+        AND start <= ?
+        AND end >= ?
       ORDER BY
         deleteAt ASC
     `)
@@ -154,6 +164,8 @@ export class SqliteCacheStore {
         url,
         method,
         body,
+        start,
+        end,
         deleteAt,
         statusCode,
         statusMessage,
@@ -163,7 +175,7 @@ export class SqliteCacheStore {
         vary,
         cachedAt,
         staleAt
-      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+      ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
     `)
 
     this.#deleteByUrlQuery = this.#db.prepare(
@@ -210,17 +222,7 @@ export class SqliteCacheStore {
 
   /**
    * @param {import('undici-types/cache-interceptor.d.ts').default.CacheKey} key
-   * @returns {(import('undici-types/cache-interceptor.d.ts').default.GetResult & { body?: Buffer })[]}
-   */
-  getAll(key) {
-    assertCacheKey(key)
-
-    return this.#findValues(key).map((value) => makeResult(value))
-  }
-
-  /**
-   * @param {import('undici-types/cache-interceptor.d.ts').default.CacheKey} key
-   * @param {import('undici-types/cache-interceptor.d.ts').default.CacheValue & { body: null | Buffer | Array<Buffer>}} value
+   * @param {import('undici-types/cache-interceptor.d.ts').default.CacheValue & { body: null | Buffer | Array<Buffer>, start: number, end: number }} value
    */
   set(key, value) {
     assertCacheKey(key)
@@ -231,12 +233,18 @@ export class SqliteCacheStore {
       return
     }
 
+    assert(Number.isFinite(value.start))
+    assert(Number.isFinite(value.end))
+    assert(!body || body?.byteLength === value.end - value.start)
+
     this.#prune()
 
     this.#insertValueQuery.run(
       makeValueUrl(key),
       key.method,
       body,
+      value.start,
+      value.end,
       value.deleteAt,
       value.statusCode,
       value.statusMessage,
@@ -301,10 +309,21 @@ export class SqliteCacheStore {
   #findValue(key, canBeExpired = false) {
     const { headers, method } = key
 
+    if (Array.isArray(headers?.range)) {
+      return undefined
+    }
+
+    const range = parseRangeHeader(headers?.range)
+
     /**
      * @type {SqliteStoreValue[]}
      */
-    const values = this.#getValuesQuery.all(makeValueUrl(key), method)
+    const values = this.#getValuesQuery.all(
+      makeValueUrl(key),
+      method,
+      range?.start ?? 0,
+      range?.end ?? Number.MAX_SAFE_INTEGER,
+    )
 
     if (values.length === 0) {
       return undefined
@@ -318,6 +337,11 @@ export class SqliteCacheStore {
 
       let matches = true
 
+      // TODO (fix): Allow full and partial match?
+      if (range && (range.start !== value.start || range.end !== value.end)) {
+        continue
+      }
+
       if (value.vary) {
         const vary = JSON.parse(value.vary)
 
@@ -336,42 +360,6 @@ export class SqliteCacheStore {
 
     return undefined
   }
-
-  /**
-   * @param {import('undici-types/cache-interceptor.d.ts').default.CacheKey} key
-   * @param {boolean} [canBeExpired=false]
-   * @returns {SqliteStoreValue[]}
-   */
-  #findValues(key, canBeExpired = false) {
-    const { headers, method } = key
-
-    /**
-     * @type {SqliteStoreValue[]}
-     */
-    const values = this.#getValuesQuery.all(makeValueUrl(key), method)
-    const matches = []
-    const now = Date.now()
-    for (const value of values) {
-      if (now >= value.deleteAt && !canBeExpired) {
-        continue
-      }
-
-      if (value.vary) {
-        const vary = JSON.parse(value.vary)
-
-        for (const header in vary) {
-          if (!headerValueEquals(headers?.[header], vary[header])) {
-            break
-          }
-          matches.push(value)
-        }
-      } else {
-        matches.push(value)
-      }
-    }
-
-    return matches
-  }
 }
 
 /**
@@ -429,7 +417,7 @@ function makeResult(value) {
 /**
  * @param {any} key
  */
-function assertCacheKey(key) {
+export function assertCacheKey(key) {
   if (typeof key !== 'object') {
     throw new TypeError(`expected key to be object, got ${typeof key}`)
   }
@@ -448,7 +436,7 @@ function assertCacheKey(key) {
 /**
  * @param {any} value
  */
-function assertCacheValue(value) {
+export function assertCacheValue(value) {
   if (typeof value !== 'object') {
     throw new TypeError(`expected value to be object, got ${typeof value}`)
   }

package/package.json

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