Implement delete all cached pages, if the paths to be cached array is empty every path is cached, update README.md

Author: luispittagros

README.md

@@ -1,6 +1,8 @@
 # Nuxt SSR Redis Cache
 
-:rocket: Blazing Fast Server Side Rendering using Redis.
+:rocket: Blazing Fast Nuxt Server Side Rendering using Redis. 
+
+Easily improves you Nuxt application performance.
 
 ## Setup
 
@@ -18,15 +20,15 @@ modules: [
       '@luispittagros/nuxt-ssr-redis-cache',
       {
         enabled: true,
-        ttl: 60 * 60,
         client: {
           socket: {
             host:  '127.0.0.1',
             port: 6379,
           },
           password: null,
         },
-        paths: [/^\/$/, '/articles/'],
+        paths: [/^\/$/, '/articles/'], // If empty or "/" is set all pages will be cached
+        ttl: 60 * 60, // 1 minute
         cacheCleanEndpoint: {
           enabled: false, 
           path: '/ssr-redis-cache',
@@ -43,15 +45,15 @@ or
   modules: ['@luispittagros/nuxt-ssr-redis-cache'],
   ssrRedisCache: {
     enabled: true,
-    ttl: 60 * 60,
     client: {
       socket: {
         host: '127.0.0.1',
         port: 6379,
       },
       password: null,
     },
-    paths: [/^\/$/, '/articles/'],
+    paths: [/^\/$/, '/articles/'], // If empty or "/" is set all pages will be cached
+    ttl: 60 * 60, // 1 minute
     cacheCleanEndpoint: {
       enabled: true, 
       path: '/ssr-redis-cache',
@@ -68,16 +70,16 @@ For the client configuration check node-redis for reference [here](https://githu
 
 Creates an endpoint that cleans cached paths, it's useful when you have content that might change often.
 
-To call the endpoint you must make a POST request to your Nuxt appplication using the path you defined (defaults to '/ssr-redis-cache') with the following request body:
+To call the endpoint you must make a POST request to your Nuxt appplication using the path you defined (defaults to '/ssr-redis-cache') with the following JSON request body:
 
 ```json
 {
-   "paths" : [ "/", "/example/" ]
+   "paths" : [ "/", "/example/" ] // Use "*" as path to delete all cached pages
 }
 ```
 
-For CORS options check the express cors middleware options [here](https://expressjs.com/en/resources/middleware/cors.html).
+For the CORS options check the express cors middleware options [here](https://expressjs.com/en/resources/middleware/cors.html).
 
 ### Cached Pages
 
-Cacheable pages have the HTTP response header "X-Cache" which may have a value of "HIT" or "MISS" accordingly.
+Cacheable/Cached pages have the HTTP response header "X-Cache" which have the value "HIT" or "MISS" accordingly.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luispittagros/nuxt-ssr-redis-cache",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Blazing Fast SSR page renderings using Redis.",
   "main": "src/cache.js",
   "author": "Luís Pitta Grós",

src/cache.js

@@ -28,12 +28,18 @@ export default async function nuxtRedisCache(moduleOptions) {
 
   this.nuxt.hook('render:setupMiddleware', () => {
     const isCacheCleanEndpointEnabled = options.cacheCleanEndpoint && options.cacheCleanEndpoint.enabled !== false
-  
+
     if (isCacheCleanEndpointEnabled) {
-      this.addServerMiddleware({ path: options.cacheCleanEndpoint.path || '/ssr-redis-cache', handler: ssrRedisCacheMiddleware(client, options.cacheCleanEndpoint)})
+      this.addServerMiddleware({
+        path: options.cacheCleanEndpoint.path || '/ssr-redis-cache',
+        handler: ssrRedisCacheMiddleware(client, options.cacheCleanEndpoint),
+      })
     }
-    
-    console.log('[Nuxt SSR Redis Cache]:', 'Cache clean endpoint is ' + (isCacheCleanEndpointEnabled ? 'enabled\x1b[32m ✔' : 'disabled\x1b[31m ✘') + '\n')
+
+    console.log(
+      '[Nuxt SSR Redis Cache]:',
+      'Cache clean endpoint is ' + (isCacheCleanEndpointEnabled ? 'enabled\x1b[32m ✔' : 'disabled\x1b[31m ✘') + '\n',
+    )
   })
 
   this.nuxt.hook('render:before', async (renderer) => {
@@ -72,7 +78,7 @@ export default async function nuxtRedisCache(moduleOptions) {
       context.res.setHeader('X-Cache', hitCache ? 'HIT' : 'MISS')
     }
 
-    if (!hitCache && isCacheable(url, options.paths)) {
+    if (!hitCache && isCacheable(url, options.paths, context.req.headers['cache-control'])) {
       client.set('nuxt/route::' + url, serialize(result), {
         EX: options.ttl,
       })
@@ -93,17 +99,19 @@ function buildOptions(moduleOptions) {
     ttl: 60 * 60,
     paths: [],
     cacheCleanEndpoint: {
-      enabled: false, 
+      enabled: false,
       path: '/ssr-redis-cache',
       cors: true,
-    }
+    },
   }
 
   return Object.assign({}, defaultOptions, moduleOptions)
 }
 
 function isCacheable(url, paths = [], cacheControl = null) {
-  return cacheControl !== 'no-cache' && paths.some((path) => (path instanceof RegExp ? path.test(url) : url.startsWith(path)))
+  return (
+    cacheControl !== 'no-cache' && (!paths.length || paths.some((path) => (path instanceof RegExp ? path.test(url) : url.startsWith(path))))
+  )
 }
 
 module.exports.meta = require('../package.json')

src/serverMiddleware.js

@@ -2,7 +2,7 @@ const express = require('express')
 const { json } = require('body-parser')
 const cors = require('cors')
 
-function ssrRedisCacheMiddleware(redisClient, options = {}) {
+function ssrRedisCacheMiddleware(client, options = {}) {
   const app = express()
 
   app.use(json())
@@ -16,7 +16,12 @@ function ssrRedisCacheMiddleware(redisClient, options = {}) {
     }
 
     try {
-      await Promise.all(paths.map((path) => redisClient.del('nuxt/route::' + path)))
+      if (paths.length === 1 && paths[0] === '*') {
+        const { keys = [] } = await client.scan(0, { MATCH: 'nuxt/route::*' });
+        await Promise.all(keys.map((path) => client.del(path)))
+      } else {
+        await Promise.all(paths.map((path) => client.del('nuxt/route::' + path)))
+      }
 
       return res.status(200).json({ success: true })
     } catch (error) {