@platformatic/service 1.26.0 → 1.28.0

package/config.d.ts

@@ -144,6 +144,12 @@ export interface PlatformaticService {
     | {
         port?: number | string;
         hostname?: string;
+        endpoint?: string;
+        server?: "own" | "parent";
+        defaultMetrics?: {
+          enabled: boolean;
+        };
+        prefix?: string;
         auth?: {
           username: string;
           password: string;

package/index.d.ts

@@ -28,7 +28,7 @@ declare module 'fastify' {
   }
 }
 
-export interface ConfigManagerConfig<T> extends Omit<IConfigManagerOptions, 'source' | 'watch' | 'schema'> {
+export interface ConfigManagerConfig<T> extends Omit<IConfigManagerOptions, 'source' | 'watch' | 'schema' | 'configVersion'> {
   transformConfig: (this: ConfigManager<T>) => Promise<void>
   schema: object
 }
@@ -40,6 +40,9 @@ export interface Stackable<ConfigType> {
   configManagerConfig: ConfigManagerConfig<ConfigType>
   schema: object
   Generator?: new () => BaseGenerator.BaseGenerator
+
+  version?: string
+  upgrade?: (config: any, version: string) => Promise<any>
 }
 
 interface SchemaExport {

package/index.js

@@ -14,6 +14,7 @@ const setupTsCompiler = require('./lib/plugins/typescript')
 const setupHealthCheck = require('./lib/plugins/health-check')
 const loadPlugins = require('./lib/plugins/plugins')
 const loadVersions = require('./lib/plugins/versions')
+const upgrade = require('./lib/upgrade')
 const { telemetry } = require('@platformatic/telemetry')
 
 const { schema } = require('./lib/schema')
@@ -21,6 +22,8 @@ const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
 const ServiceGenerator = require('./lib/generator/service-generator.js')
 
+const { version } = require('./package.json')
+
 // TODO(mcollina): arugments[2] is deprecated, remove it in the next major version.
 async function platformaticService (app, opts) {
   const configManager = app.platformatic.configManager
@@ -42,6 +45,12 @@ async function platformaticService (app, opts) {
     await app.register(telemetry, config.telemetry)
   }
 
+  // This must be done before loading the plugins, so they can be
+  // configured accordingly
+  if (isKeyEnabled('clients', config)) {
+    app.register(setupClients, config.clients)
+  }
+
   if (Array.isArray(beforePlugins)) {
     for (const plugin of beforePlugins) {
       app.register(plugin)
@@ -83,10 +92,6 @@ async function platformaticService (app, opts) {
     }
   })
 
-  if (isKeyEnabled('clients', config)) {
-    app.register(setupClients, config.clients)
-  }
-
   if (isKeyEnabled('cors', config.server)) {
     app.register(setupCors, config.server.cors)
   }
@@ -100,6 +105,7 @@ platformaticService[Symbol.for('skip-override')] = true
 platformaticService.schema = schema
 platformaticService.configType = 'service'
 platformaticService.configManagerConfig = {
+  version,
   schema,
   envWhitelist: ['PORT', 'HOSTNAME'],
   allowToWatch: ['.env'],
@@ -136,7 +142,8 @@ platformaticService.configManagerConfig = {
       this.current.watch.ignore ||= []
       this.current.watch.ignore.push(outDir + '/**/*')
     }
-  }
+  },
+  upgrade
 }
 
 function _buildServer (options, app) {

package/index.test-d.ts

@@ -1,4 +1,4 @@
-import { expectType } from 'tsd'
+import { expectType, expectError } from 'tsd'
 import { FastifyInstance } from 'fastify'
 import ConfigManager from '@platformatic/config'
 import { OpenAPI } from 'openapi-types'
@@ -39,6 +39,7 @@ function buildStackable (): Stackable<PlatformaticServiceConfig> {
   myApp.schema = platformaticService.configManagerConfig.schema
   myApp.configType = 'myApp'
   myApp.configManagerConfig = {
+    version: platformaticService.configManagerConfig.version,
     ...platformaticService.configManagerConfig,
     async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
       this.current.plugins = {
@@ -46,9 +47,19 @@ function buildStackable (): Stackable<PlatformaticServiceConfig> {
           path: 'my-plugin'
         }]
       }
+    },
+    async upgrade (config: PlatformaticServiceConfig, version: string) {
+      const upgrade = platformaticService.configManagerConfig.upgrade
+      if (typeof upgrade === 'function') {
+        return upgrade.call(this, config, version)
+      }
+      return config
     }
   }
 
+  // configVersion is not part of ConfigManagerConfig
+  expectError(myApp.configManagerConfig.configVersion)
+
   await start(myApp, ['--help'])
 
   return myApp
@@ -64,3 +75,28 @@ const myGenerator = new MyGenerator()
 
 expectType<MyGenerator>(myGenerator)
 expectType<BaseGenerator.BaseGeneratorConfig>(myGenerator.config)
+
+function buildStackable2 (): Stackable<PlatformaticServiceConfig> {
+  async function myApp (app: FastifyInstance, opts: object): Promise<void> {
+    await platformaticService(app, opts)
+  }
+
+  myApp.schema = platformaticService.configManagerConfig.schema
+  myApp.configType = 'myApp'
+  myApp.configManagerConfig = {
+    ...platformaticService.configManagerConfig,
+    async transformConfig (this: ConfigManager<PlatformaticServiceConfig>) {
+      this.current.plugins = {
+        paths: [{
+          path: 'my-plugin'
+        }]
+      }
+    }
+  }
+
+  await start(myApp, ['--help'])
+
+  return myApp
+}
+
+expectType<Stackable<PlatformaticServiceConfig>>(buildStackable2())

package/lib/bump-version.js

@@ -4,8 +4,7 @@ const { join, relative } = require('node:path')
 const { mkdir, readFile, writeFile } = require('node:fs/promises')
 const pino = require('pino')
 const pretty = require('pino-pretty')
-const { loadConfig } = require('@platformatic/config')
-const { analyze, write: writeConfig } = require('@platformatic/metaconfig')
+const { loadConfig, getParser, getStringifier } = require('@platformatic/config')
 const { platformaticService } = require('../index.js')
 const { getOpenapiSchema } = require('./get-openapi-schema.js')
 const { createMappersPlugins } = require('./update-version.js')
@@ -23,8 +22,9 @@ async function execute ({
 }) {
   const config = configManager.current
 
-  const metaConfig = await analyze({ file: configManager.fullPath })
-  const rawConfig = metaConfig.config
+  const parse = getParser(configManager.fullPath)
+  const stringify = getStringifier(configManager.fullPath)
+  const rawConfig = parse(await readFile(configManager.fullPath, 'utf8'))
 
   const versionsDirName = 'versions'
   const versionsDirPath = config.versions?.dir ??
@@ -102,7 +102,7 @@ async function execute ({
   config.versions = versionsConfigs
   rawConfig.versions = rawVersionsConfigs
 
-  await Promise.all([configManager.update(), writeConfig(metaConfig)])
+  await Promise.all([configManager.update(), writeFile(configManager.fullPath, stringify(rawConfig))])
 
   if (latestVersionConfig) {
     logger.info(`Reading openapi schema for "${latestVersion}"`)

package/lib/plugins/metrics.js

@@ -1,40 +1,120 @@
 'use strict'
 
+const os = require('node:os')
 const http = require('node:http')
 const { eventLoopUtilization } = require('node:perf_hooks').performance
 const fastify = require('fastify')
 const fp = require('fastify-plugin')
 
-const metricsPlugin = fp(async function (app) {
+const metricsPlugin = fp(async function (app, opts = {}) {
+  const defaultMetrics = opts.defaultMetrics ?? { enabled: true }
+  const prefix = opts.prefix ?? ''
+
   app.register(require('fastify-metrics'), {
-    defaultMetrics: { enabled: true },
+    defaultMetrics: defaultMetrics || { enabled: true },
     endpoint: null,
     name: 'metrics',
-    routeMetrics: { enabled: true },
-    clearRegisterOnInit: true
+    clearRegisterOnInit: false,
+    routeMetrics: {
+      enabled: true,
+      overrides: {
+        histogram: {
+          name: prefix + 'http_request_duration_seconds'
+        },
+        summary: {
+          name: prefix + 'http_request_summary_seconds'
+        }
+      }
+    }
   })
 
-  app.register(async (app) => {
-    const eluMetric = new app.metrics.client.Summary({
-      name: 'nodejs_eventloop_utilization',
-      help: 'The event loop utilization as a fraction of the loop time. 1 is fully utilized, 0 is fully idle.',
-      maxAgeSeconds: 60,
-      ageBuckets: 5,
-      labelNames: ['idle', 'active', 'utilization']
+  app.register(fp(async (app) => {
+    const httpLatencyMetric = new app.metrics.client.Summary({
+      name: prefix + 'http_request_all_summary_seconds',
+      help: 'request duration in seconds summary for all requests',
+      collect: () => {
+        process.nextTick(() => httpLatencyMetric.reset())
+      }
     })
-
-    let startELU = eventLoopUtilization()
-    const eluTimeout = setInterval(() => {
-      const endELU = eventLoopUtilization()
-      eluMetric.observe(eventLoopUtilization(endELU, startELU).utilization)
-      startELU = endELU
-    }, 100)
-
-    app.addHook('onClose', () => {
-      clearInterval(eluTimeout)
+    const ignoredMethods = ['HEAD', 'OPTIONS', 'TRACE', 'CONNECT']
+    const timers = new WeakMap()
+    app.addHook('onRequest', async (req) => {
+      if (ignoredMethods.includes(req.method)) return
+      const timer = httpLatencyMetric.startTimer()
+      timers.set(req, timer)
+    })
+    app.addHook('onResponse', async (req) => {
+      if (ignoredMethods.includes(req.method)) return
+      const timer = timers.get(req)
+      if (timer) {
+        timer()
+        timers.delete(req)
+      }
     })
+  }, {
+    encapsulate: false
+  }))
+
+  if (defaultMetrics.enabled) {
+    app.register(async (app) => {
+      let startELU = eventLoopUtilization()
+      const eluMetric = new app.metrics.client.Gauge({
+        name: 'nodejs_eventloop_utilization',
+        help: 'The event loop utilization as a fraction of the loop time. 1 is fully utilized, 0 is fully idle.',
+        collect: () => {
+          const endELU = eventLoopUtilization()
+          const result = eventLoopUtilization(endELU, startELU).utilization
+          eluMetric.set(result)
+          startELU = endELU
+        }
+      })
+      app.metrics.client.register.registerMetric(eluMetric)
+
+      let previousIdleTime = 0
+      let previousTotalTime = 0
+      const cpuMetric = new app.metrics.client.Gauge({
+        name: 'process_cpu_percent_usage',
+        help: 'The process CPU percent usage.',
+        collect: () => {
+          const cpus = os.cpus()
+          let idleTime = 0
+          let totalTime = 0
+
+          cpus.forEach(cpu => {
+            for (const type in cpu.times) {
+              totalTime += cpu.times[type]
+              if (type === 'idle') {
+                idleTime += cpu.times[type]
+              }
+            }
+          })
+
+          const idleDiff = idleTime - previousIdleTime
+          const totalDiff = totalTime - previousTotalTime
+
+          const usagePercent = 100 - ((100 * idleDiff) / totalDiff)
+          const roundedUsage = Math.round(usagePercent * 100) / 100
+          cpuMetric.set(roundedUsage)
+
+          previousIdleTime = idleTime
+          previousTotalTime = totalTime
+        }
+      })
+      app.metrics.client.register.registerMetric(cpuMetric)
+    })
+  }
 
-    app.metrics.client.register.registerMetric(eluMetric)
+  let isRestarting = false
+  app.addHook('onReady', async () => {
+    app.addPreRestartHook(async () => {
+      isRestarting = true
+      app.metrics.client.register.clear()
+    })
+  })
+  app.addHook('onClose', async () => {
+    if (!isRestarting) {
+      app.metrics.client.register.clear()
+    }
   })
 }, {
   encapsulate: false
@@ -88,7 +168,7 @@ module.exports = fp(async function (app, opts) {
   const metricsEndpoint = opts.endpoint ?? '/metrics'
   const auth = opts.auth ?? null
 
-  app.register(metricsPlugin)
+  app.register(metricsPlugin, opts)
 
   let metricsServer = app
   if (server === 'own') {

package/lib/schema.js

@@ -560,6 +560,15 @@ const metrics = {
           type: 'string',
           enum: ['own', 'parent']
         },
+        defaultMetrics: {
+          type: 'object',
+          properties: {
+            enabled: { type: 'boolean' }
+          },
+          required: ['enabled'],
+          additionalProperties: false
+        },
+        prefix: { type: 'string' },
         auth: {
           type: 'object',
           properties: {
@@ -747,6 +756,7 @@ const versions = {
 
 const platformaticServiceSchema = {
   $id: `https://platformatic.dev/schemas/v${pkg.version}/service`,
+  version: pkg.version,
   title: 'Platformatic Service',
   type: 'object',
   properties: {

package/lib/update-version.js

@@ -10,8 +10,7 @@ const { request } = require('undici')
 const { green } = require('colorette')
 const compareOpenApiSchemas = require('openapi-schema-diff')
 const { default: CodeBlockWriter } = require('code-block-writer')
-const { loadConfig } = require('@platformatic/config')
-const { analyze, write: writeConfig } = require('@platformatic/metaconfig')
+const { loadConfig, getParser, getStringifier } = require('@platformatic/config')
 const { getOpenapiSchema } = require('./get-openapi-schema.js')
 const { platformaticService } = require('../index.js')
 const {
@@ -744,8 +743,10 @@ async function addMappersToConfig (mappersDir, version, configManager) {
     if (mappersDir.startsWith(foundPluginPath)) return
   }
 
-  const metaConfig = await analyze({ file: configManager.fullPath })
-  const rawConfig = metaConfig.config
+  // TODO(mcollina) this must auto-upgrade
+  const parse = getParser(configManager.fullPath)
+  const stringify = getStringifier(configManager.fullPath)
+  const rawConfig = parse(await readFile(configManager.fullPath, 'utf8'))
   const rawPrevVersionConfig = rawConfig.versions.configs.find(c => c.version === version)
 
   const relativePath = relative(configManager.dirname, mappersDir)
@@ -755,7 +756,7 @@ async function addMappersToConfig (mappersDir, version, configManager) {
   }
   prevVersionConfig.plugins.paths.push(relativePath)
   rawPrevVersionConfig.plugins.paths.push(relativePath)
-  await Promise.all([configManager.update(), writeConfig(metaConfig)])
+  await Promise.all([configManager.update(), writeFile(configManager.fullPath, stringify(rawConfig), 'utf8')])
 }
 
 async function execute ({
@@ -854,7 +855,7 @@ async function updateVersion (_args) {
     // TODO: find out why process stucks sometimes
     process.exit(0)
   } catch (err) {
-    logger.error(err.message)
+    logger.error({ err })
     process.exit(1)
   }
 }

package/lib/upgrade.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const { join } = require('path')
+const pkg = require('../package.json')
+
+module.exports = async function upgrade (config, version) {
+  const { semgrator } = await import('semgrator')
+
+  const iterator = semgrator({
+    version,
+    path: join(__dirname, 'versions'),
+    input: config,
+    logger: this.logger.child({ name: '@platformatic/service' })
+  })
+
+  let result
+
+  for await (const updated of iterator) {
+    result = updated.result
+  }
+
+  result.$schema = `https://platformatic.dev/schemas/v${pkg.version}/service`
+
+  return result
+}

package/lib/versions/0.16.0.js

@@ -0,0 +1,82 @@
+'use strict'
+
+module.exports = {
+  version: '0.16.0',
+  toVersion: '0.17.0',
+  up: function (config) {
+    let kind = 'service'
+    // This file will be reused in platformatic/db
+    if (config.core) {
+      kind = 'db'
+    }
+
+    if (config.plugin) {
+      if (Array.isArray(config.plugin)) {
+        config.plugins = {
+          paths: config.plugin.map((p) => {
+            if (typeof p === 'string') {
+              return p
+            } else if (p.options) {
+              return {
+                path: p.path,
+                options: p.options
+              }
+            } else {
+              return p.path
+            }
+          })
+        }
+
+        if (typeof config.plugin[0] === 'object') {
+          if ('hotReload' in config.plugin[0]) {
+            config.plugins.hotReload = config.plugin[0].hotReload
+          }
+          if ('stopTimeout' in config.plugin[0]) {
+            config.plugins.stopTimeout = config.plugin[0].stopTimeout
+          }
+          if ('typescript' in config.plugin[0]) {
+            config.plugins.typescript = !!config.plugin[0].typescript
+          }
+        }
+      } else if (typeof config.plugin === 'object') {
+        if (config.plugin.options) {
+          config.plugins = {
+            paths: [{
+              path: config.plugin.path,
+              options: config.plugin.options
+            }]
+          }
+        } else {
+          config.plugins = {
+            paths: [config.plugin.path]
+          }
+        }
+
+        if ('hotReload' in config.plugin) {
+          config.plugins.hotReload = config.plugin.hotReload
+        }
+
+        if ('stopTimeout' in config.plugin) {
+          config.plugins.stopTimeout = config.plugin.stopTimeout
+        }
+
+        if ('typescript' in config.plugin) {
+          // typescript is a boolean in 0.17.0
+          config.plugins.typescript = !!config.plugin.typescript
+        }
+      } else {
+        config.plugins = {
+          paths: [config.plugin]
+        }
+      }
+
+      delete config.plugin
+    }
+
+    // TODO missing watch mode and other options
+
+    config.$schema = 'https://platformatic.dev/schemas/v0.17.0/' + kind
+
+    return config
+  }
+}

package/lib/versions/from-zero-twenty-eight-to-will-see.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const { version } = require('../../package.json')
+
+module.exports.migration = {
+  version: '0.28.0',
+  toVersion: version,
+  up: function (config) {
+    if (config.watch !== false) {
+      config.watch = typeof config.watch === 'object' ? config.watch : {}
+    }
+    delete config.plugins?.hotReload
+
+    return config
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.26.0",
+  "version": "1.28.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "@fastify/aws-lambda": "^4.0.0",
     "@fastify/compress": "^7.0.0",
     "bindings": "^1.5.0",
-    "borp": "^0.9.0",
+    "borp": "^0.10.0",
     "json-schema-to-typescript": "^13.1.2",
     "openapi-types": "^12.1.3",
     "pino-abstract-transport": "^1.1.0",
@@ -30,31 +30,31 @@
     "standard": "^17.1.0",
     "strip-ansi": "^7.1.0",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.30.4",
-    "typescript": "^5.3.3",
+    "tsd": "^0.30.7",
+    "typescript": "^5.4.2",
     "undici": "^6.0.0",
     "vscode-json-languageservice": "^5.3.9",
     "why-is-node-running": "^2.2.2",
-    "yaml": "^2.3.4"
+    "yaml": "^2.4.1"
   },
   "dependencies": {
     "@fastify/accepts": "^4.3.0",
     "@fastify/autoload": "^5.8.0",
     "@fastify/basic-auth": "^5.1.1",
-    "@fastify/cors": "^9.0.0",
+    "@fastify/cors": "^9.0.1",
     "@fastify/deepmerge": "^1.3.0",
     "@fastify/error": "^3.4.1",
     "@fastify/restartable": "^2.2.0",
-    "@fastify/static": "^7.0.0",
+    "@fastify/static": "^7.0.1",
     "@fastify/swagger": "^8.14.0",
     "@fastify/under-pressure": "^8.3.0",
     "@mercuriusjs/federation": "^2.0.0",
-    "@scalar/fastify-api-reference": "^1.13.18",
+    "@scalar/fastify-api-reference": "^1.19.5",
     "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
     "cli-progress": "^3.12.0",
-    "close-with-grace": "^1.2.0",
-    "code-block-writer": "^13.0.0",
+    "close-with-grace": "^1.3.0",
+    "code-block-writer": "^13.0.1",
     "colorette": "^2.0.20",
     "commist": "^3.2.0",
     "console-table-printer": "^2.12.0",
@@ -62,29 +62,29 @@
     "env-schema": "^5.2.1",
     "es-main": "^1.3.0",
     "execa": "^8.0.1",
-    "fastify": "^4.26.0",
-    "fastify-metrics": "^10.6.0",
+    "fastify": "^4.26.2",
+    "fastify-metrics": "^11.0.0",
     "fastify-openapi-glue": "^4.4.3",
     "fastify-plugin": "^4.5.1",
     "graphql": "^16.8.1",
     "help-me": "^5.0.0",
-    "mercurius": "^13.3.3",
+    "mercurius": "^13.4.0",
     "minimist": "^1.2.8",
     "openapi-schema-diff": "^0.0.1",
     "ora": "^6.3.1",
-    "pino": "^8.17.2",
+    "pino": "^8.19.0",
     "pino-pretty": "^10.3.1",
     "rfdc": "^1.3.1",
+    "semgrator": "^0.3.0",
     "ua-parser-js": "^1.0.37",
-    "undici": "^6.6.0",
-    "@platformatic/authenticate": "1.26.0",
-    "@platformatic/config": "1.26.0",
-    "@platformatic/generators": "1.26.0",
-    "@platformatic/client": "1.26.0",
-    "@platformatic/metaconfig": "1.26.0",
-    "@platformatic/telemetry": "1.26.0",
-    "@platformatic/scalar-theme": "1.26.0",
-    "@platformatic/utils": "1.26.0"
+    "undici": "^6.9.0",
+    "@platformatic/authenticate": "1.28.0",
+    "@platformatic/config": "1.28.0",
+    "@platformatic/generators": "1.28.0",
+    "@platformatic/client": "1.28.0",
+    "@platformatic/scalar-theme": "1.28.0",
+    "@platformatic/telemetry": "1.28.0",
+    "@platformatic/utils": "1.28.0"
   },
   "standard": {
     "ignore": [
@@ -101,7 +101,9 @@
   "scripts": {
     "test": "pnpm run lint && borp -T --concurrency=1 --timeout 120000 && tsd",
     "unit": "borp --pattern 'test/**/*.test.{js,mjs}' --ignore 'fixtures/**/*' --concurrency=1 --timeout=120000 --no-typescript",
-    "build": "node lib/schema.js | json2ts > config.d.ts",
+    "gen-schema": "node lib/schema.js > schema.json",
+    "gen-types": "json2ts > config.d.ts < schema.json",
+    "build": "pnpm run gen-schema && pnpm run gen-types",
     "lint": "standard | snazzy && ts-standard | snazzy && tsd"
   }
 }