@platformatic/next 2.24.0 → 2.25.0

package/lib/caching/valkey.js

@@ -7,6 +7,11 @@ import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { pino } from 'pino'
 
+const CACHE_HIT_METRIC = { name: 'next_cache_valkey_hit_count', help: 'Next.js Cache (Valkey) Hit Count' }
+const CACHE_MISS_METRIC = { name: 'next_cache_valkey_miss_count', help: 'Next.js Cache (Valkey) Miss Count' }
+
+const clients = new Map()
+
 export const MAX_BATCH_SIZE = 100
 
 export const sections = {
@@ -14,8 +19,6 @@ export const sections = {
   tags: 'tags'
 }
 
-const clients = new Map()
-
 export function keyFor (prefix, subprefix, section, key) {
   return [prefix, 'cache:next', subprefix, section, key ? Buffer.from(key).toString('base64url') : undefined]
     .filter(c => c)
@@ -46,6 +49,8 @@ export class CacheHandler {
   #subprefix
   #meta
   #maxTTL
+  #cacheHitMetric
+  #cacheMissMetric
 
   constructor (options) {
     options ??= {}
@@ -86,6 +91,10 @@ export class CacheHandler {
     if (!this.#store) {
       throw new Error('Please provide a the "store" option.')
     }
+
+    if (globalThis.platformatic) {
+      this.#registerMetrics()
+    }
   }
 
   async get (cacheKey, _, isRedisKey) {
@@ -98,9 +107,11 @@ export class CacheHandler {
       rawValue = await this.#store.get(key)
 
       if (!rawValue) {
+        this.#cacheMissMetric?.inc()
         return
       }
     } catch (e) {
+      this.#cacheMissMetric?.inc()
       this.#logger.error({ err: ensureLoggableError(e) }, 'Cannot read cache value from Valkey')
       throw new Error('Cannot read cache value from Valkey', { cause: e })
     }
@@ -109,6 +120,7 @@ export class CacheHandler {
     try {
       value = this.#deserialize(rawValue)
     } catch (e) {
+      this.#cacheMissMetric?.inc()
       this.#logger.error({ err: ensureLoggableError(e) }, 'Cannot deserialize cache value from Valkey')
 
       // Avoid useless reads the next time
@@ -129,6 +141,7 @@ export class CacheHandler {
       }
     }
 
+    this.#cacheHitMetric?.inc()
     return value
   }
 
@@ -325,6 +338,26 @@ export class CacheHandler {
   #deserialize (data) {
     return unpack(Buffer.from(data, 'base64url'))
   }
+
+  #registerMetrics () {
+    const { client, registry } = globalThis.platformatic.prometheus
+
+    this.#cacheHitMetric =
+      registry.getSingleMetric(CACHE_HIT_METRIC.name) ??
+      new client.Counter({
+        name: CACHE_HIT_METRIC.name,
+        help: CACHE_HIT_METRIC.help,
+        registers: [registry]
+      })
+
+    this.#cacheMissMetric =
+      registry.getSingleMetric(CACHE_MISS_METRIC.name) ??
+      new client.Counter({
+        name: CACHE_MISS_METRIC.name,
+        help: CACHE_MISS_METRIC.help,
+        registers: [registry]
+      })
+  }
 }
 
 export default CacheHandler

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/next",
-  "version": "2.24.0",
+  "version": "2.25.0",
   "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.24.0",
-    "@platformatic/utils": "2.24.0",
-    "@platformatic/config": "2.24.0"
+    "@platformatic/basic": "2.25.0",
+    "@platformatic/utils": "2.25.0",
+    "@platformatic/config": "2.25.0"
   },
   "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.24.0",
-    "@platformatic/service": "2.24.0"
+    "@platformatic/composer": "2.25.0",
+    "@platformatic/service": "2.25.0"
   },
   "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.24.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/next/2.25.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Next.js Stackable",
   "type": "object",