@platformatic/service 0.21.1 → 0.23.0

package/test/autoload.test.js

@@ -19,26 +19,28 @@ test('autoload & filesystem based routing / watch disabled', async ({ teardown,
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -58,26 +60,28 @@ test('autoload & filesystem based routing / watch enabled', async ({ teardown, e
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -101,33 +105,35 @@ test('multiple files', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -151,33 +157,35 @@ test('multiple files / watch false', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -197,26 +205,28 @@ test('autoload & filesystem based routing / watch disabled / no object', async (
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -236,26 +246,28 @@ test('autoload & filesystem based routing / watch enabled / no object', async ({
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
@@ -275,33 +287,35 @@ test('multiple files / no object', async ({ teardown, equal }) => {
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -324,33 +338,35 @@ test('multiple files / watch false / no object', async ({ teardown, equal }) =>
     metrics: false
   }
 
-  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, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from root', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/bar`)
+    const res = await request(`${app.url}/foo/bar`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from bar', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'from baz', 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/with-decorator`)
+    const res = await request(`${app.url}/foo/with-decorator`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     equal(body.hello, 'bar', 'body')
@@ -380,33 +396,35 @@ test('nested directories', async ({ teardown, equal, same }) => {
     }
   }
 
-  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}/inventory/product/42`)
+    const res = await request(`${app.url}/inventory/product/42`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     same(body, { sku: 42, inStore: 2 }, 'body')
   }
 
   {
-    const res = await request(`${server.url}/catalogue/products`)
+    const res = await request(`${app.url}/catalogue/products`)
     equal(res.statusCode, 200, 'status code')
     const body = await res.body.json()
     same(body, [{ sku: 42, name: 'foo', inStore: 2 }, { sku: 43, name: 'bar', inStore: 0 }], 'body')
   }
 
   {
-    const res = await request(`${server.url}/foo/baz`)
+    const res = await request(`${app.url}/foo/baz`)
     equal(res.statusCode, 404, 'status code')
     const body = await res.body.text()
     equal(body, 'I\'m sorry, I couldn\'t find what you were looking for.')
   }
 
   {
-    const res = await request(`${server.url}/catalogue/error`)
+    const res = await request(`${app.url}/catalogue/error`)
     equal(res.statusCode, 500, 'status code')
     const body = await res.body.text()
     equal(body, 'I\'m sorry, there was an error processing your request.')

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,14 +94,10 @@ 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)
-  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()
@@ -158,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')
   }
 
@@ -228,7 +238,6 @@ t.test('should compile typescript plugin with start command with different cwd',
   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/start.test.mjs

@@ -30,6 +30,19 @@ test('start command', async ({ equal, same, match, teardown }) => {
   child.kill('SIGINT')
 })
 
+test('allow custom env properties', async ({ equal, same, match, teardown }) => {
+  process.env.A_CUSTOM_PORT = '11111'
+  const { child, url } = await start('start', '-c', join(import.meta.url, '..', 'fixtures', 'custom-port-placeholder.json'), '--allow-env=A_CUSTOM_PORT')
+  equal(url, 'http://127.0.0.1:11111', 'A_CUSTOM_PORT env variable has been used')
+  const res = await request(`${url}`)
+  equal(res.statusCode, 200)
+  const body = await res.body.json()
+  match(body, {}, 'response')
+
+  child.kill('SIGINT')
+  delete process.env.A_CUSTOM_PORT
+})
+
 test('default logger', async ({ equal, same, match, teardown }) => {
   const { child, url } = await start('-c', join(import.meta.url, '..', '..', 'fixtures', 'hello', 'no-server-logger.json'))
   match(url, /http:\/\/127.0.0.1:[0-9]+/)
@@ -38,7 +51,6 @@ test('default logger', async ({ equal, same, match, teardown }) => {
 
 test('plugin options', async ({ equal, same, match, teardown }) => {
   const { child, url } = await start('-c', join(import.meta.url, '..', '..', 'fixtures', 'options', 'platformatic.service.yml'))
-
   const res = await request(`${url}`)
   equal(res.statusCode, 200)
   const body = await res.body.json()

package/test/cli/watch.test.mjs

@@ -11,6 +11,7 @@ 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')
       }
@@ -45,8 +46,6 @@ test('should watch js files by default', async ({ equal, teardown, comment }) =>
   ])
 
   const { child, url } = await start('-c', configFilePath)
-  child.stdout.pipe(process.stderr)
-  child.stderr.pipe(process.stderr)
   teardown(() => child.kill('SIGINT'))
 
   await writeFile(pluginFilePath, createLoggingPlugin('v2', true))
@@ -292,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', 'platformatic.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', 'platformatic.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')
 
@@ -39,16 +47,15 @@ test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
     await rmdir(join(targetDir, 'dist'))
   } catch {}
 
-  await compile(targetDir)
+  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' })