@platformatic/basic 3.0.0-alpha.1 → 3.0.0-alpha.3

package/lib/base.js

@@ -1,5 +1,5 @@
-import { client, collectMetrics } from '@platformatic/metrics'
-import { buildPinoOptions, deepmerge, executeWithTimeout, kMetadata, kTimeout } from '@platformatic/utils'
+import { buildPinoOptions, deepmerge, executeWithTimeout, kMetadata, kTimeout } from '@platformatic/foundation'
+import { client, collectMetrics, ensureMetricsGroup } from '@platformatic/metrics'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
 import EventEmitter, { once } from 'node:events'
@@ -42,7 +42,6 @@ export class BaseStackable extends EventEmitter {
     this.basePath = null
     this.isEntrypoint = this.context.isEntrypoint
     this.isProduction = this.context.isProduction
-    this.metricsRegistry = new client.Registry()
     this.#metricsCollected = false
     this.customHealthCheck = null
     this.customReadinessCheck = null
@@ -68,20 +67,26 @@ export class BaseStackable extends EventEmitter {
       setBasePath: this.setBasePath.bind(this),
       runtimeBasePath: this.runtimeConfig?.basePath ?? null,
       invalidateHttpCache: this.#invalidateHttpCache.bind(this),
-      prometheus: { client, registry: this.metricsRegistry },
       setCustomHealthCheck: this.setCustomHealthCheck.bind(this),
       setCustomReadinessCheck: this.setCustomReadinessCheck.bind(this),
       notifyConfig: this.notifyConfig.bind(this),
       logger: this.logger
     })
+
+    if (globalThis.platformatic.prometheus) {
+      this.metricsRegistry = globalThis.platformatic.prometheus.registry
+    } else {
+      this.metricsRegistry = new client.Registry()
+      this.registerGlobals({ prometheus: { client, registry: this.metricsRegistry } })
+    }
   }
 
   init () {
     return this.updateContext()
   }
 
-  updateContext (context) {
-    // No-op
+  updateContext (_context) {
+    // No-op by default
   }
 
   start () {
@@ -92,6 +97,10 @@ export class BaseStackable extends EventEmitter {
     throw new Error('BaseStackable.stop must be overriden by the subclasses')
   }
 
+  build () {
+    // No-op by default
+  }
+
   // Alias for stop
   close () {
     return this.stop()
@@ -295,6 +304,13 @@ export class BaseStackable extends EventEmitter {
       this.basePath = path
     })
 
+    // This is not really important for the URL but sometimes it also a sign
+    // that the process has been replaced and thus we need to update the client WebSocket
+    this.childManager.on('url', (url, clientWs) => {
+      this.url = url
+      this.clientWs = clientWs
+    })
+
     try {
       await this.childManager.inject()
       this.subprocess = await this.spawn(command)
@@ -461,7 +477,7 @@ export class BaseStackable extends EventEmitter {
     const { client, registry } = globalThis.platformatic.prometheus
 
     // Metrics already registered, no need to register them again
-    if (registry.getSingleMetric('http_cache_hit_count') || registry.getSingleMetric('http_cache_miss_count')) {
+    if (ensureMetricsGroup(registry, 'http.cache')) {
       return
     }
 
@@ -483,6 +499,66 @@ export class BaseStackable extends EventEmitter {
     globalThis.platformatic.onHttpCacheMiss = () => {
       cacheMissMetric.inc()
     }
+
+    const httpStatsFreeMetric = new client.Gauge({
+      name: 'http_client_stats_free',
+      help: 'Number of free (idle) http clients (sockets)',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsFree = (url, val) => {
+      httpStatsFreeMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsConnectedMetric = new client.Gauge({
+      name: 'http_client_stats_connected',
+      help: 'Number of open socket connections',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsConnected = (url, val) => {
+      httpStatsConnectedMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsPendingMetric = new client.Gauge({
+      name: 'http_client_stats_pending',
+      help: 'Number of pending requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsPending = (url, val) => {
+      httpStatsPendingMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsQueuedMetric = new client.Gauge({
+      name: 'http_client_stats_queued',
+      help: 'Number of queued requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsQueued = (url, val) => {
+      httpStatsQueuedMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsRunningMetric = new client.Gauge({
+      name: 'http_client_stats_running',
+      help: 'Number of currently active requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsRunning = (url, val) => {
+      httpStatsRunningMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsSizeMetric = new client.Gauge({
+      name: 'http_client_stats_size',
+      help: 'Number of active, pending, or queued requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsSize = (url, val) => {
+      httpStatsSizeMetric.set({ dispatcher_stats_url: url }, val)
+    }
   }
 
   async #invalidateHttpCache (opts = {}) {

package/lib/config.js

@@ -2,7 +2,7 @@ import {
   listRecognizedConfigurationFiles,
   NoConfigFileFoundError,
   findConfigurationFile as utilsFindConfigurationFile
-} from '@platformatic/utils'
+} from '@platformatic/foundation'
 import jsonPatch from 'fast-json-patch'
 import { stat } from 'node:fs/promises'
 import { dirname, resolve as resolvePath } from 'node:path'

package/lib/modules.js

@@ -1,4 +1,4 @@
-import { detectApplicationType, findConfigurationFile } from '@platformatic/utils'
+import { detectApplicationType, findConfigurationFile } from '@platformatic/foundation'
 import { readFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import { relative, resolve } from 'node:path'

package/lib/schema.js

@@ -1,12 +1,27 @@
-import { schemaComponents as utilsSchemaComponents } from '@platformatic/utils'
+import { schemaComponents as utilsSchemaComponents } from '@platformatic/foundation'
 import { readFileSync } from 'node:fs'
 
 export const packageJson = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf-8'))
 export const version = packageJson.version
 
+// This is used by applications to have common properties.
 const application = {
+  type: 'object',
+  properties: {},
+  additionalProperties: false,
+  required: [],
+  default: {}
+}
+
+/*
+  For legacy purposes, when an application is buildable (like Astro), it should use for the application properties.
+  Make sure this always extends the `application` schema above.
+*/
+
+const buildableApplication = {
   type: 'object',
   properties: {
+    ...application.properties,
     basePath: {
       type: 'string'
     },
@@ -45,7 +60,10 @@ const application = {
     }
   },
   additionalProperties: false,
-  default: {}
+  required: [...application.required],
+  default: {
+    ...application.default
+  }
 }
 
 const watch = {
@@ -60,7 +78,7 @@ const watch = {
   ]
 }
 
-export const schemaComponents = { application, watch }
+export const schemaComponents = { application, buildableApplication, watch }
 
 export const schema = {
   $id: `https://schemas.platformatic.dev/@platformatic/basic/${packageJson.version}.json`,

package/lib/worker/child-manager.js

@@ -1,5 +1,5 @@
+import { createDirectory, ensureLoggableError } from '@platformatic/foundation'
 import { ITC } from '@platformatic/itc'
-import { createDirectory, ensureLoggableError } from '@platformatic/utils'
 import { once } from 'node:events'
 import { rm, writeFile } from 'node:fs/promises'
 import { createServer } from 'node:http'
@@ -162,7 +162,7 @@ export class ChildManager extends ITC {
     const childProcessInclude = `--import="${new URL('./child-process.js', import.meta.url)}"`
 
     let telemetryInclude = ''
-    if (this.#context.telemetryConfig) {
+    if (this.#context.telemetryConfig && this.#context.telemetryConfig.enabled !== false) {
       const require = createRequire(import.meta.url)
       const telemetryPath = require.resolve('@platformatic/telemetry')
       const openTelemetrySetupPath = join(telemetryPath, '..', 'lib', 'node-telemetry.js')

package/lib/worker/child-process.js

@@ -1,12 +1,12 @@
-import { ITC } from '@platformatic/itc'
-import { client, collectMetrics } from '@platformatic/metrics'
 import {
   buildPinoFormatters,
   buildPinoTimestamp,
   disablePinoDirectWrite,
   ensureLoggableError,
   features
-} from '@platformatic/utils'
+} from '@platformatic/foundation'
+import { ITC } from '@platformatic/itc'
+import { client, collectMetrics } from '@platformatic/metrics'
 import diagnosticChannel, { tracingChannel } from 'node:diagnostics_channel'
 import { EventEmitter, once } from 'node:events'
 import { readFile } from 'node:fs/promises'
@@ -222,6 +222,66 @@ export class ChildProcess extends ITC {
     globalThis.platformatic.onHttpCacheMiss = () => {
       cacheMissMetric.inc()
     }
+
+    const httpStatsFreeMetric = new client.Gauge({
+      name: 'http_client_stats_free',
+      help: 'Number of free (idle) http clients (sockets)',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsFree = (url, val) => {
+      httpStatsFreeMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsConnectedMetric = new client.Gauge({
+      name: 'http_client_stats_connected',
+      help: 'Number of open socket connections',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsConnected = (url, val) => {
+      httpStatsConnectedMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsPendingMetric = new client.Gauge({
+      name: 'http_client_stats_pending',
+      help: 'Number of pending requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsPending = (url, val) => {
+      httpStatsPendingMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsQueuedMetric = new client.Gauge({
+      name: 'http_client_stats_queued',
+      help: 'Number of queued requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsQueued = (url, val) => {
+      httpStatsQueuedMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsRunningMetric = new client.Gauge({
+      name: 'http_client_stats_running',
+      help: 'Number of currently active requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsRunning = (url, val) => {
+      httpStatsRunningMetric.set({ dispatcher_stats_url: url }, val)
+    }
+
+    const httpStatsSizeMetric = new client.Gauge({
+      name: 'http_client_stats_size',
+      help: 'Number of active, pending, or queued requests across all clients',
+      labelNames: ['dispatcher_stats_url'],
+      registers: [registry]
+    })
+    globalThis.platformatic.onHttpStatsSize = (url, val) => {
+      httpStatsSizeMetric.set({ dispatcher_stats_url: url }, val)
+    }
   }
 
   async #getMetrics ({ format } = {}) {

package/lib/worker/child-transport.js

@@ -1,5 +1,5 @@
+import { ensureLoggableError } from '@platformatic/foundation'
 import { generateRequest, sanitize } from '@platformatic/itc'
-import { ensureLoggableError } from '@platformatic/utils'
 import { once } from 'node:events'
 import { platform } from 'node:os'
 import { workerData } from 'node:worker_threads'

package/lib/worker/listeners.js

@@ -1,4 +1,4 @@
-import { features } from '@platformatic/utils'
+import { features } from '@platformatic/foundation'
 import { subscribe, tracingChannel, unsubscribe } from 'node:diagnostics_channel'
 
 export function createServerListener (overridePort = true, overrideHost) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -19,16 +19,16 @@
     "@fastify/error": "^4.0.0",
     "execa": "^9.3.1",
     "fast-json-patch": "^3.1.1",
-    "pino": "^9.3.2",
+    "pino": "^9.9.0",
     "pino-abstract-transport": "^2.0.0",
     "semver": "^7.6.3",
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/itc": "3.0.0-alpha.1",
-    "@platformatic/metrics": "3.0.0-alpha.1",
-    "@platformatic/telemetry": "3.0.0-alpha.1",
-    "@platformatic/utils": "3.0.0-alpha.1"
+    "@platformatic/itc": "3.0.0-alpha.3",
+    "@platformatic/telemetry": "3.0.0-alpha.3",
+    "@platformatic/metrics": "3.0.0-alpha.3",
+    "@platformatic/foundation": "3.0.0-alpha.3"
   },
   "devDependencies": {
     "borp": "^0.20.0",
@@ -40,6 +40,9 @@
     "neostandard": "^0.12.0",
     "typescript": "^5.5.4"
   },
+  "engines": {
+    "node": ">=22.18.0"
+  },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout 1200000",
     "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout 1200000",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.0.0-alpha.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.0.0-alpha.3.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Basic Config",
   "type": "object",