@platformatic/service 0.6.0 → 0.7.0

package/.taprc

@@ -1,2 +1,2 @@
-timeout: 80
+timeout: 160
 coverage: false

package/index.js

@@ -33,6 +33,19 @@ async function platformaticService (app, opts, toLoad = []) {
     app.decorate('platformatic', {})
   }
 
+  {
+    const fileWatcher = opts.fileWatcher
+    const configManager = opts.configManager
+    /* c8 ignore next 4 */
+    if (fileWatcher !== undefined) {
+      app.platformatic.fileWatcher = fileWatcher
+    }
+    if (configManager !== undefined) {
+      app.platformatic.configManager = configManager
+      app.platformatic.config = configManager.current
+    }
+  }
+
   if (opts.plugin) {
     let pluginOptions = opts.plugin
     /* c8 ignore next 4 */
@@ -48,7 +61,7 @@ async function platformaticService (app, opts, toLoad = []) {
     /* c8 ignore next */
     const hotReload = opts.plugin.watchOptions?.hotReload !== false
     const isWatchEnabled = opts.plugin.watch !== false
-
+    /* c8 ignore next 13 */
     if (isWatchEnabled && hotReload) {
       await app.register(sandbox, {
         ...pluginOptions,
@@ -116,7 +129,13 @@ async function buildServer (options, app = platformaticService) {
 
   const _restart = handler.restart
 
-  handler.restart = async (opts) => {
+  let debounce = null
+  handler.restart = (opts) => {
+    /* c8 ignore next 3 */
+    if (debounce) {
+      return debounce
+    }
+
     addLoggerToTheConfig(opts)
 
     // Ignore because not tested on Windows
@@ -124,26 +143,20 @@ async function buildServer (options, app = platformaticService) {
     // this on Windows
     /* c8 ignore start */
     if (opts) {
-      opts = createServerConfig(opts)
-      opts.app = app
-
       const fileWatcher = handler.app.platformatic.fileWatcher
       const configManager = handler.app.platformatic.configManager
-
-      await _restart(opts)
-
-      if (fileWatcher !== undefined) {
-        handler.app.platformatic.fileWatcher = fileWatcher
-      }
-      if (configManager !== undefined) {
-        handler.app.platformatic.configManager = configManager
-        handler.app.platformatic.config = configManager.current
-      }
-
-      return handler
+      opts.fileWatcher = fileWatcher
+      opts.configManager = configManager
+      opts = createServerConfig(opts)
+      opts.app = app
     }
+    debounce = _restart(opts).then(() => {
+      handler.app.log.info('restarted')
+    }).finally(() => {
+      debounce = null
+    })
     /* c8 ignore stop */
-    return _restart()
+    return debounce
   }
 
   return handler

package/lib/schema.js

@@ -125,6 +125,9 @@ const plugin = {
     watch: {
       type: 'boolean'
     },
+    fallback: {
+      type: 'boolean'
+    },
     watchOptions: {
       type: 'object',
       properties: {
@@ -156,6 +159,7 @@ const plugin = {
       type: 'object'
     }
   },
+  additionalProperties: false,
   required: ['path']
 }
 

package/lib/start.mjs

@@ -34,9 +34,9 @@ async function start (_args) {
     configManager
   })
 
-  configManager.on('update', (newConfig) => onConfigUpdated(newConfig, server))
   server.app.platformatic.configManager = configManager
   server.app.platformatic.config = config
+  configManager.on('update', (newConfig) => onConfigUpdated(newConfig, server))
 
   if (
     config.plugin !== undefined &&
@@ -58,9 +58,6 @@ async function start (_args) {
   process.on('SIGUSR2', function () {
     server.app.log.info('reloading configuration')
     server.restart()
-      .then(() => {
-        server.app.log.info('restarted')
-      })
       .catch((err) => {
         server.app.log.error({
           err: {
@@ -103,7 +100,7 @@ async function startFileWatching (server) {
   })
   fileWatcher.startWatching()
 
-  server.app.log.info('start watching files')
+  server.app.log.debug('start watching files')
   server.app.platformatic.fileWatcher = fileWatcher
 }
 
@@ -112,7 +109,7 @@ async function stopFileWatching (server) {
   if (fileWatcher !== undefined) {
     await fileWatcher.stopWatching()
 
-    server.app.log.info('stop watching files')
+    server.app.log.debug('stop watching files')
     server.app.platformatic.fileWatcher = undefined
   }
 }
@@ -120,18 +117,11 @@ async function stopFileWatching (server) {
 async function onConfigUpdated (newConfig, server) {
   try {
     server.app.platformatic.config = newConfig
-    server.app.log.info('config changed')
+    server.app.log.debug('config changed')
     server.app.log.trace({ newConfig }, 'new config')
 
     await stopFileWatching(server)
 
-    if (
-      newConfig.plugin !== undefined &&
-      newConfig.plugin.watch !== false
-    ) {
-      await startFileWatching(server)
-    }
-
     await server.restart(newConfig)
   } catch (err) {
     // TODO: test this
@@ -141,14 +131,24 @@ async function onConfigUpdated (newConfig, server) {
         stack: err.stack
       }
     }, 'failed to reload config')
+  } finally {
+    if (
+      newConfig.plugin !== undefined &&
+      newConfig.plugin.watch !== false
+    ) {
+      await startFileWatching(server)
+    }
   }
 }
 
 async function onFilesUpdated (server) {
+  // 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 {
-    const config = server.app.platformatic.config
-    server.app.log.info('files changed')
-    await server.restart(config)
+    server.app.log.debug('files changed')
+    await configManager.parse()
+    await server.restart(configManager.current)
   } catch (err) {
     // TODO: test this
     server.app.log.error({

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@platformatic/service",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "",
   "main": "index.js",
   "author": "Matteo Collina <hello@matteocollina.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/plaformatic/platformatic.git"
+    "url": "git+https://github.com/platformatic/platformatic.git"
   },
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/plaformatic/platformatic/issues"
+    "url": "https://github.com/platformatic/platformatic/issues"
   },
-  "homepage": "https://github.com/plaformatic/platformatic#readme",
+  "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
     "c8": "^7.11.0",
     "snazzy": "^9.0.0",
@@ -34,8 +34,8 @@
     "@fastify/static": "^6.5.0",
     "@fastify/swagger": "^8.0.0",
     "@fastify/under-pressure": "^8.0.0",
-    "@platformatic/config": "0.6.0",
-    "@platformatic/utils": "0.6.0",
+    "@platformatic/config": "0.7.0",
+    "@platformatic/utils": "0.7.0",
     "close-with-grace": "^1.1.0",
     "commist": "^3.1.2",
     "desm": "^1.2.0",

package/test/cli/helper.mjs

@@ -38,7 +38,7 @@ export async function start (...args) {
 
   const errorTimeout = setTimeout(() => {
     throw new Error('Couldn\'t start server')
-  }, 10000)
+  }, 30000)
 
   for await (const messages of on(output, 'data')) {
     for (const message of messages) {

package/test/cli/watch.test.mjs

@@ -0,0 +1,244 @@
+import os from 'os'
+import { join, basename } from 'path'
+import { writeFile, mkdtemp } from 'fs/promises'
+import { setTimeout as sleep } from 'timers/promises'
+import t, { test } from 'tap'
+import { request } from 'undici'
+import { start } from './helper.mjs'
+
+t.jobs = 5
+
+function createLoggingPlugin (text) {
+  return `\
+    module.exports = async (app) => {
+      app.get('/version', () => '${text}')
+    }
+  `
+}
+
+test('should watch js files by default', async ({ equal, teardown }) => {
+  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
+  const pluginFilePath = join(tmpDir, 'plugin.js')
+  const configFilePath = join(tmpDir, 'platformatic.service.json')
+
+  const defaultConfig = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      watch: true
+    }
+  }
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(defaultConfig)),
+    writeFile(pluginFilePath, createLoggingPlugin('v1'))
+  ])
+
+  const { child, url } = await start('-c', configFilePath)
+  teardown(() => child.kill('SIGINT'))
+
+  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+
+  await sleep(5000)
+
+  const res = await request(`${url}/version`)
+  const version = await res.body.text()
+  equal(version, 'v2')
+})
+
+test('should watch allowed file', async ({ comment, teardown }) => {
+  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
+  const jsonFilePath = join(tmpDir, 'plugin-config.json')
+  const pluginFilePath = join(tmpDir, 'plugin.js')
+  const configFilePath = join(tmpDir, 'platformatic.service.json')
+
+  const config = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      watch: true,
+      watchOptions: {
+        allow: ['*.js', '*.json']
+      }
+    }
+  }
+
+  const pluginCode = `\
+  const readFileSync = require('fs').readFileSync
+  const json = readFileSync(${JSON.stringify(jsonFilePath)}, 'utf8')
+
+  module.exports = async function (app) {
+    if (json === 'RESTARTED') {
+      app.log.info('RESTARTED')
+    }
+  }`
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(config)),
+    writeFile(jsonFilePath, 'INITIAL'),
+    writeFile(pluginFilePath, pluginCode)
+  ])
+
+  const { child } = await start('-c', configFilePath)
+  teardown(() => child.kill('SIGINT'))
+
+  writeFile(jsonFilePath, 'RESTARTED')
+  for await (const log of child.ndj) {
+    if (log.msg === 'RESTARTED') break
+  }
+})
+
+test('should not watch ignored file', async ({ teardown, equal }) => {
+  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
+  const pluginFilePath = join(tmpDir, 'plugin.js')
+  const configFilePath = join(tmpDir, 'platformatic.service.json')
+
+  const config = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      watch: true,
+      watchOptions: {
+        ignore: [basename(pluginFilePath)]
+      }
+    }
+  }
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(config)),
+    writeFile(pluginFilePath, createLoggingPlugin('v1'))
+  ])
+
+  const { child, url } = await start('-c', configFilePath)
+  teardown(() => child.kill('SIGINT'))
+
+  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+  await sleep(5000)
+
+  const res = await request(`${url}/version`)
+  const version = await res.body.text()
+  equal(version, 'v1')
+})
+
+test('should not loop forever when doing ESM', { skip: true }, async ({ comment, fail }) => {
+  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-esm-'))
+  const pluginFilePath = join(tmpDir, 'plugin.mjs')
+  const configFilePath = join(tmpDir, 'platformatic.service.json')
+
+  const config = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      watch: true,
+      watchOptions: {
+        ignore: [basename(pluginFilePath)]
+      }
+    }
+  }
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(config)),
+    writeFile(pluginFilePath, 'export default async (app) => {}')
+  ])
+
+  const { child } = await start('-c', configFilePath)
+
+  await sleep(1000)
+
+  child.kill('SIGINT')
+
+  let linesCounter = 0
+  for await (const line of child.ndj) {
+    // lines will have a series of "config changed"
+    // messages without an ignore
+    comment(line.msg)
+    if (++linesCounter > 2) {
+      fail()
+      break
+    }
+  }
+})
+
+test('should watch config file', async ({ comment, teardown }) => {
+  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-config-'))
+  const pluginFilePath = join(tmpDir, 'plugin.js')
+  const configFilePath = join(tmpDir, 'platformatic.service.json')
+
+  const config = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      watch: true,
+      watchOptions: {
+        allow: ['*.js', '*.json']
+      }
+    }
+  }
+
+  const config2 = {
+    server: {
+      logger: {
+        level: 'info'
+      },
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugin: {
+      path: pluginFilePath,
+      options: {
+        log: true
+      }
+    }
+  }
+
+  const pluginCode = `\
+  module.exports = async function (app, opts) {
+    if (opts.log) {
+      app.log.info('RESTARTED')
+    }
+  }`
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(config)),
+    writeFile(pluginFilePath, pluginCode)
+  ])
+
+  const { child } = await start('-c', configFilePath)
+  teardown(() => child.kill('SIGINT'))
+
+  // We do not await
+  writeFile(configFilePath, JSON.stringify(config2))
+  for await (const log of child.ndj) {
+    if (log.msg === 'RESTARTED') break
+  }
+})

package/test/load-and-reload-files.test.js

@@ -201,7 +201,7 @@ test('load and reload with the fallback', async ({ teardown, equal, pass, same }
   }
 })
 
-test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
+test('load and reload ESM', { skip: true }, async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `some-plugin-${process.pid}.mjs`)
 
   await writeFile(file, `