@platformatic/service 0.26.1 → 0.28.1

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')
-})

package/test/watch.test.js

@@ -1,248 +0,0 @@
-'use strict'
-
-const { join } = require('path')
-const { tmpdir } = require('os')
-const { writeFile, mkdtemp, rm } = require('fs/promises')
-
-const { test } = require('tap')
-const { request } = require('undici')
-
-const { buildServer } = require('..')
-require('./helper')
-
-test('should stop watching files after disabling watch option', async ({ teardown, equal, pass, same }) => {
-  const tmpDir = await mkdtemp(join(tmpdir(), 'platformatic.service.test-'))
-  const pathToPlugin = join(tmpDir, 'plugin.js')
-  const pathToConfig = join(tmpDir, 'platformatic.service.json')
-
-  teardown(async () => {
-    await rm(tmpDir, { recursive: true, force: true })
-  })
-
-  await writeFile(pathToPlugin, `
-    module.exports = 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: true
-    },
-    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')
-  }
-
-  equal(app.fileWatcher.isWatching, true)
-
-  await app.platformatic.configManager.update({ ...config, watch: false })
-  await app.restart()
-
-  await writeFile(pathToPlugin, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`)
-
-  // wait to be sure that app is not watching files anymore
-  await new Promise((resolve) => setTimeout(resolve, 5000))
-
-  equal(app.fileWatcher, undefined)
-
-  {
-    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('should stop watching typescript files after disabling watch option', async ({ teardown, equal, ok, same }) => {
-  const tmpDir = await mkdtemp(join(tmpdir(), 'platformatic.service.test-'))
-  const pathToPlugin = join(tmpDir, 'plugin.ts')
-  const pathToConfig = join(tmpDir, 'platformatic.service.json')
-  const pathToTsConfig = join(tmpDir, 'tsconfig.json')
-
-  teardown(async () => {
-    await rm(tmpDir, { recursive: true, force: true })
-  })
-
-  const tsConfig = {
-    compilerOptions: {
-      module: 'commonjs',
-      esModuleInterop: true,
-      target: 'es6',
-      moduleResolution: 'node',
-      sourceMap: true,
-      pretty: true,
-      noEmitOnError: true,
-      outDir: 'dist'
-    },
-    watchOptions: {
-      watchFile: 'fixedPollingInterval',
-      watchDirectory: 'fixedPollingInterval',
-      fallbackPolling: 'dynamicPriority',
-      synchronousWatchDirectory: true,
-      excludeDirectories: [
-        '**/node_modules',
-        'dist'
-      ]
-    }
-  }
-
-  await writeFile(pathToPlugin, `
-    export 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: true,
-      typescript: true
-    },
-    watch: true,
-    metrics: false
-  }
-
-  await writeFile(pathToConfig, JSON.stringify(config, null, 2))
-  await writeFile(pathToTsConfig, JSON.stringify(tsConfig, 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')
-  }
-
-  ok(app.tsCompilerWatcher)
-
-  await app.platformatic.configManager.update({ ...config, watch: false })
-  await app.restart()
-
-  await writeFile(pathToPlugin, `
-    export default async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`)
-
-  // wait to be sure that app is not watching files anymore
-  await new Promise((resolve) => setTimeout(resolve, 10000))
-
-  equal(app.tsCompilerWatcher, undefined)
-
-  {
-    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('should watch files by default', async ({ teardown, equal, pass, same }) => {
-  const tmpDir = await mkdtemp(join(tmpdir(), 'platformatic.service.test-'))
-  const pathToPlugin = join(tmpDir, 'plugin.js')
-  const pathToConfig = join(tmpDir, 'platformatic.service.json')
-
-  teardown(async () => {
-    await rm(tmpDir, { recursive: true, force: true })
-  })
-
-  await writeFile(pathToPlugin, `
-    module.exports = 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: 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')
-  }
-
-  equal(app.fileWatcher.isWatching, true)
-
-  await writeFile(pathToPlugin, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`)
-
-  // wait to be sure that app is not watching files anymore
-  await new Promise((resolve) => setTimeout(resolve, 5000))
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 2' })
-  }
-})