@fastify/caching 9.0.2 → 9.0.3

package/{Readme.md → README.md}

@@ -8,9 +8,6 @@
 that provides server-side caching and mechanisms for manipulating HTTP cache headers according to
 [RFC 2616 §14.9](https://tools.ietf.org/html/rfc2616#section-14.9).
 
-Supports Fastify versions ^3.0.0. Version v5.x supports Fastify ^3.0.0 in
-the [`v5.x` branch](https://github.com/fastify/fastify-caching/tree/v5.x).
-
 This plugin fully supports Fastify's encapsulation. Therefore, routes that
 should have differing cache settings should be registered within different
 contexts.
@@ -19,14 +16,33 @@ In addition to providing header manipulation, the plugin also decorates the
 server instance with an object that can be used for caching items. **Note:**
 the default cache should not be used in a "production" environment. It is
 an LRU, in-memory cache that is capped at 100,000 items. It is *highly*
-recommended that a full featured cache object be supplied, e.g.
+recommended that a full-featured cache object be supplied, e.g.
 [abstract-cache-redis][acache-redis].
 
 [acache-redis]: https://www.npmjs.com/package/abstract-cache-redis
 
+## Install
+```
+npm i @fastify/caching
+```
+
+### Compatibility
+| Plugin version | Fastify version |
+| ---------------|-----------------|
+| `^9.x`         | `^5.x`          |
+| `^8.x`         | `^4.x`          |
+| `^6.x`         | `^3.x`          |
+| `^4.x`         | `^2.x`          |
+| `^1.x`         | `^1.x`          |
+
+
+Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
+in the table above.
+See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.
+
 ## Example
 
-This example shows using the plugin to disable client side caching of all
+This example shows using the plugin to disable client-side caching of all
 routes.
 
 ```js
@@ -107,7 +123,7 @@ for a *cache-response-directive* as defined by RFC 2616.
 resource may be cached. When this is set, and `privacy` is not set to `no-cache`,
 then `', max-age=<value>'` will be appended to the `cache-control` header.
 + `cache` (Default: `abstract-cache.memclient`): an [abstract-cache][acache]
-protocol compliant cache object. Note: the plugin requires a cache instance to
+protocol-compliant cache object. Note: the plugin requires a cache instance to
 properly support the ETag mechanism. Therefore, if a falsy value is supplied
 the default will be used.
 + `cacheSegment` (Default: `'@fastify/caching'`): segment identifier to use when
@@ -128,7 +144,7 @@ recommended to always supply a value to this method to avoid this operation.
 All incoming requests to paths affected by this plugin will be inspected for
 the `if-none-match` header. If the header is present, the value will be used
 to lookup the tag within the cache associated with this plugin. If the tag is
-found, then the response will be ended with a 304 status code sent to
+found, then the response will end with a 304 status code sent to
 the client.
 
 Tags will be cached according to the second parameter. If the second parameter
@@ -142,11 +158,11 @@ milliseconds. The default lifetime, when the parameter is not specified, is
 ### `reply.expires(date)`
 
 This method allows setting of the `expires` header. It accepts a regular `Date`
-object, or a string that is a valid date string according to
+object or a string that is a valid date string according to
 [RFC 2616 §14.21][sec14.21].
 
 [sec14.21]: https://tools.ietf.org/html/rfc2616#section-14.21
 
 ## License
 
-[MIT License](https://jsumners.mit-license.org/)
+Licensed under [MIT](./LICENSE).

package/index.js

@@ -38,7 +38,7 @@ function cachingLoadByEtag (req, res, next) {
   })
 }
 
-function cachingStoreByEtag (req, res, payload, next) {
+function cachingStoreByEtag (_req, res, payload, next) {
   const etag = res.getHeader('etag')
   if (!etag || !res._etagLife) return next()
   this.cache.set(
@@ -70,7 +70,7 @@ function fastifyCaching (instance, options, next) {
       value += `, s-maxage=${_options.serverExpiresIn}`
     }
 
-    instance.addHook('onRequest', function cachingSetCacheControlHeader (req, res, next) {
+    instance.addHook('onRequest', function cachingSetCacheControlHeader (_req, res, next) {
       if (!res.hasHeader('Cache-control')) {
         res.header('Cache-control', value)
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/caching",
-  "version": "9.0.2",
+  "version": "9.0.3",
   "description": "A plugin for Fastify to enable management of cache control headers",
   "main": "index.js",
   "type": "commonjs",
@@ -28,17 +28,47 @@
     "caching"
   ],
   "author": "James Sumners <james.sumners@gmail.com>",
+  "contributors": [
+    {
+      "name": "Matteo Collina",
+      "email": "hello@matteocollina.com"
+    },
+    {
+      "name": "Manuel Spigolon",
+      "email": "behemoth89@gmail.com"
+    },
+    {
+      "name": "Aras Abbasi",
+      "email": "aras.abbasi@gmail.com"
+    },
+    {
+      "name": "Frazer Smith",
+      "email": "frazer.dev@icloud.com",
+      "url": "https://github.com/fdawgs"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fastify/fastify-caching/issues"
   },
   "homepage": "https://github.com/fastify/fastify-caching#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/fastify"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/fastify"
+    }
+  ],
   "devDependencies": {
     "@fastify/pre-commit": "^2.1.0",
     "@types/node": "^22.0.0",
     "c8": "^10.1.2",
+    "eslint": "^9.17.0",
     "fastify": "^5.0.0",
-    "neostandard": "^0.11.9",
+    "neostandard": "^0.12.0",
     "tsd": "^0.31.0"
   },
   "dependencies": {

package/test/cache.test.js

@@ -21,25 +21,25 @@ test('cache is usable', async (t) => {
   t.plan(4)
 
   const fastify = Fastify()
-  await fastify.register(async (instance, options) => {
-    instance.addHook('onRequest', async function checkCachingRegistered (req, reply) {
+  await fastify.register(async (instance) => {
+    instance.addHook('onRequest', async function checkCachingRegistered () {
       t.assert.ifError(instance[Symbol.for('fastify-caching.registered')])
     })
   })
   await fastify.register(plugin)
 
-  fastify.addHook('onRequest', async function checkCachingRegistered (req, reply) {
+  fastify.addHook('onRequest', async function checkCachingRegistered () {
     t.assert.strictEqual(this[Symbol.for('fastify-caching.registered')], true)
   })
 
-  fastify.get('/one', (req, reply) => {
+  fastify.get('/one', (_req, reply) => {
     fastify.cache.set('one', { one: true }, 1000, (err) => {
       if (err) return reply.send(err)
       reply.redirect('/two')
     })
   })
 
-  fastify.get('/two', (req, reply) => {
+  fastify.get('/two', (_req, reply) => {
     fastify.cache.get('one', (err, obj) => {
       t.assert.ifError(err)
       t.assert.strictEqual(obj.item, { one: true })
@@ -70,25 +70,25 @@ test('cache is usable with function as plugin default options input', async (t)
   t.plan(4)
 
   const fastify = Fastify()
-  await fastify.register(async (instance, options) => {
-    instance.addHook('onRequest', async function checkCachingNotRegistered (req, reply) {
+  await fastify.register(async (instance) => {
+    instance.addHook('onRequest', async function checkCachingNotRegistered () {
       t.assert.failure(instance[Symbol.for('fastify-caching.registered')])
     })
   })
   await fastify.register(plugin, () => () => {})
 
-  fastify.addHook('onRequest', async function checkCachingRegistered (req, reply) {
+  fastify.addHook('onRequest', async function checkCachingRegistered () {
     t.assert.strictEqual(this[Symbol.for('fastify-caching.registered')], true)
   })
 
-  fastify.get('/one', (req, reply) => {
+  fastify.get('/one', (_req, reply) => {
     fastify.cache.set('one', { one: true }, 1000, (err) => {
       if (err) return reply.send(err)
       reply.redirect('/two')
     })
   })
 
-  fastify.get('/two', (req, reply) => {
+  fastify.get('/two', (_req, reply) => {
     fastify.cache.get('one', (err, obj) => {
       t.assert.ifError(err)
       t.assert.strictEqual(obj.item, { one: true })
@@ -120,21 +120,21 @@ test('getting cache item with error returns error', async (t) => {
   t.plan(1)
 
   const mockCache = {
-    get: (info, callback) => callback(new Error('cache.get always errors')),
-    set: (key, value, ttl, callback) => callback()
+    get: (_info, callback) => callback(new Error('cache.get always errors')),
+    set: (_key, _value, _ttl, callback) => callback()
   }
 
   const fastify = Fastify()
   await fastify.register(plugin, { cache: mockCache })
 
-  fastify.get('/one', (req, reply) => {
+  fastify.get('/one', (_req, reply) => {
     fastify.cache.set('one', { one: true }, 1000, (err) => {
       if (err) return reply.send(err)
       return reply.etag('123456').send({ hello: 'world' })
     })
   })
 
-  fastify.get('/two', (req, reply) => {
+  fastify.get('/two', () => {
     fastify.cache.get('one', (err, obj) => {
       t.assert.failure(err)
       t.assert.failure(obj)
@@ -164,7 +164,7 @@ test('etags get stored in cache', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/one', (req, reply) => {
+  fastify.get('/one', (_req, reply) => {
     reply.etag('123456').send({ hello: 'world' })
   })
 
@@ -191,7 +191,7 @@ test('etag cache life is customizable', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/one', function (req, reply) {
+  fastify.get('/one', function (_req, reply) {
     reply
       // We set a cache lifetime of 50 milliseconds
       .etag('123456', 50)
@@ -237,7 +237,7 @@ test('returns response payload', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/one', (req, reply) => {
+  fastify.get('/one', (_req, reply) => {
     reply.etag('123456', 300).send({ hello: 'world' })
   })
 

package/test/headers.test.js

@@ -10,7 +10,7 @@ test('decorators get added', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     t.assert.ok(reply.etag)
     reply.send()
   })
@@ -31,7 +31,7 @@ test('decorators add headers', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.etag(tag).send()
   })
 
@@ -51,7 +51,7 @@ test('sets etag header for falsy argument', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.etag().send()
   })
 
@@ -70,7 +70,7 @@ test('sets no-cache header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, { privacy: plugin.privacy.NOCACHE })
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -95,7 +95,7 @@ test('sets private with max-age header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, opts)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -124,7 +124,7 @@ test('sets public with max-age and s-maxage header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, opts)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -151,12 +151,12 @@ test('do not set headers if another upstream plugin already sets it', async (t)
   }
 
   const fastify = Fastify()
-  fastify.addHook('onRequest', async function checkCachingDoesNotOverrideCacheControlHeader (req, reply) {
+  fastify.addHook('onRequest', async function checkCachingDoesNotOverrideCacheControlHeader (_req, reply) {
     reply.header('cache-control', 'do not override')
   })
   await fastify.register(plugin, opts)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -182,7 +182,7 @@ test('only sets max-age and ignores s-maxage with private header', async (t) =>
   const fastify = Fastify()
   await fastify.register(plugin, opts)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -210,7 +210,7 @@ test('s-maxage is optional with public header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, opts)
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -230,7 +230,7 @@ test('sets no-store with max-age header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, { privacy: 'no-store', expiresIn: 300 })
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.send({ hello: 'world' })
   })
 
@@ -255,7 +255,7 @@ test('sets the expires header', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, { privacy: plugin.privacy.NOCACHE })
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.expires(now).send({ hello: 'world' })
   })
 
@@ -275,7 +275,7 @@ test('sets the expires header to a falsy value', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, { privacy: plugin.privacy.NOCACHE })
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.expires().send({ hello: 'world' })
   })
 
@@ -294,7 +294,7 @@ test('sets the expires header to a custom value', async (t) => {
   const fastify = Fastify()
   await fastify.register(plugin, { privacy: plugin.privacy.NOCACHE })
 
-  fastify.get('/', (req, reply) => {
+  fastify.get('/', (_req, reply) => {
     reply.expires('foobar').send({ hello: 'world' })
   })
 

package/types/index.test-d.ts

@@ -22,7 +22,7 @@ expectType<AbstractCacheCompliantObject['set']>(fastify.cache.set)
 expectType<string>(fastify.cacheSegment)
 // expectType<number>(fastify.etagMaxLife);
 
-fastify.get('/one', async (request, reply) => {
+fastify.get('/one', async (_request, reply) => {
   expectType<(tag?: string, timeToLive?: number) => FastifyReply>(reply.etag)
   expectType<(date?: Date) => FastifyReply>(reply.expires)
 
@@ -32,7 +32,7 @@ fastify.get('/one', async (request, reply) => {
   return { message: 'one' }
 })
 
-fastify.get('/two', async (request, reply) => {
+fastify.get('/two', async (_request, reply) => {
   expectType<FastifyReply>(
     reply.etag('hello', 6000).expires(new Date(Date.now() + 6000))
   )
@@ -51,7 +51,7 @@ const badCachingOptions = {
 
 expectError(shouldErrorApp.register(fastifyCaching, badCachingOptions))
 
-fastify.get('/three', async (request, reply) => {
+fastify.get('/three', async () => {
   expectAssignable<Promise<unknown>>(
     fastify.cache.get('well-known')
   )