@platformatic/service 0.21.1 → 0.23.0

package/lib/plugins/health-check.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const underPressure = require('@fastify/under-pressure')
+const fp = require('fastify-plugin')
+
+async function setupClients (app, opts) {
+  const healthCheck = opts
+
+  app.register(underPressure, {
+    exposeStatusRoute: '/status',
+    healthCheckInterval: healthCheck.interval !== undefined ? healthCheck.interval : 5000,
+    ...healthCheck,
+    healthCheck: healthCheck.fn
+  })
+}
+
+module.exports = fp(setupClients)

package/lib/plugins/plugins.js

@@ -0,0 +1,56 @@
+'use strict'
+
+const { join, resolve } = require('path')
+const { readFile } = require('fs/promises')
+
+const sandbox = require('fastify-sandbox')
+const fp = require('fastify-plugin')
+
+const { getJSPluginPath, isFileAccessible } = require('../utils')
+
+const wrapperPath = join(__dirname, 'sandbox-wrapper.js')
+
+async function loadPlugins (app) {
+  const configManager = app.platformatic.configManager
+  const config = configManager.current
+
+  if (config.plugins.typescript) {
+    const workingDir = configManager.dirname
+    const tsConfigPath = join(workingDir, 'tsconfig.json')
+
+    const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
+    if (!isTsConfigAccessible) {
+      throw new Error('Cannot load typescript plugin, tsconfig.json not found')
+    }
+
+    const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
+    const outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
+
+    config.plugins.paths = config.plugins.paths.map((plugin) => {
+      /* c8 ignore next 3 */
+      return typeof plugin === 'string'
+        ? getJSPluginPath(workingDir, plugin, outDir)
+        : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
+    })
+  }
+
+  if (config.plugins.hotReload !== false) {
+    await app.register(sandbox, {
+      path: wrapperPath,
+      options: { paths: config.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: config.plugins.paths })
+  }
+}
+
+module.exports = fp(loadPlugins)

package/lib/plugins/typescript.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const { isKeyEnabled } = require('@platformatic/utils')
+const fp = require('fastify-plugin')
+
+const compiler = require('../compile')
+
+async function setupTsCompiler (app) {
+  // TODO: move params to opts
+
+  const configManager = app.platformatic.configManager
+  const config = configManager.current
+
+  const isRestartableApp = app.restarted !== undefined
+
+  // to run the plugin without restartable
+  /* c8 ignore next 1 */
+  const persistentRef = isRestartableApp ? app.persistentRef : app
+
+  const workingDir = configManager.dirname
+
+  if (isKeyEnabled('watch', config)) {
+    let tsCompilerWatcher = persistentRef.tsCompilerWatcher
+    if (!tsCompilerWatcher) {
+      /* c8 ignore next 5 */
+      const { child } = await compiler.compileWatch(workingDir, config)
+      app.log.debug('start watching typescript files')
+      tsCompilerWatcher = child
+    }
+    app.decorate('tsCompilerWatcher', tsCompilerWatcher)
+  } else {
+    await compiler.compile(workingDir, config)
+  }
+
+  app.addHook('onClose', async () => {
+    if (!isRestartableApp || app.closingRestartable) {
+      /* c8 ignore next 4 */
+      if (app.tsCompilerWatcher) {
+        app.tsCompilerWatcher.kill('SIGTERM')
+        app.log.debug('stop watching typescript files')
+      }
+    }
+  })
+}
+
+module.exports = fp(setupTsCompiler)

package/lib/root-endpoint/index.js

@@ -1,4 +1,5 @@
 'use strict'
+
 const path = require('path')
 const fastifyStatic = require('@fastify/static')
 const userAgentParser = require('ua-parser-js')

package/lib/schema.js

@@ -134,7 +134,8 @@ const server = {
       type: 'integer'
     },
     keepAliveTimeout: {
-      type: 'integer'
+      type: 'integer',
+      default: 5000
     },
     maxRequestsPerSocket: {
       type: 'integer'
@@ -313,6 +314,12 @@ const server = {
               }
             }
           ]
+        },
+        requestCert: {
+          type: 'boolean'
+        },
+        rejectUnauthorized: {
+          type: 'boolean'
         }
       },
       additionalProperties: false,

package/lib/start.mjs

@@ -1,9 +1,6 @@
-import { dirname } from 'path'
-import { FileWatcher } from '@platformatic/utils'
 import { buildServer } from '../index.js'
 import close from 'close-with-grace'
 import { loadConfig, generateDefaultConfig } from './load-config.js'
-import { compileWatch } from './compile.js'
 import { addLoggerToTheConfig } from './utils.js'
 
 // TODO make sure coverage is reported for Windows
@@ -18,182 +15,77 @@ function defaultConfig () {
   }
 }
 
-export function buildStart (_loadConfig, _buildServer) {
+export function buildStart (_loadConfig, _buildServer, _configManagerConfig) {
   return async function start (_args) {
-    const _defaultConfig = defaultConfig()
+    const _defaultConfig = _configManagerConfig ?? defaultConfig()
     const { configManager, args } = await _loadConfig({}, _args, _defaultConfig)
 
     const config = configManager.current
 
-    // Set the logger if not present
+    // Disable hot reload from the CLI
+    if (args.hotReload === false && configManager.current.plugins) {
+      configManager.current.plugins.hotReload = false
+    }
     addLoggerToTheConfig(config)
 
-    if (
-      config.plugins?.typescript &&
-      config.plugins?.watch !== false
-    ) {
-      try {
-        await compileWatch(dirname(configManager.fullPath))
-      } catch (error) {
-        // TODO route this to a logger
-        console.error(error)
-        process.exit(1)
+    const _transformConfig = configManager._transformConfig.bind(configManager)
+    configManager._transformConfig = function () {
+      const config = configManager.current
+      if (args.hotReload === false && config.plugins) {
+        config.plugins.hotReload = false
       }
+      addLoggerToTheConfig(config)
+      return _transformConfig(config)
     }
 
-    let server = null
-
-    // Disable hot reload from the CLI
-    if (args.hotReload === false && configManager.current.plugins) {
-      configManager.current.plugins.hotReload = false
-    }
+    let app = null
 
     try {
       // Set the location of the config
-      server = await _buildServer({
-        ...config,
-        configManager
-      })
+      app = await _buildServer({ ...config, configManager })
+
+      await app.start()
+      // TODO: this log is used in the start command. Should be replaced
+      app.log.info({ url: app.url })
     } catch (err) {
       // TODO route this to a logger
       console.error(err)
       process.exit(1)
     }
 
-    server.app.platformatic.configManager = configManager
-    server.app.platformatic.config = config
-    configManager.on('update', (newConfig) => {
-      if (args.hotReload === false && configManager.current.plugins) {
-        configManager.current.plugins.hotReload = false
-      }
-      onConfigUpdated(newConfig, server)
-    })
-
-    if (
-      config.plugins !== undefined &&
-      config.watch !== false
-    ) {
-      await startFileWatching(server, args.hotReload)
-    }
-
-    try {
-      await server.listen()
-    } catch (err) {
-      server.app.log.error({ err })
-      process.exit(1)
-    }
-
-    configManager.on('error', function (err) {
-      server.app.log.error({
-        err
-      }, 'error reloading the configuration')
-    })
-
     // Ignore from CI because SIGUSR2 is not available
     // on Windows
     process.on('SIGUSR2', function () {
-      server.app.log.info('reloading configuration')
-      server.restart()
-        .catch((err) => {
-          server.app.log.error({
-            err: {
-              message: err.message,
-              stack: err.stack
-            }
-          }, 'failed to restart')
-        })
+      app.log.info('reloading configuration')
+      safeRestart(app)
       return false
     })
 
     close(async ({ signal, err }) => {
       // Windows does not support trapping signals
       if (err) {
-        server.app.log.error({
+        app.log.error({
           err: {
             message: err.message,
             stack: err.stack
           }
         }, 'exiting')
       } else if (signal) {
-        server.app.log.info({ signal }, 'received signal')
+        app.log.info({ signal }, 'received signal')
       }
 
-      await server.stop()
+      await app.close()
     })
   }
 }
 
 const start = buildStart(loadConfig, buildServer)
 
-async function startFileWatching (server, hotReload) {
-  const configManager = server.app.platformatic.configManager
-  const config = configManager.current
-
-  const fileWatcher = new FileWatcher({
-    path: dirname(configManager.fullPath),
-    allowToWatch: config.watch?.allow,
-    watchIgnore: config.watch?.ignore
-  })
-  fileWatcher.on('update', () => {
-    onFilesUpdated(server, hotReload)
-  })
-  fileWatcher.startWatching()
-
-  server.app.log.debug('start watching files')
-  server.app.platformatic.fileWatcher = fileWatcher
-}
-
-async function stopFileWatching (server) {
-  const fileWatcher = server.app.platformatic.fileWatcher
-  if (fileWatcher !== undefined) {
-    await fileWatcher.stopWatching()
-
-    server.app.log.debug('stop watching files')
-    server.app.platformatic.fileWatcher = undefined
-  }
-}
-
-async function onConfigUpdated (newConfig, server) {
+async function safeRestart (app) {
   try {
-    server.app.platformatic.config = newConfig
-    server.app.log.debug('config changed')
-    server.app.log.trace({ newConfig }, 'new config')
-
-    await stopFileWatching(server)
-
-    await server.restart(newConfig)
-  } catch (err) {
-    // TODO: test this
-    server.app.log.error({
-      err: {
-        message: err.message,
-        stack: err.stack
-      }
-    }, 'failed to reload config')
-  } finally {
-    if (
-      newConfig.plugins !== undefined &&
-      newConfig.plugins.watch !== false
-    ) {
-      await startFileWatching(server)
-    }
-  }
-}
-
-async function onFilesUpdated (server, hotReload) {
-  // Reload the config as well, otherwise we will have problems
-  // in case the files watcher triggers the config watcher too
-  const configManager = server.app.platformatic.configManager
-  try {
-    server.app.log.debug('files changed')
-    await configManager.parse()
-    if (hotReload === false && configManager.current.plugins) {
-      configManager.current.plugins.hotReload = false
-    }
-    await server.restart(configManager.current)
+    await app.restart()
   } catch (err) {
-    // TODO: test this
-    server.app.log.error({
+    app.log.error({
       err: {
         message: err.message,
         stack: err.stack

package/lib/utils.js

@@ -3,12 +3,6 @@
 const { access } = require('fs/promises')
 const { resolve, join, relative, dirname, basename } = require('path')
 
-async function findConfigFile (directory, configFileNames) {
-  const configFilesAccessibility = await Promise.all(configFileNames.map((fileName) => isFileAccessible(fileName, directory)))
-  const accessibleConfigFilename = configFileNames.find((value, index) => configFilesAccessibility[index])
-  return accessibleConfigFilename
-}
-
 async function isFileAccessible (filename, directory) {
   try {
     const filePath = directory ? resolve(directory, filename) : filename
@@ -21,8 +15,6 @@ async function isFileAccessible (filename, directory) {
 
 /* c8 ignore start */
 function addLoggerToTheConfig (config) {
-  if (config === undefined || config.server === undefined) return
-
   // Set the logger if not present
   let logger = config.server.logger
   if (!logger) {
@@ -41,7 +33,7 @@ function addLoggerToTheConfig (config) {
 }
 /* c8 ignore stop */
 
-function getJSPluginPath (configPath, tsPluginPath, compileDir) {
+function getJSPluginPath (workingDir, tsPluginPath, compileDir) {
   if (tsPluginPath.endsWith('js')) {
     return tsPluginPath
   }
@@ -57,7 +49,7 @@ function getJSPluginPath (configPath, tsPluginPath, compileDir) {
     newBaseName = basename(tsPluginPath)
   }
 
-  const tsPluginRelativePath = relative(dirname(configPath), tsPluginPath)
+  const tsPluginRelativePath = relative(workingDir, tsPluginPath)
   const jsPluginRelativePath = join(
     dirname(tsPluginRelativePath),
     newBaseName
@@ -66,7 +58,6 @@ function getJSPluginPath (configPath, tsPluginPath, compileDir) {
 }
 
 module.exports = {
-  findConfigFile,
   isFileAccessible,
   getJSPluginPath,
   addLoggerToTheConfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,55 +17,56 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "@matteo.collina/worker": "^3.0.0",
+    "@fastify/aws-lambda": "^3.2.0",
+    "@matteo.collina/worker": "^3.1.0",
     "bindings": "^1.5.0",
     "c8": "^7.13.0",
     "self-cert": "^2.0.0",
     "snazzy": "^9.0.0",
-    "split2": "^4.1.0",
+    "split2": "^4.2.0",
     "standard": "^17.0.0",
     "strip-ansi": "^7.0.1",
     "tap": "^16.3.4",
-    "tsd": "^0.28.0",
-    "typescript": "^5.0.0",
-    "undici": "^5.20.0",
-    "vscode-json-languageservice": "^5.3.0",
+    "tsd": "^0.28.1",
+    "typescript": "^5.0.4",
+    "undici": "^5.22.0",
+    "vscode-json-languageservice": "^5.3.4",
     "why-is-node-running": "^2.2.2",
-    "yaml": "^2.2.1"
+    "yaml": "^2.2.2"
   },
   "dependencies": {
     "@fastify/accepts": "^4.1.0",
     "@fastify/autoload": "^5.7.1",
     "@fastify/basic-auth": "^5.0.0",
-    "@fastify/cors": "^8.2.0",
+    "@fastify/cors": "^8.2.1",
     "@fastify/deepmerge": "^1.3.0",
-    "@fastify/restartable": "^1.4.0",
-    "@fastify/static": "^6.9.0",
+    "@fastify/restartable": "^2.1.0",
+    "@fastify/static": "^6.10.1",
     "@fastify/swagger": "^8.3.1",
-    "@fastify/swagger-ui": "^1.4.0",
+    "@fastify/swagger-ui": "^1.8.1",
     "@fastify/under-pressure": "^8.2.0",
-    "@mercuriusjs/federation": "^1.0.1",
-    "close-with-grace": "^1.1.0",
+    "@mercuriusjs/federation": "^2.0.0",
+    "close-with-grace": "^1.2.0",
     "commist": "^3.2.0",
     "desm": "^1.3.0",
     "env-schema": "^5.2.0",
     "es-main": "^1.2.0",
-    "execa": "^7.0.0",
-    "fastify": "^4.13.0",
-    "fastify-metrics": "^10.0.3",
+    "execa": "^7.1.1",
+    "fastify": "^4.17.0",
+    "fastify-metrics": "^10.3.0",
     "fastify-plugin": "^4.5.0",
     "fastify-sandbox": "^0.11.0",
     "graphql": "^16.6.0",
     "help-me": "^4.2.0",
-    "mercurius": "^12.2.0",
+    "mercurius": "^13.0.0",
     "minimist": "^1.2.8",
-    "pino": "^8.11.0",
+    "pino": "^8.12.0",
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
-    "ua-parser-js": "^1.0.33",
-    "@platformatic/client": "0.21.1",
-    "@platformatic/config": "0.21.1",
-    "@platformatic/utils": "0.21.1"
+    "ua-parser-js": "^1.0.35",
+    "@platformatic/client": "0.23.0",
+    "@platformatic/config": "0.23.0",
+    "@platformatic/utils": "0.23.0"
   },
   "standard": {
     "ignore": [