@platformatic/service 0.16.0 → 0.17.0

package/fixtures/hello/no-server-logger.json

@@ -6,8 +6,8 @@
       "level": "info"
     }
   },
-  "plugin": {
-    "path": "./plugin.js"
+  "plugins": {
+    "paths": ["./plugin.js"]
   },
   "metrics": false
 }

package/fixtures/hello/platformatic.service.json

@@ -6,8 +6,8 @@
       "level": "info"
     }
   },
-  "plugin": {
-    "path": "./plugin.js"
+  "plugins": {
+    "paths": ["./plugin.js"]
   },
   "metrics": false
 }

package/fixtures/options/platformatic.service.yml

@@ -1,8 +1,9 @@
 server:
   hostname: "127.0.0.1"
   port: 0
-plugin:
-  path: "./plugin.js"
-  options:
-    something: 'else'
+plugins:
+  paths:
+    - path: "./plugin.js"
+      options:
+        something: 'else'
 metrics: false

package/index.js

@@ -1,18 +1,17 @@
 'use strict'
 
 const { start } = require('@fastify/restartable')
-const autoload = require('@fastify/autoload')
 const sandbox = require('fastify-sandbox')
 const underPressure = require('@fastify/under-pressure')
 const { schema } = require('./lib/schema')
 const ConfigManager = require('./lib/config.js')
-const { addLoggerToTheConfig, getJSPluginPath } = require('./lib/utils')
+const { addLoggerToTheConfig, getJSPluginPath, isFileAccessible } = require('./lib/utils')
 const loadConfig = require('./lib/load-config')
 const { isKeyEnabled, deepmerge } = require('@platformatic/utils')
 const compiler = require('./lib/compile')
-const { stat } = require('fs').promises
-const { join } = require('path')
-const wrapperPath = join(__dirname, 'lib', 'autoload-wrapper.js')
+const { join, dirname, resolve } = require('path')
+const { readFile } = require('fs/promises')
+const wrapperPath = join(__dirname, 'lib', 'sandbox-wrapper.js')
 
 function createServerConfig (config) {
   // convert the config file to a new structure
@@ -59,15 +58,58 @@ async function platformaticService (app, opts, toLoad = []) {
     }
   }
 
-  // TODO apparently c8 is not able to mark
-  // this as covered even if it is
-  /* c8 ignore next 7 */
-  if (Array.isArray(opts.plugin)) {
-    for (const plugin of opts.plugin) {
-      await loadPlugin(app, opts, plugin)
+  if (opts.plugins) {
+    // if we don't have a fullPath, let's assume we are in a test and we can use the current working directory
+    const configPath = app.platformatic.configManager.fullPath || process.cwd()
+    const tsConfigPath = join(dirname(configPath), 'tsconfig.json')
+    /* c8 ignore next 21 */
+    if (await isFileAccessible(tsConfigPath)) {
+      const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
+      const outDir = resolve(dirname(tsConfigPath), tsConfig.compilerOptions.outDir)
+      opts.plugins.paths = opts.plugins.paths.map((plugin) => {
+        if (typeof plugin === 'string') {
+          return getJSPluginPath(configPath, plugin, outDir)
+        } else {
+          return {
+            path: getJSPluginPath(configPath, plugin.path, outDir),
+            options: plugin.options
+          }
+        }
+      })
+    } else {
+      for (const plugin of opts.plugins.paths) {
+        const path = typeof plugin === 'string' ? plugin : plugin.path
+        if (path.endsWith('.ts')) {
+          throw new Error(`Cannot load plugin ${path}, tsconfig.json not found`)
+        }
+      }
+    }
+
+    // if not defined, we default to true (which can happen only if config is set programmatically,
+    // that's why we ignore the coverage of the `undefined` case, which cannot be covered in cli tests)
+    // all individual plugin hot reload settings will be overloaded by global hot reload
+    /* c8 ignore next 1 */
+    const hotReload = opts.plugins.hotReload !== false
+    const isWatchEnabled = app.platformatic.config.watch !== false
+    app.log.debug({ plugins: opts.plugins.path }, 'loading plugin')
+
+    if (isWatchEnabled && hotReload) {
+      await app.register(sandbox, {
+        path: wrapperPath,
+        options: { paths: opts.plugins.paths },
+        customizeGlobalThis (_globalThis) {
+          // Taken from https://github.com/nodejs/undici/blob/fa9fd9066569b6357acacffb806aa804b688c9d8/lib/global.js#L5
+          const globalDispatcher = Symbol.for('undici.globalDispatcher.1')
+          const dispatcher = globalThis[globalDispatcher]
+          /* istanbul ignore else */
+          if (dispatcher) {
+            _globalThis[globalDispatcher] = dispatcher
+          }
+        }
+      })
+    } else {
+      await app.register(require(wrapperPath), { paths: opts.plugins.paths })
     }
-  } else if (opts.plugin) {
-    await loadPlugin(app, opts, opts.plugin)
   }
 
   // Enable CORS
@@ -87,6 +129,7 @@ async function platformaticService (app, opts, toLoad = []) {
     app.register(underPressure, {
       exposeStatusRoute: '/status',
       healthCheckInterval: opts.healthCheck.interval !== undefined ? opts.healthCheck.interval : 5000,
+      ...opts.healthCheck,
       healthCheck: opts.healthCheck.fn
     })
   }
@@ -96,61 +139,6 @@ async function platformaticService (app, opts, toLoad = []) {
   }
 }
 
-async function loadPlugin (app, config, pluginOptions) {
-  /* c8 ignore next 5 */
-  if (pluginOptions.typescript !== undefined) {
-    const configPath = app.platformatic.configManager.fullPath
-    const pluginPath = getJSPluginPath(configPath, pluginOptions.path, pluginOptions.typescript.outDir)
-    pluginOptions = { ...pluginOptions, path: pluginPath }
-  }
-
-  app.log.debug({ plugin: pluginOptions }, 'loading plugin')
-
-  // if not defined, we defaults to true (which can happen only if config is set programmatically,
-  // that's why we ignore the coverage of the `undefined` case, which cannot be covered in cli tests)
-  // all individual plugin hot reload settings will be overloaded by global hot reload
-  /* c8 ignore next 35  */
-  const hotReload = config.hotReload ?? pluginOptions.hotReload !== false
-  const isWatchEnabled = config.watch !== false
-  if (isWatchEnabled && hotReload) {
-    let options = pluginOptions
-    if ((await stat(pluginOptions.path)).isDirectory()) {
-      options = {
-        path: wrapperPath,
-        options: pluginOptions
-      }
-    }
-    await app.register(sandbox, {
-      ...options,
-      customizeGlobalThis (_globalThis) {
-        // Taken from https://github.com/nodejs/undici/blob/fa9fd9066569b6357acacffb806aa804b688c9d8/lib/global.js#L5
-        const globalDispatcher = Symbol.for('undici.globalDispatcher.1')
-        const dispatcher = globalThis[globalDispatcher]
-        /* istanbul ignore else */
-        if (dispatcher) {
-          _globalThis[globalDispatcher] = dispatcher
-        }
-      }
-    })
-    // c8 fails in reporting the coverage of this else branch, so we ignore it
-  } else {
-    if ((await stat(pluginOptions.path)).isDirectory()) {
-      const options = {
-        ...pluginOptions.options,
-        dir: pluginOptions.path
-      }
-      await app.register(autoload, options)
-    } else {
-      let plugin = await import(`file://${pluginOptions.path}`)
-      if (plugin.__esModule === true) {
-        plugin = plugin.default
-      }
-      /* c8 ignore next 4 */
-      await app.register(plugin, pluginOptions.options)
-    }
-  }
-}
-
 platformaticService[Symbol.for('skip-override')] = true
 platformaticService.schema = schema
 
@@ -254,6 +242,13 @@ async function buildServer (options, app, ConfigManagerContructor) {
   return handler
 }
 
+// This is for @platformatic/db to use
+/* c8 ignore next 4 */
+async function buildStart (loadConfig, buildServer) {
+  const { buildStart } = await import('./lib/start.mjs')
+  return buildStart(loadConfig, buildServer)
+}
+
 module.exports.buildServer = buildServer
 module.exports.schema = require('./lib/schema')
 module.exports.createServerConfig = createServerConfig
@@ -262,3 +257,4 @@ module.exports.addLoggerToTheConfig = addLoggerToTheConfig
 module.exports.loadConfig = loadConfig
 module.exports.tsCompiler = compiler
 module.exports.ConfigManager = ConfigManager
+module.exports.buildStart = buildStart

package/lib/compile.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { resolve, join } = require('path')
+const { resolve, join, dirname } = require('path')
 const pino = require('pino')
 const pretty = require('pino-pretty')
 const loadConfig = require('./load-config.js')
@@ -28,123 +28,98 @@ async function getTSCExecutablePath (cwd) {
   }
 }
 
-async function execute (logger, args, config) {
+async function setup (cwd) {
+  const logger = pino(
+    pretty({
+      translateTime: 'SYS:HH:MM:ss',
+      ignore: 'hostname,pid'
+    })
+  )
+
   const { execa } = await import('execa')
-  const cwd = process.cwd()
 
   const tscExecutablePath = await getTSCExecutablePath(cwd)
   /* c8 ignore next 4 */
   if (tscExecutablePath === undefined) {
-    throw new Error('The tsc executable was not found.')
+    const msg = 'The tsc executable was not found.'
+    logger.error(msg)
   }
 
   const tsconfigPath = resolve(cwd, 'tsconfig.json')
   const tsconfigExists = await isFileAccessible(tsconfigPath)
 
   if (!tsconfigExists) {
-    throw new Error('The tsconfig.json file was not found.')
+    const msg = 'The tsconfig.json file was not found.'
+    logger.error(msg)
+  }
+
+  return { execa, logger, tscExecutablePath }
+}
+
+async function compile (cwd) {
+  const { execa, logger, tscExecutablePath } = await setup(cwd)
+  /* c8 ignore next 3 */
+  if (!tscExecutablePath) {
+    return false
   }
 
   try {
     await execa(tscExecutablePath, ['--project', 'tsconfig.json'], { cwd })
     logger.info('Typescript compilation completed successfully.')
+    return true
   } catch (error) {
-    throw new Error('Failed to compile typescript files: ' + error)
+    logger.error(error.message)
+    return false
   }
 }
 
+// This path is tested but C8 does not see it that way given it needs to work
+// through execa.
+/* c8 ignore next 20 */
 async function compileWatch (cwd) {
-  const { execa } = await import('execa')
-  const logger = pino(
-    pretty({
-      translateTime: 'SYS:HH:MM:ss',
-      ignore: 'hostname,pid'
-    })
-  )
-
-  const tscExecutablePath = await getTSCExecutablePath(cwd)
-  /* c8 ignore next 4 */
-  if (tscExecutablePath === undefined) {
-    logger.error('The tsc executable was not found.')
-    process.exit(1)
+  const { execa, logger, tscExecutablePath } = await setup(cwd)
+  if (!tscExecutablePath) {
+    return false
   }
 
-  const tsconfigPath = resolve(cwd, 'tsconfig.json')
-  const tsconfigExists = await isFileAccessible(tsconfigPath)
-
-  if (!tsconfigExists) {
-    logger.error('The tsconfig.json file was not found.')
-    process.exit(1)
+  try {
+    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--incremental'], { cwd })
+    logger.info('Typescript compilation completed successfully. Starting watch mode.')
+  } catch (error) {
+    throw new Error('Failed to compile typescript files: ' + error)
   }
 
-  let isCompiled = false
-  return new Promise((resolve, reject) => {
-    const child = execa(tscExecutablePath, ['--project', 'tsconfig.json', '--watch'], { cwd })
-    process.on('SIGINT', () => child.kill('SIGKILL'))
-    process.on('SIGTERM', () => child.kill('SIGKILL'))
-
-    let tsCompilationMessages = []
-
-    child.stdout.on('data', (data) => {
-      let tsCompilerMessage = data.toString().trim()
-      if (tsCompilerMessage.startsWith('\u001bc')) {
-        tsCompilerMessage = tsCompilerMessage.slice(2)
-      }
-
-      if (tsCompilerMessage === '') return
-
-      const startMessage = tsCompilerMessage.match(/.*Starting compilation in watch mode.../)
-      if (startMessage !== null) {
-        logger.info(tsCompilerMessage)
-        return
-      }
-
-      tsCompilationMessages.push(tsCompilerMessage)
-
-      const resultMessage = tsCompilerMessage.match(/.*Found (\d+) error.*/)
-      if (resultMessage !== null) {
-        const errorsCount = parseInt(resultMessage[1])
-        const compilerOutput = tsCompilationMessages.join('\n')
-        /* c8 ignore next 6 */
-        if (errorsCount === 0) {
-          logger.info(compilerOutput)
-          if (!isCompiled) {
-            isCompiled = true
-            resolve()
-          }
-        } else {
-          logger.error(compilerOutput)
-          if (!isCompiled) {
-            reject(new Error('Typescript compilation failed.'))
-          }
-        }
-        tsCompilationMessages = []
-      }
-    })
+  const child = execa(tscExecutablePath, ['--project', 'tsconfig.json', '--watch', '--incremental'], { cwd })
+  child.stdout.resume()
+  child.stderr.on('data', (data) => {
+    logger.error(data.toString())
   })
-}
-
-async function compile (_args) {
-  const logger = pino(
-    pretty({
-      translateTime: 'SYS:HH:MM:ss',
-      ignore: 'hostname,pid'
-    })
-  )
 
-  const { configManager, args } = await loadConfig({}, _args)
-  await configManager.parseAndValidate()
-  const config = configManager.current
+  return { child }
+}
 
-  try {
-    await execute(logger, args, config)
-    process.exit(0)
-  } catch (error) {
-    logger.error(error.message)
-    process.exit(1)
+function buildCompileCmd (_loadConfig) {
+  return async function compileCmd (_args) {
+    let fullPath = null
+    try {
+      const { configManager } = await _loadConfig({}, _args)
+      await configManager.parseAndValidate()
+      fullPath = dirname(configManager.fullPath)
+      /* c8 ignore next 4 */
+    } catch (err) {
+      console.error(err)
+      process.exit(1)
+    }
+
+    if (!await compile(fullPath)) {
+      process.exit(1)
+    }
   }
 }
 
+const compileCmd = buildCompileCmd(loadConfig)
+
 module.exports.compile = compile
 module.exports.compileWatch = compileWatch
-module.exports.execute = execute
+module.exports.buildCompileCmd = buildCompileCmd
+module.exports.compileCmd = compileCmd

package/lib/config.js

@@ -32,17 +32,8 @@ class ServiceConfigManager extends ConfigManager {
     }
 
     // relative-to-absolute plugin path
-    /* c8 ignore next 3 */
-    if (Array.isArray(this.current.plugin)) {
-      this.current.plugin = this.current.plugin.map(fixPluginPath)
-    } else if (this.current.plugin) {
-      this.current.plugin = fixPluginPath(this.current.plugin)
-    }
-
-    // TODO: handle arrays
-    if (this.current.plugin?.typescript) {
-      const typescript = this.current.plugin.typescript
-      typescript.outDir = this._fixRelativePath(typescript.outDir)
+    if (this.current.plugins?.paths) {
+      this.current.plugins.paths = this.current.plugins.paths.map(fixPluginPath)
     }
   }
 

package/lib/load-config.js

@@ -18,15 +18,19 @@ const ourConfigFiles = [
 async function loadConfig (minimistConfig, _args, configOpts = {}, Manager = ConfigManager, configFileNames = ourConfigFiles) {
   const args = parseArgs(_args, deepmerge({ all: true })({
     string: ['allow-env'],
+    boolean: ['hotReload'],
     default: {
-      allowEnv: '' // The default is set in ConfigManager
+      allowEnv: '', // The default is set in ConfigManager
+      hotReload: true
     },
     alias: {
       v: 'version',
       c: 'config',
-      allowEnv: ['allow-env', 'E']
+      allowEnv: ['allow-env', 'E'],
+      hotReload: ['hot-reload']
     }
   }, minimistConfig))
+
   try {
     if (!args.config) {
       args.config = await findConfigFile(process.cwd(), configFileNames)

package/lib/sandbox-wrapper.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+const autoload = require('@fastify/autoload')
+const { stat } = require('fs').promises
+
+module.exports = fp(async function (app, opts) {
+  for (let plugin of opts.paths) {
+    if (typeof plugin === 'string') {
+      plugin = { path: plugin }
+    }
+    if ((await stat(plugin.path)).isDirectory()) {
+      app.register(autoload, {
+        dir: plugin.path,
+        options: plugin.options
+      })
+    } else {
+      let loaded = await import(`file://${plugin.path}`)
+      /* c8 ignore next 3 */
+      if (loaded.__esModule === true) {
+        loaded = loaded.default
+      }
+      await app.register(loaded, plugin.options)
+    }
+  }
+})

package/lib/schema.js

@@ -1,5 +1,10 @@
+#!/usr/bin/env node
+
 'use strict'
 
+const pkg = require('../package.json')
+const version = 'v' + pkg.version
+
 const cors = {
   type: 'object',
   $comment: 'See https://github.com/fastify/fastify-cors',
@@ -90,7 +95,6 @@ const cors = {
 }
 
 const server = {
-  $id: 'https://schemas.platformatic.dev/service/server',
   type: 'object',
   properties: {
     // TODO add support for level
@@ -125,7 +129,6 @@ const server = {
 }
 
 const watch = {
-  $id: 'https://schemas.platformatic.dev/service/watch',
   type: 'object',
   properties: {
     type: 'object',
@@ -152,29 +155,34 @@ const watch = {
   }
 }
 
-const plugin = {
-  $id: '#plugin',
+const plugins = {
+  $id: '#plugins',
   type: 'object',
   properties: {
-    path: {
-      type: 'string'
+    paths: {
+      type: 'array',
+      items: {
+        anyOf: [{
+          type: 'string'
+        }, {
+          type: 'object',
+          properties: {
+            path: {
+              type: 'string'
+            },
+            options: {
+              type: 'object',
+              additionalProperties: true
+            }
+          }
+        }]
+      }
     },
     stopTimeout: {
       type: 'integer'
     },
     typescript: {
-      type: 'object',
-      properties: {
-        outDir: {
-          type: 'string'
-        },
-        build: {
-          type: 'boolean',
-          default: true
-        }
-      },
-      additionalProperties: false,
-      required: ['outDir']
+      type: 'boolean'
     },
     fallback: {
       type: 'boolean'
@@ -182,38 +190,13 @@ const plugin = {
     hotReload: {
       type: 'boolean',
       default: true
-    },
-    options: {
-      type: 'object'
     }
   },
   additionalProperties: false,
-  required: ['path']
-}
-
-const pluginTypes = {
-  $id: 'https://schemas.platformatic.dev/service/pluginTypes',
-  $defs: {
-    plugin
-  },
-  anyOf: [{
-    type: 'array',
-    items: {
-      anyOf: [{
-        $ref: '#plugin'
-      }, {
-        type: 'string'
-      }]
-    }
-  }, {
-    $ref: '#plugin'
-  }, {
-    type: 'string'
-  }]
+  required: ['paths']
 }
 
 const metrics = {
-  $id: 'https://schemas.platformatic.dev/service/metrics',
   anyOf: [
     { type: 'boolean' },
     {
@@ -237,11 +220,11 @@ const metrics = {
 }
 
 const platformaticServiceSchema = {
-  $id: 'https://schemas.platformatic.dev/service',
+  $id: `https://platformatic.dev/schemas/${version}/service`,
   type: 'object',
   properties: {
     server,
-    plugin: pluginTypes,
+    plugins,
     metrics
   },
   additionalProperties: {
@@ -261,6 +244,9 @@ module.exports.schema = platformaticServiceSchema
 module.exports.metrics = metrics
 module.exports.cors = cors
 module.exports.server = server
-module.exports.plugin = plugin
-module.exports.pluginTypes = pluginTypes
+module.exports.plugins = plugins
 module.exports.watch = watch
+
+if (require.main === module) {
+  console.log(JSON.stringify(platformaticServiceSchema, null, 2))
+}