@fastify/caching 8.2.0 → 8.4.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Set default behavior to automatically convert line endings
+* text=auto eol=lf

package/.github/workflows/ci.yml

@@ -2,6 +2,11 @@ name: CI
 
 on:
   push:
+    branches:
+     - main
+     - master
+     - next
+     - 'v*'
     paths-ignore:
       - 'docs/**'
       - '*.md'

package/Readme.md

@@ -4,7 +4,7 @@
 [![NPM version](https://img.shields.io/npm/v/@fastify/caching.svg?style=flat)](https://www.npmjs.com/package/@fastify/caching)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
 
-*@fastify/caching* is a plugin for the [Fastify](http://fastify.io/) framework
+*@fastify/caching* is a plugin for the [Fastify](http://fastify.dev/) framework
 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).
 
@@ -30,7 +30,7 @@ This example shows using the plugin to disable client side caching of all
 routes.
 
 ```js
-const http = require('http')
+const http = require('node:http')
 const fastify = require('fastify')()
 const fastifyCaching = require('@fastify/caching')
 

package/index.js

@@ -3,7 +3,7 @@
 /* eslint no-prototype-builtins: 0 */
 
 const fp = require('fastify-plugin')
-const uidSafe = require('uid-safe')
+const { sync } = require('uid-safe')
 const abstractCache = require('abstract-cache')
 
 const defaultOptions = {
@@ -21,11 +21,7 @@ function cachingExpires (date) {
 }
 
 function etag (value, lifetime) {
-  if (value) {
-    this.header('ETag', value)
-  } else {
-    this.header('ETag', uidSafe.sync(18))
-  }
+  this.header('ETag', value || sync(18))
   this._etagLife = Number.isInteger(lifetime) ? lifetime : 3600000
   return this
 }
@@ -35,7 +31,7 @@ function etagHandleRequest (req, res, next) {
   const etag = req.headers['if-none-match']
   this.cache.get({ id: etag, segment: this.cacheSegment }, (err, cached) => {
     if (err) return next(err)
-    if (cached && cached.item) {
+    if (cached?.item) {
       return res.status(304).send()
     }
     next()
@@ -75,7 +71,9 @@ function fastifyCaching (instance, options, next) {
     }
 
     instance.addHook('onRequest', (req, res, next) => {
-      res.header('Cache-control', value)
+      if (!res.hasHeader('Cache-control')) {
+        res.header('Cache-control', value)
+      }
       next()
     })
   }

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@fastify/caching",
-  "version": "8.2.0",
+  "version": "8.4.0",
   "description": "A plugin for Fastify to enable management of cache control headers",
   "main": "index.js",
+  "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
     "lint": "standard --verbose | snazzy",
+    "lint:fix": "standard --verbose --fix | snazzy",
     "test": "npm run test:unit && npm run test:typescript",
     "test:typescript": "tsd",
     "test:unit": "tap",
@@ -33,16 +35,16 @@
   "homepage": "https://github.com/fastify/fastify-caching#readme",
   "devDependencies": {
     "@fastify/pre-commit": "^2.0.2",
-    "@types/node": "^18.0.0",
-    "fastify": "^4.0.0-rc.3",
+    "@types/node": "^20.6.1",
+    "fastify": "^4.23.2",
     "snazzy": "^9.0.0",
-    "standard": "^17.0.0",
-    "tap": "^16.0.0",
-    "tsd": "^0.25.0"
+    "standard": "^17.1.0",
+    "tap": "^16.3.8",
+    "tsd": "^0.31.0"
   },
   "dependencies": {
     "abstract-cache": "^1.0.1",
-    "fastify-plugin": "^4.0.0",
+    "fastify-plugin": "^4.5.1",
     "uid-safe": "^2.1.5"
   },
   "publishConfig": {

package/test/headers.test.js

@@ -139,6 +139,35 @@ test('sets public with max-age and s-maxage header', async (t) => {
   t.equal(response.headers['cache-control'], 'public, max-age=300, s-maxage=12345')
 })
 
+test('do not set headers if another upstream plugin already sets it', async (t) => {
+  t.plan(2)
+
+  const opts = {
+    privacy: plugin.privacy.PUBLIC,
+    expiresIn: 300,
+    serverExpiresIn: 12345
+  }
+
+  const fastify = Fastify()
+  fastify.addHook('onRequest', async (req, reply) => {
+    reply.header('cache-control', 'do not override')
+  })
+  await fastify.register(plugin, opts)
+
+  fastify.get('/', (req, reply) => {
+    reply.send({ hello: 'world' })
+  })
+
+  await fastify.ready()
+
+  const response = await fastify.inject({
+    method: 'GET',
+    path: '/'
+  })
+  t.ok(response.headers['cache-control'])
+  t.equal(response.headers['cache-control'], 'do not override')
+})
+
 test('only sets max-age and ignores s-maxage with private header', async (t) => {
   t.plan(2)
 

package/types/index.d.ts

@@ -35,15 +35,28 @@ type FastifyCaching = FastifyPluginCallback<fastifyCaching.FastifyCachingPluginO
   privacy: fastifyCaching.Privacy;
 };
 
+type CacheResult<T> = {
+  item: T,
+  stored: number,
+  ttl: number,
+} | null;
+
 declare namespace fastifyCaching {
   /**
    * @link [`abstract-cache` protocol documentation](https://github.com/jsumners/abstract-cache#protocol)
    */
   export interface AbstractCacheCompliantObject {
-    get(
+    get<T = unknown>(
       key: string | { id: string; segment: string },
-      callback?: (error: unknown, result: unknown) => void
+      callback: (error: unknown, result: CacheResult<T>) => void
     ): void;
+    /**
+     * If AbstractCache is using useAwait = true, then this method-header must be used.
+     * @param key
+     */
+    get<T = unknown>(
+      key: string | { id: string; segment: string },
+    ): Promise<CacheResult<T>>;
     set(
       key: string | { id: string; segment: string },
       value: unknown,
@@ -117,9 +130,8 @@ declare namespace fastifyCaching {
     serverExpiresIn?: number;
   }
 
-  export const privacy: {
-    privacy: Privacy;
-  };
+  export const privacy: Privacy;
+
   export const fastifyCaching: FastifyCaching;
   export { fastifyCaching as default };
 }

package/types/index.test-d.ts

@@ -50,3 +50,20 @@ const badCachingOptions = {
 };
 
 expectError(shouldErrorApp.register(fastifyCaching, badCachingOptions));
+
+fastify.get('/three', async (request, reply) => {
+  expectAssignable<Promise<unknown>>(
+    fastify.cache.get('well-known')
+  );
+  expectAssignable<Promise<{ item: string; stored: number; ttl: number; } | null>>(
+    fastify.cache.get<string>('well-known')
+  );
+  expectType<void>(
+    fastify.cache.get<string>('well-known', (err, value) => {
+      expectType<unknown>(err);
+      expectAssignable<{ item: string; stored: number; ttl: number; } | null>(value);
+    })
+  );
+
+  return { message: 'two' };
+});