@platformatic/service 0.17.1 → 0.18.0

package/lib/openapi.js

@@ -0,0 +1,42 @@
+'use strict'
+
+const Swagger = require('@fastify/swagger')
+const SwaggerUI = require('@fastify/swagger-ui')
+const deepmerge = require('@fastify/deepmerge')({ all: true })
+const fp = require('fastify-plugin')
+
+// For some unknown reason, c8 is not detecting any of this
+// pf
+// despite being covered by test/routes.test.js
+/* c8 ignore next 33 */
+async function setupOpenAPI (app, opts) {
+  const openapiConfig = deepmerge({
+    exposeRoute: true,
+    info: {
+      title: 'Platformatic',
+      description: 'This is a service built on top of Platformatic',
+      version: '1.0.0'
+    }
+  }, typeof opts === 'object' ? opts : {})
+  app.log.trace({ openapi: openapiConfig })
+  await app.register(Swagger, {
+    exposeRoute: openapiConfig.exposeRoute,
+    openapi: {
+      ...openapiConfig
+    },
+    refResolver: {
+      buildLocalReference (json, baseUri, fragment, i) {
+        // TODO figure out if we need def-${i}
+        /* istanbul ignore next */
+        return json.$id || `def-${i}`
+      }
+    }
+  })
+
+  app.register(SwaggerUI, {
+    ...opts,
+    prefix: '/documentation'
+  })
+}
+
+module.exports = fp(setupOpenAPI)

package/lib/schema.js

@@ -4,6 +4,7 @@
 
 const pkg = require('../package.json')
 const version = 'v' + pkg.version
+const openApiDefs = require('./openapi-schema-defs')
 
 const cors = {
   type: 'object',
@@ -123,6 +124,119 @@ const server = {
         }
       ]
     },
+    ignoreTrailingSlash: {
+      type: 'boolean'
+    },
+    ignoreDuplicateSlashes: {
+      type: 'boolean'
+    },
+    connectionTimeout: {
+      type: 'integer'
+    },
+    keepAliveTimeout: {
+      type: 'integer'
+    },
+    maxRequestsPerSocket: {
+      type: 'integer'
+    },
+    forceCloseConnections: {
+      anyOf: [
+        { type: 'boolean' },
+        { type: 'string', pattern: '^idle$' }
+      ]
+    },
+    requestTimeout: {
+      type: 'integer'
+    },
+    bodyLimit: {
+      type: 'integer'
+    },
+    maxParamLength: {
+      type: 'integer'
+    },
+    disableRequestLogging: {
+      type: 'boolean'
+    },
+    exposeHeadRoutes: {
+      type: 'boolean'
+    },
+    logger: {
+      anyOf: [
+        { type: 'boolean' },
+        {
+          type: 'object',
+          properties: {
+            level: {
+              type: 'string'
+            }
+          },
+          additionalProperties: true
+        }
+      ]
+    },
+    serializerOpts: {
+      type: 'object',
+      properties: {
+        schema: {
+          type: 'object'
+        },
+        ajv: {
+          type: 'object'
+        },
+        rounding: {
+          type: 'string',
+          enum: ['floor', 'ceil', 'round', 'trunc'],
+          default: 'trunc'
+        },
+        debugMode: {
+          type: 'boolean'
+        },
+        mode: {
+          type: 'string',
+          enum: ['debug', 'standalone']
+        },
+        largeArraySize: {
+          anyOf: [
+            { type: 'integer' },
+            { type: 'string' }
+          ],
+          default: 20000
+        },
+        largeArrayMechanism: {
+          type: 'string',
+          enum: ['default', 'json-stringify'],
+          default: 'default'
+        }
+      }
+    },
+    caseSensitive: {
+      type: 'boolean'
+    },
+    requestIdHeader: {
+      anyOf: [
+        { type: 'string' },
+        { type: 'boolean', const: false }
+      ]
+    },
+    requestIdLogLabel: {
+      type: 'string'
+    },
+    jsonShorthand: {
+      type: 'boolean'
+    },
+    trustProxy: {
+      anyOf: [
+        { type: 'boolean' },
+        { type: 'string' },
+        {
+          type: 'array',
+          items: {
+            type: 'string'
+          }
+        },
+        { type: 'integer' }
+      ]
+    },
     cors
   },
   required: ['hostname', 'port']
@@ -131,28 +245,25 @@ const server = {
 const watch = {
   type: 'object',
   properties: {
-    type: 'object',
-    properties: {
-      allow: {
-        type: 'array',
-        items: {
-          type: 'string'
-        },
-        minItems: 1,
-        nullable: true,
-        default: null
+    allow: {
+      type: 'array',
+      items: {
+        type: 'string'
       },
-      ignore: {
-        type: 'array',
-        items: {
-          type: 'string'
-        },
-        nullable: true,
-        default: null
-      }
+      minItems: 1,
+      nullable: true,
+      default: null
     },
-    additionalProperties: false
-  }
+    ignore: {
+      type: 'array',
+      items: {
+        type: 'string'
+      },
+      nullable: true,
+      default: null
+    }
+  },
+  additionalProperties: false
 }
 
 const plugins = {
@@ -219,15 +330,100 @@ const metrics = {
   ]
 }
 
+const openApiBase = {
+  type: 'object',
+  properties: {
+    info: {
+      $ref: '#/$defs/info'
+    },
+    jsonSchemaDialect: {
+      type: 'string',
+
+      default: 'https://spec.openapis.org/oas/3.1/dialect/base'
+    },
+    servers: {
+      type: 'array',
+      items: {
+        $ref: '#/$defs/server'
+      },
+      default: [
+        {
+          url: '/'
+        }
+      ]
+    },
+    paths: {
+      $ref: '#/$defs/paths'
+    },
+    webhooks: {
+      type: 'object',
+      additionalProperties: {
+        $ref: '#/$defs/path-item-or-reference'
+      }
+    },
+    components: {
+      $ref: '#/$defs/components'
+    },
+    security: {
+      type: 'array',
+      items: {
+        $ref: '#/$defs/security-requirement'
+      }
+    },
+    tags: {
+      type: 'array',
+      items: {
+        $ref: '#/$defs/tag'
+      }
+    },
+    externalDocs: {
+      $ref: '#/$defs/external-documentation'
+    },
+    prefix: {
+      type: 'string',
+      description: 'Base URL for the OpenAPI'
+    }
+  }
+}
+
+const openapi = {
+  anyOf: [{
+    ...openApiBase,
+    additionalProperties: false
+  }, {
+    type: 'boolean'
+  }]
+}
+
+const graphql = {
+  anyOf: [{
+    type: 'boolean'
+  }, {
+    type: 'object',
+    properties: {
+      graphiql: {
+        type: 'boolean'
+      }
+    }
+  }]
+}
+
+const service = {
+  type: 'object',
+  properties: {
+    openapi,
+    graphql
+  },
+  additionalProperties: false
+}
+
 const platformaticServiceSchema = {
   $id: `https://platformatic.dev/schemas/${version}/service`,
   type: 'object',
   properties: {
     server,
     plugins,
-    metrics
-  },
-  additionalProperties: {
+    metrics,
     watch: {
       anyOf: [watch, {
         type: 'boolean'
@@ -235,9 +431,15 @@ const platformaticServiceSchema = {
     },
     hotReload: {
       type: 'boolean'
-    }
+    },
+    $schema: {
+      type: 'string'
+    },
+    service
   },
-  required: ['server']
+  additionalProperties: false,
+  required: ['server'],
+  $defs: openApiDefs
 }
 
 module.exports.schema = platformaticServiceSchema
@@ -246,6 +448,8 @@ module.exports.cors = cors
 module.exports.server = server
 module.exports.plugins = plugins
 module.exports.watch = watch
+module.exports.openApiDefs = openApiDefs
+module.exports.openApiBase = openApiBase
 
 if (require.main === module) {
   console.log(JSON.stringify(platformaticServiceSchema, null, 2))

package/lib/utils.js

@@ -46,10 +46,21 @@ function getJSPluginPath (configPath, tsPluginPath, compileDir) {
     return tsPluginPath
   }
 
+  const isTs = tsPluginPath.endsWith('ts')
+  let newBaseName
+
+  // TODO: investigate why c8 does not see those
+  /* c8 ignore next 5 */
+  if (isTs) {
+    newBaseName = basename(tsPluginPath, '.ts') + '.js'
+  } else {
+    newBaseName = basename(tsPluginPath)
+  }
+
   const tsPluginRelativePath = relative(dirname(configPath), tsPluginPath)
   const jsPluginRelativePath = join(
     dirname(tsPluginRelativePath),
-    basename(tsPluginRelativePath, '.ts') + '.js'
+    newBaseName
   )
   return join(compileDir, jsPluginRelativePath)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "description": "",
   "main": "index.js",
   "author": "Matteo Collina <hello@matteocollina.com>",
@@ -14,6 +14,7 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
+    "@matteo.collina/worker": "^3.0.0",
     "bindings": "^1.5.0",
     "c8": "^7.13.0",
     "snazzy": "^9.0.0",
@@ -36,7 +37,9 @@
     "@fastify/restartable": "^1.4.0",
     "@fastify/static": "^6.9.0",
     "@fastify/swagger": "^8.3.1",
+    "@fastify/swagger-ui": "^1.4.0",
     "@fastify/under-pressure": "^8.2.0",
+    "@mercuriusjs/federation": "^1.0.1",
     "close-with-grace": "^1.1.0",
     "commist": "^3.2.0",
     "desm": "^1.3.0",
@@ -49,13 +52,14 @@
     "fastify-sandbox": "^0.11.0",
     "graphql": "^16.6.0",
     "help-me": "^4.2.0",
+    "mercurius": "^12.2.0",
     "minimist": "^1.2.8",
     "pino": "^8.11.0",
-    "pino-pretty": "^9.3.0",
+    "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.33",
-    "@platformatic/utils": "0.17.1",
-    "@platformatic/config": "0.17.1"
+    "@platformatic/config": "0.18.0",
+    "@platformatic/utils": "0.18.0"
   },
   "standard": {
     "ignore": [

package/test/cli/compile.test.mjs

@@ -12,6 +12,20 @@ function urlDirname (url) {
   return path.dirname(fileURLToPath(url))
 }
 
+function exitOnTeardown (child) {
+  return async () => {
+    if (os.platform() === 'win32') {
+      try {
+        await execa('taskkill', ['/pid', child.pid, '/f', '/t'])
+      } catch (err) {
+        console.error(`Failed to kill process ${child.pid})`)
+      }
+    } else {
+      child.kill('SIGINT')
+    }
+  }
+}
+
 t.test('should compile typescript plugin', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
   const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-1')
@@ -70,17 +84,7 @@ t.test('should compile typescript plugin with start command', async (t) => {
 
   const child = execa('node', [cliPath, 'start'], { cwd })
 
-  t.teardown(async () => {
-    if (os.platform() === 'win32') {
-      try {
-        await execa('taskkill', ['/pid', child.pid, '/f', '/t'])
-      } catch (err) {
-        console.error(`Failed to kill process ${child.pid})`)
-      }
-    } else {
-      child.kill('SIGINT')
-    }
-  })
+  t.teardown(exitOnTeardown(child))
 
   const splitter = split()
   child.stdout.pipe(splitter)
@@ -195,17 +199,7 @@ t.test('start command should not compile typescript if `typescript` is false', a
   await cp(testDir, cwd, { recursive: true })
 
   const child = execa('node', [cliPath, 'start'], { cwd })
-  t.teardown(async () => {
-    if (os.platform() === 'win32') {
-      try {
-        await execa('taskkill', ['/pid', child.pid, '/f', '/t'])
-      } catch (err) {
-        console.error(`Failed to kill process ${child.pid})`)
-      }
-    } else {
-      child.kill('SIGINT')
-    }
-  })
+  t.teardown(exitOnTeardown(child))
 
   const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
   try {
@@ -227,17 +221,7 @@ t.test('should compile typescript plugin with start command with different cwd',
 
   const child = execa('node', [cliPath, 'start', '-c', path.join(dest, 'platformatic.service.json')])
 
-  t.teardown(async () => {
-    if (os.platform() === 'win32') {
-      try {
-        await execa('taskkill', ['/pid', child.pid, '/f', '/t'])
-      } catch (err) {
-        console.error(`Failed to kill process ${child.pid})`)
-      }
-    } else {
-      child.kill('SIGINT')
-    }
-  })
+  t.teardown(exitOnTeardown(child))
 
   const splitter = split()
   child.stdout.pipe(splitter)
@@ -253,3 +237,41 @@ t.test('should compile typescript plugin with start command with different cwd',
   }
   t.fail('should compile typescript plugin with start command')
 })
+
+t.test('valid tsconfig file inside an inner folder', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-7/inner-folder')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  try {
+    await execa('node', [cliPath, 'compile'], { cwd })
+  } catch (err) {
+    t.fail('should not catch any error')
+  }
+
+  t.pass()
+})
+
+t.test('should compile typescript plugin with start command from a folder', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-autoload')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-8')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  const child = execa('node', [cliPath, 'start'], { cwd })
+
+  t.teardown(exitOnTeardown(child))
+
+  const splitter = split()
+  child.stdout.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Typescript plugin loaded')) {
+      t.pass()
+      return
+    }
+  }
+  t.fail('should compile typescript plugin with start command')
+})

package/test/cli/gen-schema.test.mjs

@@ -15,9 +15,8 @@ test('generateJsonSchemaConfig generates the file', async (t) => {
 
   const configSchema = await fs.readFile('platformatic.service.schema.json', 'utf8')
   const schema = JSON.parse(configSchema)
-  const { required, additionalProperties } = schema
+  const { required } = schema
   t.has(required, ['server'])
-  t.has(additionalProperties, { watch: {} })
   const { $id, type } = schema
   t.equal($id, `https://platformatic.dev/schemas/v${pkg.version}/service`)
   t.equal(type, 'object')

package/test/cli/watch.test.mjs

@@ -1,16 +1,19 @@
 import os from 'os'
 import { join, basename } from 'path'
 import { writeFile, mkdtemp } from 'fs/promises'
-import { setTimeout as sleep } from 'timers/promises'
 import t, { test } from 'tap'
 import { request } from 'undici'
+import { setTimeout as sleep } from 'timers/promises'
 import { start } from './helper.mjs'
 
 t.jobs = 5
 
-function createLoggingPlugin (text) {
+function createLoggingPlugin (text, reloaded = false) {
   return `\
     module.exports = async (app) => {
+      if (${reloaded}) {
+        app.log.info('RELOADED')
+      }
       app.get('/version', () => '${text}')
     }
   `
@@ -43,9 +46,11 @@ test('should watch js files by default', async ({ equal, teardown }) => {
   const { child, url } = await start('-c', configFilePath)
   teardown(() => child.kill('SIGINT'))
 
-  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+  await writeFile(pluginFilePath, createLoggingPlugin('v2', true))
 
-  await sleep(5000)
+  for await (const log of child.ndj) {
+    if (log.msg === 'RELOADED') break
+  }
 
   const res = await request(`${url}/version`)
   const version = await res.body.text()
@@ -128,7 +133,8 @@ test('should not watch ignored file', async ({ teardown, equal }) => {
   const { child, url } = await start('-c', configFilePath)
   teardown(() => child.kill('SIGINT'))
 
-  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+  await writeFile(pluginFilePath, createLoggingPlugin('v2', true))
+
   await sleep(5000)
 
   const res = await request(`${url}/version`)
@@ -273,7 +279,8 @@ test('should not hot reload files with `--hot-reload false`', async ({ teardown,
     equal(version, 'v1')
   }
 
-  await writeFile(pluginFilePath, createLoggingPlugin('v2'))
+  await writeFile(pluginFilePath, createLoggingPlugin('v2', true))
+
   await sleep(5000)
 
   {

package/test/config.test.js

@@ -217,6 +217,7 @@ test('config is adjusted to handle custom loggers', async (t) => {
   Object.defineProperty(options.server.logger, 'child', {
     value: function child () {
       called = true
+      return this
     },
     enumerable: false
   })
@@ -284,7 +285,7 @@ test('custom ConfigManager', async ({ teardown, equal, pass, same }) => {
   {
     const res = await request(`${server.url}/`)
     equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'ciao mondo', 'response')
+    same(await res.body.text(), 'hello', 'response')
   }
 })