@platformatic/runtime 1.5.1 → 1.6.0

package/fixtures/configs/monorepo.json

@@ -5,7 +5,10 @@
   "hotReload": false,
   "autoload": {
     "path": "../monorepo",
-    "exclude": ["docs", "composerApp"],
+    "exclude": [
+      "docs",
+      "composerApp"
+    ],
     "mappings": {
       "serviceAppWithLogger": {
         "id": "with-logger",
@@ -14,6 +17,10 @@
       "serviceAppWithMultiplePlugins": {
         "id": "multi-plugin-service",
         "config": "platformatic.service.json"
+      },
+      "dbApp": {
+        "id": "db-app",
+        "config": "platformatic.db.json"
       }
     }
   }

package/fixtures/monorepo/dbApp/platformatic.db.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.22.0/db",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0
+  },
+  "db": {
+    "connectionString": "sqlite://db.sqlite",
+    "graphql": true,
+    "openapi": false,
+    "ignore": {
+      "versions": true
+    },
+    "events": false
+  }
+}

package/fixtures/server/logger-transport/custom-transport.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const build = require('pino-abstract-transport')
+const fs = require('fs')
+const path = require('path')
+
+module.exports = function (opts) {
+  const dest = opts.path || path.join(process.cwd(), 'transport.log')
+  return build(function (source) {
+    source.on('data', function (obj) {
+      obj.fromTransport = true
+      fs.appendFileSync(dest, JSON.stringify(obj) + '\n')
+    })
+  })
+}

package/fixtures/server/logger-transport/platformatic.runtime.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.31.0/runtime",
+  "entrypoint": "echo",
+  "allowCycles": false,
+  "hotReload": true,
+  "autoload": {
+    "path": "services",
+    "exclude": [
+      "docs"
+    ]
+  },
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "14242",
+    "logger": {
+      "level": "info",
+      "transport": {
+        "target": "./custom-transport.js"
+      }
+    }
+  }
+}

package/fixtures/server/logger-transport/services/echo/platformatic.service.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.28.1/service", 
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      "./routes"
+    ],
+    "typescript": false
+  }
+}

package/fixtures/server/logger-transport/services/echo/routes/hello.js

@@ -0,0 +1,6 @@
+'use strict'
+module.exports = async function (fastify, opts) {
+  fastify.get('/', async (request, reply) => {
+    return { hello: 'world' }
+  })
+}

package/fixtures/server/runtime-server/platformatic.runtime.json

@@ -9,7 +9,7 @@
       "docs"
     ]
   },
-   "server": {
+  "server": {
     "hostname": "127.0.0.1",
     "port": "14242",
     "logger": {

package/fixtures/server/runtime-server/services/echo/routes/hello.js

@@ -0,0 +1,6 @@
+'use strict'
+module.exports = async function (fastify, opts) {
+  fastify.get('/', async (request, reply) => {
+    return { hello: 'world' }
+  })
+}

package/lib/api-client.js

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

package/lib/api.js

@@ -4,6 +4,7 @@ const FastifyUndiciDispatcher = require('fastify-undici-dispatcher')
 const { Agent, setGlobalDispatcher } = require('undici')
 const { PlatformaticApp } = require('./app')
 const errors = require('./errors')
+const { printSchema } = require('graphql')
 
 class RuntimeApi {
   #services
@@ -101,6 +102,8 @@ class RuntimeApi {
         return this.#getServiceConfig(params)
       case 'plt:get-service-openapi-schema':
         return this.#getServiceOpenapiSchema(params)
+      case 'plt:get-service-graphql-schema':
+        return this.#getServiceGraphqlSchema(params)
       case 'plt:start-service':
         return this.#startService(params)
       case 'plt:stop-service':
@@ -218,6 +221,26 @@ class RuntimeApi {
     }
   }
 
+  async #getServiceGraphqlSchema ({ id }) {
+    const service = this.#getServiceById(id)
+
+    if (!service.config) {
+      throw new errors.ServiceNotStartedError(id)
+    }
+
+    if (typeof service.server.graphql !== 'function') {
+      return null
+    }
+
+    try {
+      await service.server.ready()
+      const graphqlSchema = printSchema(service.server.graphql.schema)
+      return graphqlSchema
+    } catch (err) {
+      throw new errors.FailedToRetrieveGraphQLSchemaError(id, err.message)
+    }
+  }
+
   async #startService ({ id }) {
     const service = this.#getServiceById(id)
     await service.start()

package/lib/errors.js

@@ -10,6 +10,7 @@ module.exports = {
   ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, "Service with id '%s' not found"),
   ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
   FailedToRetrieveOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`, 'Failed to retrieve OpenAPI schema for service with id "%s": %s'),
+  FailedToRetrieveGraphQLSchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`, 'Failed to retrieve GraphQL schema for service with id "%s": %s'),
   ApplicationAlreadyStartedError: createError(`${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`, 'Application is already started'),
   ApplicationNotStartedError: createError(`${ERROR_PREFIX}_APPLICATION_NOT_STARTED`, 'Application has not been started'),
   ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),

package/lib/worker.js

@@ -28,26 +28,40 @@ if (typeof register === 'function' && workerData.config.loaderFile) {
 
 globalThis.fetch = undici.fetch
 
-let transport
+const config = workerData.config
+
+let loggerConfig = config.server?.logger
 let destination
 
+if (loggerConfig) {
+  loggerConfig = { ...loggerConfig }
+} else {
+  loggerConfig = {}
+}
+
 /* c8 ignore next 10 */
-if (workerData.config.loggingPort) {
+if (config.loggingPort) {
   destination = new MessagePortWritable({
-    metadata: workerData.config.loggingMetadata,
-    port: workerData.config.loggingPort
+    metadata: config.loggingMetadata,
+    port: config.loggingPort
   })
-} else if (isatty(1)) {
-  transport = pino.transport({
+  delete loggerConfig.transport
+} else if (!loggerConfig.transport && isatty(1)) {
+  loggerConfig.transport = {
     target: 'pino-pretty'
-  })
+  }
 }
 
-const logger = pino(transport, destination)
+const logger = pino(loggerConfig, destination)
+
+if (config.server) {
+  config.server.logger = logger
+}
 
 /* c8 ignore next 4 */
 process.once('uncaughtException', (err) => {
   logger.error({ err }, 'runtime error')
+  logger[pino.symbols.streamSym].flushSync?.()
   setImmediate(() => {
     process.exit(1)
   })
@@ -57,6 +71,7 @@ process.once('uncaughtException', (err) => {
 /* c8 ignore next 4 */
 process.once('unhandledRejection', (err) => {
   logger.error({ err }, 'runtime error')
+  logger[pino.symbols.streamSym].flushSync?.()
   setImmediate(() => {
     process.exit(1)
   })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -22,13 +22,14 @@
     "execa": "^8.0.1",
     "express": "^4.18.2",
     "glob": "^10.3.10",
+    "pino-abstract-transport": "^1.1.0",
     "snazzy": "^9.0.0",
     "split2": "^4.2.0",
     "standard": "^17.1.0",
     "tsd": "^0.29.0",
     "typescript": "^5.2.2",
-    "@platformatic/sql-graphql": "1.5.1",
-    "@platformatic/sql-mapper": "1.5.1"
+    "@platformatic/sql-graphql": "1.6.0",
+    "@platformatic/sql-mapper": "1.6.0"
   },
   "dependencies": {
     "@fastify/error": "^3.4.0",
@@ -41,17 +42,18 @@
     "fastest-levenshtein": "^1.0.16",
     "fastify": "^4.24.1",
     "fastify-undici-dispatcher": "^0.5.0",
+    "graphql": "^16.8.1",
     "help-me": "^4.2.0",
     "minimist": "^1.2.8",
     "pino": "^8.16.0",
     "pino-pretty": "^10.2.3",
     "undici": "^5.26.3",
-    "@platformatic/composer": "1.5.1",
-    "@platformatic/config": "1.5.1",
-    "@platformatic/db": "1.5.1",
-    "@platformatic/service": "1.5.1",
-    "@platformatic/telemetry": "1.5.1",
-    "@platformatic/utils": "1.5.1"
+    "@platformatic/composer": "1.6.0",
+    "@platformatic/db": "1.6.0",
+    "@platformatic/config": "1.6.0",
+    "@platformatic/service": "1.6.0",
+    "@platformatic/telemetry": "1.6.0",
+    "@platformatic/utils": "1.6.0"
   },
   "standard": {
     "ignore": [

package/fixtures/server/runtime-server/services/echo/routes/span.js

@@ -1,8 +0,0 @@
-'use strict'
-module.exports = async function (fastify, opts) {
-  // This returns the traceId set on the span by the service
-  fastify.get('/', async (request, reply) => {
-    const traceId = request.span.spanContext().traceId
-    return { traceId }
-  })
-}