@platformatic/next 2.20.0 → 2.21.0-alpha.2

package/lib/caching/valkey.js

@@ -42,20 +42,50 @@ export class CacheHandler {
   #logger
   #store
   #subprefix
+  #meta
   #maxTTL
 
-  constructor () {
-    this.#logger = this.#createLogger()
-    this.#config = globalThis.platformatic.config.cache
-    this.#store = getConnection(this.#config.url)
-    this.#maxTTL = this.#config.maxTTL
-    this.#subprefix = this.#getSubprefix()
+  constructor (options) {
+    options ??= {}
+
+    this.#config = options.config
+    this.#logger = options.logger
+    this.#store = options.store
+    this.#maxTTL = options.maxTTL
+    this.#subprefix = options.subprefix
+    this.#meta = options.meta
+
+    if (globalThis.platformatic) {
+      this.#config ??= globalThis.platformatic.config.cache
+      this.#logger ??= this.#createPlatformaticLogger()
+      this.#store ??= getConnection(this.#config.url)
+      this.#maxTTL ??= this.#config.maxTTL
+      this.#subprefix ??= this.#getPlatformaticSubprefix()
+      this.#meta ??= this.#getPlatformaticMeta()
+    } else {
+      this.#config ??= {}
+      this.#maxTTL ??= 86_400
+      this.#subprefix ??= ''
+      this.#meta ??= {}
+    }
+
+    if (!this.#config) {
+      throw new Error('Please provide a the "config" option.')
+    }
+
+    if (!this.#logger) {
+      throw new Error('Please provide a the "logger" option.')
+    }
+
+    if (!this.#store) {
+      throw new Error('Please provide a the "store" option.')
+    }
   }
 
-  async get (cacheKey) {
+  async get (cacheKey, _, isRedisKey) {
     this.#logger.trace({ key: cacheKey }, 'get')
 
-    const key = this.#keyFor(cacheKey, sections.values)
+    const key = isRedisKey ? cacheKey : this.#keyFor(cacheKey, sections.values)
 
     let rawValue
     try {
@@ -96,13 +126,21 @@ export class CacheHandler {
     return value
   }
 
-  async set (cacheKey, value, { tags, revalidate }) {
+  async set (cacheKey, value, { tags, revalidate }, isRedisKey) {
     this.#logger.trace({ key: cacheKey, value, tags, revalidate }, 'set')
 
+    const key = isRedisKey ? cacheKey : this.#keyFor(cacheKey, sections.values)
+
     try {
       // Compute the parameters to save
-      const key = this.#keyFor(cacheKey, sections.values)
-      const data = this.#serialize({ value, tags, lastModified: Date.now(), revalidate, maxTTL: this.#maxTTL })
+      const data = this.#serialize({
+        value,
+        tags,
+        lastModified: Date.now(),
+        revalidate,
+        maxTTL: this.#maxTTL,
+        ...this.#meta
+      })
       const expire = Math.min(revalidate, this.#maxTTL)
 
       if (expire < 1) {
@@ -131,6 +169,56 @@ export class CacheHandler {
     }
   }
 
+  async remove (cacheKey, isRedisKey) {
+    this.#logger.trace({ key: cacheKey }, 'remove')
+
+    const key = isRedisKey ? cacheKey : this.#keyFor(cacheKey, sections.values)
+
+    let rawValue
+    try {
+      rawValue = await this.#store.get(key)
+
+      if (!rawValue) {
+        return
+      }
+    } catch (e) {
+      this.#logger.error({ err: ensureLoggableError(e) }, 'Cannot read cache value from Valkey')
+      throw new Error('Cannot read cache value from Valkey', { cause: e })
+    }
+
+    let value
+    try {
+      value = this.#deserialize(rawValue)
+    } catch (e) {
+      this.#logger.error({ err: ensureLoggableError(e) }, 'Cannot deserialize cache value from Valkey')
+
+      // Avoid useless reads the next time
+      // Note that since the value was unserializable, we don't know its tags and thus
+      // we cannot remove it from the tags sets. TTL will take care of them.
+      await this.#store.del(key)
+
+      throw new Error('Cannot deserialize cache value from Valkey', { cause: e })
+    }
+
+    try {
+      const promises = []
+      promises.push(this.#store.del(key))
+
+      if (Array.isArray(value.tags)) {
+        for (const tag of value.tags) {
+          const tagsKey = this.#keyFor(tag, sections.tags)
+          this.#store.srem(tagsKey, key, 'gt')
+        }
+      }
+
+      // Execute all the operations
+      await Promise.all(promises)
+    } catch (e) {
+      this.#logger.error({ err: ensureLoggableError(e) }, 'Cannot remove cache value from Valkey')
+      throw new Error('Cannot remove cache value from Valkey', { cause: e })
+    }
+  }
+
   async revalidateTag (tags) {
     this.#logger.trace({ tags }, 'revalidateTag')
 
@@ -189,7 +277,7 @@ export class CacheHandler {
     await Promise.all(promises)
   }
 
-  #createLogger () {
+  #createPlatformaticLogger () {
     const pinoOptions = {
       level: globalThis.platformatic?.logLevel ?? 'info'
     }
@@ -205,7 +293,7 @@ export class CacheHandler {
     return pino(pinoOptions)
   }
 
-  #getSubprefix () {
+  #getPlatformaticSubprefix () {
     const root = fileURLToPath(globalThis.platformatic.root)
 
     return existsSync(resolve(root, '.next/BUILD_ID'))
@@ -213,6 +301,13 @@ export class CacheHandler {
       : 'development'
   }
 
+  #getPlatformaticMeta () {
+    return {
+      serviceId: globalThis.platformatic.serviceId,
+      workerId: globalThis.platformatic.workerId
+    }
+  }
+
   #keyFor (key, section) {
     return keyFor(this.#config.prefix, this.#subprefix, section, key)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/next",
-  "version": "2.20.0",
+  "version": "2.21.0-alpha.2",
   "description": "Platformatic Next.js Stackable",
   "main": "index.js",
   "type": "module",
@@ -23,9 +23,9 @@
     "iovalkey": "^0.2.1",
     "msgpackr": "^1.11.2",
     "semver": "^7.6.3",
-    "@platformatic/basic": "2.20.0",
-    "@platformatic/utils": "2.20.0",
-    "@platformatic/config": "2.20.0"
+    "@platformatic/basic": "2.21.0-alpha.2",
+    "@platformatic/utils": "2.21.0-alpha.2",
+    "@platformatic/config": "2.21.0-alpha.2"
   },
   "devDependencies": {
     "@fastify/reply-from": "^11.0.0",
@@ -41,8 +41,8 @@
     "react-dom": "^18.3.1",
     "typescript": "^5.5.4",
     "ws": "^8.18.0",
-    "@platformatic/composer": "2.20.0",
-    "@platformatic/service": "2.20.0"
+    "@platformatic/composer": "2.21.0-alpha.2",
+    "@platformatic/service": "2.21.0-alpha.2"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --no-timeout",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/next/2.20.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/next/2.21.0-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Next.js Stackable",
   "type": "object",