@platformatic/runtime 2.0.0-alpha.4 → 2.0.0-alpha.5

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha4Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha5Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;
@@ -201,10 +201,6 @@ export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha4Json = {
       };
   restartOnError?: boolean | number;
   services?: {
-    id: string;
-    path: string;
-    config?: string;
-    useHttp?: boolean;
     [k: string]: unknown;
   }[];
 };

package/lib/errors.js

@@ -13,6 +13,7 @@ module.exports = {
   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'),
+  FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata 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/generator/runtime-generator.js

@@ -202,7 +202,7 @@ class RuntimeGenerator extends BaseGenerator {
     })
 
     if (!this.existingConfig) {
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md')) })
+      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
     }
 
     return {
@@ -375,7 +375,7 @@ class RuntimeGenerator extends BaseGenerator {
 
         // delete dependencies
         const servicePackageJson = JSON.parse(
-          await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json'))
+          await readFile(join(this.targetDirectory, 'services', s.name, 'platformatic.json'), 'utf-8')
         )
         if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
           servicePackageJson.plugins.packages.forEach(p => {

package/lib/management-api.js

@@ -72,6 +72,20 @@ async function managementApiPlugin (app, opts) {
     return runtime.getServiceGraphqlSchema(id)
   })
 
+  app.get('/services/:id/connection-strings', async request => {
+    const { id } = request.params
+    try {
+      app.log.debug('get connection strings', { id })
+      const meta = await runtime.getServiceMeta(id)
+      if (meta.db) {
+        return meta.db
+      }
+      return null
+    } catch (err) {
+      throw new errors.FailedToRetrieveMetaError(id, err.message)
+    }
+  })
+
   app.post('/services/:id/start', async request => {
     const { id } = request.params
     app.log.debug('start service', { id })

package/lib/runtime.js

@@ -240,17 +240,20 @@ class Runtime extends EventEmitter {
       const config = this.#configManager.current
       const restartOnError = config.restartOnError
 
+      if (!restartOnError) {
+        this.logger.error(`Failed to start service "${id}".`)
+        throw error
+      }
+
       let bootstrapAttempt = this.#bootstrapAttempts.get(id)
       if (bootstrapAttempt++ >= MAX_BOOTSTRAP_ATTEMPTS || restartOnError === 0) {
-        this.logger.error(
-          `Failed to start service "${id}" after ${MAX_BOOTSTRAP_ATTEMPTS} attempts.`
-        )
+        this.logger.error(`Failed to start service "${id}" after ${MAX_BOOTSTRAP_ATTEMPTS} attempts.`)
         throw error
       }
 
       this.logger.warn(
         `Starting a service "${id}" in ${restartOnError}ms. ` +
-        `Attempt ${bootstrapAttempt} of ${MAX_BOOTSTRAP_ATTEMPTS}...`
+          `Attempt ${bootstrapAttempt} of ${MAX_BOOTSTRAP_ATTEMPTS}...`
       )
 
       this.#bootstrapAttempts.set(id, bootstrapAttempt)
@@ -720,7 +723,7 @@ class Runtime extends EventEmitter {
         if (started && this.#status === 'started') {
           if (restartOnError > 0) {
             this.logger.warn(`Restarting a service "${id}" in ${restartOnError}ms...`)
-            this.#restartCrashedService(id).catch((err) => {
+            this.#restartCrashedService(id).catch(err => {
               this.logger.error({ err }, `Failed to restart service "${id}".`)
             })
           } else {
@@ -736,7 +739,7 @@ class Runtime extends EventEmitter {
     // Setup ITC
     service[kITC] = new ITC({ port: service })
     service[kITC].listen()
-    service[kITC].handle('getServiceMeta', this.#getServiceMeta.bind(this))
+    service[kITC].handle('getServiceMeta', this.getServiceMeta.bind(this))
 
     // Handle services changes
     // This is not purposely activated on when this.#configManager.current.watch === true
@@ -838,7 +841,7 @@ class Runtime extends EventEmitter {
     return service
   }
 
-  async #getServiceMeta (id) {
+  async getServiceMeta (id) {
     const service = this.#services.get(id)
 
     if (!service) {

package/lib/schema.js

@@ -191,7 +191,10 @@ const platformaticRuntimeSchema = {
       type: 'array',
       items: {
         type: 'object',
-        required: ['id', 'path'],
+        anyOf: [
+          { required: ['id', 'path'] },
+          { required: ['id', 'url'] },
+        ],
         properties: {
           id: {
             type: 'string',
@@ -203,6 +206,9 @@ const platformaticRuntimeSchema = {
           config: {
             type: 'string',
           },
+          url: {
+            type: 'string',
+          },
           useHttp: {
             type: 'boolean',
           },

package/lib/worker/app.js

@@ -205,21 +205,14 @@ class PlatformaticApp extends EventEmitter {
 
   #logAndExit (err) {
     // Runtime logs here with console.error because stackable is not initialized
-    console.error(
-      JSON.stringify({
-        msg: err.message,
-        name: this.appConfig.id,
-      })
-    )
+    console.error(err.message)
     process.exit(1)
   }
 
   #wrapStackable (stackable) {
     const newStackable = {}
     for (const method of Object.keys(defaultStackable)) {
-      newStackable[method] = stackable[method]
-        ? stackable[method].bind(stackable)
-        : defaultStackable[method]
+      newStackable[method] = stackable[method] ? stackable[method].bind(stackable) : defaultStackable[method]
     }
     return newStackable
   }
@@ -240,8 +233,7 @@ class PlatformaticApp extends EventEmitter {
       }
     }
 
-    const dispatcher = getGlobalDispatcher()
-      .compose(interceptor)
+    const dispatcher = getGlobalDispatcher().compose(interceptor)
 
     setGlobalDispatcher(dispatcher)
   }

package/lib/worker/default-stackable.js

@@ -13,6 +13,7 @@ const defaultStackable = {
   getDispatchFunc: () => null,
   getOpenapiSchema: () => null,
   getGraphqlSchema: () => null,
+  getMeta: () => ({}),
   getMetrics: () => null,
   inject: () => {
     throw new Error('Stackable inject not implemented')

package/lib/worker/itc.js

@@ -110,6 +110,14 @@ function setupITC (app, service, dispatcher) {
     }
   })
 
+  itc.handle('getServiceMeta', async () => {
+    try {
+      return app.stackable.getMeta()
+    } catch (err) {
+      throw new errors.FailedToRetrieveMetaError(service.id, err.message)
+    }
+  })
+
   itc.handle('getMetrics', async format => {
     return app.stackable.getMetrics({ format })
   })

package/lib/worker/main.js

@@ -38,7 +38,7 @@ function handleUnhandled (type, err) {
 
 function createLogger () {
   const destination = new MessagePortWritable({ port: workerData.loggingPort })
-  const loggerInstance = pino({ level: 'trace' }, destination)
+  const loggerInstance = pino({ level: 'trace', name: workerData.serviceConfig.id }, destination)
 
   Reflect.defineProperty(process, 'stdout', { value: createPinoWritable(loggerInstance, 'info') })
   Reflect.defineProperty(process, 'stderr', { value: createPinoWritable(loggerInstance, 'error') })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.0.0-alpha.4",
+  "version": "2.0.0-alpha.5",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -34,11 +34,11 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.0.0-alpha.4",
-    "@platformatic/db": "2.0.0-alpha.4",
-    "@platformatic/service": "2.0.0-alpha.4",
-    "@platformatic/sql-graphql": "2.0.0-alpha.4",
-    "@platformatic/sql-mapper": "2.0.0-alpha.4"
+    "@platformatic/composer": "2.0.0-alpha.5",
+    "@platformatic/db": "2.0.0-alpha.5",
+    "@platformatic/sql-graphql": "2.0.0-alpha.5",
+    "@platformatic/sql-mapper": "2.0.0-alpha.5",
+    "@platformatic/service": "2.0.0-alpha.5"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -46,7 +46,7 @@
     "@hapi/topo": "^6.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
-    "close-with-grace": "^1.3.0",
+    "close-with-grace": "^2.0.0",
     "commist": "^3.2.0",
     "debounce": "^2.0.0",
     "desm": "^1.3.1",
@@ -64,15 +64,15 @@
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "undici": "^6.9.0",
-    "undici-thread-interceptor": "^0.5.0",
+    "undici-thread-interceptor": "^0.5.1",
     "ws": "^8.16.0",
-    "@platformatic/config": "2.0.0-alpha.4",
-    "@platformatic/basic": "2.0.0-alpha.4",
-    "@platformatic/generators": "2.0.0-alpha.4",
-    "@platformatic/itc": "2.0.0-alpha.4",
-    "@platformatic/telemetry": "2.0.0-alpha.4",
-    "@platformatic/ts-compiler": "2.0.0-alpha.4",
-    "@platformatic/utils": "2.0.0-alpha.4"
+    "@platformatic/basic": "2.0.0-alpha.5",
+    "@platformatic/itc": "2.0.0-alpha.5",
+    "@platformatic/generators": "2.0.0-alpha.5",
+    "@platformatic/telemetry": "2.0.0-alpha.5",
+    "@platformatic/ts-compiler": "2.0.0-alpha.5",
+    "@platformatic/utils": "2.0.0-alpha.5",
+    "@platformatic/config": "2.0.0-alpha.5"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",

package/runtime.mjs

@@ -33,7 +33,7 @@ export async function run (argv) {
   })
 
   if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
+    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version)
     process.exit(0)
   }
 

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.4.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.5.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
@@ -766,9 +766,19 @@
       "type": "array",
       "items": {
         "type": "object",
-        "required": [
-          "id",
-          "path"
+        "anyOf": [
+          {
+            "required": [
+              "id",
+              "path"
+            ]
+          },
+          {
+            "required": [
+              "id",
+              "url"
+            ]
+          }
         ],
         "properties": {
           "id": {
@@ -781,6 +791,9 @@
           "config": {
             "type": "string"
           },
+          "url": {
+            "type": "string"
+          },
           "useHttp": {
             "type": "boolean"
           }