@platformatic/service 2.0.0-alpha.2 → 2.0.0-alpha.3

package/lib/stackable.js

@@ -0,0 +1,210 @@
+'use strict'
+
+const { dirname } = require('node:path')
+const { printSchema } = require('graphql')
+const pino = require('pino')
+
+class ServiceStackable {
+  constructor (options) {
+    this.app = null
+    this._init = options.init
+    this.stackable = options.stackable
+
+    this.configManager = options.configManager
+    this.config = this.configManager.current
+    this.context = options.context
+
+    this.#updateConfig()
+  }
+
+  async init () {
+    this.#initLogger()
+
+    if (this.app === null) {
+      this.app = await this._init()
+    }
+    return this.app
+  }
+
+  async start (options = {}) {
+    await this.init()
+
+    if (options.listen === false) {
+      await this.app.ready()
+      return
+    }
+    await this.app.start()
+  }
+
+  async stop () {
+    if (this.app === null) return
+    await this.app.close()
+  }
+
+  getUrl () {
+    return this.app !== null ? this.app.url : null
+  }
+
+  async getInfo () {
+    const type = this.stackable.configType
+    const version = this.stackable.configManagerConfig.version ?? null
+    return { type, version }
+  }
+
+  async getConfig () {
+    const config = this.configManager.current
+    const logger = config.server.logger
+
+    if (logger) {
+      config.server.logger = {}
+
+      if (logger.level) {
+        config.server.logger.level = logger.level
+      }
+    }
+
+    return config
+  }
+
+  async getWatchConfig () {
+    const config = this.configManager.current
+
+    const enabled =
+      config.watch?.enabled !== false &&
+      config.plugins !== undefined
+
+    return {
+      enabled,
+      path: dirname(this.configManager.fullPath),
+      allow: config.watch?.allow,
+      ignore: config.watch?.ignore,
+    }
+  }
+
+  async getDispatchFunc () {
+    await this.init()
+    return this.app
+  }
+
+  async getOpenapiSchema () {
+    await this.init()
+    await this.app.ready()
+    return this.app.swagger ? this.app.swagger() : null
+  }
+
+  async getGraphqlSchema () {
+    await this.init()
+    await this.app.ready()
+    return this.app.graphql ? printSchema(this.app.graphql.schema) : null
+  }
+
+  async getMetrics ({ format }) {
+    await this.init()
+
+    const promRegister = this.app.metrics?.client?.register
+    if (!promRegister) return null
+
+    return format === 'json'
+      ? promRegister.getMetricsAsJSON()
+      : promRegister.metrics()
+  }
+
+  async inject (injectParams) {
+    await this.init()
+
+    const { statusCode, statusMessage, headers, body } = await this.app.inject(injectParams)
+    return { statusCode, statusMessage, headers, body }
+  }
+
+  async log (options = {}) {
+    await this.init()
+
+    const logLevel = options.level ?? 'info'
+
+    const message = options.message
+    if (!message) return
+
+    this.app.log[logLevel](message)
+  }
+
+  async updateContext (context) {
+    this.context = { ...this.context, ...context }
+    this.#updateConfig()
+  }
+
+  #updateConfig () {
+    if (!this.context) return
+
+    const {
+      serviceId,
+      telemetryConfig,
+      metricsConfig,
+      serverConfig,
+      hasManagementApi,
+      isEntrypoint,
+    } = this.context
+
+    const configManager = this.configManager
+
+    configManager.on('error', (err) => {
+      /* c8 ignore next */
+      this.stackable.log({ message: 'error reloading the configuration' + err, level: 'error' })
+    })
+
+    configManager.update({
+      ...configManager.current,
+      telemetry: telemetryConfig,
+      metrics: metricsConfig,
+    })
+
+    if (this.context.serverConfig) {
+      configManager.update({
+        ...configManager.current,
+        server: serverConfig,
+      })
+    }
+
+    if (
+      (hasManagementApi && configManager.current.metrics === undefined) ||
+      configManager.current.metrics
+    ) {
+      const labels = configManager.current.metrics?.labels || {}
+      configManager.update({
+        ...configManager.current,
+        metrics: {
+          server: 'hide',
+          defaultMetrics: { enabled: isEntrypoint },
+          ...configManager.current.metrics,
+          labels: { serviceId, ...labels },
+        },
+      })
+    }
+
+    if (!isEntrypoint) {
+      configManager.update({
+        ...configManager.current,
+        server: {
+          ...(configManager.current.server || {}),
+          trustProxy: true,
+        },
+      })
+    }
+  }
+
+  #initLogger () {
+    this.configManager.current.server = this.configManager.current.server || {}
+    const level = this.configManager.current.server.logger?.level
+
+    const pinoOptions = {
+      level: level ?? 'trace',
+    }
+
+    if (this.context?.serviceId) {
+      pinoOptions.name = this.context.serviceId
+    }
+
+    this.configManager.current.server.logger = pino(pinoOptions)
+  }
+}
+
+module.exports = { ServiceStackable }

package/lib/start.js

@@ -4,8 +4,8 @@ const { readFile } = require('fs/promises')
 const close = require('close-with-grace')
 const { loadConfig, ConfigManager, printConfigValidationErrors, printAndExitLoadConfigError } = require('@platformatic/config')
 const { addLoggerToTheConfig, isDocker } = require('./utils.js')
-const { restartable } = require('@fastify/restartable')
 const { randomUUID } = require('crypto')
+const { fastify } = require('fastify')
 
 async function adjustHttpsKeyAndCert (arg) {
   if (typeof arg === 'string') {
@@ -25,14 +25,48 @@ async function adjustHttpsKeyAndCert (arg) {
   return arg
 }
 
-async function buildServer (options, app) {
+async function createServer (context) {
+  const { app, configManager } = context
+  const config = configManager.current
+  let fastifyOptions = {}
+
+  if (config.server) {
+    // override hostname if it's docker
+    if (await isDocker()) {
+      config.server.hostname = '0.0.0.0'
+    }
+    fastifyOptions = {
+      ...config.server,
+    }
+  }
+  fastifyOptions.genReqId = function (req) { return randomUUID() }
+  const root = fastify(fastifyOptions)
+  root.decorate('platformatic', { configManager, config })
+  await root.register(app)
+  if (!root.hasRoute({ url: '/', method: 'GET' })) {
+    await root.register(require('./root-endpoint'))
+  }
+
+  root.decorate('url', {
+    getter () {
+      return context.url
+    },
+  })
+
+  return root
+}
+async function buildConfigManager (options, app) {
   let configManager = options.configManager
   if (!configManager) {
     // instantiate a new config manager from current options
     configManager = new ConfigManager({ ...app.configManagerConfig, source: options })
     await configManager.parseAndValidate()
   }
+  return configManager
+}
 
+async function buildServer (options, app) {
+  const configManager = await buildConfigManager(options, app)
   const config = configManager.current
 
   // The server now can be not present, so we might need to add logger
@@ -43,52 +77,24 @@ async function buildServer (options, app) {
     options = config
   }
 
-  let url = null
-
-  async function createRestartable (fastify) {
-    const config = configManager.current
-    let fastifyOptions = {}
-
-    if (config.server) {
-      // override hostname if it's docker
-      if (await isDocker()) {
-        config.server.hostname = '0.0.0.0'
-      }
-      fastifyOptions = {
-        ...config.server
-      }
-    }
-    fastifyOptions.genReqId = function (req) { return randomUUID() }
-    const root = fastify(fastifyOptions)
-    root.decorate('platformatic', { configManager, config })
-    await root.register(app)
-    if (!root.hasRoute({ url: '/', method: 'GET' })) {
-      await root.register(require('./root-endpoint'))
-    }
-
-    root.decorate('url', {
-      getter () {
-        return url
-      }
-    })
-
-    if (root.restarted) {
-      root.log.info('restarted')
-    }
-
-    return root
-  }
-
   if (options.server) {
     if (options.server.https) {
       options.server.https.key = await adjustHttpsKeyAndCert(options.server.https.key)
       options.server.https.cert = await adjustHttpsKeyAndCert(options.server.https.cert)
     }
   }
-  const handler = await restartable(createRestartable)
+
+  const context = {
+    app: typeof app === 'function' ? app : app.app,
+    configManager,
+  }
+  const handler = await createServer(context)
   handler.decorate('start', async () => {
-    url = await handler.listen({ host: options.server?.hostname || '127.0.0.1', port: options.server?.port || 0 })
-    return url
+    context.url = await handler.listen({
+      host: options.server?.hostname || '127.0.0.1',
+      port: options.server?.port || 0,
+    })
+    return context.url
   })
   configManager.on('error', function (err) {
     /* c8 ignore next 1 */
@@ -98,20 +104,6 @@ async function buildServer (options, app) {
   return handler
 }
 
-/* c8 ignore next 12 */
-async function safeRestart (app) {
-  try {
-    await app.restart()
-  } catch (err) {
-    app.log.error({
-      err: {
-        message: err.message,
-        stack: err.stack
-      }
-    }, 'failed to reload server')
-  }
-}
-
 async function start (appType, _args) {
   /* c8 ignore next 55 */
   let configManager = null
@@ -145,22 +137,14 @@ async function start (appType, _args) {
     printAndExitLoadConfigError(err)
   }
 
-  // Ignore from CI because SIGUSR2 is not available
-  // on Windows
-  process.on('SIGUSR2', function () {
-    app.log.info('reloading configuration')
-    safeRestart(app)
-    return false
-  })
-
   close(async ({ signal, err }) => {
     // Windows does not support trapping signals
     if (err) {
       app.log.error({
         err: {
           message: err.message,
-          stack: err.stack
-        }
+          stack: err.stack,
+        },
       }, 'exiting')
     } else if (signal) {
       app.log.info({ signal }, 'received signal')
@@ -172,5 +156,6 @@ async function start (appType, _args) {
   })
 }
 
+module.exports.buildConfigManager = buildConfigManager
 module.exports.buildServer = buildServer
 module.exports.start = start

package/lib/upgrade.js

@@ -10,7 +10,7 @@ module.exports = async function upgrade (config, version) {
     version,
     path: join(__dirname, 'versions'),
     input: config,
-    logger: this.logger.child({ name: '@platformatic/service' })
+    logger: this.logger.child({ name: '@platformatic/service' }),
   })
 
   let result
@@ -19,7 +19,7 @@ module.exports = async function upgrade (config, version) {
     result = updated.result
   }
 
-  result.$schema = `https://platformatic.dev/schemas/v${pkg.version}/service`
+  result.$schema = `https://schemas.platformatic.dev/@platformatic/service/${pkg.version}.json`
 
   return result
 }

package/lib/utils.js

@@ -31,7 +31,7 @@ function addLoggerToTheConfig (config) {
   if (isatty(1)) {
     if (!logger.transport) {
       logger.transport = {
-        target: 'pino-pretty'
+        target: 'pino-pretty',
       }
     }
   }
@@ -101,5 +101,5 @@ module.exports = {
   isDocker,
   isFileAccessible,
   getJSPluginPath,
-  addLoggerToTheConfig
+  addLoggerToTheConfig,
 }

package/lib/versions/0.16.0.js

@@ -19,12 +19,12 @@ module.exports = {
             } else if (p.options) {
               return {
                 path: p.path,
-                options: p.options
+                options: p.options,
               }
             } else {
               return p.path
             }
-          })
+          }),
         }
 
         if (typeof config.plugin[0] === 'object') {
@@ -43,12 +43,12 @@ module.exports = {
           config.plugins = {
             paths: [{
               path: config.plugin.path,
-              options: config.plugin.options
-            }]
+              options: config.plugin.options,
+            }],
           }
         } else {
           config.plugins = {
-            paths: [config.plugin.path]
+            paths: [config.plugin.path],
           }
         }
 
@@ -66,7 +66,7 @@ module.exports = {
         }
       } else {
         config.plugins = {
-          paths: [config.plugin]
+          paths: [config.plugin],
         }
       }
 
@@ -78,5 +78,5 @@ module.exports = {
     config.$schema = 'https://platformatic.dev/schemas/v0.17.0/' + kind
 
     return config
-  }
+  },
 }

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

@@ -7,10 +7,10 @@ module.exports.migration = {
   toVersion: version,
   up: function (config) {
     if (config.watch !== false) {
-      config.watch = typeof config.watch === 'object' ? config.watch : {}
+      config.watch = typeof config.watch === 'object' ? config.watch : true
     }
-    delete config.plugins?.hotReload
+    delete config.plugins?.watch
 
     return config
-  }
+  },
 }

package/lib/versions/no-allow-cycles.js

@@ -3,7 +3,7 @@
 const { version } = require('../../package.json')
 
 module.exports.migration = {
-  version: '2.0.0',
+  version: '1.99.0', // This is to account alpha versions as well
   toVersion: version,
   up: function (config) {
     if (typeof config.allowCycles === 'boolean') {
@@ -11,5 +11,5 @@ module.exports.migration = {
     }
 
     return config
-  }
+  },
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,18 +20,17 @@
     "@fastify/aws-lambda": "^4.0.0",
     "@fastify/compress": "^7.0.0",
     "bindings": "^1.5.0",
-    "borp": "^0.16.0",
-    "json-schema-to-typescript": "^14.0.0",
+    "borp": "^0.17.0",
+    "eslint": "9",
+    "json-schema-to-typescript": "^15.0.0",
+    "neostandard": "^0.11.1",
     "openapi-types": "^12.1.3",
     "pino-abstract-transport": "^1.1.0",
     "self-cert": "^2.0.0",
-    "snazzy": "^9.0.0",
     "split2": "^4.2.0",
-    "standard": "^17.1.0",
     "strip-ansi": "^7.1.0",
-    "ts-standard": "^12.0.2",
     "tsd": "^0.31.0",
-    "typescript": "^5.4.2",
+    "typescript": "^5.5.4",
     "undici": "^6.0.0",
     "vscode-json-languageservice": "^5.3.9",
     "why-is-node-running": "^2.2.2",
@@ -44,7 +43,6 @@
     "@fastify/cors": "^9.0.1",
     "@fastify/deepmerge": "^1.3.0",
     "@fastify/error": "^3.4.1",
-    "@fastify/restartable": "^2.3.1",
     "@fastify/static": "^7.0.1",
     "@fastify/swagger": "^8.14.0",
     "@fastify/under-pressure": "^8.3.0",
@@ -66,7 +64,7 @@
     "fastify-metrics": "^11.0.0",
     "fastify-openapi-glue": "^4.4.3",
     "fastify-plugin": "^4.5.1",
-    "graphql": "^16.8.1",
+    "graphql": "^16.9.0",
     "help-me": "^5.0.0",
     "mercurius": "^14.0.0",
     "minimist": "^1.2.8",
@@ -78,32 +76,20 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^6.9.0",
-    "@platformatic/client": "2.0.0-alpha.2",
-    "@platformatic/config": "2.0.0-alpha.2",
-    "@platformatic/generators": "2.0.0-alpha.2",
-    "@platformatic/telemetry": "2.0.0-alpha.2",
-    "@platformatic/utils": "2.0.0-alpha.2",
-    "@platformatic/scalar-theme": "2.0.0-alpha.2",
-    "@platformatic/ts-compiler": "2.0.0-alpha.2"
-  },
-  "standard": {
-    "ignore": [
-      "**/dist/*"
-    ]
-  },
-  "ts-standard": {
-    "ignore": [
-      "**/dist/*",
-      "fixtures/**/*",
-      "test/**/*"
-    ]
+    "@platformatic/client": "2.0.0-alpha.3",
+    "@platformatic/generators": "2.0.0-alpha.3",
+    "@platformatic/scalar-theme": "2.0.0-alpha.3",
+    "@platformatic/config": "2.0.0-alpha.3",
+    "@platformatic/ts-compiler": "2.0.0-alpha.3",
+    "@platformatic/utils": "2.0.0-alpha.3",
+    "@platformatic/telemetry": "2.0.0-alpha.3"
   },
   "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",
+    "test": "pnpm run lint && borp -T --concurrency=1 --timeout=180000 && tsd",
+    "unit": "borp --pattern 'test/**/*.test.{js,mjs}' --ignore 'fixtures/**/*' --concurrency=1 --timeout=180000 --no-typescript",
     "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"
+    "lint": "eslint && tsd"
   }
 }

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://platformatic.dev/schemas/v2.0.0-alpha.2/service",
-  "version": "2.0.0-alpha.2",
+  "$id": "https://schemas.platformatic.dev/@platformatic/service/2.0.0-alpha.3.json",
+  "version": "2.0.0-alpha.3",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {
@@ -635,9 +635,6 @@
               ],
               "additionalProperties": false
             },
-            "prefix": {
-              "type": "string"
-            },
             "auth": {
               "type": "object",
               "properties": {
@@ -823,6 +820,9 @@
     "$schema": {
       "type": "string"
     },
+    "module": {
+      "type": "string"
+    },
     "service": {
       "type": "object",
       "properties": {

package/service.mjs

@@ -12,12 +12,12 @@ import { generateJsonSchemaConfig } from './lib/gen-schema.js'
 import { generateTypes } from './lib/gen-types.mjs'
 import { createService } from './lib/create.mjs'
 
-import { start, platformaticService } from './index.js'
+import platformaticService from './index.js'
 
 const help = helpMe({
   dir: join(import.meta.url, 'help'),
   // the default
-  ext: '.txt'
+  ext: '.txt',
 })
 
 function wrapCommand (fn) {
@@ -38,7 +38,7 @@ program.register('help start', help.toStdout.bind(null, ['start']))
 
 program.register('start', (argv) => {
   /* c8 ignore next 1 */
-  start(platformaticService, argv).catch(printAndExitLoadConfigError)
+  platformaticService.start(platformaticService, argv).catch(printAndExitLoadConfigError)
 })
 
 program.register('create', wrapCommand(createService))
@@ -50,8 +50,8 @@ program.register('schema', help.toStdout.bind(null, ['schema']))
 export async function runService (argv) {
   const args = parseArgs(argv, {
     alias: {
-      v: 'version'
-    }
+      v: 'version',
+    },
   })
 
   /* c8 ignore next 4 */
@@ -62,7 +62,7 @@ export async function runService (argv) {
 
   return {
     output: await program.parseAsync(argv),
-    help
+    help,
   }
 }