feat: sqlite cache store

Co-authored-by: Robert Nagy <[email protected]> Co-authored-by: Isak Törnros <[email protected]> Signed-off-by: flakey5 <[email protected]>
nodejs · Nov 21, 2024 · f178cd1 · f178cd1
1 parent a427e4b
commit f178cd1
Show file tree

Hide file tree

Showing 10 changed files with 586 additions and 15 deletions.
diff --git a/docs/docs/api/CacheStore.md b/docs/docs/api/CacheStore.md
@@ -14,7 +14,17 @@ The `MemoryCacheStore` stores the responses in-memory.
 **Options**
 
 - `maxEntries` - 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.
+- `maxSize` - 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**
+
+- `maxSize` - 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.
 
 ## Defining a Custom Cache Store
 

diff --git a/index.js b/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 = {

diff --git a/lib/cache/memory-cache-store.js b/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
@@ -70,9 +71,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 +102,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}`