feat: sqlite cache store (#3657)

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

docs/docs/api/CacheStore.md

@@ -13,9 +13,21 @@ The `MemoryCacheStore` stores the responses in-memory.
 
 **Options**
 
-- `maxEntries` - The maximum amount of responses to store. Default `Infinity`.
+- `maxCount` - The maximum amount of responses to store. Default `Infinity`.
 - `maxEntrySize` - The maximum size in bytes that a response's body can be. If a response's body is greater than or equal to this, the response will not be cached.
 
+### `SqliteCacheStore`
+
+The `SqliteCacheStore` stores the responses in a SQLite database.
+Under the hood, it uses Node.js' [`node:sqlite`](https://nodejs.org/api/sqlite.html) api.
+The `SqliteCacheStore` is only exposed if the `node:sqlite` api is present.
+
+**Options**
+
+- `location` - The location of the SQLite database to use. Default `:memory:`.
+- `maxCount` - The maximum number of entries to store in the database. Default `Infinity`.
+- `maxEntrySize` - The maximum size in bytes that a resposne's body can be. If a response's body is greater than or equal to this, the response will not be cached. Default `Infinity`.
+
 ## Defining a Custom Cache Store
 
 The store must implement the following functions:

index.js

@@ -48,6 +48,15 @@ module.exports.cacheStores = {
   MemoryCacheStore: require('./lib/cache/memory-cache-store')
 }
 
+try {
+  const SqliteCacheStore = require('./lib/cache/sqlite-cache-store')
+  module.exports.cacheStores.SqliteCacheStore = SqliteCacheStore
+} catch (err) {
+  if (err.code !== 'ERR_UNKNOWN_BUILTIN_MODULE') {
+    throw err
+  }
+}
+
 module.exports.buildConnector = buildConnector
 module.exports.errors = errors
 module.exports.util = {

lib/cache/memory-cache-store.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { Writable } = require('node:stream')
+const { assertCacheKey, assertCacheValue } = require('../util/cache.js')
 
 /**
  * @typedef {import('../../types/cache-interceptor.d.ts').default.CacheKey} CacheKey
@@ -41,17 +42,6 @@ class MemoryCacheStore {
         this.#maxCount = opts.maxCount
       }
 
-      if (opts.maxSize !== undefined) {
-        if (
-          typeof opts.maxSize !== 'number' ||
-          !Number.isInteger(opts.maxSize) ||
-          opts.maxSize < 0
-        ) {
-          throw new TypeError('MemoryCacheStore options.maxSize must be a non-negative integer')
-        }
-        this.#maxSize = opts.maxSize
-      }
-
       if (opts.maxEntrySize !== undefined) {
         if (
           typeof opts.maxEntrySize !== 'number' ||
@@ -70,9 +60,7 @@ class MemoryCacheStore {
    * @returns {import('../../types/cache-interceptor.d.ts').default.GetResult | undefined}
    */
   get (key) {
-    if (typeof key !== 'object') {
-      throw new TypeError(`expected key to be object, got ${typeof key}`)
-    }
+    assertCacheKey(key)
 
     const topLevelKey = `${key.origin}:${key.path}`
 
@@ -103,12 +91,8 @@ class MemoryCacheStore {
    * @returns {Writable | undefined}
    */
   createWriteStream (key, val) {
-    if (typeof key !== 'object') {
-      throw new TypeError(`expected key to be object, got ${typeof key}`)
-    }
-    if (typeof val !== 'object') {
-      throw new TypeError(`expected value to be object, got ${typeof val}`)
-    }
+    assertCacheKey(key)
+    assertCacheValue(val)
 
     const topLevelKey = `${key.origin}:${key.path}`
 
@@ -142,7 +126,7 @@ class MemoryCacheStore {
         store.#size += entry.size
         store.#count += 1
 
-        if (store.#size > store.#maxSize || store.#count > store.#maxCount) {
+        if (store.#size > store.#maxEntrySize || store.#count > store.#maxCount) {
           for (const [key, entries] of store.#entries) {
             for (const entry of entries.splice(0, entries.length / 2)) {
               store.#size -= entry.size