@platformatic/runtime 0.39.0 → 0.41.0

package/fixtures/start-command-in-runtime.js

@@ -1,7 +1,7 @@
 'use strict'
 const assert = require('node:assert')
 const { request } = require('undici')
-const { startCommand } = require('../lib/unified-api')
+const { startCommand } = require('..')
 
 async function main () {
   const entrypoint = await startCommand(['-c', process.argv[2]])

package/fixtures/start-command.js

@@ -1,5 +1,5 @@
 'use strict'
-const { startCommand } = require('../lib/unified-api')
+const { startCommand } = require('..')
 
 async function main () {
   await startCommand(['-c', process.argv[2]])

package/fixtures/starter.js

@@ -1,5 +1,5 @@
 'use strict'
-const { start } = require('../lib/unified-api')
+const { start } = require('..')
 
 async function main () {
   await start(['-c', process.argv[2]])

package/index.js

@@ -1,15 +1,16 @@
 'use strict'
 const { buildServer } = require('./lib/build-server')
 const { platformaticRuntime } = require('./lib/config')
-const { start } = require('./lib/start')
-const unifiedApi = require('./lib/unified-api')
+const { start, startCommand } = require('./lib/start')
 const RuntimeApi = require('./lib/api')
 const { compile } = require('./lib/compile')
+const { loadConfig } = require('./lib/load-config')
 
 module.exports.buildServer = buildServer
 module.exports.platformaticRuntime = platformaticRuntime
 module.exports.schema = platformaticRuntime.schema
 module.exports.RuntimeApi = RuntimeApi
 module.exports.start = start
-module.exports.unifiedApi = unifiedApi
+module.exports.startCommand = startCommand
 module.exports.compile = compile
+module.exports.loadConfig = loadConfig

package/lib/app.js

@@ -4,10 +4,8 @@ const { once } = require('node:events')
 const { dirname } = require('node:path')
 const { FileWatcher } = require('@platformatic/utils')
 const debounce = require('debounce')
-const {
-  buildServer,
-  loadConfig
-} = require('./unified-api')
+const { buildServer } = require('./build-server')
+const { loadConfig } = require('./load-config')
 
 class PlatformaticApp {
   #hotReload
@@ -57,6 +55,10 @@ class PlatformaticApp {
 
     this.#restarting = true
 
+    // The CJS cache should not be cleared from the loader because v20 moved
+    // the loader to a different thread with a different CJS cache.
+    clearCjsCache()
+
     /* c8 ignore next 4 - tests may not pass in a MessagePort. */
     if (this.#loaderPort) {
       this.#loaderPort.postMessage('plt:clear-cache')
@@ -257,4 +259,19 @@ class PlatformaticApp {
   }
 }
 
+/* c8 ignore next 11 - c8 upgrade marked many existing things as uncovered */
+function clearCjsCache () {
+  // This evicts all of the modules from the require() cache.
+  // Note: This does not clean up children references to the deleted module.
+  // It's likely not a big deal for most cases, but it is a leak. The child
+  // references can be cleaned up, but it is expensive and involves walking
+  // the entire require() cache. See the DEP0144 documentation for how to do
+  // it.
+  Object.keys(require.cache).forEach((key) => {
+    if (!key.match(/node_modules/)) {
+      delete require.cache[key]
+    }
+  })
+}
+
 module.exports = { PlatformaticApp }

package/lib/build-server.js

@@ -2,8 +2,10 @@
 const ConfigManager = require('@platformatic/config')
 const { platformaticRuntime } = require('./config')
 const { startWithConfig } = require('./start')
+const { buildServer: buildServerService } = require('@platformatic/service')
+const { loadConfig } = require('./load-config')
 
-async function buildServer (options = {}) {
+async function buildServerRuntime (options = {}) {
   if (!options.configManager) {
     // Instantiate a new config manager from the current options.
     const cm = new ConfigManager({
@@ -19,10 +21,26 @@ async function buildServer (options = {}) {
     }
   }
 
-  // The transformConfig() function can't be sent between threads.
-  delete options.configManager._transformConfig
-
   return startWithConfig(options.configManager)
 }
 
+async function buildServer (options) {
+  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)
+  }
+
+  return buildServerService(options, app)
+}
+
 module.exports = { buildServer }

package/lib/compile.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { tsCompiler } = require('@platformatic/service')
-const { loadConfig } = require('./unified-api')
+const { loadConfig } = require('./load-config')
 const { dirname } = require('node:path')
 
 const pino = require('pino')

package/lib/load-config.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { Store, loadConfig } = require('@platformatic/config')
+
+const { platformaticService } = require('@platformatic/service')
+const { platformaticDB } = require('@platformatic/db')
+const { platformaticComposer } = require('@platformatic/composer')
+const { platformaticRuntime } = require('./config')
+
+const store = new Store()
+store.add(platformaticService)
+store.add(platformaticDB)
+store.add(platformaticComposer)
+store.add(platformaticRuntime)
+
+function _loadConfig (minimistConfig, args, overrides) {
+  return loadConfig(minimistConfig, args, store, overrides)
+}
+
+module.exports = { loadConfig: _loadConfig }

package/lib/loader.mjs

@@ -1,7 +1,6 @@
 import { createRequire, isBuiltin } from 'node:module'
 import { dirname, isAbsolute, resolve as pathResolve } from 'node:path'
 import { fileURLToPath, pathToFileURL } from 'node:url'
-const require = createRequire(import.meta.url)
 const isWindows = process.platform === 'win32'
 let timestamp = process.hrtime.bigint()
 let port
@@ -11,21 +10,6 @@ function bustEsmCache () {
   timestamp = process.hrtime.bigint()
 }
 
-/* c8 ignore next 11 - c8 upgrade marked many existing things as uncovered */
-function clearCjsCache () {
-  // This evicts all of the modules from the require() cache.
-  // Note: This does not clean up children references to the deleted module.
-  // It's likely not a big deal for most cases, but it is a leak. The child
-  // references can be cleaned up, but it is expensive and involves walking
-  // the entire require() cache. See the DEP0144 documentation for how to do
-  // it.
-  Object.keys(require.cache).forEach((key) => {
-    if (!key.match(/node_modules/)) {
-      delete require.cache[key]
-    }
-  })
-}
-
 function isRelativePath (p) {
   // This function is extracted from Node core, so it should work.
   /* c8 ignore next - c8 upgrade marked many existing things as uncovered */
@@ -103,9 +87,16 @@ export function globalPreload (context) {
   port.on('message', () => {
     /* c8 ignore next 3 - c8 upgrade marked many existing things as uncovered */
     bustEsmCache()
-    clearCjsCache()
     port.postMessage('plt:cache-cleared')
   })
 
   return 'globalThis.LOADER_PORT = port;'
 }
+
+export async function initialize (data) {
+  port = data.port
+  port.on('message', () => {
+    bustEsmCache()
+    port.postMessage('plt:cache-cleared')
+  })
+}

package/lib/start.js

@@ -5,9 +5,12 @@ const { join } = require('node:path')
 const { pathToFileURL } = require('node:url')
 const { Worker } = require('node:worker_threads')
 const closeWithGrace = require('close-with-grace')
-const { loadConfig } = require('@platformatic/config')
-const { parseInspectorOptions, platformaticRuntime } = require('./config')
+const { start: serviceStart } = require('@platformatic/service')
+const { loadConfig } = require('./load-config')
+const { parseInspectorOptions, wrapConfigInRuntimeConfig } = require('./config')
 const RuntimeApiClient = require('./api-client.js')
+const { printConfigValidationErrors } = require('@platformatic/config')
+
 const kLoaderFile = pathToFileURL(join(__dirname, 'loader.mjs')).href
 const kWorkerFile = join(__dirname, 'worker.js')
 const kWorkerExecArgv = [
@@ -16,17 +19,6 @@ const kWorkerExecArgv = [
   kLoaderFile
 ]
 
-async function start (argv) {
-  const config = await loadConfig({}, argv, platformaticRuntime, {
-    watch: true
-  })
-
-  config.configManager.args = config.args
-  const app = await startWithConfig(config.configManager)
-  await app.start()
-  return app
-}
-
 async function startWithConfig (configManager, env = process.env) {
   const config = configManager.current
 
@@ -38,6 +30,12 @@ async function startWithConfig (configManager, env = process.env) {
     parseInspectorOptions(configManager)
   }
 
+  if (config.hotReload) {
+    config.loaderFile = kLoaderFile
+  }
+  // The configManager cannot be transferred to the worker, so remove it.
+  delete config.configManager
+
   const worker = new Worker(kWorkerFile, {
     /* c8 ignore next */
     execArgv: config.hotReload ? kWorkerExecArgv : [],
@@ -86,4 +84,61 @@ async function startWithConfig (configManager, env = process.env) {
   return runtimeApiClient
 }
 
-module.exports = { start, startWithConfig }
+async function start (args) {
+  const config = await loadConfig({}, args)
+
+  if (config.configType === 'runtime') {
+    config.configManager.args = config.args
+    const app = await startWithConfig(config.configManager)
+    await app.start()
+    return app
+  }
+
+  return serviceStart(config.app, args)
+}
+
+async function startCommand (args) {
+  try {
+    const config = await loadConfig({}, args)
+    let runtime
+
+    if (config.configType === 'runtime') {
+      config.configManager.args = config.args
+      runtime = await startWithConfig(config.configManager)
+    } else {
+      const wrappedConfig = await wrapConfigInRuntimeConfig(config)
+      wrappedConfig.args = config.args
+      runtime = await startWithConfig(wrappedConfig)
+    }
+
+    return await runtime.start()
+  } catch (err) {
+    logErrorAndExit(err)
+  }
+}
+
+function logErrorAndExit (err) {
+  if (err.filenames) {
+    console.error(`Missing config file!
+Be sure to have a config file with one of the following names:
+
+${err.filenames.map((s) => ' * ' + s).join('\n')}
+
+In alternative run "npm create platformatic@latest" to generate a basic plt service config.`)
+    process.exit(1)
+  } else if (err.validationErrors) {
+    printConfigValidationErrors(err)
+    process.exit(1)
+  }
+
+  delete err?.stack
+  console.error(err?.message)
+
+  if (err?.cause) {
+    console.error(`${err.cause}`)
+  }
+
+  process.exit(1)
+}
+
+module.exports = { start, startWithConfig, startCommand }

package/lib/worker.js

@@ -1,16 +1,32 @@
 'use strict'
 
 const inspector = require('node:inspector')
+const { register } = require('node:module')
 const { isatty } = require('node:tty')
-const { parentPort, workerData } = require('node:worker_threads')
+const {
+  MessageChannel,
+  parentPort,
+  workerData
+} = require('node:worker_threads')
 const undici = require('undici')
 const pino = require('pino')
 const RuntimeApi = require('./api')
 const { MessagePortWritable } = require('./message-port-writable')
-const loaderPort = globalThis.LOADER_PORT // Added by loader.mjs.
+let loaderPort
+
+if (typeof register === 'function' && workerData.config.loaderFile) {
+  const { port1, port2 } = new MessageChannel()
+  register(workerData.config.loaderFile, {
+    data: { port: port2 },
+    transferList: [port2]
+  })
+  loaderPort = port1
+} else if (globalThis.LOADER_PORT) {
+  loaderPort = globalThis.LOADER_PORT
+  delete globalThis.LOADER_PORT
+}
 
 globalThis.fetch = undici.fetch
-delete globalThis.LOADER_PORT
 
 let transport
 let destination

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -22,10 +22,10 @@
     "snazzy": "^9.0.0",
     "split2": "^4.2.0",
     "standard": "^17.1.0",
-    "tsd": "^0.28.1",
+    "tsd": "^0.29.0",
     "typescript": "^5.1.6",
-    "@platformatic/sql-graphql": "0.39.0",
-    "@platformatic/sql-mapper": "0.39.0"
+    "@platformatic/sql-graphql": "0.41.0",
+    "@platformatic/sql-mapper": "0.41.0"
   },
   "dependencies": {
     "@hapi/topo": "^6.0.2",
@@ -42,12 +42,12 @@
     "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "undici": "^5.22.1",
-    "@platformatic/composer": "0.39.0",
-    "@platformatic/config": "0.39.0",
-    "@platformatic/db": "0.39.0",
-    "@platformatic/service": "0.39.0",
-    "@platformatic/telemetry": "0.39.0",
-    "@platformatic/utils": "0.39.0"
+    "@platformatic/composer": "0.41.0",
+    "@platformatic/config": "0.41.0",
+    "@platformatic/db": "0.41.0",
+    "@platformatic/service": "0.41.0",
+    "@platformatic/telemetry": "0.41.0",
+    "@platformatic/utils": "0.41.0"
   },
   "standard": {
     "ignore": [

package/runtime.mjs

@@ -6,7 +6,7 @@ import { join } from 'desm'
 import isMain from 'es-main'
 import helpMe from 'help-me'
 import parseArgs from 'minimist'
-import { startCommand } from './lib/unified-api.js'
+import { startCommand } from './index.js'
 import { compile as compileCmd } from './lib/compile.js'
 
 export const compile = compileCmd

package/test/cli/watch.test.mjs

@@ -132,7 +132,7 @@ test('should not hot reload files with `--hot-reload false', async (t) => {
   assert.strictEqual(version, 'v1')
 })
 
-test('watches CommonJS files with hotreload', { timeout: 30000, skip: process.env.CI }, async (t) => {
+test('watches CommonJS files with hotreload', { timeout: 30000 }, async (t) => {
   const tmpDir = await mkdtemp(join(base, 'watch-'))
   t.after(() => saferm(tmpDir))
   t.diagnostic(`using ${tmpDir}`)
@@ -171,7 +171,7 @@ test('watches CommonJS files with hotreload', { timeout: 30000, skip: process.en
   assert.ok(restartedThirdTime)
 })
 
-test('watches CommonJS files with hotreload on a single service', { timeout: 30000, skip: process.env.CI }, async (t) => {
+test('watches CommonJS files with hotreload on a single service', { timeout: 30000 }, async (t) => {
   const tmpDir = await mkdtemp(join(base, 'watch-'))
   t.after(() => saferm(tmpDir))
   t.diagnostic(`using ${tmpDir}`)
@@ -207,7 +207,7 @@ test('watches CommonJS files with hotreload on a single service', { timeout: 300
   assert.ok(restartedThirdTime)
 })
 
-test('do not hot reload dependencies', { timeout: 30000, skip: process.env.CI }, async (t) => {
+test('do not hot reload dependencies', { timeout: 30000 }, async (t) => {
   process.env.PORT = 0
   const config = join(fixturesDir, 'do-not-reload-dependencies', 'platformatic.service.json')
   const { child, url } = await start('-c', config)
@@ -247,7 +247,7 @@ test('do not hot reload dependencies', { timeout: 30000, skip: process.env.CI },
   assert.strictEqual((await res4.body.json()).hello, plugin2)
 })
 
-test('watches CommonJS files with hotreload on a single service', { timeout: 30000, skip: process.env.CI }, async (t) => {
+test('watches CommonJS files with hotreload on a single service', { timeout: 30000 }, async (t) => {
   const tmpDir = await mkdtemp(join(base, 'watch-'))
   t.after(() => saferm(tmpDir))
   t.diagnostic(`using ${tmpDir}`)

package/test/unified-api.test.js

@@ -7,7 +7,7 @@ const { test } = require('node:test')
 const {
   buildServer,
   loadConfig
-} = require('../lib/unified-api')
+} = require('..')
 const fixturesDir = join(__dirname, '..', 'fixtures')
 
 test('loadConfig()', async (t) => {

package/lib/unified-api.js

@@ -1,110 +0,0 @@
-'use strict'
-const { Store, loadConfig, printConfigValidationErrors } = require('@platformatic/config')
-const {
-  platformaticService,
-  buildServer,
-  start
-} = require('@platformatic/service')
-const {
-  platformaticDB
-} = require('@platformatic/db')
-const {
-  platformaticComposer
-} = require('@platformatic/composer')
-const { buildServer: runtimeBuildServer } = require('./build-server')
-const { platformaticRuntime, wrapConfigInRuntimeConfig } = require('./config')
-const {
-  start: runtimeStart,
-  startWithConfig: runtimeStartWithConfig
-} = require('./start')
-
-const store = new Store()
-store.add(platformaticService)
-store.add(platformaticDB)
-store.add(platformaticComposer)
-store.add(platformaticRuntime)
-
-/* c8 ignore next 10 - for some reason c8 is not seeing this as covered. */
-async function _buildServer (options) {
-  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) {
-    return runtimeBuildServer(options)
-  }
-
-  return buildServer(options, app)
-}
-
-function _loadConfig (minimistConfig, args, overrides) {
-  return loadConfig(minimistConfig, args, store, overrides)
-}
-
-async function _start (args) {
-  const config = await _loadConfig({}, args)
-
-  if (config.configType === 'runtime') {
-    return runtimeStart(args)
-  }
-
-  return start(config.app, args)
-}
-
-async function startCommand (args) {
-  try {
-    const config = await _loadConfig({}, args)
-    let runtime
-
-    if (config.configType === 'runtime') {
-      config.configManager.args = config.args
-      runtime = await runtimeStartWithConfig(config.configManager)
-    } else {
-      const wrappedConfig = await wrapConfigInRuntimeConfig(config)
-      wrappedConfig.args = config.args
-      runtime = await runtimeStartWithConfig(wrappedConfig)
-    }
-
-    return await runtime.start()
-  } catch (err) {
-    logErrorAndExit(err)
-  }
-}
-
-function logErrorAndExit (err) {
-  if (err.filenames) {
-    console.error(`Missing config file!
-Be sure to have a config file with one of the following names:
-
-${err.filenames.map((s) => ' * ' + s).join('\n')}
-
-In alternative run "npm create platformatic@latest" to generate a basic plt service config.`)
-    process.exit(1)
-  } else if (err.validationErrors) {
-    printConfigValidationErrors(err)
-    process.exit(1)
-  }
-
-  delete err?.stack
-  console.error(err?.message)
-
-  if (err?.cause) {
-    console.error(`${err.cause}`)
-  }
-
-  process.exit(1)
-}
-
-module.exports = {
-  buildServer: _buildServer,
-  loadConfig: _loadConfig,
-  start: _start,
-  startCommand
-}