@platformatic/runtime 0.30.1 → 0.31.1

package/fixtures/dbAppWithMigrationError/migrations/001.do.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS movies (
+  id INTEGER PRIMARY KEY,
+  title TEXT NOT NULL fiddlesticks
+);

package/fixtures/dbAppWithMigrationError/migrations/001.undo.sql

@@ -0,0 +1 @@
+DROP TABLE movies;

package/fixtures/dbAppWithMigrationError/platformatic.db.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.30.0/db",
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 3042
+  },
+  "migrations": {
+    "autoApply": true,
+    "dir": "migrations",
+    "table": "versions"
+  },
+  "types": {
+    "autogenerate": false
+  },
+  "plugins": {
+    "paths": [
+      "plugin.js"
+    ]
+  },
+  "db": {
+    "connectionString": "sqlite://db.sqlite",
+    "graphql": true,
+    "ignore": {
+      "versions": true
+    },
+    "events": false
+  }
+}

package/fixtures/dbAppWithMigrationError/plugin.js

@@ -0,0 +1,5 @@
+/// <reference path="./global.d.ts" />
+'use strict'
+
+/** @param {import('fastify').FastifyInstance} app */
+module.exports = async function (app) {}

package/fixtures/typescript/services/movies/.env

@@ -0,0 +1,4 @@
+PLT_SERVER_HOSTNAME=127.0.0.1
+PORT=3001
+PLT_SERVER_LOGGER_LEVEL=info
+DATABASE_URL=sqlite://./db.sqlite

package/index.js

@@ -4,6 +4,7 @@ const { platformaticRuntime } = require('./lib/config')
 const { start } = require('./lib/start')
 const unifiedApi = require('./lib/unified-api')
 const RuntimeApi = require('./lib/api')
+const { compile } = require('./lib/compile')
 
 module.exports.buildServer = buildServer
 module.exports.platformaticRuntime = platformaticRuntime
@@ -11,3 +12,4 @@ module.exports.schema = platformaticRuntime.schema
 module.exports.RuntimeApi = RuntimeApi
 module.exports.start = start
 module.exports.unifiedApi = unifiedApi
+module.exports.compile = compile

package/lib/compile.js

@@ -1,41 +1,50 @@
 'use strict'
 
-const { loadConfig, tsCompiler } = require('@platformatic/service')
+const { tsCompiler } = require('@platformatic/service')
+const { loadConfig } = require('./unified-api')
+const { dirname } = require('node:path')
+
 const pino = require('pino')
 const pretty = require('pino-pretty')
 const { isatty } = require('node:tty')
 
-const { platformaticRuntime } = require('./config')
-
-async function compile (argv) {
-  const { configManager } = await loadConfig({}, argv, platformaticRuntime, {
+async function compile (argv, logger) {
+  const { configManager, configType } = await loadConfig({}, argv, undefined, {
     watch: false
   })
 
-  let stream
+  /* c8 ignore next */
+  if (!logger) {
+    let stream
 
-  /* c8 ignore next 6 */
-  if (isatty(process.stdout.fd)) {
-    stream = pretty({
-      translateTime: 'SYS:HH:MM:ss',
-      ignore: 'hostname,pid'
-    })
+    if (isatty(process.stdout.fd)) {
+      stream = pretty({
+        translateTime: 'SYS:HH:MM:ss',
+        ignore: 'hostname,pid'
+      })
+    }
+
+    logger = pino(stream)
   }
 
-  const logger = pino(stream)
+  let compiled = false
 
-  for (const service of configManager.current.services) {
-    const childLogger = logger.child({ name: service.id })
+  if (configType === 'runtime') {
+    for (const service of configManager.current.services) {
+      const childLogger = logger.child({ name: service.id })
 
-    const serviceConfig = await loadConfig({}, argv, platformaticRuntime, {
-      watch: false
-    })
+      const serviceConfig = await loadConfig({}, argv, undefined, {
+        watch: false
+      })
 
-    const compiled = await tsCompiler.compile(service.path, serviceConfig.config, childLogger)
-    if (!compiled) {
-      logger.trace('No typescript found, skipping compilation')
+      const serviceWasCompiled = await tsCompiler.compile(service.path, serviceConfig.config, childLogger)
+      compiled ||= serviceWasCompiled
     }
+  } else {
+    compiled = await tsCompiler.compile(dirname(configManager.fullPath), configManager.current, logger)
   }
+
+  return compiled
 }
 
 module.exports.compile = compile

package/lib/message-port-writable.js

@@ -11,6 +11,14 @@ class MessagePortWritable extends Writable {
     this.metadata = opts.metadata
   }
 
+  _write (chunk, encoding, callback) {
+    this.port.postMessage({
+      metadata: this.metadata,
+      logs: [chunk.toString().trim()]
+    })
+    process.nextTick(callback)
+  }
+
   _writev (chunks, callback) {
     // Process the logs here before trying to send them across the thread
     // boundary. Sometimes the chunks have an undocumented method on them

package/lib/unified-api.js

@@ -135,7 +135,12 @@ async function _loadConfig (minimistConfig, args, configType, overrides) {
     configType = await getConfigType(args)
   }
 
-  return loadConfig(minimistConfig, args, getApp(configType), overrides)
+  const app = getApp(configType)
+  const res = await loadConfig(minimistConfig, args, app, overrides)
+  res.configType = configType
+  res.app = app
+
+  return res
 }
 
 async function _start (args) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.30.1",
+  "version": "0.31.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -24,8 +24,8 @@
     "standard": "^17.1.0",
     "tsd": "^0.28.1",
     "typescript": "^5.1.6",
-    "@platformatic/sql-mapper": "0.30.1",
-    "@platformatic/sql-graphql": "0.30.1"
+    "@platformatic/sql-mapper": "0.31.1",
+    "@platformatic/sql-graphql": "0.31.1"
   },
   "dependencies": {
     "@hapi/topo": "^6.0.2",
@@ -40,11 +40,11 @@
     "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "undici": "^5.22.1",
-    "@platformatic/composer": "0.30.1",
-    "@platformatic/config": "0.30.1",
-    "@platformatic/db": "0.30.1",
-    "@platformatic/service": "0.30.1",
-    "@platformatic/utils": "0.30.1"
+    "@platformatic/composer": "0.31.1",
+    "@platformatic/config": "0.31.1",
+    "@platformatic/db": "0.31.1",
+    "@platformatic/service": "0.31.1",
+    "@platformatic/utils": "0.31.1"
   },
   "standard": {
     "ignore": [

package/runtime.mjs

@@ -7,7 +7,9 @@ import isMain from 'es-main'
 import helpMe from 'help-me'
 import parseArgs from 'minimist'
 import { start } from './lib/start.js'
-import { compile } from './lib/compile.js'
+import { compile as compileCmd } from './lib/compile.js'
+
+export const compile = compileCmd
 
 const help = helpMe({
   dir: join(import.meta.url, 'help'),

package/test/cli/compile.test.mjs

@@ -14,20 +14,8 @@ try {
 } catch {
 }
 
-test('compile without tsconfigs', async () => {
-  const config = join(import.meta.url, '..', '..', 'fixtures', 'configs', 'monorepo.json')
-  await execa(cliPath, ['compile', '-c', config])
-})
-
-test('compile with tsconfig', async (t) => {
-  const tmpDir = await mkdtemp(path.join(base, 'test-runtime-compile-'))
-  const prev = process.cwd()
-  process.chdir(tmpDir)
-  t.after(() => {
-    process.chdir(prev)
-  })
-
-  t.after(async () => {
+function delDir (tmpDir) {
+  return async function () {
     // We give up after 10s.
     // This is because on Windows, it's very hard to delete files if the file
     // system is not collaborating.
@@ -42,8 +30,24 @@ test('compile with tsconfig', async (t) => {
         }
       }
     }
+  }
+}
+
+test('compile without tsconfigs', async () => {
+  const config = join(import.meta.url, '..', '..', 'fixtures', 'configs', 'monorepo.json')
+  await execa(cliPath, ['compile', '-c', config])
+})
+
+test('compile with tsconfig', async (t) => {
+  const tmpDir = await mkdtemp(path.join(base, 'test-runtime-compile-'))
+  const prev = process.cwd()
+  process.chdir(tmpDir)
+  t.after(() => {
+    process.chdir(prev)
   })
 
+  t.after(delDir(tmpDir))
+
   const folder = join(import.meta.url, '..', '..', 'fixtures', 'typescript')
   await cp(folder, tmpDir, { recursive: true })
 
@@ -72,22 +76,7 @@ test('compile with tsconfig custom flags', async (t) => {
     process.chdir(prev)
   })
 
-  t.after(async () => {
-    // We give up after 10s.
-    // This is because on Windows, it's very hard to delete files if the file
-    // system is not collaborating.
-    for (let i = 0; i < 10; i++) {
-      try {
-        await rm(tmpDir, { recursive: true, force: true })
-        break
-      } catch (err) {
-        if (err.code === 'EBUSY') {
-          await sleep(1000)
-          continue
-        }
-      }
-    }
-  })
+  t.after(delDir(tmpDir))
 
   const folder = join(import.meta.url, '..', '..', 'fixtures', 'typescript-custom-flags')
   await cp(folder, tmpDir, { recursive: true })
@@ -108,3 +97,28 @@ test('compile with tsconfig custom flags', async (t) => {
     assert.deepStrictEqual(lines[i].msg, expected[i].msg)
   }
 })
+
+test('compile single service', async (t) => {
+  const tmpDir = await mkdtemp(path.join(base, 'test-runtime-compile-'))
+  const prev = process.cwd()
+  process.chdir(tmpDir)
+  t.after(() => {
+    process.chdir(prev)
+  })
+
+  t.after(delDir(tmpDir))
+
+  const folder = join(import.meta.url, '..', '..', 'fixtures', 'typescript', 'services', 'movies')
+  await cp(folder, tmpDir, { recursive: true })
+
+  const { stdout } = await execa(cliPath, ['compile'])
+
+  const lines = stdout.split('\n').map(JSON.parse)
+  const expected = [{
+    msg: 'Typescript compilation completed successfully.'
+  }]
+
+  for (let i = 0; i < expected.length; i++) {
+    assert.deepStrictEqual(lines[i].msg, expected[i].msg)
+  }
+})

package/test/start.test.js

@@ -8,6 +8,7 @@ const { MessageChannel } = require('node:worker_threads')
 const { request } = require('undici')
 const { loadConfig } = require('@platformatic/service')
 const { buildServer, platformaticRuntime } = require('..')
+const { wrapConfigInRuntimeConfig } = require('../lib/config')
 const { startWithConfig } = require('../lib/start')
 const fixturesDir = join(__dirname, '..', 'fixtures')
 
@@ -156,3 +157,30 @@ test('handles uncaught exceptions with db app', async (t) => {
 
   assert.strictEqual(exitCode, 42)
 })
+
+test('logs errors during db migrations', async (t) => {
+  const configFile = join(fixturesDir, 'dbAppWithMigrationError', 'platformatic.db.json')
+  const config = await loadConfig({}, ['-c', configFile], 'db')
+  const runtimeConfig = await wrapConfigInRuntimeConfig(config)
+  const { port1, port2 } = new MessageChannel()
+  runtimeConfig.current.loggingPort = port2
+  runtimeConfig.current.loggingMetadata = { foo: 1, bar: 2 }
+  const runtime = await startWithConfig(runtimeConfig)
+  const messages = []
+
+  port1.on('message', (msg) => {
+    messages.push(msg)
+  })
+
+  await assert.rejects(async () => {
+    await runtime.start()
+  }, /The runtime exited before the operation completed/)
+
+  assert.strictEqual(messages.length, 2)
+  assert.deepStrictEqual(messages[0].metadata, runtimeConfig.current.loggingMetadata)
+  assert.strictEqual(messages[0].logs.length, 1)
+  assert.match(messages[0].logs[0], /running 001.do.sql/)
+  assert.deepStrictEqual(messages[1].metadata, runtimeConfig.current.loggingMetadata)
+  assert.strictEqual(messages[1].logs.length, 1)
+  assert.match(messages[1].logs[0], /near \\"fiddlesticks\\": syntax error/)
+})