@platformatic/service 0.46.1 → 0.47.0

package/test/load-plugin.test.js

@@ -1,67 +0,0 @@
-'use strict'
-
-// setup the undici agent
-require('./helper')
-
-const { test } = require('tap')
-const { buildServer, platformaticService } = require('..')
-const { request } = require('undici')
-
-test('customize service', async ({ teardown, equal }) => {
-  async function myApp (app, opts) {
-    await platformaticService(app, opts, [async function (app) {
-      app.get('/', () => 'hello world')
-    }])
-  }
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    }
-  }, myApp)
-
-  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')
-})
-
-test('catch errors from the other side', async ({ teardown, equal, same }) => {
-  async function myApp (app, opts) {
-    await platformaticService(app, opts, [async function (app) {
-      app.get('/', () => 'hello world')
-    }])
-  }
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        path: require.resolve('./fixtures/other-side.js')
-      }]
-    }
-  }, myApp)
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  const res = await (request(app.url))
-  const body = await res.body.json()
-  equal(res.statusCode, 500)
-  same(body, {
-    statusCode: 500,
-    error: 'Internal Server Error',
-    message: 'kaboom'
-  })
-})

package/test/metrics.test.js

@@ -1,220 +0,0 @@
-'use strict'
-
-// setup the undici agent
-require('./helper')
-
-const { test, equal } = require('tap')
-const { buildServer } = require('..')
-const { request } = require('undici')
-const { promisify } = require('util')
-const sleep = promisify(setTimeout)
-
-test('has /metrics endpoint on default prometheus port', 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()
-
-  // 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'))
-  const body = await res.body.text()
-  equal(res.statusCode, 200)
-  match(res.headers['content-type'], /^text\/plain/)
-  testPrometheusOutput(body)
-})
-
-test('has /metrics endpoint with accept application/json', 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()
-
-  const res = await (request(
-    'http://127.0.0.1:9090/metrics',
-    {
-      headers: {
-        accept: 'application/json'
-      }
-    }
-  ))
-  match(res.headers['content-type'], /^application\/json/)
-  const json = await res.body.json()
-  equal(res.statusCode, 200)
-  testPrometheusJsonOutput(json)
-})
-
-test('has /metrics endpoint on configured port', async ({ teardown, equal, fail, match }) => {
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: {
-      port: 9999
-    }
-  })
-
-  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/)
-  const body = await res.body.text()
-  testPrometheusOutput(body)
-})
-
-test('support basic auth', async ({ teardown, equal, fail, match }) => {
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: {
-      auth: {
-        username: 'foo',
-        password: 'bar'
-      }
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await (request('http://127.0.0.1:9090/metrics'))
-    equal(res.statusCode, 401)
-    match(res.headers['content-type'], /^application\/json/)
-  }
-
-  {
-    // wrong credentials
-    const res = await (request('http://127.0.0.1:9090/metrics', {
-      headers: {
-        authorization: `Basic ${Buffer.from('bar:foo').toString('base64')}`
-      }
-    }))
-    equal(res.statusCode, 401)
-    match(res.headers['content-type'], /^application\/json/)
-  }
-
-  {
-    const res = await (request('http://127.0.0.1:9090/metrics', {
-      headers: {
-        authorization: `Basic ${Buffer.from('foo:bar').toString('base64')}`
-      }
-    }))
-    equal(res.statusCode, 200)
-    match(res.headers['content-type'], /^text\/plain/)
-    const body = await res.body.text()
-    testPrometheusOutput(body)
-  }
-})
-
-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)
-})
-
-test('restarting 10 times does not leak', async ({ teardown, equal, fail, match }) => {
-  process.on('warning', (warning) => {
-    fail('warning was raised')
-  })
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: true
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-
-  await app.start()
-
-  for (let i = 0; i < 10; i++) {
-    await app.restart()
-  }
-})
-
-function testPrometheusOutput (output) {
-  let metricBlock = []
-  const lines = output.split('\n')
-  for (let i = 0; i < lines.length; i++) {
-    const line = lines[i]
-    if (line === '') {
-      // check this metric set
-      checkMetricBlock(metricBlock)
-      metricBlock = []
-    } else {
-      metricBlock.push(line)
-    }
-  }
-}
-
-function checkMetricBlock (metricBlock) {
-  if (!metricBlock[0].match(/^# HELP/)) {
-    throw new Error('First line should be HELP')
-  }
-
-  if (!metricBlock[1].match(/^# TYPE/)) {
-    throw new Error('Second line should be TYPE')
-  }
-  for (let i = 2; i < metricBlock.length; i++) {
-    const split = metricBlock[i].split(' ')
-    if (split.length !== 2) {
-      throw new Error(`Bad format for metric: ${metricBlock[i]}`)
-    }
-  }
-  return true
-}
-
-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')
-  }
-}

package/test/routes.test.js

@@ -1,230 +0,0 @@
-'use strict'
-
-const { test } = require('tap')
-const { buildServer } = require('..')
-const { buildConfig } = require('./helper')
-const { request } = require('undici')
-const { join } = require('path')
-
-test('should respond 200 on root endpoint', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0,
-      healthCheck: {
-        enabled: true,
-        interval: 2000
-      }
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    // No browser (i.e. curl)
-    const res = await (request(`${app.url}/`))
-    equal(res.statusCode, 200)
-    const body = await res.body.json()
-    same(body, { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' })
-  }
-
-  {
-    // browser
-    const res = await (request(`${app.url}/`, {
-      headers: {
-        'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36'
-      }
-    }))
-
-    equal(res.statusCode, 200)
-    equal(res.headers['content-type'], 'text/html; charset=UTF-8')
-  }
-})
-
-test('should not overwrite a plugin which define a root endpoint', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0,
-      healthCheck: {
-        enabled: true,
-        interval: 2000
-      }
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  const res = await (request(`${app.url}/`))
-  equal(res.statusCode, 200)
-  const body = await res.body.json()
-  same(body, { message: 'Root Plugin' })
-})
-
-test('openapi enabled', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0,
-      healthCheck: {
-        enabled: true,
-        interval: 2000
-      }
-    },
-    service: {
-      openapi: true
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    // No browser (i.e. curl)
-    const res = await (request(`${app.url}/documentation/json`))
-    equal(res.statusCode, 200)
-    const body = await res.body.json()
-
-    equal(body.openapi, '3.0.3')
-    equal(body.info.title, 'Platformatic')
-    equal(body.info.version, '1.0.0')
-    equal(!!body.paths['/'].get, true)
-  }
-})
-
-test('openapi config', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    service: {
-      openapi: {
-        info: {
-          title: 'My Service',
-          version: '0.0.42',
-          description: 'My Service is the best service ever'
-        }
-      }
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    // No browser (i.e. curl)
-    const res = await (request(`${app.url}/documentation/json`))
-    equal(res.statusCode, 200)
-    const body = await res.body.json()
-
-    equal(body.openapi, '3.0.3')
-    equal(body.info.title, 'My Service')
-    equal(body.info.version, '0.0.42')
-    equal(body.info.description, 'My Service is the best service ever')
-    equal(!!body.paths['/'].get, true)
-  }
-})
-
-test('openapi disabled', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0,
-      healthCheck: {
-        enabled: true,
-        interval: 2000
-      }
-    },
-    service: {
-      openapi: false
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    // No browser (i.e. curl)
-    const res = await (request(`${app.url}/documentation/json`))
-    equal(res.statusCode, 404)
-    await res.body.text()
-  }
-})
-
-test('openapi disabled by default', async ({ teardown, equal, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0,
-      healthCheck: {
-        enabled: true,
-        interval: 2000
-      }
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    // No browser (i.e. curl)
-    const res = await (request(`${app.url}/documentation/json`))
-    equal(res.statusCode, 404)
-    await res.body.text()
-  }
-})
-
-test('request id is a uuid', async ({ teardown, equal, match }) => {
-  const UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'request-id.js')]
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  const res = await request(`${app.url}/request-id`, {
-    method: 'GET'
-  })
-  equal(res.statusCode, 200)
-  const json = await res.body.json()
-  match(json.request_id, UUID_REGEX)
-})

package/test/schema.test.js

@@ -1,12 +0,0 @@
-'use strict'
-
-const { test } = require('tap')
-const { join } = require('path')
-const { schema } = require('../lib/schema')
-
-test('schema output', async (t) => {
-  const { execa } = await import('execa')
-  const { stdout } = await execa(process.execPath, [join(__dirname, '..', 'lib', 'schema.js')])
-
-  t.same(stdout, JSON.stringify(schema, null, 2))
-})

package/test/telemetry.test.js

@@ -1,87 +0,0 @@
-'use strict'
-
-const { buildConfig } = require('./helper')
-const { test } = require('tap')
-const { buildServer } = require('..')
-const { request } = require('undici')
-const { join } = require('path')
-const os = require('os')
-const { writeFile } = require('fs/promises')
-
-test('should not configure telemetry if not configured', async ({ teardown, equal, pass, same }) => {
-  const app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-  equal(app.openTelemetry, undefined)
-})
-
-test('should setup telemetry if configured', 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 app = await buildServer(buildConfig({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-
-    telemetry: {
-      serviceName: 'test-service',
-      version: '1.0.0',
-      exporter: {
-        type: 'memory'
-      }
-    },
-    plugins: {
-      paths: [{
-        path: file,
-        options: {
-          message: 'hello'
-        }
-      }]
-    }
-  }))
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  const res = await request(`${app.url}/`, {
-    method: 'GET',
-    headers: {
-      'Content-Type': 'application/json'
-    },
-    body: JSON.stringify({
-      query: `
-          mutation {
-            savePage(input: { title: "Hello" }) {
-              id
-              title
-            }
-          }
-        `
-    })
-  })
-  equal(res.statusCode, 200, 'savePage status code')
-  const { exporters } = app.openTelemetry
-  const finishedSpans = exporters[0].getFinishedSpans()
-  equal(finishedSpans.length, 1)
-  const span = finishedSpans[0]
-  equal(span.name, 'GET /')
-  equal(span.attributes['http.request.method'], 'GET')
-  equal(span.attributes['url.path'], '/')
-  equal(span.attributes['http.response.status_code'], 200)
-})

package/test/utils.test.js

@@ -1,37 +0,0 @@
-'use strict'
-
-const { test } = require('tap')
-const { getJSPluginPath, isFileAccessible } = require('../lib/utils')
-const { join, resolve } = require('path')
-
-test('should get the path of a TS plugin', (t) => {
-  t.plan(1)
-
-  const result = getJSPluginPath('/something', '/something/plugin.ts', '/something/dist')
-  const expected = join('/something', 'dist', 'plugin.js')
-  t.equal(result, expected)
-})
-
-test('should get the path of a JS plugin', (t) => {
-  t.plan(1)
-
-  const result = getJSPluginPath('/something', '/something/plugin.js', '/something/dist')
-  t.equal(result, '/something/plugin.js')
-})
-
-test('isFileAccessible with dir', async (t) => {
-  const dir = resolve(join(__dirname, '..', 'fixtures', 'hello'))
-  t.equal(await isFileAccessible('platformatic.service.json', dir), true)
-})
-
-test('isFileAccessible no dir', async (t) => {
-  const file = resolve(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'))
-  t.equal(await isFileAccessible(file), true)
-})
-
-test('should return the same plugin folder if it\'s already the compiled one', (t) => {
-  t.plan(1)
-
-  const result = getJSPluginPath('/something', '/something/dist/plugins', '/something/dist')
-  t.equal(result, '/something/dist/plugins')
-})