feat: http caching (#3562)

* feat: http caching Implements bare-bones http caching as per rfc9111 Closes #3231 Closes #2760 Closes #2256 Closes #1146 Co-authored-by: Carlos Fuentes <me@metcoder.dev> Co-authored-by: Robert Nagy <ronagy@icloud.com> Co-authored-by: Isak Törnros <isak.tornros@hotmail.com> Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! feat: http caching Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! fixup! feat: http caching Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! fixup! fixup! feat: http caching Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Update lib/handler/cache-handler.js Co-authored-by: Robert Nagy <ronagy@icloud.com> * Apply suggestions from code review Co-authored-by: Carlos Fuentes <me@metcoder.dev> * fixup! fixup! fixup! fixup! feat: http caching Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! fixup! fixup! fixup! fixup! feat: http caching Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * clarify type for MemoryCacheStore Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * tmp Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! tmp Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * perf things, deleteByOrigin Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * incredibly messy and broken impl of streaming idea Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fix tests Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * check if the response is already cached again Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * backpressure patch Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * move body out of CacheStoreValue, remove size property Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Robert Nagy <ronagy@icloud.com> * add some comments on createWriteStream Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fix type tests, make staleAt and deleteAt absolute Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * empty the body when overwriting the response Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * update onError calls Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * remove request deduplication for now Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * rename value -> opts, storedValue -> value Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fix types Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Matteo Collina <matteo.collina@gmail.com> * simplify parsing for qualified no-cache and private Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fix header omission, some cleanup Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * running the tests in ci is probably a good idea Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fix some testing values Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * fixup! running the tests in ci is probably a good idea Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Update lib/interceptor/cache.js Co-authored-by: Robert Nagy <ronagy@icloud.com> * Update lib/util/cache.js Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * update from reviews Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Update lib/interceptor/cache.js Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Apply suggestions from code review Co-authored-by: Robert Nagy <ronagy@icloud.com> * change from reviews Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * add promise support back for createReadStream Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Robert Nagy <ronagy@icloud.com> * check if onError was called Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * add docs Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * add errorCallback Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Update types/cache-interceptor.d.ts Co-authored-by: Carlos Fuentes <me@metcoder.dev> * use fake timers and cleanup client Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * lazy cache wellknown headers Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Update lib/cache/memory-cache-store.js Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * code review Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Apply suggestions from code review Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * code review pt2 Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> * Update lib/handler/cache-revalidation-handler.js Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Update lib/handler/cache-handler.js Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> * Apply suggestions from code review * fix --------- Signed-off-by: flakey5 <73616808+flakey5@users.noreply.github.com> Co-authored-by: Robert Nagy <ronagy@icloud.com> Co-authored-by: Carlos Fuentes <me@metcoder.dev> Co-authored-by: Aras Abbasi <aras.abbasi@googlemail.com> Co-authored-by: Matteo Collina <matteo.collina@gmail.com>
nodejs · Oct 14, 2024 · 2d40ade · 2d40ade
1 parent e8c3aba
commit 2d40ade
Show file tree

Hide file tree

Showing 20 changed files with 2,597 additions and 4 deletions.
diff --git a/docs/docs/api/CacheStore.md b/docs/docs/api/CacheStore.md
@@ -0,0 +1,116 @@
+# Cache Store
+
+A Cache Store is responsible for storing and retrieving cached responses.
+It is also responsible for deciding which specific response to use based off of
+a response's `Vary` header (if present).
+
+## Pre-built Cache Stores
+
+### `MemoryCacheStore`
+
+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.
+
+## Defining a Custom Cache Store
+
+The store must implement the following functions:
+
+### Getter: `isFull`
+
+This tells the cache interceptor if the store is full or not. If this is true,
+the cache interceptor will not attempt to cache the response.
+
+### Function: `createReadStream`
+
+Parameters:
+
+* **req** `Dispatcher.RequestOptions` - Incoming request
+
+Returns: `CacheStoreReadable | Promise<CacheStoreReadable | undefined> | undefined` - If the request is cached, a readable for the body is returned. Otherwise, `undefined` is returned.
+
+### Function: `createWriteStream`
+
+Parameters:
+
+* **req** `Dispatcher.RequestOptions` - Incoming request
+* **value** `CacheStoreValue` - Response to store
+
+Returns: `CacheStoreWriteable | undefined` - If the store is full, return `undefined`. Otherwise, return a writable so that the cache interceptor can stream the body and trailers to the store.
+
+## `CacheStoreValue`
+
+This is an interface containing the majority of a response's data (minus the body).
+
+### Property `statusCode`
+
+`number` - The response's HTTP status code.
+
+### Property `statusMessage`
+
+`string` - The response's HTTP status message.
+
+### Property `rawHeaders`
+
+`(Buffer | Buffer[])[]` - The response's headers.
+
+### Property `rawTrailers`
+
+`string[] | undefined` - The response's trailers.
+
+### Property `vary`
+
+`Record<string, string> | undefined` - The headers defined by the response's `Vary` header
+and their respective values for later comparison
+
+For example, for a response like
+```
+Vary: content-encoding, accepts
+content-encoding: utf8
+accepts: application/json
+```
+
+This would be
+```js
+{
+  'content-encoding': 'utf8',
+  accepts: 'application/json'
+}
+```
+
+### Property `cachedAt`
+
+`number` - Time in millis that this value was cached.
+
+### Property `staleAt`
+
+`number` - Time in millis that this value is considered stale.
+
+### Property `deleteAt`
+
+`number` - Time in millis that this value is to be deleted from the cache. This
+is either the same sa staleAt or the `max-stale` caching directive.
+
+The store must not return a response after the time defined in this property.
+
+## `CacheStoreReadable`
+
+This extends Node's [`Readable`](https://nodejs.org/api/stream.html#class-streamreadable)
+and defines extra properties relevant to the cache interceptor.
+
+### Getter: `value`
+
+The response's [`CacheStoreValue`](#cachestorevalue)
+
+## `CacheStoreWriteable`
+
+This extends Node's [`Writable`](https://nodejs.org/api/stream.html#class-streamwritable)
+and defines extra properties relevant to the cache interceptor.
+
+### Setter: `rawTrailers`
+
+If the response has trailers, the cache interceptor will pass them to the cache
+interceptor through this method.
diff --git a/docs/docs/api/Dispatcher.md b/docs/docs/api/Dispatcher.md
@@ -1233,6 +1233,16 @@ test('should not error if request status code is not in the specified error code
 
 The Response Error Interceptor provides a robust mechanism for handling HTTP response errors by capturing detailed error information and propagating it through a structured `ResponseError` class. This enhancement improves error handling and debugging capabilities in applications using the interceptor.
 
+##### `Cache Interceptor`
+
+The `cache` interceptor implements client-side response caching as described in
+[RFC9111](https://www.rfc-editor.org/rfc/rfc9111.html).
+
+**Options**
+
+- `store` - The [`CacheStore`](./CacheStore.md) to store and retrieve responses from. Default is [`MemoryCacheStore`](./CacheStore.md#memorycachestore).
+- `methods` - The [**safe** HTTP methods](https://www.rfc-editor.org/rfc/rfc9110#section-9.2.1) to cache the response of.
+
 ## Instance Events
 
 ### Event: `'connect'`

diff --git a/index.js b/index.js
@@ -40,7 +40,12 @@ module.exports.interceptors = {
   redirect: require('./lib/interceptor/redirect'),
   retry: require('./lib/interceptor/retry'),
   dump: require('./lib/interceptor/dump'),
-  dns: require('./lib/interceptor/dns')
+  dns: require('./lib/interceptor/dns'),
+  cache: require('./lib/interceptor/cache')
+}
+
+module.exports.cacheStores = {
+  MemoryCacheStore: require('./lib/cache/memory-cache-store')
 }
 
 module.exports.buildConnector = buildConnector