@platformatic/runtime 2.5.5-alpha.3 → 2.5.6-alpha.2

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime255Alpha3Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime256Alpha2Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -109,6 +109,17 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime255Alpha3Json = {
         };
     [k: string]: unknown;
   };
+  httpCache?:
+    | boolean
+    | {
+        store?: string;
+        /**
+         * @minItems 1
+         */
+        methods?: [string, ...string[]];
+        cacheTagsHeader?: string;
+        [k: string]: unknown;
+      };
   watch?: boolean | string;
   managementApi?:
     | boolean

package/lib/management-api.js

@@ -22,6 +22,11 @@ async function managementApiPlugin (app, opts) {
 
   const runtime = opts.runtime
 
+  app.get('/status', async () => {
+    const status = runtime.getRuntimeStatus()
+    return { status }
+  })
+
   app.get('/metadata', async () => {
     return runtime.getRuntimeMetadata()
   })
@@ -188,6 +193,15 @@ async function managementApiPlugin (app, opts) {
     const logFileStream = await runtime.getLogFileStream(logId, runtimePID)
     return logFileStream
   })
+
+  app.get('/http-cache/requests', async () => {
+    return runtime.getCachedHttpRequests()
+  })
+
+  app.post('/http-cache/invalidate', async (req) => {
+    const { origin, routes, tags } = req.body
+    await runtime.invalidateHttpCache({ origin, routes, tags })
+  })
 }
 
 async function startManagementApi (runtime, configManager) {

package/lib/runtime.js

@@ -16,6 +16,7 @@ const errors = require('./errors')
 const { createLogger } = require('./logger')
 const { startManagementApi } = require('./management-api')
 const { startPrometheusServer } = require('./prom-server')
+const { createSharedStore } = require('./shared-http-cache')
 const { getRuntimeTmpDir } = require('./utils')
 const { sendViaITC, waitEventFromITC } = require('./worker/itc')
 const { kId, kITC, kConfig } = require('./worker/symbols')
@@ -53,6 +54,7 @@ class Runtime extends EventEmitter {
   #bootstrapAttempts
   #inspectors
   #inspectorServer
+  #sharedHttpCache
 
   constructor (configManager, runtimeLogsDir, env) {
     super()
@@ -72,6 +74,7 @@ class Runtime extends EventEmitter {
     this.#restartPromises = new Map()
     this.#bootstrapAttempts = new Map()
     this.#inspectors = []
+    this.#sharedHttpCache = null
   }
 
   async init () {
@@ -116,6 +119,11 @@ class Runtime extends EventEmitter {
       throw e
     }
 
+    this.#sharedHttpCache = createSharedStore(
+      this.#configManager.dirname,
+      config.httpCache
+    )
+
     this.#updateStatus('init')
   }
 
@@ -202,6 +210,10 @@ class Runtime extends EventEmitter {
     return this.#url
   }
 
+  getRuntimeStatus () {
+    return this.#status
+  }
+
   async close (fromManagementApi = false, silent = false) {
     this.#updateStatus('closing')
 
@@ -751,6 +763,24 @@ class Runtime extends EventEmitter {
     return createReadStream(filePath)
   }
 
+  async getCachedHttpRequests () {
+    return this.#sharedHttpCache.getRoutes()
+  }
+
+  async invalidateHttpCache (options = {}) {
+    const { origin, routes, tags } = options
+
+    if (!this.#sharedHttpCache) return
+
+    if (routes && routes.length > 0) {
+      await this.#sharedHttpCache.deleteRoutes(routes)
+    }
+
+    if (tags && tags.length > 0) {
+      await this.#sharedHttpCache.deleteByCacheTags(origin, tags)
+    }
+  }
+
   #updateStatus (status) {
     this.#status = status
     this.emit(status)
@@ -861,7 +891,18 @@ class Runtime extends EventEmitter {
       port: service,
       handlers: {
         getServiceMeta: this.getServiceMeta.bind(this),
-        getServices: this.getServices.bind(this)
+        getServices: this.getServices.bind(this),
+        isHttpCacheFull: () => this.#sharedHttpCache.isFull(),
+        getHttpCacheValue: opts => this.#sharedHttpCache.getValue(opts.request),
+        setHttpCacheValue: opts => this.#sharedHttpCache.setValue(
+          opts.request,
+          opts.response,
+          opts.payload
+        ),
+        deleteHttpCacheValue: opts => this.#sharedHttpCache.deleteByOrigin(
+          opts.origin
+        ),
+        invalidateHttpCache: opts => this.invalidateHttpCache(opts),
       }
     })
     service[kITC].listen()

package/lib/schema.js

@@ -142,6 +142,32 @@ const platformaticRuntimeSchema = {
         }
       }
     },
+    httpCache: {
+      oneOf: [
+        {
+          type: 'boolean'
+        },
+        {
+          type: 'object',
+          properties: {
+            store: {
+              type: 'string'
+            },
+            methods: {
+              type: 'array',
+              items: {
+                type: 'string'
+              },
+              default: ['GET', 'HEAD'],
+              minItems: 1
+            },
+            cacheTagsHeader: {
+              type: 'string'
+            }
+          }
+        }
+      ]
+    },
     watch: {
       anyOf: [
         {

package/lib/shared-http-cache.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const { join } = require('node:path')
+const { createRequire } = require('node:module')
+const MemoryCacheStore = require('@platformatic/undici-cache-memory')
+
+function createSharedStore (projectDir, httpCacheConfig = {}) {
+  const runtimeRequire = createRequire(join(projectDir, 'file'))
+
+  const { store, ...storeConfig } = httpCacheConfig
+  const CacheStore = store ? runtimeRequire(store) : MemoryCacheStore
+
+  class SharedCacheStore extends CacheStore {
+    async getValue (req) {
+      const readStream = await this.createReadStream(req)
+      if (!readStream) return null
+
+      let payload = ''
+      for await (const chunk of readStream) {
+        payload += chunk
+      }
+
+      const response = this.#sanitizeResponse(readStream.value)
+      return { response, payload }
+    }
+
+    setValue (req, opts, data) {
+      const writeStream = this.createWriteStream(req, opts)
+      writeStream.write(data)
+      writeStream.end()
+      return null
+    }
+
+    #sanitizeResponse (response) {
+      return {
+        ...response,
+        rawHeaders: response.rawHeaders.map(header => header.toString())
+      }
+    }
+  }
+
+  return new SharedCacheStore(storeConfig)
+}
+
+module.exports = { createSharedStore }

package/lib/worker/http-cache.js

@@ -0,0 +1,83 @@
+'use strict'
+
+const { Readable, Writable } = require('node:stream')
+const { kITC } = require('./symbols')
+
+class RemoteCacheStore {
+  get isFull () {
+    // TODO: make an itc call to the shared cache when interceptor supports
+    // an async isFull method
+    return false
+  }
+
+  async createReadStream (request) {
+    const itc = globalThis[kITC]
+    if (!itc) return
+
+    const cachedValue = await itc.send('getHttpCacheValue', {
+      request: this.#sanitizeRequest(request)
+    })
+    if (!cachedValue) return
+
+    const readable = new Readable({
+      read () {}
+    })
+
+    Object.defineProperty(readable, 'value', {
+      get () { return cachedValue.response }
+    })
+
+    readable.push(cachedValue.payload)
+    readable.push(null)
+
+    return readable
+  }
+
+  createWriteStream (request, response) {
+    const itc = globalThis[kITC]
+    if (!itc) throw new Error('Cannot write to cache without an ITC instance')
+
+    let payload = ''
+
+    request = this.#sanitizeRequest(request)
+    response = this.#sanitizeResponse(response)
+
+    return new Writable({
+      write (chunk, encoding, callback) {
+        payload += chunk
+        callback()
+      },
+      final (callback) {
+        itc.send('setHttpCacheValue', { request, response, payload })
+          .then(() => callback())
+          .catch((err) => callback(err))
+      }
+    })
+  }
+
+  deleteByOrigin (origin) {
+    const itc = globalThis[kITC]
+    if (!itc) throw new Error('Cannot delete from cache without an ITC instance')
+
+    itc.send('deleteHttpCacheValue', { origin })
+    // TODO: return a Promise
+  }
+
+  #sanitizeRequest (request) {
+    return {
+      origin: request.origin,
+      method: request.method,
+      path: request.path,
+      headers: request.headers
+    }
+  }
+
+  #sanitizeResponse (response) {
+    return {
+      ...response,
+      rawHeaders: response.rawHeaders.map(header => header.toString())
+    }
+  }
+}
+
+module.exports = RemoteCacheStore

package/lib/worker/main.js

@@ -7,9 +7,11 @@ const { pathToFileURL } = require('node:url')
 const inspector = require('node:inspector')
 
 const pino = require('pino')
-const { fetch, setGlobalDispatcher, Agent } = require('undici')
+const { fetch, setGlobalDispatcher, getGlobalDispatcher, Agent } = require('undici')
 const { wire } = require('undici-thread-interceptor')
+const undici = require('undici')
 
+const RemoteCacheStore = require('./http-cache')
 const { PlatformaticApp } = require('./app')
 const { setupITC } = require('./itc')
 const loadInterceptors = require('./interceptors')
@@ -78,10 +80,21 @@ async function main () {
     }
   }
 
-  const globalDispatcher = new Agent({
-    ...config.undici,
-    interceptors
-  }).compose(composedInterceptors)
+  const dispatcherOpts = { ...config.undici }
+
+  if (Object.keys(interceptors).length > 0) {
+    const clientInterceptors = [...interceptors.Agent, ...interceptors.Client]
+    const poolInterceptors = [...interceptors.Agent, ...interceptors.Pool]
+
+    dispatcherOpts.factory = (origin, opts) => {
+      return opts && opts.connections === 1
+        ? new undici.Client(origin, opts).compose(clientInterceptors)
+        : new undici.Pool(origin, opts).compose(poolInterceptors)
+    }
+  }
+
+  const globalDispatcher = new Agent(dispatcherOpts)
+    .compose(composedInterceptors)
 
   setGlobalDispatcher(globalDispatcher)
 
@@ -90,6 +103,15 @@ async function main () {
   // TODO: make this configurable
   const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: 5 * 60 * 1000 })
 
+  if (config.httpCache) {
+    setGlobalDispatcher(
+      getGlobalDispatcher().compose(undici.interceptors.cache({
+        store: new RemoteCacheStore(),
+        methods: config.httpCache.methods ?? ['GET', 'HEAD']
+      }))
+    )
+  }
+
   // If the service is an entrypoint and runtime server config is defined, use it.
   let serverConfig = null
   if (config.server && service.entrypoint) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.5.5-alpha.3",
+  "version": "2.5.6-alpha.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -19,7 +19,7 @@
   "devDependencies": {
     "@fastify/express": "^4.0.0",
     "@fastify/formbody": "^8.0.0",
-    "borp": "^0.17.0",
+    "borp": "^0.18.0",
     "c8": "^10.0.0",
     "eslint": "9",
     "execa": "^8.0.1",
@@ -35,17 +35,18 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.5.5-alpha.3",
-    "@platformatic/db": "2.5.5-alpha.3",
-    "@platformatic/service": "2.5.5-alpha.3",
-    "@platformatic/sql-graphql": "2.5.5-alpha.3",
-    "@platformatic/sql-mapper": "2.5.5-alpha.3"
+    "@platformatic/composer": "2.5.6-alpha.2",
+    "@platformatic/service": "2.5.6-alpha.2",
+    "@platformatic/db": "2.5.6-alpha.2",
+    "@platformatic/sql-graphql": "2.5.6-alpha.2",
+    "@platformatic/sql-mapper": "2.5.6-alpha.2"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
     "@fastify/websocket": "^11.0.0",
     "@hapi/topo": "^6.0.2",
     "@platformatic/http-metrics": "^0.2.1",
+    "@platformatic/undici-cache-memory": "^0.3.0",
     "@watchable/unpromise": "^1.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
@@ -67,16 +68,16 @@
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "thread-cpu-usage": "^0.2.0",
-    "undici": "^6.9.0",
+    "undici": "7.0.0-alpha.3",
     "undici-thread-interceptor": "^0.7.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.5.5-alpha.3",
-    "@platformatic/config": "2.5.5-alpha.3",
-    "@platformatic/generators": "2.5.5-alpha.3",
-    "@platformatic/itc": "2.5.5-alpha.3",
-    "@platformatic/telemetry": "2.5.5-alpha.3",
-    "@platformatic/ts-compiler": "2.5.5-alpha.3",
-    "@platformatic/utils": "2.5.5-alpha.3"
+    "@platformatic/basic": "2.5.6-alpha.2",
+    "@platformatic/config": "2.5.6-alpha.2",
+    "@platformatic/generators": "2.5.6-alpha.2",
+    "@platformatic/telemetry": "2.5.6-alpha.2",
+    "@platformatic/itc": "2.5.6-alpha.2",
+    "@platformatic/ts-compiler": "2.5.6-alpha.2",
+    "@platformatic/utils": "2.5.6-alpha.2"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.5.5-alpha.3.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.5.6-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -379,6 +379,35 @@
         }
       }
     },
+    "httpCache": {
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "store": {
+              "type": "string"
+            },
+            "methods": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": [
+                "GET",
+                "HEAD"
+              ],
+              "minItems": 1
+            },
+            "cacheTagsHeader": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
     "watch": {
       "anyOf": [
         {