@platformatic/runtime 0.35.3 → 0.35.4

package/fixtures/configs/monorepo-openapi.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.35.0/runtime",
+  "entrypoint": "without-openapi",
+  "hotReload": false,
+  "services": [
+    {
+      "id": "without-openapi",
+      "path": "../monorepo-openapi/serviceAppWithoutOpenapi",
+      "config": "platformatic.service.json"
+    }
+  ]
+}

package/fixtures/monorepo-openapi/serviceAppWithoutOpenapi/platformatic.service.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.20.0/service",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0
+  },
+  "plugins": {
+    "paths": [
+      "plugin.js"
+    ]
+  },
+  "watch": false
+}

package/fixtures/monorepo-openapi/serviceAppWithoutOpenapi/plugin.js

@@ -0,0 +1,8 @@
+'use strict'
+
+/** @param {import('fastify').FastifyInstance} app */
+module.exports = async function (app) {
+  app.get('/', async () => {
+    return { hello: 'world' }
+  })
+}

package/lib/api-client.js

@@ -47,6 +47,10 @@ class RuntimeApiClient extends EventEmitter {
     return this.#sendCommand('plt:get-service-config', { id })
   }
 
+  async getServiceOpenapiSchema (id) {
+    return this.#sendCommand('plt:get-service-openapi-schema', { id })
+  }
+
   async startService (id) {
     return this.#sendCommand('plt:start-service', { id })
   }

package/lib/api.js

@@ -7,7 +7,6 @@ const { PlatformaticApp } = require('./app')
 class RuntimeApi {
   #services
   #dispatcher
-  #loaderPort
 
   constructor (config, logger, loaderPort) {
     this.#services = new Map()
@@ -87,6 +86,8 @@ class RuntimeApi {
         return this.#getServiceDetails(params)
       case 'plt:get-service-config':
         return this.#getServiceConfig(params)
+      case 'plt:get-service-openapi-schema':
+        return this.#getServiceOpenapiSchema(params)
       case 'plt:start-service':
         return this.#startService(params)
       case 'plt:stop-service':
@@ -184,6 +185,25 @@ class RuntimeApi {
     return config.configManager.current
   }
 
+  async #getServiceOpenapiSchema ({ id }) {
+    const service = this.#getServiceById(id)
+
+    if (!service.config) {
+      throw new Error(`Service with id '${id}' is not started`)
+    }
+
+    if (typeof service.server.swagger !== 'function') {
+      throw new Error(`Service with id '${id}' does not expose an OpenAPI schema`)
+    }
+
+    try {
+      const openapiSchema = service.server.swagger()
+      return openapiSchema
+    } catch (err) {
+      throw new Error(`Failed to retrieve OpenAPI schema for service with id '${id}': ${err.message}`)
+    }
+  }
+
   async #startService ({ id }) {
     const service = this.#getServiceById(id)
     await service.start()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.35.3",
+  "version": "0.35.4",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -24,8 +24,8 @@
     "standard": "^17.1.0",
     "tsd": "^0.28.1",
     "typescript": "^5.1.6",
-    "@platformatic/sql-graphql": "0.35.3",
-    "@platformatic/sql-mapper": "0.35.3"
+    "@platformatic/sql-graphql": "0.35.4",
+    "@platformatic/sql-mapper": "0.35.4"
   },
   "dependencies": {
     "@hapi/topo": "^6.0.2",
@@ -42,12 +42,12 @@
     "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "undici": "^5.22.1",
-    "@platformatic/composer": "0.35.3",
-    "@platformatic/config": "0.35.3",
-    "@platformatic/db": "0.35.3",
-    "@platformatic/service": "0.35.3",
-    "@platformatic/telemetry": "0.35.3",
-    "@platformatic/utils": "0.35.3"
+    "@platformatic/composer": "0.35.4",
+    "@platformatic/config": "0.35.4",
+    "@platformatic/db": "0.35.4",
+    "@platformatic/service": "0.35.4",
+    "@platformatic/telemetry": "0.35.4",
+    "@platformatic/utils": "0.35.4"
   },
   "standard": {
     "ignore": [

package/test/api.test.js

@@ -303,3 +303,55 @@ test('should handle a lot of runtime api requests', async (t) => {
 
   await Promise.all(promises)
 })
+
+test('should get a service openapi schema', async (t) => {
+  const configFile = join(fixturesDir, 'configs', 'monorepo.json')
+  const config = await loadConfig({}, ['-c', configFile], platformaticRuntime)
+  const app = await buildServer(config.configManager.current)
+
+  await app.start()
+
+  t.after(async () => {
+    await app.close()
+  })
+
+  const openapiSchema = await app.getServiceOpenapiSchema('with-logger')
+  assert.deepStrictEqual(openapiSchema, {
+    openapi: '3.0.3',
+    info: {
+      title: 'Platformatic',
+      description: 'This is a service built on top of Platformatic',
+      version: '1.0.0'
+    },
+    components: { schemas: {} },
+    paths: {
+      '/': {
+        get: {
+          responses: {
+            200: {
+              description: 'Default Response'
+            }
+          }
+        }
+      }
+    }
+  })
+})
+
+test('should fail to get a service openapi schema if service does not expose it', async (t) => {
+  const configFile = join(fixturesDir, 'configs', 'monorepo-openapi.json')
+  const config = await loadConfig({}, ['-c', configFile], platformaticRuntime)
+  const app = await buildServer(config.configManager.current)
+
+  await app.start()
+
+  t.after(async () => {
+    await app.close()
+  })
+
+  try {
+    await app.getServiceOpenapiSchema('without-openapi')
+  } catch (err) {
+    assert.strictEqual(err.message, 'Service with id \'without-openapi\' does not expose an OpenAPI schema')
+  }
+})