@platformatic/service 2.62.0 → 2.63.0

package/config.d.ts

@@ -64,6 +64,14 @@ export interface PlatformaticService {
               [k: string]: unknown;
             };
           };
+          formatters?: {
+            path: string;
+          };
+          timestamp?: "epochTime" | "unixTime" | "nullTime" | "isoTime";
+          redact?: {
+            paths: string[];
+            censor?: string;
+          };
           [k: string]: unknown;
         };
     loggerInstance?: {

package/lib/stackable.js

@@ -10,7 +10,7 @@ const { client, collectMetrics } = require('@platformatic/metrics')
 const httpMetrics = require('@platformatic/fastify-http-metrics')
 const { extractTypeScriptCompileOptionsFromConfig } = require('./compile')
 const { compile } = require('@platformatic/ts-compiler')
-const { deepmerge } = require('@platformatic/utils')
+const { deepmerge, buildPinoFormatters, buildPinoTimestamp } = require('@platformatic/utils')
 
 const kITC = Symbol.for('plt.runtime.itc')
 
@@ -56,7 +56,8 @@ class ServiceStackable {
       runtimeBasePath: this.runtimeConfig?.basePath ?? null,
       invalidateHttpCache: this.#invalidateHttpCache.bind(this),
       prometheus: { client, registry: this.metricsRegistry },
-      setCustomHealthCheck: this.setCustomHealthCheck.bind(this)
+      setCustomHealthCheck: this.setCustomHealthCheck.bind(this),
+      setCustomReadinessCheck: this.setCustomReadinessCheck.bind(this)
     })
   }
 
@@ -111,6 +112,7 @@ class ServiceStackable {
   async getConfig () {
     const config = Object.assign({}, this.configManager.current)
     config.server = Object.assign({}, config.server)
+
     const logger = config.server.loggerInstance
 
     if (logger) {
@@ -190,6 +192,17 @@ class ServiceStackable {
     return await this.customHealthCheck()
   }
 
+  setCustomReadinessCheck (fn) {
+    this.customReadinessCheck = fn
+  }
+
+  async getCustomReadinessCheck () {
+    if (!this.customReadinessCheck) {
+      return true
+    }
+    return await this.customReadinessCheck()
+  }
+
   // This method is not a part of Stackable interface because we need to register
   // fastify metrics before the server is started.
   async #collectMetrics () {
@@ -390,6 +403,13 @@ class ServiceStackable {
       pinoOptions.base = { pid: process.pid, hostname: hostname(), worker: this.context.worker.index }
     }
 
+    if (this.loggerConfig?.formatters) {
+      pinoOptions.formatters = buildPinoFormatters(this.loggerConfig?.formatters)
+    }
+    if (this.loggerConfig?.timestamp) {
+      pinoOptions.timestamp = buildPinoTimestamp(this.loggerConfig?.timestamp)
+    }
+
     this.logger = pino(pinoOptions)
 
     // Only one of logger and loggerInstance should be set

package/lib/utils.js

@@ -3,6 +3,7 @@
 const { access, readFile, stat } = require('node:fs/promises')
 const { resolve, join, relative, dirname, basename } = require('node:path')
 const { isatty } = require('tty')
+const { setPinoFormatters, setPinoTimestamp } = require('@platformatic/utils')
 
 async function isFileAccessible (filename, directory) {
   try {
@@ -16,27 +17,36 @@ async function isFileAccessible (filename, directory) {
 
 /* c8 ignore start */
 function addLoggerToTheConfig (config) {
+  if (config.server?.loggerInstance) {
+    return
+  }
+
   // We might have a config with no server
   if (!config.server) {
     config.server = {}
   }
-  // Set the logger if not present
-  if (!config.server.loggerInstance) {
-    let logger = config.server.logger
-    if (!logger) {
-      config.server.logger = { level: 'info' }
-      logger = config.server.logger
-    }
 
-    // If TTY use pino-pretty
-    if (isatty(1)) {
-      if (!logger.transport) {
-        logger.transport = {
-          target: 'pino-pretty',
-        }
+  let logger = config.server.logger
+  if (!logger) {
+    config.server.logger = { level: 'info' }
+    logger = config.server.logger
+  }
+
+  // If TTY use pino-pretty
+  if (isatty(1)) {
+    if (!logger.transport) {
+      logger.transport = {
+        target: 'pino-pretty',
       }
     }
   }
+
+  if (config.server.logger?.formatters) {
+    setPinoFormatters(config.server.logger)
+  }
+  if (config.server.logger?.timestamp) {
+    setPinoTimestamp(config.server.logger)
+  }
 }
 /* c8 ignore stop */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "2.62.0",
+  "version": "2.63.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "@fastify/aws-lambda": "^5.0.0",
     "@fastify/compress": "^8.0.0",
     "bindings": "^1.5.0",
-    "borp": "^0.19.0",
+    "borp": "^0.20.0",
     "eslint": "9",
     "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.12.0",
@@ -31,7 +31,7 @@
     "strip-ansi": "^7.1.0",
     "tsd": "^0.32.0",
     "typescript": "^5.5.4",
-    "undici": "7.4.0",
+    "undici": "7.8.0",
     "vscode-json-languageservice": "^5.3.9",
     "why-is-node-running": "^2.2.2",
     "yaml": "^2.4.1"
@@ -47,7 +47,7 @@
     "@fastify/swagger": "^9.0.0",
     "@fastify/under-pressure": "^9.0.0",
     "@platformatic/fastify-http-metrics": "^0.3.0",
-    "@scalar/fastify-api-reference": "1.28.23",
+    "@scalar/fastify-api-reference": "1.28.31",
     "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
     "cli-progress": "^3.12.0",
@@ -76,14 +76,14 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/config": "2.62.0",
-    "@platformatic/generators": "2.62.0",
-    "@platformatic/client": "2.62.0",
-    "@platformatic/metrics": "2.62.0",
-    "@platformatic/scalar-theme": "2.62.0",
-    "@platformatic/telemetry": "2.62.0",
-    "@platformatic/ts-compiler": "2.62.0",
-    "@platformatic/utils": "2.62.0"
+    "@platformatic/client": "2.63.0",
+    "@platformatic/config": "2.63.0",
+    "@platformatic/scalar-theme": "2.63.0",
+    "@platformatic/metrics": "2.63.0",
+    "@platformatic/generators": "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 -T --concurrency=1 --timeout=300000 && tsd",

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.62.0.json",
-  "version": "2.62.0",
+  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.63.0.json",
+  "version": "2.63.0",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {
@@ -180,6 +180,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": [