@nxtedition/nxt-undici 7.2.11 → 7.3.1

package/lib/index.d.ts

@@ -0,0 +1,252 @@
+import type { Readable } from 'node:stream'
+
+export interface URLObject {
+  origin?: string | null
+  path?: string | null
+  host?: string | null
+  hostname?: string | null
+  port?: string | number | null
+  protocol?: string | null
+  pathname?: string | null
+  search?: string | null
+}
+
+export type URLLike = string | URL | URLObject
+
+export interface Dispatcher {
+  dispatch(opts: object, handler: DispatchHandler): void
+}
+
+export interface DispatchHandler {
+  onConnect?(abort: (reason?: Error) => void): void
+  onHeaders?(
+    statusCode: number,
+    headers: Record<string, string | string[]>,
+    resume: () => void,
+  ): boolean | void
+  onData?(chunk: Buffer): boolean | void
+  onComplete?(trailers?: Record<string, string | string[]>): void
+  onError?(err: Error): void
+  onUpgrade?(
+    statusCode: number,
+    headers: Record<string, string | string[]>,
+    socket: import('node:net').Socket,
+  ): void
+}
+
+export type DispatchFn = (opts: DispatchOptions, handler: DispatchHandler) => void | Promise<void>
+
+export type Interceptor = (dispatch: DispatchFn) => DispatchFn
+
+export interface LoggerLike {
+  child(bindings: Record<string, unknown>): LoggerLike
+  debug(obj: unknown, msg?: string): void
+  error(obj: unknown, msg?: string): void
+  warn(obj: unknown, msg?: string): void
+  info(obj: unknown, msg?: string): void
+}
+
+export interface DispatchOptions {
+  id?: string | null
+  origin?: string | null
+  path?: string | null
+  method?: string | null
+  body?:
+    | Readable
+    | Uint8Array
+    | string
+    | ((signal: AbortSignal) => Readable | Uint8Array | string | Iterable<unknown>)
+    | null
+  query?: Record<string, unknown> | null
+  headers?: Record<string, string | string[] | null | undefined> | null
+  signal?: AbortSignal | null
+  reset?: boolean | null
+  blocking?: boolean | null
+  timeout?: number | { headers?: number | null; body?: number | null } | null
+  headersTimeout?: number | null
+  bodyTimeout?: number | null
+  idempotent?: boolean | null
+  typeOfService?: number | null
+  retry?: RetryOptions | number | boolean | RetryFn | null
+  proxy?: ProxyOptions | boolean | null
+  cache?: CacheOptions | boolean | null
+  upgrade?: boolean | null
+  follow?: number | FollowFn | boolean | null
+  error?: boolean | null
+  verify?: VerifyOptions | boolean | null
+  logger?: LoggerLike | null
+  dns?: DnsOptions | boolean | null
+  connect?: Record<string, unknown> | null
+  priority?:
+    | 0
+    | 1
+    | 2
+    | 'low'
+    | 'normal'
+    | 'high'
+    | 'lower'
+    | 'lowest'
+    | 'higher'
+    | 'highest'
+    | null
+  lookup?: LookupFn | null
+}
+
+export interface RetryOptions {
+  count?: number
+  retry?: RetryFn
+}
+
+export type RetryFn = (
+  err: Error,
+  retryCount: number,
+  opts: DispatchOptions,
+  defaultRetryFn: () => Promise<boolean>,
+) => boolean | Promise<boolean>
+
+export type FollowFn = (location: string, count: number, opts: DispatchOptions) => boolean
+
+export type LookupFn = (
+  origin: string | URLLike | Array<string | URLLike>,
+  opts: { signal?: AbortSignal },
+  callback: (err: Error | null, address: string | null) => void,
+) => void | Promise<string>
+
+export interface ProxyOptions {
+  httpVersion?: string
+  socket?: import('node:net').Socket
+  name?: string
+  req?: import('node:http').IncomingMessage
+}
+
+export interface CacheOptions {
+  store?: CacheStore
+  maxEntrySize?: number
+}
+
+export interface VerifyOptions {
+  hash?: boolean
+  size?: boolean
+}
+
+export interface DnsOptions {
+  ttl?: number
+  balance?: 'hash'
+}
+
+export interface LogInterceptorOptions {
+  bindings?: Record<string, unknown>
+}
+
+export interface CacheKey {
+  origin: string
+  method: string
+  path: string
+  headers?: Record<string, string | string[] | null | undefined>
+}
+
+export interface CacheValue {
+  statusCode: number
+  statusMessage: string
+  headers?: Record<string, string | string[]>
+  body: Uint8Array | null
+  start: number
+  end: number
+  cacheControlDirectives?: Record<string, unknown>
+  etag?: string
+  vary?: Record<string, string | string[]>
+  cachedAt: number
+  staleAt: number
+  deleteAt?: number
+}
+
+export interface CacheGetResult {
+  statusCode: number
+  statusMessage: string
+  headers?: Record<string, string | string[]>
+  body?: Buffer
+  etag?: string
+  cacheControlDirectives?: Record<string, unknown>
+  vary?: Record<string, string | string[]>
+  cachedAt: number
+  staleAt: number
+  deleteAt: number
+}
+
+export interface CacheStore {
+  get(key: CacheKey): CacheGetResult | undefined
+  set(
+    key: CacheKey,
+    value: CacheValue & { body: null | Buffer | Buffer[]; start: number; end: number },
+  ): void
+  purgeStale(): void
+  close(): void
+}
+
+export interface RequestOptions extends DispatchOptions {
+  url?: URLLike | null
+  dispatch?: DispatchFn | null
+  dispatcher?: Dispatcher | null
+}
+
+export interface ResponseData {
+  statusCode: number
+  headers: Record<string, string | string[] | undefined>
+  body: Readable
+}
+
+export function request(
+  urlOrOpts: URLLike | RequestOptions,
+  opts?: RequestOptions | null,
+): Promise<ResponseData>
+
+export function dispatch(
+  dispatcher: Dispatcher,
+  opts: DispatchOptions,
+  handler: DispatchHandler,
+): void | Promise<void>
+
+export function compose(
+  dispatcherOrInterceptor: Dispatcher | DispatchFn | Interceptor,
+  ...interceptors: (Interceptor | null | undefined)[]
+): DispatchFn
+
+export function parseHeaders(
+  headers:
+    | Record<string, string | string[] | null | undefined>
+    | (Buffer | string | (Buffer | string)[])[],
+  obj?: Record<string, string | string[]>,
+): Record<string, string | string[]>
+
+export const interceptors: {
+  query: () => Interceptor
+  requestBodyFactory: () => Interceptor
+  responseError: () => Interceptor
+  responseRetry: () => Interceptor
+  responseVerify: () => Interceptor
+  log: (opts?: LogInterceptorOptions) => Interceptor
+  redirect: () => Interceptor
+  proxy: () => Interceptor
+  cache: () => Interceptor
+  requestId: () => Interceptor
+  dns: () => Interceptor
+  lookup: () => Interceptor
+  priority: () => Interceptor
+}
+
+export const cache: {
+  SqliteCacheStore: typeof SqliteCacheStore
+}
+
+export class SqliteCacheStore implements CacheStore {
+  constructor(opts?: { location?: string; db?: Record<string, unknown>; maxSize?: number })
+  get(key: CacheKey): CacheGetResult | undefined
+  set(
+    key: CacheKey,
+    value: CacheValue & { body: null | Buffer | Buffer[]; start: number; end: number },
+  ): void
+  purgeStale(): void
+  close(): void
+}
+
+export { Client, Pool, Agent, getGlobalDispatcher, setGlobalDispatcher } from '@nxtedition/undici'

package/lib/index.js

@@ -124,8 +124,7 @@ function wrapDispatch(dispatcher) {
         const userAgent =
           opts.userAgent ?? globalThis.userAgent ?? globalThis.__nxt_undici_user_agent
         if (userAgent != null) {
-          headers['user-agent'] ??=
-            opts.userAgent ?? globalThis.userAgent ?? globalThis.__nxt_undici_user_agent
+          headers['user-agent'] ??= userAgent
         }
 
         if (opts.priority != null) {

package/lib/interceptor/cache.js

@@ -121,7 +121,7 @@ class CacheHandler extends DecoratorHandler {
     const start = contentRange ? contentRange.start : 0
     const end = contentRange ? contentRange.end : contentLength
 
-    if (end == null || end - start < this.#maxEntrySize) {
+    if (end == null || end - start <= this.#maxEntrySize) {
       const cachedAt = Date.now()
       this.#value = {
         body: [],

package/lib/interceptor/log.js

@@ -94,7 +94,10 @@ class Handler extends DecoratorHandler {
         headers: this.#headers,
         timing: this.#timing,
         bytesRead: this.#pos,
-        bytesReadPerSecond: (this.#pos * 1e3) / (this.#timing.end - this.#timing.data),
+        bytesReadPerSecond:
+          this.#timing.data >= 0 && this.#timing.end > this.#timing.data
+            ? (this.#pos * 1e3) / (this.#timing.end - this.#timing.data)
+            : 0,
       },
       elapsedTime: this.#timing.end,
     }
@@ -119,7 +122,10 @@ class Handler extends DecoratorHandler {
         headers: this.#headers,
         timing: this.#timing,
         bytesRead: this.#pos,
-        bytesReadPerSecond: (this.#pos * 1e3) / (this.#timing.end - this.#timing.data),
+        bytesReadPerSecond:
+          this.#timing.data >= 0 && this.#timing.end > this.#timing.data
+            ? (this.#pos * 1e3) / (this.#timing.end - this.#timing.data)
+            : 0,
       },
       elapsedTime: this.#timing.end,
       err,

package/lib/interceptor/redirect.js

@@ -59,7 +59,7 @@ class Handler extends DecoratorHandler {
     this.#location = typeof headers.location === 'string' ? headers.location : ''
 
     if (!this.#location) {
-      throw new Error(`Missing redirection location .`)
+      throw new Error(`Missing redirection location.`)
     }
 
     this.#history.push(this.#location)

package/lib/interceptor/response-retry.js

@@ -1,6 +1,6 @@
 import assert from 'node:assert'
 import tp from 'node:timers/promises'
-import { DecoratorHandler, isDisturbed, decorateError, parseRangeHeader } from '../utils.js'
+import { DecoratorHandler, isDisturbed, decorateError, parseContentRange } from '../utils.js'
 
 function noop() {}
 
@@ -103,7 +103,7 @@ class Handler extends DecoratorHandler {
       }
 
       if (statusCode === 206) {
-        const { start, size, end = size } = parseRangeHeader(headers['content-range']) ?? {}
+        const { start, size, end = size } = parseContentRange(headers['content-range']) ?? {}
         if (start == null || end == null || contentLength !== end - start) {
           this.#headersSent = true
           return super.onHeaders(statusCode, headers, resume)
@@ -147,7 +147,7 @@ class Handler extends DecoratorHandler {
         return false
       }
 
-      const contentRange = parseRangeHeader(headers['content-range'])
+      const contentRange = parseContentRange(headers['content-range'])
       if (!contentRange) {
         this.#maybeError(null)
         return false
@@ -175,9 +175,8 @@ class Handler extends DecoratorHandler {
       this.#pos += chunk.byteLength
     }
 
-    this.#retryCount = 0
-
     if (this.#statusCode < 400) {
+      this.#retryCount = 0
       return super.onData(chunk)
     }
 
@@ -195,6 +194,7 @@ class Handler extends DecoratorHandler {
     this.#trailers = trailers
 
     if (this.#statusCode < 400) {
+      this.#retryCount = 0
       return super.onComplete(trailers)
     }
 
@@ -285,6 +285,7 @@ class Handler extends DecoratorHandler {
           assert(Number.isFinite(this.#pos))
           assert(this.#end == null || (Number.isFinite(this.#end) && this.#end > 0))
 
+          this.#opts = { ...this.#opts, headers: { ...this.#opts.headers } }
           this.#opts.headers['if-match'] = this.#etag
           this.#opts.headers.range = `bytes=${this.#pos}-${this.#end ? this.#end - 1 : ''}`
           this.#opts.logger?.debug({ err, retryCount: this.#retryCount }, 'retry response body')
@@ -313,7 +314,7 @@ class Handler extends DecoratorHandler {
 
     const retryMax = retryOpts?.count ?? 8
 
-    if (retryCount > retryMax) {
+    if (retryCount >= retryMax) {
       return false
     }
 

package/lib/interceptor/response-verify.js

@@ -46,14 +46,14 @@ class Handler extends DecoratorHandler {
 
     if (this.#contentLength != null && this.#pos !== Number(this.#contentLength)) {
       super.onError(
-        Object.assign(new Error('Request Content-Length mismatch'), {
+        Object.assign(new Error('Response Content-Length mismatch'), {
           expected: Number(this.#contentLength),
           actual: this.#pos,
         }),
       )
     } else if (this.#contentMD5 != null && contentMD5 !== this.#contentMD5) {
       super.onError(
-        Object.assign(new Error('Request Content-MD5 mismatch'), {
+        Object.assign(new Error('Response Content-MD5 mismatch'), {
           expected: this.#contentMD5,
           actual: contentMD5,
         }),

package/lib/sqlite-cache-store.js

@@ -4,6 +4,23 @@ import { parseRangeHeader, getFastNow } from './utils.js'
 
 const VERSION = 7
 
+/** @typedef {{ purgeStale: () => void } } */
+const stores = new Set()
+
+{
+  const offPeakBC = new BroadcastChannel('nxt:offPeak')
+  offPeakBC.unref()
+  offPeakBC.onmessage = () => {
+    for (const store of stores) {
+      try {
+        store.purgeStale()
+      } catch (err) {
+        process.emitWarning(err)
+      }
+    }
+  }
+}
+
 /**
  * @typedef {import('undici-types/cache-interceptor.d.ts').default.CacheStore} CacheStore
  * @implements {CacheStore}
@@ -51,10 +68,10 @@ export class SqliteCacheStore {
   #deleteExpiredValuesTime = getFastNow()
 
   /**
-   * @param {import('undici-types/cache-interceptor.d.ts').default.SqliteCacheStoreOpts & { maxEntryCount?: number } | undefined} opts
+   * @param {import('undici-types/cache-interceptor.d.ts').default.SqliteCacheStoreOpts & { maxSize?: number } | undefined} opts
    */
   constructor(opts) {
-    this.#db = new DatabaseSync(opts?.location ?? ':memory:', { timeout: 100, ...opts?.db })
+    this.#db = new DatabaseSync(opts?.location ?? ':memory:', { timeout: 40, ...opts?.db })
 
     this.#db.exec(`
       PRAGMA journal_mode = WAL;
@@ -84,10 +101,18 @@ 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,
         body,
+        start,
+        end,
         deleteAt,
         statusCode,
         statusMessage,
@@ -128,9 +153,16 @@ export class SqliteCacheStore {
     this.#deleteExpiredValuesQuery = this.#db.prepare(
       `DELETE FROM cacheInterceptorV${VERSION} WHERE deleteAt <= ?`,
     )
+
+    stores.add(this)
+  }
+
+  purgeStale() {
+    this.#prune()
   }
 
   close() {
+    stores.delete(this)
     this.#db.close()
   }
 
@@ -141,8 +173,6 @@ export class SqliteCacheStore {
   get(key) {
     assertCacheKey(key)
 
-    this.#prune()
-
     const value = this.#findValue(key)
     return value ? makeResult(value) : undefined
   }
@@ -161,8 +191,19 @@ export class SqliteCacheStore {
     assert(Number.isFinite(value.end))
     assert(!body || body?.byteLength === value.end - value.start)
 
-    this.#prune()
+    try {
+      this.#insert(key, value, body)
+    } catch (err) {
+      if (err?.errcode === 13 /* SQLITE_FULL */) {
+        this.#prune()
+        this.#insert(key, value, body)
+      } else {
+        throw err
+      }
+    }
+  }
 
+  #insert(key, value, body) {
     this.#insertValueQuery.run(
       makeValueUrl(key),
       key.method,
@@ -184,8 +225,8 @@ export class SqliteCacheStore {
   #prune() {
     const now = getFastNow()
     if (now > this.#deleteExpiredValuesTime) {
-      this.#deleteExpiredValuesQuery.run(this.#deleteExpiredValuesTime)
-      this.#deleteExpiredValuesTime += 60e3
+      this.#deleteExpiredValuesQuery.run(now)
+      this.#deleteExpiredValuesTime = now + 60e3
     }
   }
 
@@ -203,6 +244,10 @@ export class SqliteCacheStore {
 
     const range = parseRangeHeader(headers?.range)
 
+    if (range === null) {
+      return undefined
+    }
+
     /**
      * @type {SqliteStoreValue[]}
      */

package/lib/utils.js

@@ -66,7 +66,7 @@ export function parseContentRange(range) {
 }
 
 // Parsed accordingly to RFC 9110
-// https://www.rfc-editor.org/rfc/rfc9110#field.content-range
+// https://www.rfc-editor.org/rfc/rfc9110#field.range
 /**
  * @param {string} [range]
  * @returns {RangeHeader|null|undefined}
@@ -80,12 +80,12 @@ export function parseRangeHeader(range) {
     return null
   }
 
-  const m = range.match(/^bytes (\d+)-(\d+)\/(\d+)?$/)
+  const m = range.match(/^bytes=(\d+)-(\d+)?$/)
   return m
     ? {
         start: parseInt(m[1]),
         end: m[2] ? parseInt(m[2]) + 1 : null,
-        size: m[3] ? parseInt(m[3]) : null,
+        size: null,
       }
     : null
 }
@@ -154,7 +154,7 @@ export function parseURL(url) {
 }
 
 export function parseOrigin(url) {
-  url = module.exports.parseURL(url)
+  url = parseURL(url)
 
   if (url.pathname !== '/' || url.search || url.hash) {
     throw new Error('invalid url')
@@ -390,7 +390,7 @@ export function decorateError(err, opts, { statusCode, headers, trailers, body }
 
     if (
       typeof body === 'string' &&
-      (!headers['content-type'] || headers['content-type'].startsWith('application/json'))
+      (!headers?.['content-type'] || headers['content-type'].startsWith('application/json'))
     ) {
       try {
         body = JSON.parse(body)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/nxt-undici",
-  "version": "7.2.11",
+  "version": "7.3.1",
   "license": "MIT",
   "author": "Robert Nagy <robert.nagy@boffins.se>",
   "main": "lib/index.js",
@@ -9,30 +9,33 @@
     "lib/*"
   ],
   "dependencies": {
-    "@nxtedition/scheduler": "^3.0.1",
+    "@nxtedition/scheduler": "^3.0.8",
     "@nxtedition/undici": "^11.1.3",
-    "cache-control-parser": "^2.0.6",
+    "cache-control-parser": "^2.2.0",
     "fast-querystring": "^1.1.2",
     "http-errors": "^2.0.1",
     "xxhash-wasm": "^1.1.0"
   },
   "devDependencies": {
-    "@types/node": "^25.2.0",
-    "eslint": "^9.39.2",
-    "eslint-plugin-n": "^17.23.2",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.2.3",
+    "eslint": "^10.0.0",
+    "eslint-plugin-n": "^17.24.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.2.7",
+    "pino": "^9.6.0",
     "pinst": "^3.0.0",
     "prettier": "^3.8.1",
     "send": "^1.2.1",
-    "tap": "^21.5.0",
-    "undici-types": "^7.20.0"
+    "tap": "^21.5.1",
+    "undici-types": "^7.22.0"
   },
   "scripts": {
     "prepare": "husky",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable",
-    "test": "tap test"
+    "test": "tap test",
+    "test:coverage": "tap test --coverage-report=text --coverage-report=html"
   },
   "lint-staged": {
     "*.{js,jsx,md,ts}": [