@platformatic/service 0.22.0 → 0.23.1

package/test/cli/compile.test.mjs

@@ -32,23 +32,28 @@ t.test('should compile typescript plugin', async (t) => {
 
   await cp(testDir, cwd, { recursive: true })
 
-  try {
-    const child = await execa('node', [cliPath, 'compile'], { cwd })
-    t.equal(child.stdout.includes('Typescript compilation completed successfully.'), true)
-  } catch (err) {
-    console.log(err.stdout)
-    console.log(err.stderr)
-    t.fail(err.stderr)
-  }
+  const child = execa('node', [cliPath, 'compile'], { cwd })
 
-  const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
-  try {
-    await access(jsPluginPath)
-  } catch (err) {
-    t.fail(err)
-  }
+  t.teardown(exitOnTeardown(child))
 
-  t.pass()
+  const splitter = split()
+  child.stdout.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Typescript compilation completed successfully.')) {
+      const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
+      try {
+        await access(jsPluginPath)
+      } catch (err) {
+        t.fail(err)
+      }
+
+      t.pass()
+      return
+    }
+  }
+  t.fail('should compile typescript plugin with a compile command')
 })
 
 t.test('should compile typescript plugin even if typescript is `false`', async (t) => {
@@ -57,23 +62,28 @@ t.test('should compile typescript plugin even if typescript is `false`', async (
 
   await cp(testDir, cwd, { recursive: true })
 
-  try {
-    const child = await execa('node', [cliPath, 'compile'], { cwd })
-    t.equal(child.stdout.includes('Typescript compilation completed successfully.'), true)
-  } catch (err) {
-    console.log(err.stdout)
-    console.log(err.stderr)
-    t.fail(err.stderr)
-  }
+  const child = execa('node', [cliPath, 'compile'], { cwd })
 
-  const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
-  try {
-    await access(jsPluginPath)
-  } catch (err) {
-    t.fail(err)
-  }
+  t.teardown(exitOnTeardown(child))
 
-  t.pass()
+  const splitter = split()
+  child.stdout.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Typescript compilation completed successfully.')) {
+      const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
+      try {
+        await access(jsPluginPath)
+      } catch (err) {
+        t.fail(err)
+      }
+
+      t.pass()
+      return
+    }
+  }
+  t.fail('should compile typescript plugin with a compile command')
 })
 
 t.test('should compile typescript plugin with start command', async (t) => {
@@ -84,8 +94,6 @@ t.test('should compile typescript plugin with start command', async (t) => {
 
   const child = execa('node', [cliPath, 'start'], { cwd })
 
-  t.teardown(exitOnTeardown(child))
-
   const splitter = split()
   child.stdout.pipe(splitter)
 
@@ -156,7 +164,11 @@ 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.stderr.includes('Found 1 error'), true)
+    if (!err.stderr.includes('Found 1 error')) {
+      t.comment(err.stdout)
+      t.comment(err.stderr)
+      t.fail('should throw one ts error')
+    }
     childProcess.kill('SIGINT')
   }
 

package/test/cli/watch.test.mjs

@@ -291,3 +291,42 @@ test('should not hot reload files with `--hot-reload false`', async ({ teardown,
     equal(version, 'v1')
   }
 })
+
+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: false
+  }
+
+  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 === 'error reloading the configuration') break
+  }
+
+  const res = await request(`${url}/version`)
+  const version = await res.body.text()
+  equal(version, 'v1')
+})

package/test/clients.test.js

@@ -8,30 +8,38 @@ const { request } = require('undici')
 const { compile } = require('../lib/compile')
 const { rmdir } = require('fs/promises')
 
-test('client is loaded', async ({ teardown, equal, pass, same, comment }) => {
-  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
-  await server1.listen()
+test('client is loaded', async ({ teardown, equal, same }) => {
+  const app1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
 
-  process.env.PLT_CLIENT_URL = server1.url
+  teardown(async () => {
+    await app1.close()
+  })
+  await app1.start()
 
-  const server2 = await buildServer(join(__dirname, '..', 'fixtures', 'hello-client', 'platformatic.service.json'))
+  process.env.PLT_CLIENT_URL = app1.url
+
+  const app2 = await buildServer(join(__dirname, '..', 'fixtures', 'hello-client', 'platformatic.service.json'))
 
   teardown(async () => {
-    await server2.stop()
-    await server1.stop()
+    await app2.close()
   })
-  await server2.listen()
-  const res = await request(`${server2.url}/`)
+  await app2.start()
+
+  const res = await request(`${app2.url}/`)
   equal(res.statusCode, 200, 'status code')
   const data = await res.body.json()
   same(data, { hello: 'world' })
 })
 
 test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
-  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
-  await server1.listen()
+  const app1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
+
+  teardown(async () => {
+    await app1.close()
+  })
+  await app1.start()
 
-  process.env.PLT_CLIENT_URL = server1.url
+  process.env.PLT_CLIENT_URL = app1.url
 
   const targetDir = join(__dirname, '..', 'fixtures', 'hello-client-ts')
 
@@ -41,14 +49,13 @@ test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
 
   await compile(targetDir, { server: { logger: { level: 'warn' } } })
 
-  const server2 = await buildServer(join(targetDir, 'platformatic.service.json'))
+  const app2 = await buildServer(join(targetDir, 'platformatic.service.json'))
   teardown(async () => {
-    await server2.stop()
-    await server1.stop()
+    await app2.close()
   })
-  await server2.listen()
+  await app2.start()
 
-  const res = await request(`${server2.url}/`)
+  const res = await request(`${app2.url}/`)
   equal(res.statusCode, 200, 'status code')
   const data = await res.body.json()
   same(data, { hello: 'world' })

package/test/config.test.js

@@ -3,6 +3,7 @@
 require('./helper')
 const { test } = require('tap')
 const { buildServer } = require('..')
+const { loadConfig } = require('../lib/load-config')
 const { request } = require('undici')
 const { join } = require('path')
 const os = require('os')
@@ -16,7 +17,7 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
       app.get('/', () => options.message)
     }`)
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -31,16 +32,19 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
     },
     metrics: false
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'hello', 'response')
   }
 
-  await server.app.platformatic.configManager.update({
+  await app.platformatic.configManager.update({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -56,10 +60,10 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
     metrics: false
   })
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'ciao mondo', 'response')
   }
@@ -90,17 +94,20 @@ test('config reloads from a written file', async ({ teardown, equal, pass, same
       app.get('/', () => options.message)
     }`)
 
-  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, 'add status code')
     same(await res.body.text(), 'hello', 'response')
   }
 
-  await server.app.platformatic.configManager.update({
+  await app.platformatic.configManager.update({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -116,10 +123,10 @@ test('config reloads from a written file', async ({ teardown, equal, pass, same
     metrics: false
   })
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'ciao mondo', 'response')
   }
@@ -173,25 +180,28 @@ test('config reloads from a written file from a route', async ({ teardown, equal
       })
     }`)
 
-  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, 'add status code')
     same(await res.body.text(), 'hello', 'response')
   }
 
   {
-    const res = await request(`${server.url}/restart`, {
+    const res = await request(`${app.url}/restart`, {
       method: 'POST'
     })
     equal(res.statusCode, 200, 'add status code')
   }
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'ciao mondo', 'response')
   }
@@ -234,7 +244,7 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
       app.get('/', () => options.message)
     }`)
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -249,16 +259,19 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
     },
     metrics: false
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'hello', 'response')
   }
 
-  await server.app.platformatic.configManager.update({
+  await app.platformatic.configManager.update({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -274,79 +287,38 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
     metrics: false
   })
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/`)
+    const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
     same(await res.body.text(), 'ciao mondo', 'response')
   }
 })
 
-test('restart throws if config is invalid', async ({ teardown, rejects }) => {
-  const server = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
+test('can merge provided config with default config', async ({ plan, same }) => {
+  plan(6)
+  const configFile = join(__dirname, 'fixtures', 'custom-port-placeholder.json')
+  const defaultConfig = {
+    mergeDefaults: true,
+    onMissingEnv (key) {
+      same(key, 'A_CUSTOM_PORT')
+      return '42'
     }
-  })
-  teardown(server.stop)
-  await server.listen()
-
-  await rejects(server.restart({ foo: 'bar' }))
-})
-
-test('config reloads by calling restart', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `${process.pid}-1.js`)
-
-  await writeFile(file, `
-    module.exports = async function (app, options) {
-      app.get('/', () => options.message)
-    }`)
-
-  const server = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        path: file,
-        options: {
-          message: 'hello'
-        }
-      }]
-    },
-    metrics: false
-  })
-  teardown(server.stop)
-  await server.listen()
+  }
 
   {
-    const res = await request(`${server.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello', 'response')
+    const config = await loadConfig({}, ['-c', configFile], defaultConfig)
+    same(config.configManager.current.server.port, 42)
+    // This comes from the default config.
+    same(config.configManager.schemaOptions.useDefaults, true)
   }
 
-  await server.restart({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        path: file,
-        options: {
-          message: 'ciao mondo'
-        }
-      }]
-    },
-    metrics: false
-  })
-
   {
-    const res = await request(`${server.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'ciao mondo', 'response')
+    defaultConfig.mergeDefaults = false
+    const config = await loadConfig({}, ['-c', configFile], defaultConfig)
+    same(config.configManager.current.server.port, 42)
+    // This comes from the default config.
+    same(config.configManager.schemaOptions.useDefaults, undefined)
   }
 })

package/test/cors.test.js

@@ -6,7 +6,7 @@ const { buildServer, platformaticService } = require('..')
 const { request } = require('undici')
 
 test('CORS is disabled by default', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -18,9 +18,12 @@ test('CORS is disabled by default', async ({ teardown, equal, pass, same }) => {
   })
 
   // handles login
-  teardown(server.stop)
-  await server.listen()
-  const res = await (request(`${server.url}/login`, {
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await (request(`${app.url}/login`, {
     method: 'OPTIONS',
     headers: {
       'Access-Control-Request-Method': 'POST',
@@ -31,7 +34,7 @@ test('CORS is disabled by default', async ({ teardown, equal, pass, same }) => {
 })
 
 test('CORS can be enabled', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -45,11 +48,14 @@ test('CORS can be enabled', async ({ teardown, equal, pass, same }) => {
     app.register(platformaticService, opts)
     app.post('/login', (req, reply) => {})
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -63,7 +69,7 @@ test('CORS can be enabled', async ({ teardown, equal, pass, same }) => {
 })
 
 test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -79,11 +85,14 @@ test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
     app.register(platformaticService, opts)
     app.post('/login', (req, reply) => {})
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -96,7 +105,7 @@ test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -109,7 +118,7 @@ test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -123,7 +132,7 @@ test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
 })
 
 test('CORS with an array of strings', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -137,11 +146,14 @@ test('CORS with an array of strings', async ({ teardown, equal, pass, same }) =>
     app.register(platformaticService, opts)
     app.post('/login', (req, reply) => {})
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -154,7 +166,7 @@ test('CORS with an array of strings', async ({ teardown, equal, pass, same }) =>
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -167,7 +179,7 @@ test('CORS with an array of strings', async ({ teardown, equal, pass, same }) =>
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -181,7 +193,7 @@ test('CORS with an array of strings', async ({ teardown, equal, pass, same }) =>
 })
 
 test('CORS with an array and a regexp', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -197,11 +209,14 @@ test('CORS with an array and a regexp', async ({ teardown, equal, pass, same })
     app.register(platformaticService, opts)
     app.post('/login', (req, reply) => {})
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -214,7 +229,7 @@ test('CORS with an array and a regexp', async ({ teardown, equal, pass, same })
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -227,7 +242,7 @@ test('CORS with an array and a regexp', async ({ teardown, equal, pass, same })
   }
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',
@@ -241,7 +256,7 @@ test('CORS with an array and a regexp', async ({ teardown, equal, pass, same })
 })
 
 test('CORS with a string', async ({ teardown, equal, pass, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -255,11 +270,14 @@ test('CORS with a string', async ({ teardown, equal, pass, same }) => {
     app.register(platformaticService, opts)
     app.post('/login', (req, reply) => {})
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await (request(`${server.url}/_admin/login`, {
+    const res = await (request(`${app.url}/_admin/login`, {
       method: 'OPTIONS',
       headers: {
         'Access-Control-Request-Method': 'POST',