@platformatic/service 0.22.0 → 0.23.0

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,183 +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), config)
-      } 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
-    }
-    addLoggerToTheConfig(configManager.current)
-    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

@@ -33,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
   }
@@ -49,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,7 +17,8 @@
   },
   "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",
@@ -39,10 +40,10 @@
     "@fastify/basic-auth": "^5.0.0",
     "@fastify/cors": "^8.2.1",
     "@fastify/deepmerge": "^1.3.0",
-    "@fastify/restartable": "^1.4.0",
+    "@fastify/restartable": "^2.1.0",
     "@fastify/static": "^6.10.1",
     "@fastify/swagger": "^8.3.1",
-    "@fastify/swagger-ui": "^1.8.0",
+    "@fastify/swagger-ui": "^1.8.1",
     "@fastify/under-pressure": "^8.2.0",
     "@mercuriusjs/federation": "^2.0.0",
     "close-with-grace": "^1.2.0",
@@ -59,13 +60,13 @@
     "help-me": "^4.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.35",
-    "@platformatic/client": "0.22.0",
-    "@platformatic/config": "0.22.0",
-    "@platformatic/utils": "0.22.0"
+    "@platformatic/client": "0.23.0",
+    "@platformatic/config": "0.23.0",
+    "@platformatic/utils": "0.23.0"
   },
   "standard": {
     "ignore": [

package/test/autoload.test.js

@@ -19,26 +19,28 @@ test('autoload & filesystem based routing / watch disabled', async ({ teardown,
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -58,26 +60,28 @@ test('autoload & filesystem based routing / watch enabled', async ({ teardown, e
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -101,33 +105,35 @@ test('multiple files', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -151,33 +157,35 @@ test('multiple files / watch false', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -197,26 +205,28 @@ test('autoload & filesystem based routing / watch disabled / no object', async (
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -236,26 +246,28 @@ test('autoload & filesystem based routing / watch enabled / no object', async ({
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -275,33 +287,35 @@ test('multiple files / no object', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -324,33 +338,35 @@ test('multiple files / watch false / no object', async ({ teardown, equal }) =>
     metrics: false
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -380,33 +396,35 @@ test('nested directories', async ({ teardown, equal, same }) => {
     }
   }
 
-  const server = await buildServer(config)
-  teardown(server.stop)
-  await server.listen()
+  const app = await buildServer(config)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/inventory/product/42`)
+    const res = await request(`${app.url}/inventory/product/42`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     same(body, { sku: 42, inStore: 2 }, 'body')
   }
 
   {
-    const res = await request(`${server.url}/catalogue/products`)
+    const res = await request(`${app.url}/catalogue/products`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     same(body, [{ sku: 42, name: 'foo', inStore: 2 }, { sku: 43, name: 'bar', inStore: 0 }], 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 404, 'status code')
     const body = await res.body.text()
     equal(body, 'I\'m sorry, I couldn\'t find what you were looking for.')
   }
 
   {
-    const res = await request(`${server.url}/catalogue/error`)
+    const res = await request(`${app.url}/catalogue/error`)
     equal(res.statusCode, 500, 'status code')
     const body = await res.body.text()
     equal(body, 'I\'m sorry, there was an error processing your request.')