@platformatic/runtime 2.48.0 → 2.50.0

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime2480Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime2500Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -173,6 +173,34 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime2480Json = {
         labels?: {
           [k: string]: string;
         };
+        readiness?:
+          | boolean
+          | {
+              endpoint?: string;
+              success?: {
+                statusCode?: number;
+                body?: string;
+              };
+              fail?: {
+                statusCode?: number;
+                body?: string;
+              };
+            };
+        liveness?:
+          | boolean
+          | {
+              endpoint?: string;
+              success?: {
+                statusCode?: number;
+                body?: string;
+              };
+              fail?: {
+                statusCode?: number;
+                body?: string;
+              };
+            };
+        additionalProperties?: never;
+        [k: string]: unknown;
       };
   telemetry?: OpenTelemetry;
   inspectorOptions?: {

package/lib/errors.js

@@ -20,6 +20,7 @@ module.exports = {
   FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata for service with id "%s": %s'),
   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'),
   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/prom-server.js

@@ -2,13 +2,48 @@
 
 const fastify = require('fastify')
 
+const DEFAULT_HOSTNAME = '0.0.0.0'
+const DEFAULT_PORT = 9090
+const DEFAULT_METRICS_ENDPOINT = '/metrics'
+const DEFAULT_READINESS_ENDPOINT = '/ready'
+const DEFAULT_READINESS_SUCCESS_STATUS_CODE = 200
+const DEFAULT_READINESS_SUCCESS_BODY = 'OK'
+const DEFAULT_READINESS_FAIL_STATUS_CODE = 500
+const DEFAULT_READINESS_FAIL_BODY = 'ERR'
+const DEFAULT_LIVENESS_ENDPOINT = '/status'
+const DEFAULT_LIVENESS_SUCCESS_STATUS_CODE = 200
+const DEFAULT_LIVENESS_SUCCESS_BODY = 'OK'
+const DEFAULT_LIVENESS_FAIL_STATUS_CODE = 500
+const DEFAULT_LIVENESS_FAIL_BODY = 'ERR'
+
+async function checkReadiness (runtime) {
+  const workers = await runtime.getWorkers()
+
+  for (const worker of Object.values(workers)) {
+    if (worker.status !== 'started') {
+      return false
+    }
+  }
+  return true
+}
+
+async function checkLiveness (runtime) {
+  if (!(await checkReadiness(runtime))) {
+    return false
+  }
+
+  const checks = await runtime.getCustomHealthChecks()
+
+  return Object.values(checks).every(check => check)
+}
+
 async function startPrometheusServer (runtime, opts) {
   if (opts.enabled === false) {
     return
   }
-  const host = opts.hostname ?? '0.0.0.0'
-  const port = opts.port ?? 9090
-  const metricsEndpoint = opts.endpoint ?? '/metrics'
+  const host = opts.hostname ?? DEFAULT_HOSTNAME
+  const port = opts.port ?? DEFAULT_PORT
+  const metricsEndpoint = opts.endpoint ?? DEFAULT_METRICS_ENDPOINT
   const auth = opts.auth ?? null
 
   const promServer = fastify({ name: 'Prometheus server' })
@@ -40,6 +75,54 @@ async function startPrometheusServer (runtime, opts) {
     },
   })
 
+  if (opts.readiness !== false) {
+    const successStatusCode = opts.readiness?.success?.statusCode ?? DEFAULT_READINESS_SUCCESS_STATUS_CODE
+    const successBody = opts.readiness?.success?.body ?? DEFAULT_READINESS_SUCCESS_BODY
+    const failStatusCode = opts.readiness?.fail?.statusCode ?? DEFAULT_READINESS_FAIL_STATUS_CODE
+    const failBody = opts.readiness?.fail?.body ?? DEFAULT_READINESS_FAIL_BODY
+
+    promServer.route({
+      url: opts.readiness?.endpoint ?? DEFAULT_READINESS_ENDPOINT,
+      method: 'GET',
+      logLevel: 'warn',
+      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)
+        }
+      },
+    })
+  }
+
+  if (opts.liveness !== false) {
+    const successStatusCode = opts.liveness?.success?.statusCode ?? DEFAULT_LIVENESS_SUCCESS_STATUS_CODE
+    const successBody = opts.liveness?.success?.body ?? DEFAULT_LIVENESS_SUCCESS_BODY
+    const failStatusCode = opts.liveness?.fail?.statusCode ?? DEFAULT_LIVENESS_FAIL_STATUS_CODE
+    const failBody = opts.liveness?.fail?.body ?? DEFAULT_LIVENESS_FAIL_BODY
+
+    promServer.route({
+      url: opts.liveness?.endpoint ?? DEFAULT_LIVENESS_ENDPOINT,
+      method: 'GET',
+      logLevel: 'warn',
+      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)
+        }
+      },
+    })
+  }
+
   await promServer.listen({ port, host })
   return promServer
 }

package/lib/runtime.js

@@ -66,7 +66,7 @@ class Runtime extends EventEmitter {
   #loggerDestination
   #metrics
   #metricsTimeout
-  #status
+  #status // starting, started, stopping, stopped, closed
   #meshInterceptor
   #dispatcher
   #managementApi
@@ -648,6 +648,21 @@ class Runtime extends EventEmitter {
     return status
   }
 
+  async getCustomHealthChecks () {
+    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, 'getCustomHealthCheck')
+      }
+    }
+
+    return status
+  }
+
   async getServiceDetails (id, allowUnloaded = false) {
     let service
 

package/lib/schema.js

@@ -380,9 +380,65 @@ const platformaticRuntimeSchema = {
             labels: {
               type: 'object',
               additionalProperties: { type: 'string' }
-            }
-          },
-          additionalProperties: false
+            },
+            readiness: {
+              anyOf: [
+                { type: 'boolean' },
+                {
+                  type: 'object',
+                  properties: {
+                    endpoint: { type: 'string' },
+                    success: {
+                      type: 'object',
+                      properties: {
+                        statusCode: { type: 'number' },
+                        body: { type: 'string' }
+                      },
+                      additionalProperties: false
+                    },
+                    fail: {
+                      type: 'object',
+                      properties: {
+                        statusCode: { type: 'number' },
+                        body: { type: 'string' }
+                      },
+                      additionalProperties: false
+                    }
+                  },
+                  additionalProperties: false
+                }
+              ]
+            },
+            liveness: {
+              anyOf: [
+                { type: 'boolean' },
+                {
+                  type: 'object',
+                  properties: {
+                    endpoint: { type: 'string' },
+                    success: {
+                      type: 'object',
+                      properties: {
+                        statusCode: { type: 'number' },
+                        body: { type: 'string' }
+                      },
+                      additionalProperties: false
+                    },
+                    fail: {
+                      type: 'object',
+                      properties: {
+                        statusCode: { type: 'number' },
+                        body: { type: 'string' }
+                      },
+                      additionalProperties: false
+                    }
+                  },
+                  additionalProperties: false
+                }
+              ]
+            },
+            additionalProperties: false
+          }
         }
       ]
     },

package/lib/worker/default-stackable.js

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

package/lib/worker/itc.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.48.0",
+  "version": "2.50.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -37,12 +37,12 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.48.0",
-    "@platformatic/node": "2.48.0",
-    "@platformatic/service": "2.48.0",
-    "@platformatic/sql-graphql": "2.48.0",
-    "@platformatic/sql-mapper": "2.48.0",
-    "@platformatic/db": "2.48.0"
+    "@platformatic/db": "2.50.0",
+    "@platformatic/node": "2.50.0",
+    "@platformatic/service": "2.50.0",
+    "@platformatic/composer": "2.50.0",
+    "@platformatic/sql-mapper": "2.50.0",
+    "@platformatic/sql-graphql": "2.50.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/config": "2.48.0",
-    "@platformatic/basic": "2.48.0",
-    "@platformatic/generators": "2.48.0",
-    "@platformatic/itc": "2.48.0",
-    "@platformatic/telemetry": "2.48.0",
-    "@platformatic/ts-compiler": "2.48.0",
-    "@platformatic/utils": "2.48.0"
+    "@platformatic/basic": "2.50.0",
+    "@platformatic/generators": "2.50.0",
+    "@platformatic/config": "2.50.0",
+    "@platformatic/itc": "2.50.0",
+    "@platformatic/telemetry": "2.50.0",
+    "@platformatic/ts-compiler": "2.50.0",
+    "@platformatic/utils": "2.50.0"
   },
   "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.48.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.50.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -1153,9 +1153,89 @@
               "additionalProperties": {
                 "type": "string"
               }
-            }
-          },
-          "additionalProperties": false
+            },
+            "readiness": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "endpoint": {
+                      "type": "string"
+                    },
+                    "success": {
+                      "type": "object",
+                      "properties": {
+                        "statusCode": {
+                          "type": "number"
+                        },
+                        "body": {
+                          "type": "string"
+                        }
+                      },
+                      "additionalProperties": false
+                    },
+                    "fail": {
+                      "type": "object",
+                      "properties": {
+                        "statusCode": {
+                          "type": "number"
+                        },
+                        "body": {
+                          "type": "string"
+                        }
+                      },
+                      "additionalProperties": false
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              ]
+            },
+            "liveness": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "endpoint": {
+                      "type": "string"
+                    },
+                    "success": {
+                      "type": "object",
+                      "properties": {
+                        "statusCode": {
+                          "type": "number"
+                        },
+                        "body": {
+                          "type": "string"
+                        }
+                      },
+                      "additionalProperties": false
+                    },
+                    "fail": {
+                      "type": "object",
+                      "properties": {
+                        "statusCode": {
+                          "type": "number"
+                        },
+                        "body": {
+                          "type": "string"
+                        }
+                      },
+                      "additionalProperties": false
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              ]
+            },
+            "additionalProperties": false
+          }
         }
       ]
     },