@platformatic/runtime 2.30.0 → 2.30.1-alpha.1

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2300Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2301Alpha1Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;

package/lib/worker/http-cache.js

@@ -1,8 +1,13 @@
 'use strict'
 
+const { randomUUID } = require('node:crypto')
 const { Readable, Writable } = require('node:stream')
+const { interceptors } = require('undici')
 const { kITC } = require('./symbols')
 
+const kCacheIdHeader = Symbol('cacheIdHeader')
+const CACHE_ID_HEADER = 'x-plt-http-cache-id'
+
 const noop = () => {}
 
 class RemoteCacheStore {
@@ -56,13 +61,19 @@ class RemoteCacheStore {
     }
   }
 
-  createWriteStream (request, response) {
+  createWriteStream (key, value) {
+    const cacheEntryId = value.headers?.[kCacheIdHeader]
+    if (cacheEntryId) {
+      key = { ...key, id: cacheEntryId }
+      value.headers = { ...value.headers, [CACHE_ID_HEADER]: cacheEntryId }
+    }
+
     const itc = globalThis[kITC]
     if (!itc) throw new Error('Cannot write to cache without an ITC instance')
 
     let payload = ''
 
-    request = this.#sanitizeRequest(request)
+    key = this.#sanitizeRequest(key)
 
     return new Writable({
       write (chunk, encoding, callback) {
@@ -70,7 +81,7 @@ class RemoteCacheStore {
         callback()
       },
       final (callback) {
-        itc.send('setHttpCacheValue', { request, response, payload })
+        itc.send('setHttpCacheValue', { request: key, response: value, payload })
           .then(() => callback())
           .catch((err) => callback(err))
       }
@@ -96,4 +107,59 @@ class RemoteCacheStore {
   }
 }
 
-module.exports = RemoteCacheStore
+const httpCacheInterceptor = (interceptorOpts) => {
+  const originalInterceptor = interceptors.cache(interceptorOpts)
+
+  // AsyncLocalStorage that contains a client http request span
+  // Exists only when the nodejs stackable telemetry is enabled
+  const clientSpansAls = globalThis.platformatic.clientSpansAls
+
+  return (originalDispatch) => {
+    const dispatch = (opts, handler) => {
+      const originOnResponseStart = handler.onResponseStart.bind(handler)
+      handler.onResponseStart = (ac, statusCode, headers, statusMessage) => {
+        // Setting a potentially cache entry id when cache miss happens
+        headers[kCacheIdHeader] = randomUUID()
+        return originOnResponseStart(ac, statusCode, headers, statusMessage)
+      }
+
+      return originalDispatch(opts, handler)
+    }
+
+    const dispatcher = originalInterceptor(dispatch)
+
+    return (opts, handler) => {
+      const originOnResponseStart = handler.onResponseStart.bind(handler)
+      handler.onResponseStart = (ac, statusCode, headers, statusMessage) => {
+        const cacheEntryId = headers[kCacheIdHeader] ?? headers[CACHE_ID_HEADER]
+        const isCacheHit = headers.age !== undefined
+
+        if (cacheEntryId) {
+          // Setting a cache id header on cache hit
+          headers[CACHE_ID_HEADER] = cacheEntryId
+          delete headers[kCacheIdHeader]
+
+          if (clientSpansAls) {
+            try {
+              const { span } = clientSpansAls.getStore()
+              if (span) {
+                span.setAttribute('http.cache.id', cacheEntryId)
+                span.setAttribute('http.cache.hit', isCacheHit.toString())
+              }
+            } catch (err) {
+              interceptorOpts.logger.error(err, 'Error setting cache id on span')
+            }
+          }
+        }
+        return originOnResponseStart(ac, statusCode, headers, statusMessage)
+      }
+
+      if (!clientSpansAls) {
+        return dispatcher(opts, handler)
+      }
+      return clientSpansAls.run({ span: null }, () => dispatcher(opts, handler))
+    }
+  }
+}
+
+module.exports = { RemoteCacheStore, httpCacheInterceptor }

package/lib/worker/main.js

@@ -16,7 +16,7 @@ const { fetch, setGlobalDispatcher, getGlobalDispatcher, Agent } = require('undi
 const { wire } = require('undici-thread-interceptor')
 const undici = require('undici')
 
-const RemoteCacheStore = require('./http-cache')
+const { RemoteCacheStore, httpCacheInterceptor } = require('./http-cache')
 const { PlatformaticApp } = require('./app')
 const { setupITC } = require('./itc')
 const { loadInterceptors } = require('./interceptors')
@@ -158,7 +158,7 @@ async function main () {
   if (config.httpCache) {
     setGlobalDispatcher(
       getGlobalDispatcher().compose(
-        undici.interceptors.cache({
+        httpCacheInterceptor({
           store: new RemoteCacheStore({
             onRequest: (opts) => {
               globalThis.platformatic?.onHttpCacheRequest?.(opts)
@@ -171,7 +171,8 @@ async function main () {
             },
             logger: globalThis.platformatic.logger
           }),
-          methods: config.httpCache.methods ?? ['GET', 'HEAD']
+          methods: config.httpCache.methods ?? ['GET', 'HEAD'],
+          logger: globalThis.platformatic.logger
         })
       )
     )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.30.0",
+  "version": "2.30.1-alpha.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -35,18 +35,19 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.30.0",
-    "@platformatic/db": "2.30.0",
-    "@platformatic/node": "2.30.0",
-    "@platformatic/service": "2.30.0",
-    "@platformatic/sql-mapper": "2.30.0",
-    "@platformatic/sql-graphql": "2.30.0"
+    "@platformatic/composer": "2.30.1-alpha.1",
+    "@platformatic/db": "2.30.1-alpha.1",
+    "@platformatic/service": "2.30.1-alpha.1",
+    "@platformatic/sql-graphql": "2.30.1-alpha.1",
+    "@platformatic/node": "2.30.1-alpha.1",
+    "@platformatic/sql-mapper": "2.30.1-alpha.1"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
     "@fastify/error": "^4.0.0",
     "@fastify/websocket": "^11.0.0",
     "@hapi/topo": "^6.0.2",
+    "@opentelemetry/api": "^1.8.0",
     "@platformatic/http-metrics": "^0.2.1",
     "@platformatic/undici-cache-memory": "^0.8.1",
     "@watchable/unpromise": "^1.0.2",
@@ -71,15 +72,15 @@
     "tail-file-stream": "^0.2.0",
     "thread-cpu-usage": "^0.2.0",
     "undici": "^7.0.0",
-    "undici-thread-interceptor": "^0.10.0",
+    "undici-thread-interceptor": "^0.10.3",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.30.0",
-    "@platformatic/config": "2.30.0",
-    "@platformatic/itc": "2.30.0",
-    "@platformatic/telemetry": "2.30.0",
-    "@platformatic/generators": "2.30.0",
-    "@platformatic/ts-compiler": "2.30.0",
-    "@platformatic/utils": "2.30.0"
+    "@platformatic/basic": "2.30.1-alpha.1",
+    "@platformatic/config": "2.30.1-alpha.1",
+    "@platformatic/generators": "2.30.1-alpha.1",
+    "@platformatic/telemetry": "2.30.1-alpha.1",
+    "@platformatic/ts-compiler": "2.30.1-alpha.1",
+    "@platformatic/itc": "2.30.1-alpha.1",
+    "@platformatic/utils": "2.30.1-alpha.1"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.30.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.30.1-alpha.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {