@platformatic/runtime 0.33.0 → 0.34.0

package/fixtures/configs/monorepo-hotreload-env.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.33.0/runtime",
+  "entrypoint": "serviceApp",
+  "allowCycles": true,
+  "hotReload": "{PLT_HOT_RELOAD}",
+  "autoload": {
+    "path": "../monorepo",
+    "exclude": ["docs", "composerApp"],
+    "mappings": {
+      "serviceAppWithLogger": {
+        "id": "with-logger",
+        "config": "platformatic.service.json"
+      },
+      "serviceAppWithMultiplePlugins": {
+        "id": "multi-plugin-service",
+        "config": "platformatic.service.json"
+      }
+    }
+  }
+}

package/fixtures/do-not-reload-dependencies/node_modules/foo/foo.js

@@ -0,0 +1,2 @@
+'use strict'
+module.exports = Math.random()

package/fixtures/do-not-reload-dependencies/node_modules/foo/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "foo.js"
+}

package/fixtures/do-not-reload-dependencies/node_modules/foom/foom.js

@@ -0,0 +1 @@
+export default Math.random()

package/fixtures/do-not-reload-dependencies/node_modules/foom/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "foom.js",
+  "type": "module"
+}

package/fixtures/do-not-reload-dependencies/platformatic.service.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.33.1/service",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": "{PORT}",
+    "logger": {
+      "level": "info"
+    }
+  },
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      "./plugin.js"
+    ]
+  }
+}

package/fixtures/do-not-reload-dependencies/plugin.js

@@ -0,0 +1,14 @@
+'use strict'
+
+module.exports = function (fastify, opts, next) {
+  fastify.get('/plugin1', function (request, reply) {
+    const foo = require('foo')
+    reply.send({ hello: foo })
+  })
+
+  fastify.get('/plugin2', async function (request, reply) {
+    const foom = (await import('foom')).default
+    return { hello: foom }
+  })
+  next()
+}

package/lib/api.js

@@ -49,9 +49,18 @@ class RuntimeApi {
   }
 
   async #handleProcessLevelEvent (message) {
-    await Promise.allSettled(this.#services.values().map(async (service) => {
+    const services = [...this.#services.values()]
+    await Promise.allSettled(services.map(async (service) => {
       await service.handleProcessLevelEvent(message)
     }))
+
+    for (const service of services) {
+      if (service.getStatus() === 'started') {
+        return
+      }
+    }
+
+    process.exit() // Exit the worker thread if all services are stopped
   }
 
   async #executeCommand (message) {

package/lib/app.js

@@ -148,6 +148,7 @@ class PlatformaticApp {
 
     if (this.#started) {
       await this.stop()
+      this.server.log.info('server stopped')
     }
   }
 

package/lib/config.js

@@ -222,6 +222,12 @@ platformaticRuntime.configType = 'runtime'
 platformaticRuntime.configManagerConfig = {
   schema,
   allowToWatch: ['.env'],
+  schemaOptions: {
+    useDefaults: true,
+    coerceTypes: true,
+    allErrors: true,
+    strict: false
+  },
   async transformConfig () {
     await _transformConfig(this)
   }
@@ -243,7 +249,16 @@ async function wrapConfigInRuntimeConfig ({ configManager, args }) {
       }
     ]
   }
-  const cm = new ConfigManager({ source: wrapperConfig, schema })
+  const cm = new ConfigManager({
+    source: wrapperConfig,
+    schema,
+    schemaOptions: {
+      useDefaults: true,
+      coerceTypes: true,
+      allErrors: true,
+      strict: false
+    }
+  })
 
   await _transformConfig(cm)
   await cm.parseAndValidate()

package/lib/loader.mjs

@@ -20,7 +20,9 @@ function clearCjsCache () {
   // the entire require() cache. See the DEP0144 documentation for how to do
   // it.
   Object.keys(require.cache).forEach((key) => {
-    delete require.cache[key]
+    if (!key.match(/node_modules/)) {
+      delete require.cache[key]
+    }
   })
 }
 
@@ -89,7 +91,7 @@ export async function resolve (specifier, context, nextResolve) {
 
   // If the specifier could not be mapped to a file, or the path is this file,
   // then don't do anything.
-  if (typeof url !== 'string' || url === import.meta.url) {
+  if (typeof url !== 'string' || url === import.meta.url || url.match(/node_modules/)) {
     return nextResolve(specifier, context)
   }
 

package/lib/schema.js

@@ -47,7 +47,6 @@ const platformaticRuntimeSchema = {
     services: {
       type: 'array',
       default: [],
-      minItems: 1,
       items: {
         type: 'object',
         required: ['id', 'path', 'config'],

package/lib/worker.js

@@ -32,14 +32,18 @@ const logger = pino(transport, destination)
 /* c8 ignore next 4 */
 process.once('uncaughtException', (err) => {
   logger.error({ err }, 'runtime error')
-  throw err
+  setImmediate(() => {
+    process.exit(1)
+  })
 })
 
 // Tested by test/cli/start.test.mjs by C8 does not see it.
 /* c8 ignore next 4 */
 process.once('unhandledRejection', (err) => {
   logger.error({ err }, 'runtime error')
-  throw err
+  setImmediate(() => {
+    process.exit(1)
+  })
 })
 
 function main () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -24,8 +24,8 @@
     "standard": "^17.1.0",
     "tsd": "^0.28.1",
     "typescript": "^5.1.6",
-    "@platformatic/sql-graphql": "0.33.0",
-    "@platformatic/sql-mapper": "0.33.0"
+    "@platformatic/sql-graphql": "0.34.0",
+    "@platformatic/sql-mapper": "0.34.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.33.0",
-    "@platformatic/config": "0.33.0",
-    "@platformatic/db": "0.33.0",
-    "@platformatic/service": "0.33.0",
-    "@platformatic/telemetry": "0.33.0",
-    "@platformatic/utils": "0.33.0"
+    "@platformatic/composer": "0.34.0",
+    "@platformatic/config": "0.34.0",
+    "@platformatic/db": "0.34.0",
+    "@platformatic/service": "0.34.0",
+    "@platformatic/telemetry": "0.34.0",
+    "@platformatic/utils": "0.34.0"
   },
   "standard": {
     "ignore": [

package/test/cli/watch.test.mjs

@@ -1,11 +1,12 @@
 import assert from 'node:assert'
-import { cp, writeFile, mkdtemp, mkdir, rm } from 'node:fs/promises'
+import { cp, writeFile, mkdtemp, mkdir, rm, utimes } from 'node:fs/promises'
 import { join } from 'node:path'
 import { test } from 'node:test'
 import { setTimeout as sleep } from 'node:timers/promises'
 import desm from 'desm'
 import { request } from 'undici'
 import { start } from './helper.mjs'
+import { on } from 'node:events'
 
 const fixturesDir = join(desm(import.meta.url), '..', '..', 'fixtures')
 
@@ -205,3 +206,79 @@ 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) => {
+  process.env.PORT = 0
+  const config = join(fixturesDir, 'do-not-reload-dependencies', 'platformatic.service.json')
+  const { child, url } = await start('-c', config)
+  t.after(() => child.kill('SIGINT'))
+  t.after(() => delete process.env.PORT)
+
+  const res1 = await request(`${url}/plugin1`)
+  const plugin1 = (await res1.body.json()).hello
+
+  const res2 = await request(`${url}/plugin2`)
+  const plugin2 = (await res2.body.json()).hello
+
+  utimes(config, new Date(), new Date()).catch(() => {})
+
+  // wait for restart
+  for await (const messages of on(child.ndj, 'data')) {
+    let url
+    for (const message of messages) {
+      if (message.msg) {
+        url = message.msg.match(/server listening at (.+)/i)?.[1]
+
+        if (url !== undefined) {
+          break
+        }
+      }
+    }
+
+    if (url !== undefined) {
+      break
+    }
+  }
+
+  const res3 = await request(`${url}/plugin1`)
+  assert.strictEqual((await res3.body.json()).hello, plugin1)
+
+  const res4 = await request(`${url}/plugin2`)
+  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) => {
+  const tmpDir = await mkdtemp(join(base, 'watch-'))
+  t.after(() => saferm(tmpDir))
+  t.diagnostic(`using ${tmpDir}`)
+  const appSrc = join(fixturesDir, 'monorepo', 'serviceAppWithLogger')
+  const appDst = join(tmpDir)
+  const cjsPluginFilePath = join(appDst, 'plugin.js')
+
+  await Promise.all([
+    cp(appSrc, appDst, { recursive: true })
+  ])
+
+  await writeFile(cjsPluginFilePath, createCjsLoggingPlugin('v1', false))
+  const { child } = await start('-c', join(appDst, 'platformatic.service.json'))
+  t.after(() => child.kill('SIGINT'))
+
+  await writeFile(cjsPluginFilePath, createCjsLoggingPlugin('v2', true))
+
+  let restartedSecondTime = false
+  let restartedThirdTime = false
+
+  for await (const log of child.ndj) {
+    if (log.msg === 'RELOADED v2') {
+      restartedSecondTime = true
+    } else if (log.msg === 'RELOADED v3') {
+      assert.ok(restartedSecondTime)
+      restartedThirdTime = true
+      break
+    } else if (log.msg?.match(/listening/)) {
+      await writeFile(cjsPluginFilePath, createCjsLoggingPlugin('v3', true))
+    }
+  }
+
+  assert.ok(restartedThirdTime)
+})

package/test/config.test.js

@@ -3,7 +3,7 @@
 const assert = require('node:assert')
 const { join } = require('node:path')
 const { test } = require('node:test')
-const { loadConfig } = require('@platformatic/service')
+const { loadConfig, platformaticService } = require('@platformatic/service')
 const { parseInspectorOptions, platformaticRuntime } = require('../lib/config')
 const fixturesDir = join(__dirname, '..', 'fixtures')
 
@@ -209,3 +209,21 @@ test('parseInspectorOptions()', async (t) => {
     assert.strictEqual(cm.current.inspectorOptions.port, 65535)
   })
 })
+
+test('same schemaOptions as platformatic service', async () => {
+  assert.deepStrictEqual(platformaticRuntime.schemaOptions, platformaticService.schemaOptions)
+})
+
+test('correctly loads the hotReload value from a string', async () => {
+  const configFile = join(fixturesDir, 'configs', 'monorepo-hotreload-env.json')
+  process.env.PLT_HOT_RELOAD = 'true'
+  const loaded = await loadConfig({}, ['-c', configFile], platformaticRuntime)
+  assert.strictEqual(loaded.configManager.current.hotReload, true)
+})
+
+test('correctly loads the hotReload value from a string', async () => {
+  const configFile = join(fixturesDir, 'configs', 'monorepo-hotreload-env.json')
+  process.env.PLT_HOT_RELOAD = 'false'
+  const loaded = await loadConfig({}, ['-c', configFile], platformaticRuntime)
+  assert.strictEqual(loaded.configManager.current.hotReload, false)
+})