@platformatic/runtime 1.53.3 → 2.0.0-alpha.10

package/fixtures/typescript-custom-flags/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-custom-flags/services/titles/platformatic.service.json

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

package/fixtures/typescript-no-env/platformatic.runtime.json

@@ -1,8 +1,7 @@
 {
-  "$schema": "https://platformatic.dev/schemas/v0.28.1/runtime",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
   "entrypoint": "composer",
-  "allowCycles": false,
-  "hotReload": true,
+  "watch": true,
   "autoload": {
     "path": "services",
     "exclude": [

package/fixtures/typescript-no-env/services/composer/platformatic.composer.json

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

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

@@ -1,11 +1,10 @@
-import { Entity } from '@platformatic/sql-mapper';
-import graphqlPlugin from '@platformatic/sql-graphql'
+import { Entity } from '@platformatic/sql-mapper'
 import { EntityTypes, Movie } from './types'
 
 declare module 'fastify' {
   interface FastifyInstance {
     getSchema<T extends 'Movie'>(schemaId: T): {
-      '$id': string,
+      $id: string,
       title: string,
       description: string,
       type: string,

package/fixtures/typescript-no-env/services/movies/platformatic.db.json

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

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

@@ -3,7 +3,7 @@
  * A Movie
  */
 declare interface Movie {
-    id?: number;
-    title: string;
+  id?: number;
+  title: string;
 }
-export { Movie };
+export { Movie }

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,26 @@
 '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 { buildRuntime, start, startCommand } = require('./lib/start')
+const symbols = require('./lib/worker/symbols')
+const { loadConfig, getRuntimeLogsDir } = require('./lib/utils')
 
 module.exports.buildServer = buildServer
+module.exports.buildRuntime = buildRuntime
+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

@@ -1,22 +1,19 @@
 'use strict'
 
+const { createRequire } = require('node:module')
+const { join } = require('node:path')
+
 const ConfigManager = require('@platformatic/config')
+
 const { platformaticRuntime } = require('./config')
 const { buildRuntime } = require('./start')
-const { buildServer: buildServerService } = require('@platformatic/service')
-const { loadConfig } = require('./load-config')
+const { loadConfig } = require('./utils')
 
-async function buildServerRuntime (options = {}) {
-  const {
-    serviceMap,
-    loggingPort,
-    loggingMetadata
-  } = options
+async function buildServerRuntime (options = {}, args = undefined) {
+  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({
@@ -25,8 +22,6 @@ async function buildServerRuntime (options = {}) {
     })
     await cm.parseAndValidate()
 
-    cm.current.loggingPort = loggingPort
-    cm.current.loggingMetadata = loggingMetadata
     cm.current.serviceMap = serviceMap
 
     if (typeof options === 'string') {
@@ -36,10 +31,14 @@ async function buildServerRuntime (options = {}) {
     }
   }
 
+  if (args) {
+    options.configManager.args = args
+  }
+
   return buildRuntime(options.configManager, options.env)
 }
 
-async function buildServer (options) {
+async function buildServer (options, args) {
   if (typeof options === 'string') {
     const config = await loadConfig({}, ['-c', options])
     options = config.configManager.current
@@ -52,10 +51,19 @@ async function buildServer (options) {
   delete options.app
 
   if (app === platformaticRuntime || !app) {
-    return buildServerRuntime(options)
+    return buildServerRuntime(options, args)
   }
 
-  return buildServerService(options, app)
+  if (app.buildServer) {
+    return app.buildServer(options)
+  }
+
+  // App is a stackable. Hopefully we have `@platformatic/service` available.
+  const projectRoot = join(options.configManager.dirname, 'package.json')
+  const require = createRequire(projectRoot)
+  const { buildServer } = require('@platformatic/service')
+
+  return buildServer(options, app)
 }
 
 module.exports = { buildServer }

package/lib/compile.js

@@ -1,16 +1,19 @@
 'use strict'
 
-const { tsCompiler } = require('@platformatic/service')
-const { loadConfig } = require('./load-config')
-const { dirname } = 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 } = await loadConfig({}, argv, {
-    watch: false
+  const { configManager, configType, app } = await loadConfig({}, argv, {
+    watch: false,
   }, false)
   /* c8 ignore next */
   if (!logger) {
@@ -19,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',
       })
     }
 
@@ -28,28 +31,68 @@ 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) {
       const childLogger = logger.child({ name: service.id })
 
       const serviceConfigPath = service.config
-      const { configManager } = await loadConfig({}, ['-c', serviceConfigPath], {
+      const { configManager, app } = await loadConfig({}, ['-c', serviceConfigPath], {
         onMissingEnv (key) {
           return service.localServiceEnvVars.get(key)
         },
-        watch: false
+        watch: false,
       }, false)
 
-      const serviceWasCompiled = await tsCompiler.compile(service.path, configManager.current, childLogger, compileOptions)
-      compiled ||= serviceWasCompiled
+      const tsOptions = await extract(configManager, app)
+
+      if (tsOptions) {
+        const serviceWasCompiled = await tsCompiler.compile({
+          ...compileOptions,
+          ...tsOptions,
+          cwd: service.path,
+          logger: childLogger,
+        })
+        compiled ||= serviceWasCompiled
+      }
     }
   } else {
-    compiled = await tsCompiler.compile(dirname(configManager.fullPath), configManager.current, logger, compileOptions)
+    const tsOptions = await extract(configManager, app)
+    if (tsOptions) {
+      compiled = await tsCompiler.compile({
+        ...compileOptions,
+        ...tsOptions,
+        cwd: dirname(configManager.fullPath),
+        logger,
+      })
+    }
   }
 
   return compiled
 }
 
+async function extract (configManager, app) {
+  let extractTypeScriptCompileOptionsFromConfig = app.extractTypeScriptCompileOptionsFromConfig
+
+  if (!extractTypeScriptCompileOptionsFromConfig) {
+    // This is a bit of a hack, but it is needed to avoid a circular dependency
+    // it also allow for customizations if needed
+    const _require = createRequire(join(configManager.dirname, 'package.json'))
+    const toLoad = _require.resolve('@platformatic/service')
+    try {
+      extractTypeScriptCompileOptionsFromConfig = (await import(pathToFileURL(toLoad))).extractTypeScriptCompileOptionsFromConfig
+    } catch {
+    }
+    // If we can't load `@platformatic/service` we just return null
+    // and we won't be compiling typescript
+  }
+
+  if (!extractTypeScriptCompileOptionsFromConfig) {
+    return null
+  }
+
+  return extractTypeScriptCompileOptionsFromConfig(configManager.current)
+}
+
 module.exports.compile = compile