@platformatic/service 1.15.1 → 1.17.0

package/index.js

@@ -21,13 +21,18 @@ const { addLoggerToTheConfig } = require('./lib/utils')
 const { start, buildServer } = require('./lib/start')
 const ServiceGenerator = require('./lib/generator/service-generator.js')
 
-// TODO(mcollina): toLoad is deprecated, remove it in the next major version.
-async function platformaticService (app, opts, toLoad) {
+// TODO(mcollina): arugments[2] is deprecated, remove it in the next major version.
+async function platformaticService (app, opts) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
-  const beforePlugins = opts.beforePlugins || toLoad || []
+  const beforePlugins = opts.beforePlugins || arguments[2] || []
 
   if (isKeyEnabled('metrics', config)) {
+    if (config.metrics.server === 'own' && parseInt(config.server.port) === parseInt(config.metrics.port)) {
+      app.log.warn('In order to serve metrics on the same port as the core applicaton, set metrics.server to "parent".')
+      config.metrics.server = 'parent'
+    }
+
     app.register(setupMetrics, config.metrics)
   }
 

package/lib/plugins/metrics.js

@@ -8,26 +8,44 @@ const basicAuth = require('@fastify/basic-auth')
 const fastifyAccepts = require('@fastify/accepts')
 const Fastify = require('fastify')
 
-// This is a global server to match global
+// This is a global httpServer to match global
 // prometheus. It's an antipattern, so do
 // not use it elsewhere.
-let server = null
+let httpServer = null
 
 module.exports = fp(async function (app, opts) {
-  let port = 9090
-  let host = '0.0.0.0'
-  if (typeof opts === 'object') {
-    if (undefined !== opts.port) {
-      port = opts.port
+  const server = opts.server ?? 'own'
+  const hostname = opts.hostname ?? '0.0.0.0'
+  const port = opts.port ?? 9090
+  const metricsEndpoint = opts.endpoint ?? '/metrics'
+  const auth = opts.auth ?? null
+
+  let basicAuthValidator = null
+  if (auth) {
+    const { username, password } = auth
+    basicAuthValidator = function (user, pass, req, reply, done) {
+      if (username !== user || password !== pass) {
+        return reply.code(401).send({ message: 'Unauthorized' })
+      }
+      return done()
     }
-    /* c8 ignore next 3 */
-    if (undefined !== opts.hostname) {
-      host = opts.hostname
+
+    if (server === 'parent') {
+      await app.register(basicAuth, {
+        validate: basicAuthValidator
+      })
+
+      app.addHook('onRoute', (routeOptions) => {
+        if (routeOptions.url === metricsEndpoint) {
+          routeOptions.onRequest = app.basicAuth
+        }
+      })
     }
   }
+
   app.register(metricsPlugin, {
     defaultMetrics: { enabled: true },
-    endpoint: null,
+    endpoint: server === 'parent' ? metricsEndpoint : null,
     name: 'metrics',
     routeMetrics: { enabled: true },
     clearRegisterOnInit: true
@@ -56,24 +74,28 @@ module.exports = fp(async function (app, opts) {
     app.metrics.client.register.registerMetric(eluMetric)
   })
 
-  if (server && server.address().port !== port) {
-    await new Promise((resolve) => server.close(resolve))
-    server = null
+  if (httpServer && httpServer.address().port !== port) {
+    await new Promise((resolve) => httpServer.close(resolve))
+    httpServer = null
+  }
+
+  if (server === 'parent') {
+    return
   }
 
-  if (!server) {
-    server = http.createServer()
-    server.listen(port, host)
-    server.unref()
+  if (!httpServer) {
+    httpServer = http.createServer()
+    httpServer.listen(port, hostname)
+    httpServer.unref()
   }
 
   const promServer = Fastify({
     name: 'Prometheus server',
     serverFactory: (handler) => {
-      server.removeAllListeners('request')
-      server.removeAllListeners('clientError')
-      server.on('request', handler)
-      return server
+      httpServer.removeAllListeners('request')
+      httpServer.removeAllListeners('clientError')
+      httpServer.on('request', handler)
+      return httpServer
     },
     logger: app.log.child({ name: 'prometheus' })
   })
@@ -81,7 +103,7 @@ module.exports = fp(async function (app, opts) {
   promServer.register(fastifyAccepts)
 
   const metricsEndpointOptions = {
-    url: '/metrics',
+    url: metricsEndpoint,
     method: 'GET',
     logLevel: 'warn',
     handler: async (req, reply) => {
@@ -95,15 +117,9 @@ module.exports = fp(async function (app, opts) {
     }
   }
 
-  if (opts.auth) {
-    const { username, password } = opts.auth
+  if (auth) {
     await promServer.register(basicAuth, {
-      validate: function (user, pass, req, reply, done) {
-        if (username !== user || password !== pass) {
-          return reply.code(401).send({ message: 'Unauthorized' })
-        }
-        return done()
-      }
+      validate: basicAuthValidator
     })
     metricsEndpointOptions.onRequest = promServer.basicAuth
   }

package/lib/plugins/openapi.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const Swagger = require('@fastify/swagger')
-const SwaggerUI = require('@fastify/swagger-ui')
+const ScalarApiReference = require('@scalar/fastify-api-reference')
 const deepmerge = require('@fastify/deepmerge')({ all: true })
 const fp = require('fastify-plugin')
 
@@ -54,12 +54,20 @@ async function setupOpenAPI (app, opts) {
 
   await app.register(Swagger, swaggerOptions)
 
-  const { default: theme } = await import('@platformatic/swagger-ui-theme')
-  app.register(SwaggerUI, {
-    ...theme,
+  const { default: scalarTheme } = await import('@platformatic/scalar-theme')
+  const routePrefix = openapi.swaggerPrefix || '/documentation'
+
+  /** Serve spec file in yaml and json */
+  app.get(`${routePrefix}/json`, { schema: { hide: true } }, async () => app.swagger())
+  app.get(`${routePrefix}/yaml`, { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+  app.register(ScalarApiReference, {
+    ...opts,
     ...openapi,
-    logLevel: 'warn',
-    prefix: openapi.swaggerPrefix || '/documentation'
+    routePrefix,
+    configuration: {
+      customCss: scalarTheme.theme
+    }
   })
 }
 

package/lib/plugins/versions.js

@@ -13,7 +13,7 @@ const {
 const wrapperPath = join(__dirname, 'sandbox-wrapper.js')
 
 const Swagger = require('@fastify/swagger')
-const SwaggerUI = require('@fastify/swagger-ui')
+const ScalarApiReference = require('@scalar/fastify-api-reference')
 
 async function loadVersions (app) {
   const configManager = app.platformatic.configManager
@@ -44,9 +44,12 @@ async function loadVersions (app) {
       }
     })
 
-    app.register(SwaggerUI, {
+    app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
+    app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+    app.register(ScalarApiReference, {
       logLevel: 'warn',
-      prefix: '/documentation'
+      routePrefix: '/documentation'
     })
 
     if (latestVersionConfig.plugins) {
@@ -110,9 +113,12 @@ async function loadVersions (app) {
         }
       })
 
-      app.register(SwaggerUI, {
+      app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
+      app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+      app.register(ScalarApiReference, {
         logLevel: 'warn',
-        prefix: '/documentation'
+        routePrefix: '/documentation'
       })
 
       const componentSchemas = prevOpenapiSchema.components?.schemas ?? {}

package/lib/root-endpoint/public/index.html

@@ -222,6 +222,9 @@
     <script>
       const currentPath = window.location.pathname
     
+      const openApiLink = document.getElementById('openapi-link')
+      openApiLink.href = currentPath + 'documentation'
+
       const graphqlLink = document.getElementById('graphql-link')
       graphqlLink.href = currentPath + 'graphiql'
 

package/lib/schema.js

@@ -555,6 +555,11 @@ const metrics = {
           ]
         },
         hostname: { type: 'string' },
+        endpoint: { type: 'string' },
+        server: {
+          type: 'string',
+          enum: ['own', 'parent']
+        },
         auth: {
           type: 'object',
           properties: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.15.1",
+  "version": "1.17.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,7 +20,7 @@
     "@fastify/aws-lambda": "^3.3.0",
     "@fastify/compress": "^6.5.0",
     "bindings": "^1.5.0",
-    "c8": "^8.0.1",
+    "c8": "^9.0.0",
     "glob": "^10.3.10",
     "json-schema-to-typescript": "^13.1.1",
     "openapi-types": "^12.1.3",
@@ -31,7 +31,7 @@
     "standard": "^17.1.0",
     "strip-ansi": "^7.1.0",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.29.0",
+    "tsd": "^0.30.0",
     "typescript": "^5.2.2",
     "undici": "^6.0.0",
     "vscode-json-languageservice": "^5.3.6",
@@ -48,23 +48,23 @@
     "@fastify/restartable": "^2.1.1",
     "@fastify/static": "^6.11.2",
     "@fastify/swagger": "^8.10.1",
-    "@fastify/swagger-ui": "^2.0.0",
     "@fastify/under-pressure": "^8.3.0",
     "@mercuriusjs/federation": "^2.0.0",
+    "@scalar/fastify-api-reference": "^1.10.1",
     "@types/ws": "^8.5.6",
     "ajv": "^8.12.0",
+    "cli-progress": "^3.12.0",
     "close-with-grace": "^1.2.0",
     "code-block-writer": "^12.0.0",
-    "commist": "^3.2.0",
     "colorette": "^2.0.20",
-    "cli-progress": "^3.12.0",
+    "commist": "^3.2.0",
     "desm": "^1.3.0",
     "env-schema": "^5.2.0",
     "es-main": "^1.3.0",
     "execa": "^8.0.1",
     "fastify": "^4.23.2",
-    "fastify-openapi-glue": "^4.3.3",
     "fastify-metrics": "^10.3.2",
+    "fastify-openapi-glue": "^4.3.3",
     "fastify-plugin": "^4.5.1",
     "graphql": "^16.8.1",
     "help-me": "^5.0.0",
@@ -74,16 +74,16 @@
     "pino": "^8.15.3",
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
-    "undici": "^6.0.0",
     "ua-parser-js": "^1.0.36",
-    "@platformatic/authenticate": "1.15.1",
-    "@platformatic/client": "1.15.1",
-    "@platformatic/config": "1.15.1",
-    "@platformatic/generators": "1.15.1",
-    "@platformatic/swagger-ui-theme": "1.15.1",
-    "@platformatic/telemetry": "1.15.1",
-    "@platformatic/utils": "1.15.1",
-    "@platformatic/metaconfig": "1.15.1"
+    "undici": "^6.0.0",
+    "@platformatic/authenticate": "1.17.0",
+    "@platformatic/client": "1.17.0",
+    "@platformatic/config": "1.17.0",
+    "@platformatic/generators": "1.17.0",
+    "@platformatic/metaconfig": "1.17.0",
+    "@platformatic/scalar-theme": "1.17.0",
+    "@platformatic/telemetry": "1.17.0",
+    "@platformatic/utils": "1.17.0"
   },
   "standard": {
     "ignore": [
@@ -98,7 +98,7 @@
     ]
   },
   "scripts": {
-    "test": "pnpm run lint && c8 -x fixtures -x test node ./test/runner.js && tsd",
+    "test": "pnpm run lint && node ./test/runner.js && tsd",
     "nocov": "pnpm run lint && node ./test/runner.js && tsd",
     "build": "node lib/schema.js | json2ts > config.d.ts",
     "lint": "standard | snazzy && ts-standard | snazzy"

package/.taprc

@@ -1,2 +0,0 @@
-timeout: 500
-coverage: false