@platformatic/service 0.22.0 → 0.23.1

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

@@ -16,7 +16,7 @@ test('load and reload', async ({ teardown, equal, pass, same }) => {
     }`
   )
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -26,11 +26,14 @@ test('load and reload', 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, 'status code')
     const data = await res.body.json()
     same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
@@ -38,13 +41,13 @@ test('load and reload', async ({ teardown, equal, pass, same }) => {
 
   await writeFile(file, `
     module.exports = async function (app) {
-      app.get('/', () => "hello world" ) 
+      app.get('/', () => "hello world" )
     }`)
 
-  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(), 'hello world', 'response')
   }
@@ -60,7 +63,7 @@ test('error', async ({ teardown, equal, pass, match }) => {
       })
     }`)
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -70,63 +73,19 @@ test('error', async ({ teardown, equal, pass, match }) => {
     },
     metrics: false
   })
-  teardown(server.stop)
-  await server.listen()
 
-  const res = await request(`${server.url}/`)
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await request(`${app.url}/`)
   equal(res.statusCode, 500, 'add status code')
   match(await res.body.json(), {
     message: 'kaboom'
   })
 })
 
-test('update config', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
-  await writeFile(file, `
-    module.exports = async function (app) {
-    }`
-  )
-
-  const server = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: false
-  })
-  teardown(server.stop)
-  await server.listen()
-
-  {
-    const res = await request(`${server.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' })
-  }
-
-  const file2 = join(os.tmpdir(), `some-plugin-${process.pid}-2.js`)
-  await writeFile(file2, `
-    module.exports = async function (app) {
-      app.get('/', () => "hello world" ) 
-    }`)
-
-  await server.restart({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file2]
-    }
-  })
-
-  {
-    const res = await request(`${server.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
-  }
-})
-
 test('mock undici is supported', async ({ teardown, equal, pass, same }) => {
   const previousAgent = getGlobalDispatcher()
   teardown(() => setGlobalDispatcher(previousAgent))
@@ -147,7 +106,7 @@ test('mock undici is supported', async ({ teardown, equal, pass, same }) => {
     hello: 'world'
   })
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -156,10 +115,13 @@ test('mock undici is supported', async ({ teardown, equal, pass, same }) => {
       paths: [join(__dirname, 'fixtures', 'undici-plugin.js')]
     }
   })
-  teardown(server.stop)
-  await server.listen()
 
-  const res = await request(`${server.url}/request`, {
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await request(`${app.url}/request`, {
     method: 'GET'
   })
   equal(res.statusCode, 200)
@@ -176,7 +138,7 @@ test('load and reload with the fallback', async ({ teardown, equal, pass, same }
     }`
   )
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -187,11 +149,14 @@ test('load and reload with the fallback', async ({ teardown, equal, pass, same }
       fallback: true
     }
   })
-  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, 'status code')
     const data = await res.body.json()
     same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
@@ -199,13 +164,13 @@ test('load and reload with the fallback', async ({ teardown, equal, pass, same }
 
   await writeFile(file, `
     module.exports = async function (app) {
-      app.get('/', () => "hello world" ) 
+      app.get('/', () => "hello world" )
     }`)
 
-  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(), 'hello world', 'response')
   }
@@ -219,7 +184,7 @@ test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
     }`
   )
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -228,11 +193,14 @@ test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
       paths: [file]
     }
   })
-  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, 'status code')
     const data = await res.body.json()
     same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
@@ -240,13 +208,13 @@ test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
 
   await writeFile(file, `
     export default async function (app) {
-      app.get('/', () => "hello world" ) 
+      app.get('/', () => "hello world" )
     }`)
 
-  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(), 'hello world', 'response')
   }
@@ -271,34 +239,35 @@ test('server should be available after reload a compromised plugin', async ({ te
       paths: [file]
     }
   }
-  const restartConfig = { ...config }
-  delete restartConfig.server
 
-  const server = await buildServer(config)
-  await server.listen()
+  const app = await buildServer(config)
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   await writeFile(file, compromisedModule)
-  await server.restart(restartConfig).catch(() => {
+  await app.restart().catch(() => {
     pass('plugin reload failed')
   })
 
   {
-    const res = await request(`${server.url}/`, { method: 'GET' })
+    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 rejects(server.restart(restartConfig))
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/`, { method: 'GET' })
+    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' })
   }
-
-  teardown(server.stop)
 })
 
 test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) => {
@@ -312,7 +281,7 @@ test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) =>
     }`
   )
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -322,11 +291,14 @@ test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) =>
       hotReload: false
     }
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
 
   {
-    const res = await request(`${server.url}/test`, {
+    const res = await request(`${app.url}/test`, {
       method: 'GET'
     })
     equal(res.statusCode, 200)
@@ -341,10 +313,10 @@ test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) =>
     }`
   )
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/test`, {
+    const res = await request(`${app.url}/test`, {
       method: 'GET'
     })
     equal(res.statusCode, 200)
@@ -354,9 +326,10 @@ test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) =>
 })
 
 test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.mjs`)
+  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(file, `
+  await writeFile(pathToPlugin, `
     export default async function (app) {
       app.get('/test', {}, async function (request, response) {
         return { res: "plugin, version 1"}
@@ -364,31 +337,36 @@ test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
     }`
   )
 
-  const server = await buildServer({
+  const config = {
     server: {
       hostname: '127.0.0.1',
       port: 0
     },
     plugins: {
-      paths: [file],
+      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()
   })
-  teardown(server.stop)
-  await server.listen()
+  await app.start()
 
   {
-    const res = await request(`${server.url}/test`, {
+    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, `
+  await writeFile(pathToPlugin, `
     export default async function (app) {
       app.get('/test', {}, async function (request, response) {
         return { res: "plugin, version 2"}
@@ -396,10 +374,10 @@ test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
     }`
   )
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/test`, {
+    const res = await request(`${app.url}/test`, {
       method: 'GET'
     })
     equal(res.statusCode, 200)
@@ -409,9 +387,10 @@ test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
 })
 
 test('hot reload disabled, with default export', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.js`)
+  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(file, `
+  await writeFile(pathToPlugin, `
     Object.defineProperty(exports, "__esModule", { value: true })
     exports.default = async function plugin (app) {
       app.get('/test', {}, async function (request, response) {
@@ -419,30 +398,36 @@ test('hot reload disabled, with default export', async ({ teardown, equal, pass,
       })
     }`)
 
-  const server = await buildServer({
+  const config = {
     server: {
       hostname: '127.0.0.1',
       port: 0
     },
     plugins: {
-      paths: [file],
+      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()
   })
-  teardown(server.stop)
-  await server.listen()
+  await app.start()
 
   {
-    const res = await request(`${server.url}/test`, {
+    const res = await request(`${app.url}/test`, {
       method: 'GET'
     })
     same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
   }
 
-  await writeFile(file, `
+  await writeFile(pathToPlugin, `
     Object.defineProperty(exports, "__esModule", { value: true })
     exports.default = async function plugin (app) {
       app.get('/test', {}, async function (request, response) {
@@ -451,10 +436,10 @@ test('hot reload disabled, with default export', async ({ teardown, equal, pass,
     }`
   )
 
-  await server.restart()
+  await app.restart()
 
   {
-    const res = await request(`${server.url}/test`, {
+    const res = await request(`${app.url}/test`, {
       method: 'GET'
     })
     equal(res.statusCode, 200)

package/test/load-plugin.test.js

@@ -14,15 +14,19 @@ test('customize service', async ({ teardown, equal }) => {
     }])
   }
 
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
     }
   }, myApp)
-  teardown(server.stop)
-  await server.listen()
-  const res = await (request(server.url))
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await (request(app.url))
   const body = await res.body.text()
   equal(res.statusCode, 200)
   equal(body, 'hello world')

package/test/metrics.test.js

@@ -10,15 +10,19 @@ const { promisify } = require('util')
 const sleep = promisify(setTimeout)
 
 test('has /metrics endpoint on default prometheus port', async ({ teardown, equal, fail, match }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
     },
     metrics: true
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   // needed to reach 100% code cov, otherwise the ELU check won't run
   await sleep(120)
   const res = await (request('http://127.0.0.1:9090/metrics'))
@@ -29,15 +33,19 @@ test('has /metrics endpoint on default prometheus port', async ({ teardown, equa
 })
 
 test('has /metrics endpoint with accept application/json', async ({ teardown, equal, fail, match }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
     },
     metrics: true
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   const res = await (request(
     'http://127.0.0.1:9090/metrics',
     {
@@ -53,7 +61,7 @@ test('has /metrics endpoint with accept application/json', async ({ teardown, eq
 })
 
 test('has /metrics endpoint on configured port', async ({ teardown, equal, fail, match }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -62,8 +70,12 @@ test('has /metrics endpoint on configured port', async ({ teardown, equal, fail,
       port: 9999
     }
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   const res = await (request('http://127.0.0.1:9999/metrics'))
   equal(res.statusCode, 200)
   match(res.headers['content-type'], /^text\/plain/)
@@ -72,7 +84,7 @@ test('has /metrics endpoint on configured port', async ({ teardown, equal, fail,
 })
 
 test('support basic auth', async ({ teardown, equal, fail, match }) => {
-  const server = await buildServer({
+  const app = await buildServer({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -84,8 +96,12 @@ test('support basic auth', async ({ teardown, equal, fail, match }) => {
       }
     }
   })
-  teardown(server.stop)
-  await server.listen()
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     const res = await (request('http://127.0.0.1:9090/metrics'))
     equal(res.statusCode, 401)
@@ -116,15 +132,28 @@ test('support basic auth', async ({ teardown, equal, fail, match }) => {
   }
 })
 
-function testPrometheusJsonOutput (output) {
-  for (const metric of output) {
-    equal(typeof metric.help, 'string', 'metric.help is string')
-    equal(typeof metric.name, 'string', 'metric.name is string')
-    equal(typeof metric.type, 'string', 'metric.type is string')
-    equal(typeof metric.aggregator, 'string', 'metric.aggregator is string')
-    equal(Array.isArray(metric.values), true, 'metric.values is array')
-  }
-}
+test('do not error on restart', async ({ teardown, equal, fail, match }) => {
+  const app = await buildServer({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    metrics: true
+  })
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+  await app.restart()
+
+  const res = await (request('http://127.0.0.1:9090/metrics'))
+  equal(res.statusCode, 200)
+  match(res.headers['content-type'], /^text\/plain/)
+  const body = await res.body.text()
+  testPrometheusOutput(body)
+})
+
 function testPrometheusOutput (output) {
   let metricBlock = []
   const lines = output.split('\n')
@@ -157,21 +186,12 @@ function checkMetricBlock (metricBlock) {
   return true
 }
 
-test('do not error on restart', async ({ teardown, equal, fail, match }) => {
-  const server = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: true
-  })
-  teardown(server.stop)
-  await server.listen()
-  await server.restart()
-
-  const res = await (request('http://127.0.0.1:9090/metrics'))
-  equal(res.statusCode, 200)
-  match(res.headers['content-type'], /^text\/plain/)
-  const body = await res.body.text()
-  testPrometheusOutput(body)
-})
+function testPrometheusJsonOutput (output) {
+  for (const metric of output) {
+    equal(typeof metric.help, 'string', 'metric.help is string')
+    equal(typeof metric.name, 'string', 'metric.name is string')
+    equal(typeof metric.type, 'string', 'metric.type is string')
+    equal(typeof metric.aggregator, 'string', 'metric.aggregator is string')
+    equal(Array.isArray(metric.values), true, 'metric.values is array')
+  }
+}