@platformatic/service 0.21.1 → 0.23.0

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,11 +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('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'
+    }
+  }
+
+  {
+    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)
+  }
+
+  {
+    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',

package/test/fixtures/bad-typescript-plugin/platformatic.service.json

@@ -4,7 +4,9 @@
       "level": "info"
     },
     "hostname": "127.0.0.1",
-    "port": "3042"
+    "port": "3042",
+    "pluginTimeout": 30000,
+    "keepAliveTimeout": 1
   },
   "plugins": {
     "paths": ["plugin.ts"],

package/test/fixtures/custom-port-placeholder.json

@@ -0,0 +1,10 @@
+{
+  "server": {
+    "logger": {
+      "level": "info"
+    },
+    "hostname": "127.0.0.1",
+    "port": "{A_CUSTOM_PORT}",
+    "pluginTimeout": "10"
+  }
+}

package/test/fixtures/typescript-autoload/platformatic.service.json

@@ -4,7 +4,9 @@
       "level": "info"
     },
     "hostname": "127.0.0.1",
-    "port": "0"
+    "port": "0",
+    "pluginTimeout": 60000,
+    "keepAliveTimeout": 1
   },
   "plugins": {
     "paths": ["routes"],

package/test/fixtures/typescript-plugin/platformatic.service.json

@@ -4,7 +4,9 @@
       "level": "info"
     },
     "hostname": "127.0.0.1",
-    "port": "0"
+    "port": "0",
+    "pluginTimeout": 60000,
+    "keepAliveTimeout": 1
   },
   "plugins": {
     "paths": ["plugin.ts"],

package/test/fixtures/typescript-plugin-nocompile/platformatic.service.json

@@ -5,7 +5,8 @@
     },
     "hostname": "127.0.0.1",
     "port": "0",
-    "pluginTimeout": 60000
+    "pluginTimeout": 60000,
+    "keepAliveTimeout": 1
   },
   "plugins": {
     "paths": ["plugin.ts"],

package/test/graphql.test.js

@@ -7,7 +7,7 @@ const { request } = require('undici')
 const { join } = require('path')
 
 test('graphql enabled', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -23,12 +23,14 @@ test('graphql enabled', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'hello-world-resolver.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/graphql`, {
+    const res = await request(`${app.url}/graphql`, {
       method: 'POST',
       headers: {
         'content-type': 'application/json'
@@ -50,14 +52,14 @@ test('graphql enabled', async ({ teardown, equal, same }) => {
   }
 
   {
-    const res = await request(`${server.url}/graphiql`)
+    const res = await request(`${app.url}/graphiql`)
     equal(res.statusCode, 200, 'graphiql status code')
   }
 })
 
 test('graphql disabled', async ({ teardown, equal, fail }) => {
   try {
-    const server = await buildServer(buildConfig({
+    const app = await buildServer(buildConfig({
       server: {
         hostname: '127.0.0.1',
         port: 0,
@@ -73,7 +75,7 @@ test('graphql disabled', async ({ teardown, equal, fail }) => {
         paths: [join(__dirname, 'fixtures', 'hello-world-resolver.js')]
       }
     }))
-    await server.stop()
+    await app.close()
     fail('should have errored but did not')
   } catch (err) {
     equal(err.message, 'Cannot read properties of undefined (reading \'extendSchema\')')
@@ -81,7 +83,7 @@ test('graphql disabled', async ({ teardown, equal, fail }) => {
 })
 
 test('disable graphiql', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -99,12 +101,14 @@ test('disable graphiql', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'hello-world-resolver.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/graphql`, {
+    const res = await request(`${app.url}/graphql`, {
       method: 'POST',
       headers: {
         'content-type': 'application/json'
@@ -126,14 +130,14 @@ test('disable graphiql', async ({ teardown, equal, same }) => {
   }
 
   {
-    const res = await request(`${server.url}/graphiql`)
+    const res = await request(`${app.url}/graphiql`)
     equal(res.statusCode, 404, 'graphiql status code')
   }
 })
 
 test('graphql disabled by default', async ({ teardown, equal, fail }) => {
   try {
-    const server = await buildServer(buildConfig({
+    const app = await buildServer(buildConfig({
       server: {
         hostname: '127.0.0.1',
         port: 0,
@@ -146,7 +150,7 @@ test('graphql disabled by default', async ({ teardown, equal, fail }) => {
         paths: [join(__dirname, 'fixtures', 'hello-world-resolver.js')]
       }
     }))
-    await server.stop()
+    await app.close()
     fail('should have errored but did not')
   } catch (err) {
     equal(err.message, 'Cannot read properties of undefined (reading \'extendSchema\')')

package/test/healthcheck.test.js

@@ -7,7 +7,7 @@ const { request } = require('undici')
 
 test('healthcheck route enabled with interval', async ({ teardown, equal, same }) => {
   let check = true
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -20,11 +20,14 @@ test('healthcheck route enabled with interval', async ({ teardown, equal, same }
     },
     metrics: false
   })
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
-    const res = await (request(`${server.url}/status`))
+    const res = await (request(`${app.url}/status`))
     equal(res.statusCode, 200)
     const body = await res.body.json()
     same(body, { status: 'ok' })
@@ -33,7 +36,7 @@ test('healthcheck route enabled with interval', async ({ teardown, equal, same }
   check = false
 
   {
-    const res = await (request(`${server.url}/status`))
+    const res = await (request(`${app.url}/status`))
     equal(res.statusCode, 503)
     const body = await res.body.json()
     same(body, {
@@ -48,7 +51,7 @@ test('healthcheck route enabled with interval', async ({ teardown, equal, same }
 })
 
 test('healthcheck route enabled without interval', async ({ teardown, equal, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -56,11 +59,14 @@ test('healthcheck route enabled without interval', async ({ teardown, equal, sam
     },
     metrics: false
   })
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
-    const res = await (request(`${server.url}/status`))
+    const res = await (request(`${app.url}/status`))
     equal(res.statusCode, 200)
     const body = await res.body.json()
     same(body, { status: 'ok' })
@@ -68,16 +74,19 @@ test('healthcheck route enabled without interval', async ({ teardown, equal, sam
 })
 
 test('healthcheck route disabled', async ({ teardown, equal, same }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
     },
     metrics: false
   })
-  teardown(server.stop)
 
-  await server.listen()
-  const res = await (request(`${server.url}/status`))
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await (request(`${app.url}/status`))
   equal(res.statusCode, 404)
 })