@platformatic/runtime 2.0.0-alpha.1 → 2.0.0-alpha.3

package/fixtures/typescript-no-env/services/movies/types/index.d.ts

@@ -1,7 +1,7 @@
 import { Movie } from './Movie'
-  
-  interface EntityTypes  {
-    Movie:Movie
-  }
-  
-  export { EntityTypes ,Movie }
+
+interface EntityTypes {
+  Movie: Movie
+}
+
+export { EntityTypes, Movie }

package/fixtures/typescript-no-env/services/titles/client/client.d.ts

@@ -1,10 +1,10 @@
 import { FastifyPluginAsync } from 'fastify'
 
 interface GetMoviesRequest {
-  'limit'?: number;
-  'offset'?: number;
-  'totalCount'?: boolean;
-  'fields'?: Array<string>;
+  limit?: number;
+  offset?: number;
+  totalCount?: boolean;
+  fields?: Array<string>;
   'where.id.eq'?: number;
   'where.id.neq'?: number;
   'where.id.gt'?: number;
@@ -29,22 +29,22 @@ interface GetMoviesRequest {
 }
 
 interface GetMoviesResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface CreateMovieRequest {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface CreateMovieResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface UpdateMoviesRequest {
-  'fields'?: Array<string>;
+  fields?: Array<string>;
   'where.id.eq'?: number;
   'where.id.neq'?: number;
   'where.id.gt'?: number;
@@ -64,44 +64,44 @@ interface UpdateMoviesRequest {
   'where.title.in'?: string;
   'where.title.nin'?: string;
   'where.or'?: Array<string>;
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface UpdateMoviesResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface GetMovieByIdRequest {
-  'fields'?: Array<string>;
-  'id': number;
+  fields?: Array<string>;
+  id: number;
 }
 
 interface GetMovieByIdResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface UpdateMovieRequest {
-  'fields'?: Array<string>;
-  'id': number;
-  'title': string;
+  fields?: Array<string>;
+  id: number;
+  title: string;
 }
 
 interface UpdateMovieResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface DeleteMoviesRequest {
-  'fields'?: Array<string>;
-  'id': number;
+  fields?: Array<string>;
+  id: number;
 }
 
 interface DeleteMoviesResponseOK {
-  'id'?: number;
-  'title': string;
+  id?: number;
+  title: string;
 }
 
 interface Client {
@@ -117,15 +117,15 @@ type ClientPlugin = FastifyPluginAsync<NonNullable<client.ClientOptions>>
 
 declare module 'fastify' {
   interface ConfigureClient {
-    getHeaders(req: FastifyRequest, reply: FastifyReply): Promise<Record<string,string>>;
+    getHeaders(req: FastifyRequest, reply: FastifyReply): Promise<Record<string, string>>;
   }
   interface FastifyInstance {
-    'client': Client;
+    client: Client;
     configureClient(opts: ConfigureClient): unknown
   }
 
   interface FastifyRequest {
-    'client': Client;
+    client: Client;
   }
 }
 
@@ -133,9 +133,9 @@ declare namespace client {
   export interface ClientOptions {
     url: string
   }
-  export const client: ClientPlugin;
-  export { client as default };
+  export const client: ClientPlugin
+  export { client as default }
 }
 
-declare function client(...params: Parameters<ClientPlugin>): ReturnType<ClientPlugin>;
-export = client;
+declare function client (...params: Parameters<ClientPlugin>): ReturnType<ClientPlugin>
+export = client

package/fixtures/typescript-no-env/services/titles/platformatic.service.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.28.1/service",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
   "server": {
     "hostname": "{PLT_SERVER_HOSTNAME}",
     "port": "{PORT}",

package/index.d.ts

@@ -11,13 +11,13 @@ export type pltRuntimeBuildServer = {
 }
 
 declare module '@platformatic/runtime' {
-  export function buildServer(opts: object): Promise<pltRuntimeBuildServer>
-  export function start(args: object): Promise<object>
-  export function startCommand(args: object): Promise<void>
-  export function loadConfig(minimistConfig: object, args: object, store: object, overrides: object, replaceEnv: boolean): void
-  export function compile(argv: string[], logger: BaseLogger): void
-  export function platformaticRuntime(): Promise<void>
-  export function wrapConfigInRuntimeConfig(args: object): object
+  export function buildServer (opts: object): Promise<pltRuntimeBuildServer>
+  export function start (args: object): Promise<object>
+  export function startCommand (args: object): Promise<void>
+  export function loadConfig (minimistConfig: object, args: object, store: object, overrides: object, replaceEnv: boolean): void
+  export function compile (argv: string[], logger: BaseLogger): void
+  export function platformaticRuntime (): Promise<void>
+  export function wrapConfigInRuntimeConfig (args: object): object
   export const Generator: RuntimeGenerator.RuntimeGenerator
 }
 
@@ -42,4 +42,3 @@ export module errors {
   export const CannotMapSpecifierToAbsolutePathError: (specifier: string) => FastifyError
   export const NodeInspectorFlagsNotSupportedError: () => FastifyError
 }
-

package/index.js

@@ -1,21 +1,25 @@
 'use strict'
+
 const { buildServer } = require('./lib/build-server')
-const { platformaticRuntime, wrapConfigInRuntimeConfig } = require('./lib/config')
-const { start, startCommand } = require('./lib/start')
-const RuntimeApi = require('./lib/api')
 const { compile } = require('./lib/compile')
-const { loadConfig } = require('./lib/load-config')
 const errors = require('./lib/errors')
+const { platformaticRuntime, wrapConfigInRuntimeConfig } = require('./lib/config')
 const RuntimeGenerator = require('./lib/generator/runtime-generator')
+const { Runtime } = require('./lib/runtime')
+const { start, startCommand } = require('./lib/start')
+const symbols = require('./lib/worker/symbols')
+const { loadConfig, getRuntimeLogsDir } = require('./lib/utils')
 
 module.exports.buildServer = buildServer
+module.exports.compile = compile
+module.exports.errors = errors
+module.exports.Generator = RuntimeGenerator
+module.exports.getRuntimeLogsDir = getRuntimeLogsDir
+module.exports.loadConfig = loadConfig
 module.exports.platformaticRuntime = platformaticRuntime
-module.exports.wrapConfigInRuntimeConfig = wrapConfigInRuntimeConfig
 module.exports.schema = platformaticRuntime.schema
-module.exports.RuntimeApi = RuntimeApi
 module.exports.start = start
 module.exports.startCommand = startCommand
-module.exports.compile = compile
-module.exports.loadConfig = loadConfig
-module.exports.errors = errors
-module.exports.Generator = RuntimeGenerator
+module.exports.symbols = symbols
+module.exports.Runtime = Runtime
+module.exports.wrapConfigInRuntimeConfig = wrapConfigInRuntimeConfig

package/index.test-d.ts

@@ -1,6 +1,6 @@
-import { expectError, expectType } from 'tsd';
-import { LightMyRequestResponse } from 'fastify';
-import { pltRuntimeBuildServer, errors } from '.';
+import { expectError, expectType } from 'tsd'
+import { LightMyRequestResponse } from 'fastify'
+import { pltRuntimeBuildServer, errors } from '.'
 import { FastifyError } from '@fastify/error'
 
 const server: pltRuntimeBuildServer = {
@@ -9,19 +9,18 @@ const server: pltRuntimeBuildServer = {
   restart: async () => { },
   stop: async () => { },
   inject: async () => ({} as LightMyRequestResponse),
-};
+}
 
-expectType<pltRuntimeBuildServer>(server);
-expectError<pltRuntimeBuildServer>({ ...server, address: 42 });
-expectError<pltRuntimeBuildServer>({ ...server, port: 'WRONG' });
-expectError<pltRuntimeBuildServer>({ ...server, restart: 'WRONG' });
-expectError<pltRuntimeBuildServer>({ ...server, stop: 'WRONG' });
-expectError<pltRuntimeBuildServer>({ ...server, inject: 'WRONG' });
+expectType<pltRuntimeBuildServer>(server)
+expectError<pltRuntimeBuildServer>({ ...server, address: 42 })
+expectError<pltRuntimeBuildServer>({ ...server, port: 'WRONG' })
+expectError<pltRuntimeBuildServer>({ ...server, restart: 'WRONG' })
+expectError<pltRuntimeBuildServer>({ ...server, stop: 'WRONG' })
+expectError<pltRuntimeBuildServer>({ ...server, inject: 'WRONG' })
 
 // Errors
 type ErrorWithNoParams = () => FastifyError
 type ErrorWithOneParam = (param: string) => FastifyError
-type ErrorWithOneAnyParam = (param: string) => FastifyError
 type ErrorWithTwoParams = (param1: string, param2: string) => FastifyError
 
 expectType<ErrorWithNoParams>(errors.RuntimeExitedError)
@@ -40,4 +39,3 @@ expectType<ErrorWithNoParams>(errors.InspectorPortError)
 expectType<ErrorWithNoParams>(errors.InspectorHostError)
 expectType<ErrorWithOneParam>(errors.CannotMapSpecifierToAbsolutePathError)
 expectType<ErrorWithNoParams>(errors.NodeInspectorFlagsNotSupportedError)
-

package/lib/build-server.js

@@ -2,32 +2,26 @@
 
 const { createRequire } = require('node:module')
 const { join } = require('node:path')
+
 const ConfigManager = require('@platformatic/config')
+
 const { platformaticRuntime } = require('./config')
 const { buildRuntime } = require('./start')
-const { loadConfig } = require('./load-config')
+const { loadConfig } = require('./utils')
 
 async function buildServerRuntime (options = {}) {
-  const {
-    serviceMap,
-    loggingPort,
-    loggingMetadata
-  } = options
+  const { serviceMap } = options
 
   if (!options.configManager) {
     delete options.serviceMap
-    delete options.loggingPort
-    delete options.loggingMetadata
 
     // Instantiate a new config manager from the current options.
     const cm = new ConfigManager({
       ...platformaticRuntime.configManagerConfig,
-      source: options
+      source: options,
     })
     await cm.parseAndValidate()
 
-    cm.current.loggingPort = loggingPort
-    cm.current.loggingMetadata = loggingMetadata
     cm.current.serviceMap = serviceMap
 
     if (typeof options === 'string') {

package/lib/compile.js

@@ -1,18 +1,19 @@
 'use strict'
 
-const tsCompiler = require('@platformatic/ts-compiler')
-const { loadConfig } = require('./load-config')
-const { dirname, join } = require('node:path')
 const { createRequire } = require('node:module')
+const { dirname, join } = require('node:path')
+const { isatty } = require('node:tty')
 const { pathToFileURL } = require('node:url')
 
+const tsCompiler = require('@platformatic/ts-compiler')
 const pino = require('pino')
 const pretty = require('pino-pretty')
-const { isatty } = require('node:tty')
+
+const { loadConfig } = require('./utils')
 
 async function compile (argv, logger) {
   const { configManager, configType, app } = await loadConfig({}, argv, {
-    watch: false
+    watch: false,
   }, false)
   /* c8 ignore next */
   if (!logger) {
@@ -21,7 +22,7 @@ async function compile (argv, logger) {
     if (isatty(process.stdout.fd)) {
       stream = pretty({
         translateTime: 'SYS:HH:MM:ss',
-        ignore: 'hostname,pid'
+        ignore: 'hostname,pid',
       })
     }
 
@@ -30,7 +31,7 @@ async function compile (argv, logger) {
 
   let compiled = false
   const compileOptions = {
-    clean: argv.includes('--clean')
+    clean: argv.includes('--clean'),
   }
   if (configType === 'runtime') {
     for (const service of configManager.current.services) {
@@ -41,7 +42,7 @@ async function compile (argv, logger) {
         onMissingEnv (key) {
           return service.localServiceEnvVars.get(key)
         },
-        watch: false
+        watch: false,
       }, false)
 
       const tsOptions = await extract(configManager, app)
@@ -51,7 +52,7 @@ async function compile (argv, logger) {
           ...compileOptions,
           ...tsOptions,
           cwd: service.path,
-          logger: childLogger
+          logger: childLogger,
         })
         compiled ||= serviceWasCompiled
       }
@@ -63,7 +64,7 @@ async function compile (argv, logger) {
         ...compileOptions,
         ...tsOptions,
         cwd: dirname(configManager.fullPath),
-        logger
+        logger,
       })
     }
   }

package/lib/config.js

@@ -1,9 +1,12 @@
 'use strict'
+
 const { readdir } = require('node:fs/promises')
 const { join, resolve: pathResolve } = require('node:path')
+
 const ConfigManager = require('@platformatic/config')
-const { schema } = require('./schema')
+
 const errors = require('./errors')
+const { schema } = require('./schema')
 const upgrade = require('./upgrade')
 
 const kServicesAutoloaded = Symbol('plt.servicesAutoloaded')
@@ -65,11 +68,11 @@ async function _transformConfig (configManager) {
   for (let i = 0; i < services.length; ++i) {
     const service = services[i]
 
-    if (configManager._fixPaths) {
+    if (configManager._fixPaths && service.config) {
       service.config = pathResolve(service.path, service.config)
     }
     service.entrypoint = service.id === config.entrypoint
-    service.hotReload = !!config.hotReload
+    service.watch = !!config.watch
     service.dependencies = []
     service.localServiceEnvVars = new Map()
     service.localUrl = `http://${service.id}.plt.local`
@@ -87,6 +90,10 @@ async function _transformConfig (configManager) {
 
   configManager.current.services = services
   configManager.current.services[kServicesAutoloaded] = true
+
+  if (configManager.current.restartOnError === true) {
+    configManager.current.restartOnError = 5000
+  }
 }
 
 async function platformaticRuntime () {
@@ -104,12 +111,12 @@ platformaticRuntime.configManagerConfig = {
     useDefaults: true,
     coerceTypes: true,
     allErrors: true,
-    strict: false
+    strict: false,
   },
   async transformConfig () {
     await _transformConfig(this)
   },
-  upgrade
+  upgrade,
 }
 
 async function wrapConfigInRuntimeConfig ({ configManager, args }) {
@@ -128,14 +135,14 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
   const wrapperConfig = {
     $schema: schema.$id,
     entrypoint: serviceId,
-    hotReload: true,
+    watch: true,
     services: [
       {
         id: serviceId,
         path: configManager.dirname,
-        config: configManager.fullPath
-      }
-    ]
+        config: configManager.fullPath,
+      },
+    ],
   }
   const cm = new ConfigManager({
     source: wrapperConfig,
@@ -144,9 +151,9 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
       useDefaults: true,
       coerceTypes: true,
       allErrors: true,
-      strict: false
+      strict: false,
     },
-    transformConfig () { return _transformConfig(this) }
+    transformConfig () { return _transformConfig(this) },
   })
 
   await cm.parseAndValidate()
@@ -198,15 +205,15 @@ function parseInspectorOptions (configManager) {
       host,
       port,
       breakFirstLine: hasInspectBrk,
-      hotReloadDisabled: !!current.hotReload
+      watchDisabled: !!current.watch,
     }
 
-    current.hotReload = false
+    current.watch = false
   }
 }
 
 module.exports = {
   parseInspectorOptions,
   platformaticRuntime,
-  wrapConfigInRuntimeConfig
+  wrapConfigInRuntimeConfig,
 }

package/lib/dependencies.js

@@ -2,6 +2,7 @@
 
 const Topo = require('@hapi/topo')
 const { closest } = require('fastest-levenshtein')
+
 const errors = require('./errors')
 
 function missingDependencyErrorMessage (clientName, service, services) {
@@ -38,7 +39,7 @@ function topologicalSort (services, config) {
     topo.add(service, {
       group: service.id,
       after: localDependencyIds,
-      manual: true
+      manual: true,
     })
   }
 

package/lib/errors.js

@@ -7,8 +7,9 @@ const ERROR_PREFIX = 'PLT_RUNTIME'
 module.exports = {
   AddressInUseError: createError(`${ERROR_PREFIX}_EADDR_IN_USE`, 'The current port is in use by another application'),
   RuntimeExitedError: createError(`${ERROR_PREFIX}_RUNTIME_EXIT`, 'The runtime exited before the operation completed'),
+  ServiceExitedError: createError(`${ERROR_PREFIX}_SERVICE_EXIT`, 'The service %s exited prematurely with error code %d'),
   UnknownRuntimeAPICommandError: createError(`${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`, 'Unknown Runtime API command "%s"'),
-  ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service not found. Available services are: %s'),
+  ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service %s not found. Available services are: %s'),
   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'),
@@ -29,5 +30,5 @@ module.exports = {
   WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
 
   // TODO: should remove next one as it's not used anymore
-  CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime')
+  CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime'),
 }

package/lib/generator/errors.js

@@ -6,5 +6,5 @@ const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
 
 module.exports = {
   NoServiceNamedError: createError(`${ERROR_PREFIX}_NO_SERVICE_FOUND`, 'No service named \'%s\' has been added to this runtime.'),
-  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.')
+  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.'),
 }

package/lib/generator/runtime-generator.d.ts

@@ -1,5 +1,5 @@
-import { BaseGenerator } from "@platformatic/generators"
-import { FileGenerator } from "@platformatic/generators/lib/file-generator"
+import { BaseGenerator } from '@platformatic/generators'
+import { FileGenerator } from '@platformatic/generators/lib/file-generator'
 
 type Service = {
   config: FileGenerator.FileGenerator | BaseGenerator.BaseGenerator
@@ -13,7 +13,7 @@ type KeyValue = {
   [key: string]: string
 }
 
-type RuntimeGeneratorOptions =  BaseGenerator.BaseGeneratorOptions & {
+type RuntimeGeneratorOptions = BaseGenerator.BaseGeneratorOptions & {
   logLevel: string
 }
 
@@ -21,17 +21,17 @@ export namespace RuntimeGenerator {
   export class RuntimeGenerator extends BaseGenerator.BaseGenerator {
     services: Service[]
     entryPoint: Service
-    constructor(opts?: RuntimeGeneratorOptions)
-  
-    addService(service: Service, name: string): Promise<void>
-  
-    setEntryPoint(entryPoint: string): void
-  
-    setServicesDirectory(): void
-  
-    setServicesConfig(configToOverride: object): void
-  
-    getRuntimeEnv(): KeyValue
-    writeServicesFiles(): Promise<GeneratorMetadata>
+    constructor (opts?: RuntimeGeneratorOptions)
+
+    addService (service: Service, name: string): Promise<void>
+
+    setEntryPoint (entryPoint: string): void
+
+    setServicesDirectory (): void
+
+    setServicesConfig (configToOverride: object): void
+
+    getRuntimeEnv (): KeyValue
+    writeServicesFiles (): Promise<GeneratorMetadata>
   }
 }