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

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,7 +25,44 @@ async function adjustHttpsKeyAndCert (arg) {
   return arg
 }
 
-async function buildServer (options, app) {
+async function createServer (serverContext) {
+  const { app, configManager, context } = serverContext
+  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, { context })
+  if (!root.hasRoute({ url: '/', method: 'GET' })) {
+    await root.register(require('./root-endpoint'))
+  }
+
+  root.decorate('url', {
+    getter () {
+      return serverContext.url
+    },
+  })
+
+  return root
+}
+async function buildConfigManager (options, app) {
+  const loggerInstance = options.server?.loggerInstance
+  if (loggerInstance) {
+    delete options.server.loggerInstance
+    options.server ||= {}
+    options.server.logger = { level: loggerInstance.level }
+  }
+
   let configManager = options.configManager
   if (!configManager) {
     // instantiate a new config manager from current options
@@ -33,6 +70,16 @@ async function buildServer (options, app) {
     await configManager.parseAndValidate()
   }
 
+  if (loggerInstance) {
+    configManager.current.server ||= {}
+    delete configManager.current.server.logger
+    configManager.current.server.loggerInstance = loggerInstance
+  }
+  return configManager
+}
+
+async function buildServer (options, app, context) {
+  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 +90,25 @@ 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 serverContext = {
+    app: typeof app === 'function' ? app : app.app,
+    configManager,
+    context
+  }
+  const handler = await createServer(serverContext)
   handler.decorate('start', async () => {
-    url = await handler.listen({ host: options.server?.hostname || '127.0.0.1', port: options.server?.port || 0 })
-    return url
+    serverContext.url = await handler.listen({
+      host: options.server?.hostname || '127.0.0.1',
+      port: options.server?.port || 0,
+    })
+    return serverContext.url
   })
   configManager.on('error', function (err) {
     /* c8 ignore next 1 */
@@ -98,20 +118,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 +151,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 +170,6 @@ async function start (appType, _args) {
   })
 }
 
+module.exports.buildConfigManager = buildConfigManager
 module.exports.buildServer = buildServer
 module.exports.start = start

package/lib/upgrade.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const { join } = require('path')
-const pkg = require('../package.json')
 
 module.exports = async function upgrade (config, version) {
   const { semgrator } = await import('semgrator')
@@ -10,7 +9,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 +18,5 @@ module.exports = async function upgrade (config, version) {
     result = updated.result
   }
 
-  result.$schema = `https://platformatic.dev/schemas/v${pkg.version}/service`
-
   return result
 }

package/lib/utils.js

@@ -21,17 +21,19 @@ function addLoggerToTheConfig (config) {
     config.server = {}
   }
   // Set the logger if not present
-  let logger = config.server.logger
-  if (!logger) {
-    config.server.logger = { level: 'info' }
-    logger = config.server.logger
-  }
+  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'
+    // If TTY use pino-pretty
+    if (isatty(1)) {
+      if (!logger.transport) {
+        logger.transport = {
+          target: 'pino-pretty',
+        }
       }
     }
   }
@@ -101,5 +103,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/2.0.0.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const pkg = require('../../package.json')
+
+module.exports = {
+  version: '2.0.0',
+  up: function (config) {
+    config.$schema = `https://schemas.platformatic.dev/@platformatic/service/${pkg.version}.json`
+    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.21",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,43 +17,42 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@fastify/aws-lambda": "^4.0.0",
-    "@fastify/compress": "^7.0.0",
+    "@fastify/aws-lambda": "^5.0.0",
+    "@fastify/compress": "^8.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",
+    "pino-abstract-transport": "^2.0.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",
     "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.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",
-    "@mercuriusjs/federation": "^3.0.0",
+    "@fastify/accepts": "^5.0.0",
+    "@fastify/autoload": "^6.0.0",
+    "@fastify/basic-auth": "^6.0.0",
+    "@fastify/cors": "^10.0.0",
+    "@fastify/deepmerge": "^2.0.0",
+    "@fastify/error": "^4.0.0",
+    "@fastify/static": "^8.0.0",
+    "@fastify/swagger": "^9.0.0",
+    "@fastify/under-pressure": "^9.0.0",
+    "@mercuriusjs/federation": "^4.0.0",
+    "@platformatic/fastify-http-metrics": "^0.1.0",
     "@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.3.0",
+    "close-with-grace": "^2.0.0",
     "code-block-writer": "^13.0.1",
     "colorette": "^2.0.20",
     "commist": "^3.2.0",
@@ -62,48 +61,35 @@
     "env-schema": "^5.2.1",
     "es-main": "^1.3.0",
     "execa": "^8.0.1",
-    "fastify": "^4.28.1",
-    "fastify-metrics": "^11.0.0",
-    "fastify-openapi-glue": "^4.4.3",
-    "fastify-plugin": "^4.5.1",
-    "graphql": "^16.8.1",
+    "fastify": "^5.0.0",
+    "fastify-metrics": "^12.0.0",
+    "fastify-plugin": "^5.0.0",
+    "graphql": "^16.9.0",
     "help-me": "^5.0.0",
-    "mercurius": "^14.0.0",
+    "mercurius": "^15.0.0",
     "minimist": "^1.2.8",
     "my-ua-parser": "^2.0.2",
     "ora": "^6.3.1",
-    "pino": "^8.19.0",
+    "pino": "^9.0.0",
     "pino-pretty": "^11.0.0",
     "prom-client": "^15.1.2",
     "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.21",
+    "@platformatic/generators": "2.0.0-alpha.21",
+    "@platformatic/scalar-theme": "2.0.0-alpha.21",
+    "@platformatic/config": "2.0.0-alpha.21",
+    "@platformatic/telemetry": "2.0.0-alpha.21",
+    "@platformatic/ts-compiler": "2.0.0-alpha.21",
+    "@platformatic/utils": "2.0.0-alpha.21"
   },
   "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.21.json",
+  "version": "2.0.0-alpha.21",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {
@@ -93,7 +93,24 @@
               "type": "object",
               "properties": {
                 "level": {
-                  "type": "string"
+                  "type": "string",
+                  "default": "info",
+                  "oneOf": [
+                    {
+                      "enum": [
+                        "fatal",
+                        "error",
+                        "warn",
+                        "info",
+                        "debug",
+                        "trace",
+                        "silent"
+                      ]
+                    },
+                    {
+                      "pattern": "^\\{.+\\}$"
+                    }
+                  ]
                 },
                 "transport": {
                   "anyOf": [
@@ -154,10 +171,17 @@
                   "additionalProperties": false
                 }
               },
+              "required": [
+                "level"
+              ],
+              "default": {},
               "additionalProperties": true
             }
           ]
         },
+        "loggerInstance": {
+          "type": "object"
+        },
         "serializerOpts": {
           "type": "object",
           "properties": {
@@ -635,9 +659,6 @@
               ],
               "additionalProperties": false
             },
-            "prefix": {
-              "type": "string"
-            },
             "auth": {
               "type": "object",
               "properties": {
@@ -823,6 +844,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,19 +50,19 @@ 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 */
   if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
+    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version)
     process.exit(0)
   }
 
   return {
     output: await program.parseAsync(argv),
-    help
+    help,
   }
 }