@platformatic/composer 2.40.0 → 2.42.0

package/index.js

@@ -6,10 +6,9 @@ const { platformaticService, buildServer, buildStackable } = require('@platforma
 
 const { schema } = require('./lib/schema')
 const serviceProxy = require('./lib/proxy')
-const openapi = require('./lib/openapi.js')
 const graphql = require('./lib/graphql')
 const composerHook = require('./lib/composer-hook')
-const openapiGenerator = require('./lib/openapi-generator')
+const { openApiGenerator, openApiComposer } = require('./lib/openapi-generator')
 const graphqlGenerator = require('./lib/graphql-generator')
 const { isSameGraphqlSchema, fetchGraphqlSubgraphs } = require('./lib/graphql-fetch')
 const notHostConstraints = require('./lib/proxy/not-host-constraints')
@@ -42,15 +41,18 @@ async function platformaticComposer (app, opts) {
     }
   }
 
+  await app.register(composerHook)
+
+  let generatedComposedOpenAPI = null
   if (hasOpenapiServices) {
-    app.register(openapi, config.composer)
+    generatedComposedOpenAPI = await openApiGenerator(app, config.composer)
   }
+
   app.register(serviceProxy, { ...config.composer, context: opts.context })
-  app.register(composerHook)
-  await app.register(platformaticService, { config, context: opts.context })
+  await app.register(platformaticService, { config: { ...config, openapi: false }, context: opts.context })
 
-  if (hasOpenapiServices) {
-    await app.register(openapiGenerator, config.composer)
+  if (generatedComposedOpenAPI) {
+    await app.register(openApiComposer, { opts: config.composer, generated: generatedComposedOpenAPI })
   }
 
   if (hasGraphqlServices) {

package/lib/openapi-composer.js

@@ -6,6 +6,7 @@ const errors = require('./errors')
 function composeOpenApi (apis, options = {}) {
   const mergedPaths = {}
   const mergedSchemas = {}
+  const mergedSecuritySchemes = {}
 
   for (const { id, prefix, schema } of apis) {
     const { paths, components } = clone(schema)
@@ -15,6 +16,18 @@ function composeOpenApi (apis, options = {}) {
       namespaceSchemaRefs(apiPrefix, pathSchema)
       namespaceSchemaOperationIds(apiPrefix, pathSchema)
 
+      for (const methodSchema of Object.values(pathSchema)) {
+        if (methodSchema.security) {
+          methodSchema.security = methodSchema.security.map(security => {
+            const newSecurity = {}
+            for (const [securityKey, securityValue] of Object.entries(security)) {
+              newSecurity[apiPrefix + securityKey] = securityValue
+            }
+            return newSecurity
+          })
+        }
+      }
+
       const mergedPath = prefix ? prefix + path : path
 
       if (mergedPaths[mergedPath]) {
@@ -23,13 +36,21 @@ function composeOpenApi (apis, options = {}) {
       mergedPaths[mergedPath] = pathSchema
     }
 
-    if (components && components.schemas) {
-      for (const [schemaKey, schema] of Object.entries(components.schemas)) {
-        if (schema.title == null) {
-          schema.title = schemaKey
+    if (components) {
+      if (components.schemas) {
+        for (const [schemaKey, schema] of Object.entries(components.schemas)) {
+          if (schema.title == null) {
+            schema.title = schemaKey
+          }
+          namespaceSchemaRefs(apiPrefix, schema)
+          mergedSchemas[apiPrefix + schemaKey] = schema
+        }
+      }
+
+      if (components.securitySchemes) {
+        for (const [securitySchemeKey, securityScheme] of Object.entries(components.securitySchemes)) {
+          mergedSecuritySchemes[apiPrefix + securitySchemeKey] = securityScheme
         }
-        namespaceSchemaRefs(apiPrefix, schema)
-        mergedSchemas[apiPrefix + schemaKey] = schema
       }
     }
   }
@@ -41,6 +62,7 @@ function composeOpenApi (apis, options = {}) {
       version: options.version || '1.0.0',
     },
     components: {
+      securitySchemes: mergedSecuritySchemes,
       schemas: mergedSchemas,
     },
     paths: mergedPaths,

package/lib/openapi-generator.js

@@ -3,12 +3,14 @@
 const { readFile } = require('node:fs/promises')
 const { request, getGlobalDispatcher } = require('undici')
 const fp = require('fastify-plugin')
-const errors = require('./errors')
+const fastifySwagger = require('@fastify/swagger')
 
+const errors = require('./errors')
 const { modifyOpenApiSchema, originPathSymbol } = require('./openapi-modifier')
 const composeOpenApi = require('./openapi-composer')
 const loadOpenApiConfig = require('./openapi-load-config.js')
 const { prefixWithSlash } = require('./utils.js')
+const openApiScalar = require('./openapi-scalar')
 
 async function fetchOpenApiSchema (openApiUrl) {
   const { body } = await request(openApiUrl)
@@ -29,7 +31,7 @@ async function getOpenApiSchema (origin, openapi) {
   return readOpenApiSchema(openapi.file)
 }
 
-async function composeOpenAPI (app, opts) {
+async function generateComposedOpenApi (app, opts) {
   if (!opts.services.some(s => s.openapi)) { return }
 
   const { services } = opts
@@ -72,9 +74,46 @@ async function composeOpenAPI (app, opts) {
     openApiSchemas.push({ id, prefix, schema, originSchema, config: openapiConfig })
   }
 
+  const composedOpenApiSchema = composeOpenApi(openApiSchemas, opts.openapi)
+
   app.decorate('openApiSchemas', openApiSchemas)
+  app.decorate('composedOpenApiSchema', composedOpenApiSchema)
+
+  await app.register(fastifySwagger, {
+    exposeRoute: true,
+    openapi: {
+      info: {
+        title: opts.openapi?.title || 'Platformatic Composer',
+        version: opts.openapi?.version || '1.0.0'
+      },
+      servers: [{ url: globalThis.platformatic?.runtimeBasePath ?? '/' }],
+      components: app.composedOpenApiSchema.components
+    },
+    transform ({ schema, url }) {
+      for (const service of opts.services) {
+        if (!service.proxy) continue
+
+        const prefix = service.proxy.prefix ?? ''
+        const proxyPrefix = prefix.at(-1) === '/' ? prefix.slice(0, -1) : prefix
+
+        const proxyUrls = [proxyPrefix + '/', proxyPrefix + '/*']
+        if (proxyUrls.includes(url)) {
+          schema = schema ?? {}
+          schema.hide = true
+          break
+        }
+      }
+      return { schema, url }
+    }
+  })
 
-  const composedOpenApiSchema = composeOpenApi(openApiSchemas, opts.openapi)
+  await app.register(openApiScalar, opts)
+
+  return { apiByApiRoutes }
+}
+
+async function openApiComposer (app, { opts, generated }) {
+  const { apiByApiRoutes } = generated
 
   const dispatcher = getGlobalDispatcher()
 
@@ -84,7 +123,7 @@ async function composeOpenAPI (app, opts) {
   })
 
   await app.register(await import('@platformatic/fastify-openapi-glue'), {
-    specification: composedOpenApiSchema,
+    specification: app.composedOpenApiSchema,
     addEmptySchema: opts.addEmptySchema,
     operationResolver: (operationId, method, openApiPath) => {
       const { origin, prefix, schema } = apiByApiRoutes[openApiPath]
@@ -167,4 +206,5 @@ function generateRenamedPath (renamedOpenApiPath, routeParams) {
   return renamedOpenApiPath.replace(/{(.*?)}/g, () => routeParams.shift())
 }
 
-module.exports = fp(composeOpenAPI)
+module.exports.openApiGenerator = generateComposedOpenApi
+module.exports.openApiComposer = fp(openApiComposer)

package/lib/openapi-scalar.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+
+async function openApiScalar (app, opts) {
+  const { default: scalarTheme } = await import('@platformatic/scalar-theme')
+
+  /** Serve spec file in yaml and json */
+  app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
+  app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
+
+  const routePrefix = opts.openapi?.swaggerPrefix || '/documentation'
+
+  await app.register(require('@scalar/fastify-api-reference'), {
+    logLevel: 'warn',
+    routePrefix,
+    configuration: {
+      customCss: scalarTheme.theme
+    }
+  })
+}
+
+module.exports = fp(openApiScalar)

package/lib/proxy.js

@@ -1,8 +1,9 @@
 'use strict'
 
-const { getGlobalDispatcher } = require('undici')
 const httpProxy = require('@fastify/http-proxy')
 const fp = require('fastify-plugin')
+const { workerData } = require('node:worker_threads')
+const { getGlobalDispatcher } = require('undici')
 
 const kITC = Symbol.for('plt.runtime.itc')
 const kProxyRoute = Symbol('plt.composer.proxy.route')
@@ -14,12 +15,18 @@ async function resolveServiceProxyParameters (service) {
   const meta = (await globalThis[kITC]?.send('getServiceMeta', service.id))?.composer ?? { prefix: service.id }
 
   // If no prefix could be found, assume the service id
-  const prefix = (service.proxy?.prefix ?? meta.prefix ?? service.id).replace(/(\/$)/g, '')
-
+  let prefix = (service.proxy?.prefix ?? meta.prefix ?? service.id).replace(/(\/$)/g, '')
   let rewritePrefix = ''
   let internalRewriteLocationHeader = true
 
   if (meta.wantsAbsoluteUrls) {
+    const basePath = workerData.config.basePath
+
+    // Strip the runtime basepath from the prefix when it comes from the service meta
+    if (basePath && !service.proxy?.prefix && prefix.startsWith(basePath)) {
+      prefix = prefix.substring(basePath.length)
+    }
+
     // The rewritePrefix purposely ignores service.proxy?.prefix to let
     // the service always being able to configure their value
     rewritePrefix = meta.prefix ?? service.id
@@ -138,7 +145,14 @@ module.exports = fp(async function (app, opts) {
       })
     }
 
-    const toReplace = url ? new RegExp(url.replace(/127\.0\.0\.1/, 'localhost').replace(/\[::\]/, 'localhost').replace('http://', 'https?://')) : null
+    const toReplace = url
+      ? new RegExp(
+        url
+          .replace(/127\.0\.0\.1/, 'localhost')
+          .replace(/\[::\]/, 'localhost')
+          .replace('http://', 'https?://')
+      )
+      : null
 
     const proxyOptions = {
       websocket: true,
@@ -153,7 +167,7 @@ module.exports = fp(async function (app, opts) {
       },
       internalRewriteLocationHeader: false,
       replyOptions: {
-        rewriteHeaders: (headers) => {
+        rewriteHeaders: headers => {
           let location = headers.location
           if (location) {
             if (toReplace) {
@@ -186,7 +200,7 @@ module.exports = fp(async function (app, opts) {
             ...telemetryHeaders,
             'x-forwarded-for': request.ip,
             'x-forwarded-host': request.host,
-            'x-forwarded-proto': request.protocol,
+            'x-forwarded-proto': request.protocol
           }
 
           request.log.trace({ headers }, 'rewritten headers before proxying')
@@ -209,6 +223,7 @@ module.exports = fp(async function (app, opts) {
     if (host) {
       await app.register(httpProxy, {
         ...proxyOptions,
+        prefix: '/',
         constraints: { host }
       })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/composer",
-  "version": "2.40.0",
+  "version": "2.42.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -31,9 +31,9 @@
     "typescript": "^5.5.4",
     "why-is-node-running": "2",
     "ws": "^8.16.0",
-    "@platformatic/client": "2.40.0",
-    "@platformatic/config": "2.40.0",
-    "@platformatic/db": "2.40.0"
+    "@platformatic/client": "2.42.0",
+    "@platformatic/config": "2.42.0",
+    "@platformatic/db": "2.42.0"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -42,7 +42,7 @@
     "@fastify/static": "^8.0.0",
     "@fastify/swagger": "^9.0.0",
     "@fastify/view": "^10.0.1",
-    "@platformatic/fastify-openapi-glue": "^5.0.0",
+    "@platformatic/fastify-openapi-glue": "^5.1.0",
     "@platformatic/graphql-composer": "^0.10.0",
     "@scalar/fastify-api-reference": "^1.19.5",
     "ajv": "^8.12.0",
@@ -67,12 +67,12 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/config": "2.40.0",
-    "@platformatic/generators": "2.40.0",
-    "@platformatic/scalar-theme": "2.40.0",
-    "@platformatic/service": "2.40.0",
-    "@platformatic/telemetry": "2.40.0",
-    "@platformatic/utils": "^2.40.0"
+    "@platformatic/generators": "2.42.0",
+    "@platformatic/scalar-theme": "2.42.0",
+    "@platformatic/telemetry": "2.42.0",
+    "@platformatic/service": "2.42.0",
+    "@platformatic/utils": "^2.42.0",
+    "@platformatic/config": "2.42.0"
   },
   "scripts": {
     "test": "pnpm run lint && borp -T --timeout=300000 -c 1 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/composer/2.40.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/composer/2.42.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Composer",
   "type": "object",

package/lib/openapi.js

@@ -1,50 +0,0 @@
-'use strict'
-
-const fp = require('fastify-plugin')
-
-async function composeOpenAPI (app, opts) {
-  await app.register(require('@fastify/swagger'), {
-    exposeRoute: true,
-    openapi: {
-      info: {
-        title: opts.openapi?.title || 'Platformatic Composer',
-        version: opts.openapi?.version || '1.0.0'
-      },
-      servers: [{ url: globalThis.platformatic?.runtimeBasePath ?? '/' }],
-    },
-    transform: ({ schema, url }) => {
-      for (const service of opts.services) {
-        if (!service.proxy) continue
-
-        const prefix = service.proxy.prefix ?? ''
-        const proxyPrefix = prefix.at(-1) === '/' ? prefix.slice(0, -1) : prefix
-
-        const proxyUrls = [proxyPrefix + '/', proxyPrefix + '/*']
-        if (proxyUrls.includes(url)) {
-          schema = schema ?? {}
-          schema.hide = true
-          break
-        }
-      }
-      return { schema, url }
-    }
-  })
-
-  const { default: scalarTheme } = await import('@platformatic/scalar-theme')
-
-  /** Serve spec file in yaml and json */
-  app.get('/documentation/json', { schema: { hide: true } }, async () => app.swagger())
-  app.get('/documentation/yaml', { schema: { hide: true } }, async () => app.swagger({ yaml: true }))
-
-  const routePrefix = opts.openapi?.swaggerPrefix || '/documentation'
-
-  await app.register(require('@scalar/fastify-api-reference'), {
-    logLevel: 'warn',
-    routePrefix,
-    configuration: {
-      customCss: scalarTheme.theme
-    }
-  })
-}
-
-module.exports = fp(composeOpenAPI)