@platformatic/runtime 2.62.0 → 2.63.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2620Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2630Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -77,6 +77,14 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2620Json = {
         [k: string]: unknown;
       };
     };
+    formatters?: {
+      path: string;
+    };
+    timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
+    redact?: {
+      paths: string[];
+      censor?: string;
+    };
     [k: string]: unknown;
   };
   server?: {

package/lib/errors.js

@@ -21,6 +21,7 @@ module.exports = {
   FailedToRetrieveMetricsError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`, 'Failed to retrieve metrics for service with id "%s": %s'),
   FailedToRetrieveHealthError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_HEALTH`, 'Failed to retrieve health for service with id "%s": %s'),
   FailedToPerformCustomHealthCheckError: createError(`${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_HEALTH_CHECK`, 'Failed to perform custom healthcheck for service with id "%s": %s'),
+  FailedToPerformCustomReadinessCheckError: createError(`${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_READINESS_CHECK`, 'Failed to perform custom readiness check for service with id "%s": %s'),
   ApplicationAlreadyStartedError: createError(`${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`, 'Application is already started'),
   ApplicationNotStartedError: createError(`${ERROR_PREFIX}_APPLICATION_NOT_STARTED`, 'Application has not been started'),
   ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),

package/lib/logger.js

@@ -3,9 +3,9 @@
 const { once } = require('node:events')
 const { join } = require('node:path')
 const { isatty } = require('node:tty')
-
 const pino = require('pino')
 const pretty = require('pino-pretty')
+const { buildPinoFormatters, buildPinoTimestamp } = require('@platformatic/utils')
 
 const customPrettifiers = {
   name (name, _, obj) {
@@ -18,6 +18,7 @@ const customPrettifiers = {
   }
 }
 
+// Create the runtime logger
 async function createLogger (config, runtimeLogsDir) {
   const loggerConfig = { ...config.logger }
 
@@ -28,6 +29,13 @@ async function createLogger (config, runtimeLogsDir) {
       ? pretty({ customPrettifiers })
       : pino.destination(1)
 
+  if (loggerConfig.formatters) {
+    loggerConfig.formatters = buildPinoFormatters(loggerConfig.formatters)
+  }
+  if (loggerConfig.timestamp) {
+    loggerConfig.timestamp = buildPinoTimestamp(loggerConfig.timestamp)
+  }
+
   if (!config.managementApi) {
     return [pino(loggerConfig, cliStream), cliStream]
   }

package/lib/prom-server.js

@@ -19,22 +19,52 @@ const DEFAULT_LIVENESS_FAIL_BODY = 'ERR'
 async function checkReadiness (runtime) {
   const workers = await runtime.getWorkers()
 
+  // check if all workers are started
   for (const worker of Object.values(workers)) {
     if (worker.status !== 'started') {
-      return false
+      return { status: false }
     }
   }
-  return true
+
+  // perform custom readiness checks, get custom response content if any
+  const checks = await runtime.getCustomReadinessChecks()
+
+  let response
+  const status = Object.values(checks).every(check => {
+    if (typeof check === 'boolean') {
+      return check
+    } else if (typeof check === 'object') {
+      response = check
+      return check.status
+    }
+    return false
+  })
+
+  return { response, status }
 }
 
 async function checkLiveness (runtime) {
-  if (!(await checkReadiness(runtime))) {
-    return false
+  const { status: ready, response: readinessResponse } = await checkReadiness(runtime)
+  if (!ready) {
+    return { status: false, readiness: readinessResponse }
   }
+  // TODO test, doc
+  // in case of readiness check failure, if custom readiness response is set, we return the readiness check response on health check endpoint
 
   const checks = await runtime.getCustomHealthChecks()
 
-  return Object.values(checks).every(check => check)
+  let response
+  const status = Object.values(checks).every(check => {
+    if (typeof check === 'boolean') {
+      return check
+    } else if (typeof check === 'object') {
+      response = check
+      return check.status
+    }
+    return false
+  })
+
+  return { response, status }
 }
 
 async function startPrometheusServer (runtime, opts) {
@@ -88,12 +118,27 @@ async function startPrometheusServer (runtime, opts) {
       handler: async (req, reply) => {
         reply.type('text/plain')
 
-        const ready = await checkReadiness(runtime)
-
-        if (ready) {
-          reply.status(successStatusCode).send(successBody)
-        } else {
-          reply.status(failStatusCode).send(failBody)
+        const { status, response } = await checkReadiness(runtime)
+
+        if (typeof response === 'boolean') {
+          if (status) {
+            reply.status(successStatusCode).send(successBody)
+          } else {
+            reply.status(failStatusCode).send(failBody)
+          }
+        } else if (typeof response === 'object') {
+          const { status, body, statusCode } = response
+          if (status) {
+            reply.status(statusCode || successStatusCode).send(body || successBody)
+          } else {
+            reply.status(statusCode || failStatusCode).send(body || failBody)
+          }
+        } else if (!response) {
+          if (status) {
+            reply.status(successStatusCode).send(successBody)
+          } else {
+            reply.status(failStatusCode).send(failBody)
+          }
         }
       },
     })
@@ -112,12 +157,27 @@ async function startPrometheusServer (runtime, opts) {
       handler: async (req, reply) => {
         reply.type('text/plain')
 
-        const live = await checkLiveness(runtime)
-
-        if (live) {
-          reply.status(successStatusCode).send(successBody)
-        } else {
-          reply.status(failStatusCode).send(failBody)
+        const { status, response, readiness } = await checkLiveness(runtime)
+
+        if (typeof response === 'boolean') {
+          if (status) {
+            reply.status(successStatusCode).send(successBody)
+          } else {
+            reply.status(failStatusCode).send(readiness?.body || failBody)
+          }
+        } else if (typeof response === 'object') {
+          const { status, body, statusCode } = response
+          if (status) {
+            reply.status(statusCode || successStatusCode).send(body || successBody)
+          } else {
+            reply.status(statusCode || failStatusCode).send(body || readiness?.body || failBody)
+          }
+        } else if (!response) {
+          if (status) {
+            reply.status(successStatusCode).send(successBody)
+          } else {
+            reply.status(failStatusCode).send(readiness?.body || failBody)
+          }
         }
       },
     })

package/lib/runtime.js

@@ -672,6 +672,21 @@ class Runtime extends EventEmitter {
     return status
   }
 
+  async getCustomReadinessChecks () {
+    const status = {}
+
+    for (const [service, { count }] of Object.entries(this.#workers.configuration)) {
+      for (let i = 0; i < count; i++) {
+        const label = `${service}:${i}`
+        const worker = this.#workers.get(label)
+
+        status[label] = await sendViaITC(worker, 'getCustomReadinessCheck')
+      }
+    }
+
+    return status
+  }
+
   async getServiceDetails (id, allowUnloaded = false) {
     let service
 

package/lib/worker/default-stackable.js

@@ -17,6 +17,7 @@ const defaultStackable = {
   getOpenapiSchema: () => null,
   getGraphqlSchema: () => null,
   getCustomHealthCheck: () => null,
+  getCustomReadinessCheck: () => null,
   getMeta: () => ({}),
   getMetrics: () => null,
   inject: () => {

package/lib/worker/itc.js

@@ -174,6 +174,14 @@ function setupITC (app, service, dispatcher) {
         } catch (err) {
           throw new errors.FailedToPerformCustomHealthCheckError(service.id, err.message)
         }
+      },
+
+      async getCustomReadinessCheck () {
+        try {
+          return await app.stackable.getCustomReadinessCheck()
+        } catch (err) {
+          throw new errors.FailedToPerformCustomReadinessCheckError(service.id, err.message)
+        }
       }
     }
   })

package/lib/worker/main.js

@@ -16,7 +16,9 @@ const {
   ensureFlushedWorkerStdio,
   executeWithTimeout,
   ensureLoggableError,
-  getPrivateSymbol
+  getPrivateSymbol,
+  buildPinoFormatters,
+  buildPinoTimestamp
 } = require('@platformatic/utils')
 const dotenv = require('dotenv')
 const pino = require('pino')
@@ -69,12 +71,23 @@ function patchLogging () {
 }
 
 function createLogger () {
-  const pinoOptions = { level: 'trace', name: workerData.serviceConfig.id }
+  const pinoOptions = {
+    level: 'trace',
+    name: workerData.serviceConfig.id,
+    ...workerData.config.logger
+  }
 
   if (workerData.worker?.count > 1) {
     pinoOptions.base = { pid: process.pid, hostname: hostname(), worker: workerData.worker.index }
   }
 
+  if (pinoOptions.formatters) {
+    pinoOptions.formatters = buildPinoFormatters(pinoOptions.formatters)
+  }
+  if (pinoOptions.timestamp) {
+    pinoOptions.timestamp = buildPinoTimestamp(pinoOptions.timestamp)
+  }
+
   return pino(pinoOptions)
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.62.0",
+  "version": "2.63.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -21,7 +21,7 @@
     "@fastify/express": "^4.0.0",
     "@fastify/formbody": "^8.0.0",
     "autocannon": "^8.0.0",
-    "borp": "^0.19.0",
+    "borp": "^0.20.0",
     "c8": "^10.0.0",
     "eslint": "9",
     "execa": "^9.0.0",
@@ -37,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/db": "2.62.0",
-    "@platformatic/node": "2.62.0",
-    "@platformatic/sql-mapper": "2.62.0",
-    "@platformatic/sql-graphql": "2.62.0",
-    "@platformatic/composer": "2.62.0",
-    "@platformatic/service": "2.62.0"
+    "@platformatic/composer": "2.63.0",
+    "@platformatic/db": "2.63.0",
+    "@platformatic/node": "2.63.0",
+    "@platformatic/service": "2.63.0",
+    "@platformatic/sql-graphql": "2.63.0",
+    "@platformatic/sql-mapper": "2.63.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -76,13 +76,13 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.13.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.62.0",
-    "@platformatic/config": "2.62.0",
-    "@platformatic/generators": "2.62.0",
-    "@platformatic/itc": "2.62.0",
-    "@platformatic/telemetry": "2.62.0",
-    "@platformatic/ts-compiler": "2.62.0",
-    "@platformatic/utils": "2.62.0"
+    "@platformatic/config": "2.63.0",
+    "@platformatic/basic": "2.63.0",
+    "@platformatic/generators": "2.63.0",
+    "@platformatic/itc": "2.63.0",
+    "@platformatic/telemetry": "2.63.0",
+    "@platformatic/ts-compiler": "2.63.0",
+    "@platformatic/utils": "2.63.0"
   },
   "scripts": {
     "test": "pnpm run lint && borp --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.62.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.63.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -733,6 +733,46 @@
             }
           },
           "additionalProperties": false
+        },
+        "formatters": {
+          "type": "object",
+          "properties": {
+            "path": {
+              "type": "string",
+              "resolvePath": true
+            }
+          },
+          "required": [
+            "path"
+          ],
+          "additionalProperties": false
+        },
+        "timestamp": {
+          "enum": [
+            "epochTime",
+            "unixTime",
+            "nullTime",
+            "isoTime"
+          ]
+        },
+        "redact": {
+          "type": "object",
+          "properties": {
+            "paths": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "censor": {
+              "type": "string",
+              "default": "[redacted]"
+            }
+          },
+          "required": [
+            "paths"
+          ],
+          "additionalProperties": false
         }
       },
       "required": [