@platformatic/runtime 2.72.0 → 3.0.0-alpha.1

package/lib/schema.js

@@ -21,6 +21,7 @@ schemaComponents.runtimeProperties.logger = runtimeLogger
 const platformaticRuntimeSchema = {
   $id: `https://schemas.platformatic.dev/@platformatic/runtime/${pkg.version}.json`,
   $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Platformatic Runtime Config',
   type: 'object',
   properties: schemaComponents.runtimeProperties,
   anyOf: [{ required: ['autoload'] }, { required: ['services'] }, { required: ['web'] }],

package/lib/upgrade.js

@@ -1,15 +1,15 @@
 'use strict'
 
+const { abstractLogger } = require('@platformatic/utils')
 const { join } = require('node:path')
+const { semgrator } = require('semgrator')
 
-module.exports = async function upgrade (config, version) {
-  const { semgrator } = await import('semgrator')
-
+async function upgrade (logger, config, version) {
   const iterator = semgrator({
     version,
     path: join(__dirname, 'versions'),
     input: config,
-    logger: this.logger.child({ name: '@platformatic/runtime' }),
+    logger: logger?.child({ name: '@platformatic/runtime' }) ?? abstractLogger
   })
 
   let result
@@ -20,3 +20,5 @@ module.exports = async function upgrade (config, version) {
 
   return result
 }
+
+module.exports = { upgrade }

package/lib/utils.js

@@ -4,14 +4,6 @@ const { createHash } = require('node:crypto')
 const { tmpdir } = require('node:os')
 const { join } = require('node:path')
 
-const {
-  Store,
-  loadConfig: pltConfigLoadConfig,
-  loadEmptyConfig: pltConfigLoadEmptyConfig
-} = require('@platformatic/config')
-
-const { platformaticRuntime } = require('./config')
-
 function getArrayDifference (a, b) {
   return a.filter(element => {
     return !b.includes(element)
@@ -33,42 +25,9 @@ function getRuntimeLogsDir (runtimeDir, runtimePID) {
   return join(runtimeTmpDir, runtimePID.toString(), 'logs')
 }
 
-async function loadConfig (minimistConfig, args, overrides, replaceEnv = true) {
-  const { default: platformaticBasic } = await import('@platformatic/basic')
-  const store = new Store()
-  store.add(platformaticRuntime)
-
-  const id = platformaticRuntime.schema.$id.replace('@platformatic/runtime', 'wattpm')
-  const schema = {
-    ...platformaticRuntime.schema,
-    $id: id
-  }
-  const configManagerConfig = {
-    ...platformaticRuntime.configManagerConfig,
-    schema
-  }
-  const wattpm = {
-    ...platformaticRuntime,
-    schema,
-    configManagerConfig
-  }
-  store.add(wattpm)
-  store.add(platformaticBasic)
-
-  return pltConfigLoadConfig(minimistConfig, args, store, overrides, replaceEnv)
-}
-
-async function loadEmptyConfig (path, overrides, replaceEnv = true) {
-  const { default: platformaticBasic } = await import('@platformatic/basic')
-
-  return pltConfigLoadEmptyConfig(path, platformaticBasic, overrides, replaceEnv)
-}
-
 module.exports = {
   getArrayDifference,
   getRuntimeLogsDir,
   getRuntimeTmpDir,
-  getServiceUrl,
-  loadConfig,
-  loadEmptyConfig
+  getServiceUrl
 }

package/lib/worker/app.js

@@ -7,14 +7,27 @@ const {
   performance: { eventLoopUtilization }
 } = require('node:perf_hooks')
 const { workerData } = require('node:worker_threads')
-const { ConfigManager } = require('@platformatic/config')
-const { FileWatcher } = require('@platformatic/utils')
+const {
+  FileWatcher,
+  listRecognizedConfigurationFiles,
+  loadConfigurationModule,
+  loadConfiguration
+} = require('@platformatic/utils')
 const { getGlobalDispatcher, setGlobalDispatcher } = require('undici')
 const debounce = require('debounce')
 
 const errors = require('../errors')
-const defaultStackable = require('./default-stackable')
-const { getServiceUrl, loadConfig, loadEmptyConfig } = require('../utils')
+const { getServiceUrl } = require('../utils')
+
+function fetchServiceUrl (service, key) {
+  if (service.localServiceEnvVars.has(key)) {
+    return service.localServiceEnvVars.get(key)
+  } else if (!key.endsWith('_URL') || !service.id) {
+    return null
+  }
+
+  return getServiceUrl(service.id)
+}
 
 class PlatformaticApp extends EventEmitter {
   #starting
@@ -60,7 +73,8 @@ class PlatformaticApp extends EventEmitter {
       serverConfig,
       worker: workerData?.worker,
       hasManagementApi: !!hasManagementApi,
-      localServiceEnvVars: this.appConfig.localServiceEnvVars
+      localServiceEnvVars: this.appConfig.localServiceEnvVars,
+      fetchServiceUrl: fetchServiceUrl.bind(null, appConfig)
     }
   }
 
@@ -73,63 +87,45 @@ class PlatformaticApp extends EventEmitter {
   async updateContext (context) {
     this.#context = { ...this.#context, ...context }
     if (this.stackable) {
-      this.stackable.updateContext(context)
+      await this.stackable.updateContext(context)
     }
   }
 
   async getBootstrapDependencies () {
-    return this.stackable.getBootstrapDependencies()
+    return this.stackable.getBootstrapDependencies?.() ?? []
   }
 
   async init () {
     try {
       const appConfig = this.appConfig
-      let loadedConfig
+
+      if (appConfig.isProduction && !process.env.NODE_ENV) {
+        process.env.NODE_ENV = 'production'
+      }
 
       // Before returning the base application, check if there is any file we recognize
       // and the user just forgot to specify in the configuration.
       if (!appConfig.config) {
-        const candidate = ConfigManager.listConfigFiles().find(f => existsSync(resolve(appConfig.path, f)))
+        const candidate = listRecognizedConfigurationFiles().find(f => existsSync(resolve(appConfig.path, f)))
 
         if (candidate) {
           appConfig.config = resolve(appConfig.path, candidate)
         }
       }
 
-      if (!appConfig.config) {
-        loadedConfig = await loadEmptyConfig(
-          appConfig.path,
-          {
-            onMissingEnv: this.#fetchServiceUrl,
-            context: appConfig
-          },
-          true
-        )
+      if (appConfig.config) {
+        // Parse the configuration file the first time to obtain the schema
+        const unvalidatedConfig = await loadConfiguration(appConfig.config, null, {
+          onMissingEnv: this.#context.fetchServiceUrl
+        })
+        const pkg = await loadConfigurationModule(appConfig.path, unvalidatedConfig)
+        this.stackable = await pkg.create(appConfig.path, appConfig.config, this.#context)
+        // We could not find a configuration file, we use the bundle @platformatic/basic with the runtime to load it
       } else {
-        loadedConfig = await loadConfig(
-          {},
-          ['-c', appConfig.config],
-          {
-            onMissingEnv: this.#fetchServiceUrl,
-            context: appConfig
-          },
-          true
-        )
+        const pkg = await loadConfigurationModule(resolve(__dirname, '../..'), {}, '@platformatic/basic')
+        this.stackable = await pkg.create(appConfig.path, {}, this.#context)
       }
 
-      const app = loadedConfig.app
-
-      if (appConfig.isProduction && !process.env.NODE_ENV) {
-        process.env.NODE_ENV = 'production'
-      }
-
-      const stackable = await app.buildStackable({
-        onMissingEnv: this.#fetchServiceUrl,
-        config: this.appConfig.config,
-        context: this.#context
-      })
-      this.stackable = this.#wrapStackable(stackable)
-
       this.#updateDispatcher()
     } catch (err) {
       if (err.validationErrors) {
@@ -149,13 +145,14 @@ class PlatformaticApp extends EventEmitter {
     this.#starting = true
 
     try {
-      await this.stackable.init()
+      await this.stackable.init?.()
     } catch (err) {
       this.#logAndExit(err)
     }
 
     if (this.#watch) {
       const watchConfig = await this.stackable.getWatchConfig()
+
       if (watchConfig.enabled !== false) {
         /* c8 ignore next 4 */
         this.#debouncedRestart = debounce(() => {
@@ -168,6 +165,7 @@ class PlatformaticApp extends EventEmitter {
     }
 
     const listen = !!this.appConfig.useHttp
+
     try {
       await this.stackable.start({ listen })
       this.#listening = listen
@@ -207,18 +205,6 @@ class PlatformaticApp extends EventEmitter {
   }
 
   async getMetrics ({ format }) {
-    const dispatcher = getGlobalDispatcher()
-    if (globalThis.platformatic?.onHttpStatsFree && dispatcher?.stats) {
-      for (const url in dispatcher.stats) {
-        const { free, connected, pending, queued, running, size } = dispatcher.stats[url]
-        globalThis.platformatic.onHttpStatsFree(url, free || 0)
-        globalThis.platformatic.onHttpStatsConnected(url, connected || 0)
-        globalThis.platformatic.onHttpStatsPending(url, pending || 0)
-        globalThis.platformatic.onHttpStatsQueued(url, queued || 0)
-        globalThis.platformatic.onHttpStatsRunning(url, running || 0)
-        globalThis.platformatic.onHttpStatsSize(url, size || 0)
-      }
-    }
     return this.stackable.getMetrics({ format })
   }
 
@@ -236,16 +222,6 @@ class PlatformaticApp extends EventEmitter {
     }
   }
 
-  #fetchServiceUrl (key, { parent, context: service }) {
-    if (service.localServiceEnvVars.has(key)) {
-      return service.localServiceEnvVars.get(key)
-    } else if (!key.endsWith('_URL') || !parent.serviceId) {
-      return null
-    }
-
-    return getServiceUrl(parent.serviceId)
-  }
-
   #startFileWatching (watch) {
     if (this.#fileWatcher) {
       return
@@ -280,14 +256,6 @@ class PlatformaticApp extends EventEmitter {
     process.exit(1)
   }
 
-  #wrapStackable (stackable) {
-    const newStackable = {}
-    for (const method of Object.keys(defaultStackable)) {
-      newStackable[method] = stackable[method] ? stackable[method].bind(stackable) : defaultStackable[method]
-    }
-    return newStackable
-  }
-
   #updateDispatcher () {
     const telemetryConfig = this.#context.telemetryConfig
     const telemetryId = telemetryConfig?.serviceName

package/lib/worker/itc.js

@@ -56,7 +56,7 @@ async function waitEventFromITC (worker, event) {
   return safeHandleInITC(worker, () => once(worker[kITC], event))
 }
 
-function setupITC (app, service, dispatcher, sharedContext) {
+function setupITC (app, service, dispatcher) {
   const messaging = new MessagingITC(app.appConfig.id, workerData.config)
 
   Object.assign(globalThis.platformatic ?? {}, {
@@ -210,10 +210,6 @@ function setupITC (app, service, dispatcher, sharedContext) {
         }
       },
 
-      setSharedContext (context) {
-        sharedContext._set(context)
-      },
-
       saveMessagingChannel (channel) {
         messaging.addSource(channel)
       }

package/lib/worker/main.js

@@ -11,7 +11,6 @@ const { ServerResponse } = require('node:http')
 
 const {
   disablePinoDirectWrite,
-  ensureFlushedWorkerStdio,
   executeWithTimeout,
   ensureLoggableError,
   getPrivateSymbol,
@@ -23,7 +22,6 @@ const pino = require('pino')
 const { fetch } = require('undici')
 
 const { PlatformaticApp } = require('./app')
-const { SharedContext } = require('./shared-context')
 const { setupITC } = require('./itc')
 const { setDispatcher } = require('./interceptors')
 const { kId, kITC, kStderrMarker } = require('./symbols')
@@ -45,7 +43,6 @@ function handleUnhandled (app, type, err) {
 
 function patchLogging () {
   disablePinoDirectWrite()
-  ensureFlushedWorkerStdio()
 
   const kFormatForStderr = getPrivateSymbol(console, 'kFormatForStderr')
 
@@ -190,15 +187,8 @@ async function main () {
     }
   }
 
-  const sharedContext = new SharedContext()
-  // Limit the amount of methods a user can call
-  globalThis.platformatic.sharedContext = {
-    get: () => sharedContext.get(),
-    update: (...args) => sharedContext.update(...args)
-  }
-
   // Setup interaction with parent port
-  const itc = setupITC(app, service, threadDispatcher, sharedContext)
+  const itc = setupITC(app, service, threadDispatcher)
   globalThis[kITC] = itc
 
   // Get the dependencies

package/lib/worker/messaging.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { withResolvers, executeWithTimeout, kTimeout } = require('@platformatic/utils')
+const { executeWithTimeout, kTimeout } = require('@platformatic/utils')
 const { ITC, generateResponse, sanitize } = require('@platformatic/itc')
 const errors = require('../errors')
 const { RoundRobinMap } = require('./round-robin-map')
@@ -112,7 +112,7 @@ class MessagingITC extends ITC {
   }
 
   _createClosePromise () {
-    const { promise, resolve, reject } = withResolvers()
+    const { promise, resolve, reject } = Promise.withResolvers()
     this.#closeResolvers = { resolve, reject }
     return promise
   }

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.72.0",
+  "version": "3.0.0-alpha.1",
   "description": "",
   "main": "index.js",
-  "bin": {
-    "plt-runtime": "./runtime.mjs"
-  },
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "repository": {
     "type": "git",
@@ -33,16 +30,15 @@
     "neostandard": "^0.12.0",
     "pino-abstract-transport": "^2.0.0",
     "split2": "^4.2.0",
-    "tsd": "^0.32.0",
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.72.0",
-    "@platformatic/db": "2.72.0",
-    "@platformatic/node": "2.72.0",
-    "@platformatic/service": "2.72.0",
-    "@platformatic/sql-graphql": "2.72.0",
-    "@platformatic/sql-mapper": "2.72.0"
+    "@platformatic/composer": "3.0.0-alpha.1",
+    "@platformatic/db": "3.0.0-alpha.1",
+    "@platformatic/node": "3.0.0-alpha.1",
+    "@platformatic/service": "3.0.0-alpha.1",
+    "@platformatic/sql-graphql": "3.0.0-alpha.1",
+    "@platformatic/sql-mapper": "3.0.0-alpha.1"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -57,7 +53,6 @@
     "commist": "^3.2.0",
     "cron": "^4.1.0",
     "debounce": "^2.0.0",
-    "desm": "^1.3.1",
     "dotenv": "^16.4.5",
     "dotenv-tool": "^0.1.1",
     "es-main": "^1.3.0",
@@ -76,24 +71,22 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.14.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.72.0",
-    "@platformatic/config": "2.72.0",
-    "@platformatic/metrics": "2.72.0",
-    "@platformatic/itc": "2.72.0",
-    "@platformatic/telemetry": "2.72.0",
-    "@platformatic/ts-compiler": "2.72.0",
-    "@platformatic/utils": "2.72.0",
-    "@platformatic/generators": "2.72.0"
+    "@platformatic/metrics": "3.0.0-alpha.1",
+    "@platformatic/basic": "3.0.0-alpha.1",
+    "@platformatic/generators": "3.0.0-alpha.1",
+    "@platformatic/itc": "3.0.0-alpha.1",
+    "@platformatic/telemetry": "3.0.0-alpha.1",
+    "@platformatic/ts-compiler": "3.0.0-alpha.1",
+    "@platformatic/utils": "3.0.0-alpha.1"
   },
   "scripts": {
-    "test": "pnpm run lint && borp --concurrency=1 --timeout=1200000 && tsd",
+    "test": "pnpm run lint && borp --concurrency=1 --timeout=1200000",
     "test:main": "borp --concurrency=1 --timeout=1200000 test/*.test.js test/*.test.mjs test/versions/*.test.js test/versions/*.test.mjs",
     "test:api": "borp --concurrency=1 --timeout=1200000 test/api/*.test.js test/api/*.test.mjs test/management-api/*.test.js test/management-api/*.test.mjs",
     "test:cli": "borp --concurrency=1 --timeout=1200000 test/cli/*.test.js test/cli/*.test.mjs test/cli/**/*.test.js test/cli/**/*.test.mjs",
     "test:start": "borp --concurrency=1 --timeout=1200000 test/start/*.test.js test/start/*.test.mjs",
     "test:multiple-workers": "borp --concurrency=1 --timeout=1200000 test/multiple-workers/*.test.js test/multiple-workers/*.test.mjs",
-    "test:types": "tsd",
-    "coverage": "pnpm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=1200000 && tsd",
+    "coverage": "pnpm run lint && borp -X fixtures -X test -C --concurrency=1 --timeout=1200000 ",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "pnpm run gen-schema && pnpm run gen-types",

package/schema.json

@@ -1,6 +1,7 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.72.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.0.0-alpha.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Platformatic Runtime Config",
   "type": "object",
   "properties": {
     "$schema": {

package/help/compile.txt

@@ -1,8 +0,0 @@
-Compile all typescript plugins for all services.
-
-``` bash
-  $ platformatic runtime compile
-```
-
-This command will compile the TypeScript
-plugins for each services registered in the runtime.

package/help/help.txt

@@ -1,5 +0,0 @@
-Available commands:
-
-* `help` - show this help message.
-* `help <command>` - shows more information about a command.
-* `start` - start the application.

package/help/start.txt

@@ -1,21 +0,0 @@
-Start the Platformatic Runtime with the following command:
-
-```bash
- $ platformatic runtime start
-```
-
-You can also specify a custom routes file, for example:
-
-```bash
- $ platformatic runtime start routes.js
-```
-
-Where `routes.js` is:
-
-```javascript
-module.exports = async function (app) {
-  app.get('/hello', async () => {
-    return { hello: 'hello123' }
-  })
-}
-```

package/index.test-d.ts

@@ -1,41 +0,0 @@
-import { expectError, expectType } from 'tsd'
-import { LightMyRequestResponse } from 'fastify'
-import { pltRuntimeBuildServer, errors } from '.'
-import { FastifyError } from '@fastify/error'
-
-const server: pltRuntimeBuildServer = {
-  address: 'localhost',
-  port: 3000,
-  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' })
-
-// Errors
-type ErrorWithNoParams = () => FastifyError
-type ErrorWithOneParam = (param: string) => FastifyError
-type ErrorWithTwoParams = (param1: string, param2: string) => FastifyError
-
-expectType<ErrorWithNoParams>(errors.RuntimeExitedError)
-expectType<ErrorWithOneParam>(errors.UnknownRuntimeAPICommandError)
-expectType<ErrorWithOneParam>(errors.ServiceNotFoundError)
-expectType<ErrorWithOneParam>(errors.ServiceNotStartedError)
-expectType<ErrorWithTwoParams>(errors.FailedToRetrieveOpenAPISchemaError)
-expectType<ErrorWithNoParams>(errors.ApplicationAlreadyStartedError)
-expectType<ErrorWithNoParams>(errors.ApplicationNotStartedError)
-expectType<ErrorWithNoParams>(errors.ConfigPathMustBeStringError)
-expectType<ErrorWithOneParam>(errors.NoConfigFileFoundError)
-expectType<ErrorWithOneParam>(errors.InvalidEntrypointError)
-expectType<ErrorWithOneParam>(errors.MissingDependencyError)
-expectType<ErrorWithNoParams>(errors.InspectAndInspectBrkError)
-expectType<ErrorWithNoParams>(errors.InspectorPortError)
-expectType<ErrorWithNoParams>(errors.InspectorHostError)
-expectType<ErrorWithOneParam>(errors.CannotMapSpecifierToAbsolutePathError)
-expectType<ErrorWithNoParams>(errors.NodeInspectorFlagsNotSupportedError)

package/lib/build-server.js

@@ -1,67 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-const { createRequire } = require('node:module')
-const ConfigManager = require('@platformatic/config')
-const { platformaticRuntime } = require('./config')
-const { buildRuntime } = require('./start')
-const { loadConfig } = require('./utils')
-
-async function buildServerRuntime (options = {}, args = undefined) {
-  const { serviceMap } = options
-
-  if (!options.configManager) {
-    delete options.serviceMap
-
-    // Instantiate a new config manager from the current options.
-    const cm = new ConfigManager({
-      ...platformaticRuntime.configManagerConfig,
-      source: options
-    })
-    await cm.parseAndValidate()
-
-    cm.current.serviceMap = serviceMap
-
-    if (typeof options === 'string') {
-      options = { configManager: cm }
-    } else {
-      options.configManager = cm
-    }
-  }
-
-  if (args) {
-    options.configManager.args = args
-  }
-
-  return buildRuntime(options.configManager, options.env)
-}
-
-async function buildServer (options, args) {
-  if (typeof options === 'string') {
-    const config = await loadConfig({}, ['-c', options])
-    options = config.configManager.current
-    options.configManager = config.configManager
-    options.app = config.app
-  }
-
-  const app = options.app
-
-  delete options.app
-
-  if (app === platformaticRuntime || !app) {
-    return buildServerRuntime(options, args)
-  }
-
-  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 }