@platformatic/service 0.16.0 → 0.17.1

package/lib/start.mjs

@@ -9,89 +9,114 @@ import { addLoggerToTheConfig } from './utils.js'
 // TODO make sure coverage is reported for Windows
 // Currently C8 is not reporting it
 /* c8 ignore start */
-async function start (_args) {
-  const { configManager } = await loadConfig({}, _args, { watch: true })
 
-  const config = configManager.current
+export function buildStart (_loadConfig, _buildServer) {
+  return async function start (_args) {
+    const { configManager, args } = await _loadConfig({}, _args, { watch: true })
 
-  // Set the logger if not present
-  addLoggerToTheConfig(config)
+    const config = configManager.current
 
-  if (
-    config.plugin?.typescript !== undefined &&
-    config.plugin?.watch !== false &&
-    config.plugin?.typescript?.build !== false
-  ) {
-    try {
-      await compileWatch(dirname(configManager.fullPath))
-    } catch (error) {
-      console.error(error)
-      process.exit(1)
+    // Set the logger if not present
+    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)
+      }
     }
-  } else if (config.plugin?.typescript !== undefined && config.plugin?.typescript?.build === false) {
-    // we don't have the logger here, shall we create one just for this message?
-    console.log(`TS build is disabled, expecting compiled js files in ${config.plugin.typescript.outDir} folder`)
-  }
 
-  // Set the location of the config
-  const server = await buildServer({
-    ...config,
-    configManager
-  })
+    let server = null
 
-  server.app.platformatic.configManager = configManager
-  server.app.platformatic.config = config
-  configManager.on('update', (newConfig) => onConfigUpdated(newConfig, server))
+    // Disable hot reload from the CLI
+    if (args.hotReload === false && configManager.current.plugins) {
+      configManager.current.plugins.hotReload = false
+    }
 
-  if (
-    config.plugin !== undefined &&
-    config.watch !== false
-  ) {
-    await startFileWatching(server)
-  }
+    try {
+      // Set the location of the config
+      server = await _buildServer({
+        ...config,
+        configManager
+      })
+    } catch (err) {
+      // TODO route this to a logger
+      console.error(err)
+      process.exit(1)
+    }
 
-  await server.listen()
+    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)
+    })
 
-  configManager.on('error', function (err) {
-    server.app.log.error({
-      err
-    }, 'error reloading the configuration')
-  })
+    if (
+      config.plugins !== undefined &&
+      config.watch !== false
+    ) {
+      await startFileWatching(server, args.hotReload)
+    }
 
-  // Ignore from CI because SIGUSR2 is not available
-  // on Windows
-  process.on('SIGUSR2', function () {
-    server.app.log.info('reloading configuration')
-    server.restart()
-      .catch((err) => {
+    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')
+        })
+      return false
+    })
+
+    close(async ({ signal, err }) => {
+      // Windows does not support trapping signals
+      if (err) {
         server.app.log.error({
           err: {
             message: err.message,
             stack: err.stack
           }
-        }, 'failed to restart')
-      })
-    return false
-  })
-
-  close(async ({ signal, err }) => {
-    // Windows does not support trapping signals
-    if (err) {
-      server.app.log.error({
-        err: {
-          message: err.message,
-          stack: err.stack
-        }
-      }, 'exiting')
-    } else if (signal) {
-      server.app.log.info({ signal }, 'received signal')
-    }
+        }, 'exiting')
+      } else if (signal) {
+        server.app.log.info({ signal }, 'received signal')
+      }
 
-    await server.stop()
-  })
+      await server.stop()
+    })
+  }
 }
 
-async function startFileWatching (server) {
+const start = buildStart(loadConfig, buildServer)
+
+async function startFileWatching (server, hotReload) {
   const configManager = server.app.platformatic.configManager
   const config = configManager.current
 
@@ -101,7 +126,7 @@ async function startFileWatching (server) {
     watchIgnore: config.watch?.ignore
   })
   fileWatcher.on('update', () => {
-    onFilesUpdated(server)
+    onFilesUpdated(server, hotReload)
   })
   fileWatcher.startWatching()
 
@@ -138,21 +163,24 @@ async function onConfigUpdated (newConfig, server) {
     }, 'failed to reload config')
   } finally {
     if (
-      newConfig.plugin !== undefined &&
-      newConfig.plugin.watch !== false
+      newConfig.plugins !== undefined &&
+      newConfig.plugins.watch !== false
     ) {
       await startFileWatching(server)
     }
   }
 }
 
-async function onFilesUpdated (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)
   } catch (err) {
     // TODO: test this

package/lib/utils.js

@@ -42,6 +42,10 @@ function addLoggerToTheConfig (config) {
 /* c8 ignore stop */
 
 function getJSPluginPath (configPath, tsPluginPath, compileDir) {
+  if (tsPluginPath.endsWith('js')) {
+    return tsPluginPath
+  }
+
   const tsPluginRelativePath = relative(dirname(configPath), tsPluginPath)
   const jsPluginRelativePath = join(
     dirname(tsPluginRelativePath),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.16.0",
+  "version": "0.17.1",
   "description": "",
   "main": "index.js",
   "author": "Matteo Collina <hello@matteocollina.com>",
@@ -15,27 +15,27 @@
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
     "bindings": "^1.5.0",
-    "c8": "^7.12.0",
+    "c8": "^7.13.0",
     "snazzy": "^9.0.0",
     "split2": "^4.1.0",
     "standard": "^17.0.0",
     "strip-ansi": "^7.0.1",
-    "tap": "^16.3.2",
-    "typescript": "^4.9.4",
-    "undici": "^5.14.0",
-    "vscode-json-languageservice": "^5.1.3",
+    "tap": "^16.3.4",
+    "typescript": "^4.9.5",
+    "undici": "^5.20.0",
+    "vscode-json-languageservice": "^5.3.0",
     "why-is-node-running": "^2.2.2",
-    "yaml": "^2.1.3"
+    "yaml": "^2.2.1"
   },
   "dependencies": {
     "@fastify/accepts": "^4.1.0",
-    "@fastify/autoload": "^5.6.0",
+    "@fastify/autoload": "^5.7.1",
     "@fastify/basic-auth": "^5.0.0",
     "@fastify/cors": "^8.2.0",
     "@fastify/deepmerge": "^1.3.0",
     "@fastify/restartable": "^1.4.0",
-    "@fastify/static": "^6.6.0",
-    "@fastify/swagger": "^8.2.1",
+    "@fastify/static": "^6.9.0",
+    "@fastify/swagger": "^8.3.1",
     "@fastify/under-pressure": "^8.2.0",
     "close-with-grace": "^1.1.0",
     "commist": "^3.2.0",
@@ -43,19 +43,19 @@
     "env-schema": "^5.2.0",
     "es-main": "^1.2.0",
     "execa": "^7.0.0",
-    "fastify": "^4.10.2",
-    "fastify-metrics": "^10.0.0",
-    "fastify-plugin": "^4.4.0",
+    "fastify": "^4.13.0",
+    "fastify-metrics": "^10.0.3",
+    "fastify-plugin": "^4.5.0",
     "fastify-sandbox": "^0.11.0",
     "graphql": "^16.6.0",
     "help-me": "^4.2.0",
-    "minimist": "^1.2.7",
-    "pino": "^8.8.0",
-    "pino-pretty": "^9.1.1",
+    "minimist": "^1.2.8",
+    "pino": "^8.11.0",
+    "pino-pretty": "^9.3.0",
     "rfdc": "^1.3.0",
-    "ua-parser-js": "^1.0.32",
-    "@platformatic/config": "0.16.0",
-    "@platformatic/utils": "0.16.0"
+    "ua-parser-js": "^1.0.33",
+    "@platformatic/utils": "0.17.1",
+    "@platformatic/config": "0.17.1"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -9,7 +9,7 @@ import { join } from 'desm'
 import { generateJsonSchemaConfig } from './lib/gen-schema.js'
 
 import start from './lib/start.mjs'
-import { compile } from './lib/compile.js'
+import { compileCmd } from './lib/compile.js'
 
 const help = helpMe({
   dir: join(import.meta.url, 'help'),
@@ -23,7 +23,7 @@ program.register('help', help.toStdout)
 program.register('help start', help.toStdout.bind(null, ['start']))
 
 program.register('start', start)
-program.register('compile', compile)
+program.register('compile', compileCmd)
 program.register('schema config', generateJsonSchemaConfig)
 program.register('schema', help.toStdout.bind(null, ['schema']))
 

package/test/autoload.test.js

@@ -12,8 +12,8 @@ test('autoload & filesystem based routing / watch disabled', async ({ teardown,
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: {
-      path: join(__dirname, 'fixtures', 'directories', 'routes')
+    plugins: {
+      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
     },
     watch: false,
     metrics: false
@@ -51,8 +51,8 @@ test('autoload & filesystem based routing / watch enabled', async ({ teardown, e
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: {
-      path: join(__dirname, 'fixtures', 'directories', 'routes')
+    plugins: {
+      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
     },
     watch: true,
     metrics: false
@@ -90,11 +90,13 @@ test('multiple files', async ({ teardown, equal }) => {
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: [{
-      path: join(__dirname, 'fixtures', 'directories', 'plugins')
-    }, {
-      path: join(__dirname, 'fixtures', 'directories', 'routes')
-    }],
+    plugins: {
+      paths: [{
+        path: join(__dirname, 'fixtures', 'directories', 'plugins')
+      }, {
+        path: join(__dirname, 'fixtures', 'directories', 'routes')
+      }]
+    },
     watch: true,
     metrics: false
   }
@@ -138,11 +140,13 @@ test('multiple files / watch false', async ({ teardown, equal }) => {
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: [{
-      path: join(__dirname, 'fixtures', 'directories', 'plugins')
-    }, {
-      path: join(__dirname, 'fixtures', 'directories', 'routes')
-    }],
+    plugins: {
+      paths: [{
+        path: join(__dirname, 'fixtures', 'directories', 'plugins')
+      }, {
+        path: join(__dirname, 'fixtures', 'directories', 'routes')
+      }]
+    },
     watch: false,
     metrics: false
   }
@@ -186,7 +190,9 @@ test('autoload & filesystem based routing / watch disabled / no object', async (
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: join(__dirname, 'fixtures', 'directories', 'routes'),
+    plugins: {
+      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
+    },
     watch: false,
     metrics: false
   }
@@ -223,7 +229,9 @@ test('autoload & filesystem based routing / watch enabled / no object', async ({
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: join(__dirname, 'fixtures', 'directories', 'routes'),
+    plugins: {
+      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
+    },
     watch: true,
     metrics: false
   }
@@ -260,7 +268,9 @@ test('multiple files / no object', async ({ teardown, equal }) => {
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: [join(__dirname, 'fixtures', 'directories', 'plugins'), join(__dirname, 'fixtures', 'directories', 'routes')],
+    plugins: {
+      paths: [join(__dirname, 'fixtures', 'directories', 'plugins'), join(__dirname, 'fixtures', 'directories', 'routes')]
+    },
     watch: true,
     metrics: false
   }
@@ -304,10 +314,12 @@ test('multiple files / watch false / no object', async ({ teardown, equal }) =>
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: [
-      join(__dirname, 'fixtures', 'directories', 'plugins'),
-      join(__dirname, 'fixtures', 'directories', 'routes')
-    ],
+    plugins: {
+      paths: [
+        join(__dirname, 'fixtures', 'directories', 'plugins'),
+        join(__dirname, 'fixtures', 'directories', 'routes')
+      ]
+    },
     watch: false,
     metrics: false
   }

package/test/cli/compile.test.mjs

@@ -37,7 +37,7 @@ t.test('should compile typescript plugin', async (t) => {
   t.pass()
 })
 
-t.test('should compile typescript plugin even if build is `false`', async (t) => {
+t.test('should compile typescript plugin even if typescript is `false`', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
   const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-2')
 
@@ -84,8 +84,10 @@ t.test('should compile typescript plugin with start command', async (t) => {
 
   const splitter = split()
   child.stdout.pipe(splitter)
+  child.stderr.pipe(process.stderr)
 
   for await (const data of splitter) {
+    console.log(data)
     const sanitized = stripAnsi(data)
     if (sanitized.includes('Typescript plugin loaded')) {
       t.pass()
@@ -102,6 +104,8 @@ t.test('should not compile bad typescript plugin', async (t) => {
     await execa('node', [cliPath, 'compile'], { cwd })
     t.fail('should not compile bad typescript plugin')
   } catch (err) {
+    t.comment(err.stdout)
+    t.comment(err.stderr)
     t.equal(err.stdout.includes('Found 1 error in plugin.ts'), true)
   }
 
@@ -129,6 +133,8 @@ t.test('missing tsconfig file', async (t) => {
     await execa('node', [cliPath, 'compile'], { cwd })
     t.fail('should not compile typescript plugin')
   } catch (err) {
+    t.comment(err.stdout)
+    t.comment(err.stderr)
     t.equal(err.stdout.includes('The tsconfig.json file was not found.'), true)
   }
 
@@ -148,7 +154,7 @@ t.test('start command should not compile typescript plugin with errors', async (
     await childProcess
     t.fail('should not compile bad typescript plugin')
   } catch (err) {
-    t.equal(err.stdout.includes('Found 1 error'), true)
+    t.equal(err.stderr.includes('Found 1 error'), true)
     childProcess.kill('SIGINT')
   }
 
@@ -177,11 +183,12 @@ t.test('should not compile typescript plugin with start without tsconfig', async
     t.teardown(() => child.kill('SIGINT'))
     t.fail('should not compile typescript plugin with start without tsconfig')
   } catch (err) {
+    t.comment(err.stdout)
     t.equal(err.stdout.includes('The tsconfig.json file was not found.'), true)
   }
 })
 
-t.test('start command should not compile typescript if `build` is false', async (t) => {
+t.test('start command should not compile typescript if `typescript` is false', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
   const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-6')
 
@@ -234,8 +241,10 @@ t.test('should compile typescript plugin with start command with different cwd',
 
   const splitter = split()
   child.stdout.pipe(splitter)
+  child.stderr.pipe(process.stderr)
 
   for await (const data of splitter) {
+    console.log(data)
     const sanitized = stripAnsi(data)
     if (sanitized.includes('Typescript plugin loaded')) {
       t.pass()

package/test/cli/gen-schema.test.mjs

@@ -6,6 +6,8 @@ import { generateJsonSchemaConfig } from '../../lib/gen-schema.js'
 import { join } from 'path'
 import jsonLanguageService from 'vscode-json-languageservice'
 
+const pkg = JSON.parse(await fs.readFile('../../package.json', 'utf8'))
+
 test('generateJsonSchemaConfig generates the file', async (t) => {
   const tmpDir = await mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
   process.chdir(tmpDir)
@@ -17,7 +19,7 @@ test('generateJsonSchemaConfig generates the file', async (t) => {
   t.has(required, ['server'])
   t.has(additionalProperties, { watch: {} })
   const { $id, type } = schema
-  t.equal($id, 'https://schemas.platformatic.dev/service')
+  t.equal($id, `https://platformatic.dev/schemas/v${pkg.version}/service`)
   t.equal(type, 'object')
 
   const languageservice = jsonLanguageService.getLanguageService({
@@ -29,7 +31,7 @@ test('generateJsonSchemaConfig generates the file', async (t) => {
   languageservice.configure({ allowComments: false, schemas: [{ fileMatch: ['*.data.json'], uri: $id }] })
 
   const jsonContent = `{
-    "$schema": "https://schemas.platformatic.dev/service",
+    "$schema": "https://platformatic.dev/schemas/v${pkg.version}/service",
     "server": {
       "hostname": "127.0.0.1",
       "port": 3000

package/test/cli/watch.test.mjs

@@ -30,8 +30,8 @@ test('should watch js files by default', async ({ equal, teardown }) => {
       port: 0
     },
     watch: true,
-    plugin: {
-      path: pluginFilePath
+    plugins: {
+      paths: [pluginFilePath]
     }
   }
 
@@ -69,8 +69,8 @@ test('should watch allowed file', async ({ comment, teardown }) => {
     watch: {
       allow: ['*.js', '*.json']
     },
-    plugin: {
-      path: pluginFilePath
+    plugins: {
+      paths: [pluginFilePath]
     }
   }
 
@@ -115,8 +115,8 @@ test('should not watch ignored file', async ({ teardown, equal }) => {
     watch: {
       ignore: [basename(pluginFilePath)]
     },
-    plugin: {
-      path: pluginFilePath
+    plugins: {
+      paths: [pluginFilePath]
     }
   }
 
@@ -152,8 +152,8 @@ test('should not loop forever when doing ESM', async ({ comment, fail }) => {
     watch: {
       ignore: [basename(pluginFilePath)]
     },
-    plugin: {
-      path: pluginFilePath
+    plugins: {
+      paths: [pluginFilePath]
     }
   }
 
@@ -196,8 +196,8 @@ test('should watch config file', async ({ comment, teardown }) => {
     watch: {
       allow: ['*.js', '*.json']
     },
-    plugin: {
-      path: pluginFilePath
+    plugins: {
+      paths: [pluginFilePath]
     }
   }
 
@@ -209,11 +209,13 @@ test('should watch config file', async ({ comment, teardown }) => {
       hostname: '127.0.0.1',
       port: 0
     },
-    plugin: {
-      path: pluginFilePath,
-      options: {
-        log: true
-      }
+    plugins: {
+      paths: [{
+        path: pluginFilePath,
+        options: {
+          log: true
+        }
+      }]
     }
   }
 
@@ -238,3 +240,45 @@ test('should watch config file', async ({ comment, teardown }) => {
     if (log.msg === 'RESTARTED') break
   }
 })
+
+test('should not hot reload files with `--hot-reload false`', 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
+    },
+    plugins: {
+      paths: [pluginFilePath]
+    }
+  }
+
+  await Promise.all([
+    writeFile(configFilePath, JSON.stringify(config)),
+    writeFile(pluginFilePath, createLoggingPlugin('v1'))
+  ])
+
+  const { child, url } = await start('-c', configFilePath, '--hot-reload', 'false')
+  teardown(() => child.kill('SIGINT'))
+
+  {
+    const res = await request(`${url}/version`)
+    const version = await res.body.text()
+    equal(version, 'v1')
+  }
+
+  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+  await sleep(5000)
+
+  {
+    const res = await request(`${url}/version`)
+    const version = await res.body.text()
+    equal(version, 'v1')
+  }
+})