@platformatic/service 0.27.0 → 0.28.1

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

@@ -4,12 +4,13 @@ require('./helper')
 const { test } = require('tap')
 const { buildServer } = require('..')
 const { request, setGlobalDispatcher, getGlobalDispatcher, MockAgent } = require('undici')
+const { randomUUID } = require('crypto')
 const { join } = require('path')
 const os = require('os')
 const { writeFile } = require('fs/promises')
 
 test('load and reload', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
+  const file = join(os.tmpdir(), `some-plugin-${randomUUID()}.js`)
 
   await writeFile(file, `
     module.exports = async function (app) {
@@ -50,12 +51,13 @@ test('load and reload', async ({ teardown, equal, pass, same }) => {
   {
     const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
+    // The plugin is in Node's module cache, so the new value is not seen.
+    same(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
   }
 })
 
 test('error', async ({ teardown, equal, pass, match }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
+  const file = join(os.tmpdir(), `some-plugin-${randomUUID()}.js`)
 
   await writeFile(file, `
     module.exports = async function (app) {
@@ -132,52 +134,6 @@ test('mock undici is supported', async ({ teardown, equal, pass, same }) => {
   })
 })
 
-test('load and reload with the fallback', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
-
-  await writeFile(file, `
-    module.exports = async function (app) {
-    }`
-  )
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file],
-      stopTimeout: 1000,
-      fallback: true
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-
-  await writeFile(file, `
-    module.exports = async function (app) {
-      app.get('/', () => "hello world" )
-    }`)
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
-  }
-})
-
 test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `some-plugin-${process.pid}.mjs`)
 
@@ -218,234 +174,7 @@ test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
   {
     const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
-  }
-})
-
-test('server should be available after reload a compromised plugin', async ({ teardown, equal, pass, same, rejects }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
-
-  const workingModule = `
-    module.exports = async function (app) {
-      (() => { /* console.log('loaded') */ })()
-    }`
-  const compromisedModule = '//console.log(\'loaded but server fails\')'
-  await writeFile(file, workingModule)
-
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file]
-    }
-  }
-
-  const app = await buildServer(config)
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  await writeFile(file, compromisedModule)
-  await app.restart().catch(() => {
-    pass('plugin reload failed')
-  })
-
-  {
-    const res = await request(`${app.url}/`, { method: 'GET' })
-    equal(res.statusCode, 200, 'status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-
-  await writeFile(file, workingModule)
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/`, { method: 'GET' })
-    equal(res.statusCode, 200, 'add status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-})
-
-test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.js`)
-
-  await writeFile(file, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 1"}
-      })
-    }`
-  )
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file],
-      hotReload: false
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-
-  await writeFile(file, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-})
-
-test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
-  const pathToPlugin = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.mjs`)
-  const pathToConfig = join(os.tmpdir(), `platformatic.service.${process.pid}.json`)
-
-  await writeFile(pathToPlugin, `
-    export default async function (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 1"}
-      })
-    }`
-  )
-
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [pathToPlugin],
-      stopTimeout: 1000,
-      hotReload: false
-    },
-    watch: true,
-    metrics: false
-  }
-  await writeFile(pathToConfig, JSON.stringify(config, null, 2))
-  const app = await buildServer(pathToConfig)
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-
-  await writeFile(pathToPlugin, `
-    export default async function (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-})
-
-test('hot reload disabled, with default export', async ({ teardown, equal, pass, same }) => {
-  const pathToPlugin = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.js`)
-  const pathToConfig = join(os.tmpdir(), `platformatic.service.${process.pid}.json`)
-
-  await writeFile(pathToPlugin, `
-    Object.defineProperty(exports, "__esModule", { value: true })
-    exports.default = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 1"}
-      })
-    }`)
-
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [pathToPlugin],
-      stopTimeout: 1000,
-      hotReload: false
-    },
-    watch: true,
-    metrics: false
-  }
-
-  await writeFile(pathToConfig, JSON.stringify(config, null, 2))
-  const app = await buildServer(pathToConfig)
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-
-  await writeFile(pathToPlugin, `
-    Object.defineProperty(exports, "__esModule", { value: true })
-    exports.default = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
+    // The plugin is in Node's module cache, so the new value is not seen.
+    same(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
   }
 })

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2019",
+    "outDir": "build",
+    "sourceMap": true,
+    "strictNullChecks": true
+  }
+}

package/lib/plugins/file-watcher.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const { FileWatcher } = require('@platformatic/utils')
-const fp = require('fastify-plugin')
-
-async function setupFileWatcher (app, opts) {
-  // 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
-
-  let fileWatcher = persistentRef.fileWatcher
-  if (!fileWatcher) {
-    fileWatcher = new FileWatcher({
-      path: configManager.dirname,
-      allowToWatch: config.watch?.allow,
-      watchIgnore: config.watch?.ignore
-    })
-
-    fileWatcher.on('update', () => {
-      opts.onFilesUpdated(persistentRef)
-    })
-
-    app.log.debug('start watching files')
-    fileWatcher.startWatching()
-  }
-
-  app.decorate('fileWatcher', fileWatcher)
-
-  app.addHook('onClose', async () => {
-    if (!isRestartableApp || app.closingRestartable) {
-      app.fileWatcher.stopWatching()
-      app.log.debug('stop watching files')
-    }
-  })
-}
-
-module.exports = fp(setupFileWatcher)

package/test/cli/watch.test.mjs

@@ -1,289 +0,0 @@
-import os from 'os'
-import { join, basename } from 'path'
-import { writeFile, mkdtemp } from 'fs/promises'
-import t, { test } from 'tap'
-import { request } from 'undici'
-import { setTimeout as sleep } from 'timers/promises'
-import { start } from './helper.mjs'
-
-t.jobs = 5
-
-function createLoggingPlugin (text, reloaded = false) {
-  return `\
-    module.exports = async (app) => {
-      app.log.info({ reloaded: ${reloaded}, text: '${text}' }, 'debugme')
-      if (${reloaded}) {
-        app.log.info('RELOADED')
-      }
-      app.get('/version', () => '${text}')
-    }
-  `
-}
-
-test('should watch js files by default', async ({ equal, teardown, comment }) => {
-  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
-  comment(`using ${tmpDir}`)
-  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
-    },
-    watch: true,
-    plugins: {
-      paths: [pluginFilePath]
-    }
-  }
-
-  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', true))
-
-  for await (const log of child.ndj) {
-    if (log.msg === 'RELOADED') break
-  }
-
-  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
-    },
-    watch: {
-      allow: ['*.js', '*.json']
-    },
-    plugins: {
-      paths: [pluginFilePath]
-    }
-  }
-
-  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
-    },
-    watch: {
-      ignore: [basename(pluginFilePath)]
-    },
-    plugins: {
-      paths: [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', true))
-
-  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', 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
-    },
-    watch: {
-      ignore: [basename(pluginFilePath)]
-    },
-    plugins: {
-      paths: [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
-    },
-    watch: {
-      allow: ['*.js', '*.json']
-    },
-    plugins: {
-      paths: [pluginFilePath]
-    }
-  }
-
-  const config2 = {
-    server: {
-      logger: {
-        level: 'info'
-      },
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        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
-  }
-})
-
-test('should not fail when updating wrong config', async ({ equal, teardown, comment }) => {
-  const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
-  comment(`using ${tmpDir}`)
-  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
-    },
-    plugins: {
-      paths: [pluginFilePath]
-    },
-    watch: true
-  }
-
-  await Promise.all([
-    writeFile(configFilePath, JSON.stringify(defaultConfig)),
-    writeFile(pluginFilePath, createLoggingPlugin('v1', true))
-  ])
-
-  const { child, url } = await start(['-c', configFilePath])
-  teardown(() => child.kill('SIGINT'))
-
-  writeFile(configFilePath, 'this is not a valid config')
-
-  for await (const log of child.ndj) {
-    if (log.msg === 'failed to reload server') break
-  }
-
-  const res = await request(`${url}/version`)
-  const version = await res.body.text()
-  equal(version, 'v1')
-})