@fastify/caching 9.0.4 → 9.0.6

package/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release the package
+
+on:
+  workflow_dispatch:
+    inputs:
+      semver:
+        description: 'Release bump type'
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+permissions: {}
+
+jobs:
+  release:
+    permissions:
+      id-token: write # required for npm provenance via OIDC
+      contents: write # required to push the release commit and the tag
+    uses: fastify/workflows/.github/workflows/reusable-release.yml@731d0cca9a6a5b9586dad6b0326d49001ab9216f
+    with:
+      semver: ${{ inputs.semver }}

package/index.js

@@ -72,10 +72,10 @@ function fastifyCaching (instance, options, next) {
 
     instance.addHook('onSend', function cachingSetCacheControlHeader (_req, reply, _payload, next) {
       if (!reply.hasHeader('Cache-control')) {
-        // Only apply the caching value to successful (2xx) responses.
+        // Only apply the caching value to successful (2xx) and 304 Not Modified responses.
         // Error responses must not be cached, otherwise browsers may serve
         // a stale 4xx/5xx for the duration of max-age.
-        if (reply.statusCode >= 200 && reply.statusCode < 300) {
+        if ((reply.statusCode >= 200 && reply.statusCode < 300) || reply.statusCode === 304) {
           reply.header('Cache-control', value)
         } else {
           reply.header('Cache-control', 'no-store')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/caching",
-  "version": "9.0.4",
+  "version": "9.0.6",
   "description": "A plugin for Fastify to enable management of cache control headers",
   "main": "index.js",
   "type": "commonjs",

package/test/headers.test.js

@@ -346,6 +346,66 @@ test('does not override a Cache-control header set upstream on error responses',
   t.assert.strictEqual(response.headers['cache-control'], 'private, max-age=10')
 })
 
+test('sets configured Cache-control header on 304 Not Modified responses', async (t) => {
+  t.plan(2)
+
+  const opts = {
+    privacy: plugin.privacy.PRIVATE,
+    expiresIn: 300
+  }
+
+  const fastify = Fastify()
+  await fastify.register(plugin, opts)
+
+  fastify.get('/', (_req, reply) => {
+    reply.code(304).send()
+  })
+
+  await fastify.ready()
+
+  const response = await fastify.inject({
+    method: 'GET',
+    path: '/'
+  })
+  t.assert.strictEqual(response.statusCode, 304)
+  t.assert.strictEqual(response.headers['cache-control'], 'private, max-age=300')
+})
+
+test('sets configured Cache-control header on conditional 304 etag hit responses', async (t) => {
+  t.plan(4)
+
+  const opts = {
+    privacy: plugin.privacy.PUBLIC,
+    expiresIn: 300
+  }
+
+  const fastify = Fastify()
+  await fastify.register(plugin, opts)
+
+  fastify.get('/', (_req, reply) => {
+    reply.etag('123456').send({ hello: 'world' })
+  })
+
+  await fastify.ready()
+
+  const first = await fastify.inject({
+    method: 'GET',
+    path: '/'
+  })
+  t.assert.strictEqual(first.statusCode, 200)
+  t.assert.strictEqual(first.headers['cache-control'], 'public, max-age=300')
+
+  const second = await fastify.inject({
+    method: 'GET',
+    path: '/',
+    headers: {
+      'if-none-match': '123456'
+    }
+  })
+  t.assert.strictEqual(second.statusCode, 304)
+  t.assert.strictEqual(second.headers['cache-control'], 'public, max-age=300')
+})
+
 test('sets the expires header', async (t) => {
   t.plan(2)