@platformatic/runtime 0.31.1 → 0.32.0

package/README.md

@@ -1,6 +1,6 @@
 # @platformatic/runtime
 
-Check out the full documentation for Platformatic Runtime on [our website](https://oss.platformatic.dev/docs/getting-started/quick-start-guide).
+Check out the full documentation for Platformatic Runtime on [our website](https://docs.platformatic.dev/docs/getting-started/quick-start-guide).
 
 ## Install
 

package/fixtures/leven/.env.sample

@@ -0,0 +1,4 @@
+PLT_SERVER_HOSTNAME=127.0.0.1
+PORT=3043
+PLT_SERVER_LOGGER_LEVEL=info
+PLT_EXAMPLE=world

package/fixtures/leven/platformatic.runtime.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.31.0/runtime",
+  "entrypoint": "rainy-empire",
+  "allowCycles": false,
+  "hotReload": true,
+  "autoload": {
+    "path": "services",
+    "exclude": [
+      "docs"
+    ]
+  }
+}

package/fixtures/leven/services/deeply-spittle/platformatic.service.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.31.0/service",
+  "server": {
+    "hostname": "{PLT_SERVER_HOSTNAME}",
+    "port": "{PORT}",
+    "logger": {
+      "level": "{PLT_SERVER_LOGGER_LEVEL}"
+    }
+  },
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugins",
+        "encapsulate": false,
+        "options": {
+          "example": "{PLT_EXAMPLE}"
+        }
+      },
+      "./routes"
+    ]
+  }
+}

package/fixtures/leven/services/deeply-spittle/plugins/example.js

@@ -0,0 +1,6 @@
+/// <reference types="@platformatic/service" />
+'use strict'
+/** @param {import('fastify').FastifyInstance} fastify */
+module.exports = async function (fastify, opts) {
+  fastify.decorate('example', 'foobar')
+}

package/fixtures/leven/services/deeply-spittle/routes/root.js

@@ -0,0 +1,8 @@
+/// <reference types="@platformatic/service" />
+'use strict'
+/** @param {import('fastify').FastifyInstance} fastify */
+module.exports = async function (fastify, opts) {
+  fastify.get('/', async (request, reply) => {
+    return { hello: fastify.example }
+  })
+}

package/fixtures/leven/services/rainy-empire/platformatic.composer.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.31.0/composer",
+  "server": {
+    "hostname": "{PLT_SERVER_HOSTNAME}",
+    "port": "{PORT}",
+    "logger": {
+      "level": "{PLT_SERVER_LOGGER_LEVEL}"
+    }
+  },
+  "composer": {
+    "services": [
+      {
+        "id": "deeply-splitte",
+        "openapi": {
+          "url": "/documentation/json"
+        }
+      }
+    ]
+  },
+  "watch": false
+}

package/fixtures/no-env.service.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://platformatic.dev/schemas/v0.31.0/service",
+  "server": {
+    "hostname": "{PLT_SERVER_HOSTNAME}",
+    "port": "{PORT}",
+    "logger": {
+      "level": "{PLT_SERVER_LOGGER_LEVEL}"
+    }
+  },
+  "service": {
+    "openapi": true
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugins",
+        "encapsulate": false,
+        "options": {
+          "example": "{PLT_EXAMPLE}"
+        }
+      },
+      "./routes"
+    ]
+  }
+}

package/lib/app.js

@@ -24,7 +24,9 @@ class PlatformaticApp {
     this.server = null
     this.#started = false
     this.#originalWatch = null
-    this.#logger = logger
+    this.#logger = logger.child({
+      name: this.appConfig.id
+    })
   }
 
   getStatus () {
@@ -148,12 +150,19 @@ class PlatformaticApp {
   async #initializeConfig () {
     const appConfig = this.appConfig
 
-    this.config = await loadConfig({}, ['-c', appConfig.config], null, {
-      watch: true,
-      onMissingEnv (key) {
-        return appConfig.localServiceEnvVars.get(key)
-      }
-    })
+    let _config
+    try {
+      _config = await loadConfig({}, ['-c', appConfig.config], null, {
+        watch: true,
+        onMissingEnv (key) {
+          return appConfig.localServiceEnvVars.get(key)
+        }
+      })
+    } catch (err) {
+      this.#logAndExit(err)
+    }
+
+    this.config = _config
     const { configManager } = this.config
 
     function applyOverrides () {
@@ -206,9 +215,7 @@ class PlatformaticApp {
   #setuplogger (configManager) {
     // Set the logger if not present (and the config supports it).
     if (configManager.current.server) {
-      const childLogger = this.#logger.child({
-        name: this.appConfig.id
-      }, { level: configManager.current.server.logger?.level || 'info' })
+      const childLogger = this.#logger.child({}, { level: configManager.current.server.logger?.level || 'info' })
       configManager.current.server.logger = childLogger
     }
   }

package/lib/config.js

@@ -1,6 +1,7 @@
 'use strict'
 const { readFile, readdir } = require('node:fs/promises')
 const { basename, join, resolve: pathResolve } = require('node:path')
+const { closest } = require('fastest-levenshtein')
 const Topo = require('@hapi/topo')
 const ConfigManager = require('@platformatic/config')
 const { schema } = require('./schema')
@@ -71,6 +72,15 @@ async function _transformConfig (configManager) {
   }
 }
 
+function missingDependencyErrorMessage (clientName, service, configManager) {
+  const closestName = closest(clientName, [...configManager.current.serviceMap.keys()])
+  let errorMsg = `service '${service.id}' has unknown dependency: '${clientName}'.`
+  if (closestName) {
+    errorMsg += ` Did you mean '${closestName}'?`
+  }
+  return errorMsg
+}
+
 async function parseClientsAndComposer (configManager) {
   for (let i = 0; i < configManager.current.services.length; ++i) {
     const service = configManager.current.services[i]
@@ -86,8 +96,7 @@ async function parseClientsAndComposer (configManager) {
         const dependency = configManager.current.serviceMap.get(clientName)
 
         if (dependency === undefined) {
-          /* c8 ignore next 2 */
-          throw new Error(`service '${service.id}' has unknown dependency: '${clientName}'`)
+          throw new Error(missingDependencyErrorMessage(clientName, service, configManager))
         }
 
         dependency.dependents.push(service.id)
@@ -170,7 +179,7 @@ async function parseClientsAndComposer (configManager) {
 
           /* c8 ignore next 4 */
           if (dependency === undefined) {
-            reject(new Error(`service '${service.id}' has unknown dependency: '${clientName}'`))
+            reject(new Error(missingDependencyErrorMessage(clientName, service, configManager)))
             return
           }
 

package/lib/schema.js

@@ -67,7 +67,14 @@ const platformaticRuntimeSchema = {
       type: 'string'
     },
     hotReload: {
-      type: 'boolean'
+      anyOf: [
+        {
+          type: 'boolean'
+        },
+        {
+          type: 'string'
+        }
+      ]
     },
     allowCycles: {
       type: 'boolean'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.31.1",
+  "version": "0.32.0",
   "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.31.1",
-    "@platformatic/sql-graphql": "0.31.1"
+    "@platformatic/sql-graphql": "0.32.0",
+    "@platformatic/sql-mapper": "0.32.0"
   },
   "dependencies": {
     "@hapi/topo": "^6.0.2",
@@ -33,6 +33,7 @@
     "commist": "^3.2.0",
     "desm": "^1.3.0",
     "es-main": "^1.2.0",
+    "fastest-levenshtein": "^1.0.16",
     "fastify": "^4.18.0",
     "fastify-undici-dispatcher": "^0.4.1",
     "help-me": "^4.2.0",
@@ -40,11 +41,11 @@
     "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "undici": "^5.22.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"
+    "@platformatic/composer": "0.32.0",
+    "@platformatic/config": "0.32.0",
+    "@platformatic/db": "0.32.0",
+    "@platformatic/service": "0.32.0",
+    "@platformatic/utils": "0.32.0"
   },
   "standard": {
     "ignore": [
@@ -53,7 +54,8 @@
     ]
   },
   "scripts": {
-    "test": "npm run lint && c8 -x fixtures -x test node --test && tsd",
+    "test": "npm run lint && node --test && tsd",
+    "coverage": "npm run lint && c8 -x fixtures -x test node --test && tsd",
     "lint": "standard | snazzy"
   }
 }

package/test/app.test.js

@@ -308,3 +308,35 @@ test('restarts on config change without overriding the configManager', async (t)
   }
   assert.strictEqual(configManager, app.server.platformatic.configManager)
 })
+
+test('logs errors if an env variable is missing', async (t) => {
+  const { logger, stream } = getLoggerAndStream()
+  const configFile = join(fixturesDir, 'no-env.service.json')
+  const config = {
+    id: 'no-env',
+    config: configFile,
+    path: fixturesDir,
+    entrypoint: true,
+    hotReload: true
+  }
+  const app = new PlatformaticApp(config, null, logger)
+
+  t.mock.method(process, 'exit', () => {
+    throw new Error('exited')
+  })
+
+  await assert.rejects(async () => {
+    await app.start()
+  }, /exited/)
+  assert.strictEqual(process.exit.mock.calls.length, 1)
+  assert.strictEqual(process.exit.mock.calls[0].arguments[0], 1)
+
+  stream.end()
+  const lines = []
+  for await (const line of stream) {
+    lines.push(line)
+  }
+  const lastLine = lines[lines.length - 1]
+  assert.strictEqual(lastLine.name, 'no-env')
+  assert.strictEqual(lastLine.msg, 'Cannot parse config file. Cannot read properties of undefined (reading \'get\')')
+})

package/test/cli/compile-2.test.mjs

@@ -0,0 +1,69 @@
+import { test } from 'node:test'
+import assert from 'node:assert'
+import { join } from 'desm'
+import path from 'node:path'
+import { cliPath, delDir } from './helper.mjs'
+import { execa } from 'execa'
+import { mkdtemp, cp, mkdir } from 'node:fs/promises'
+
+const base = join(import.meta.url, '..', 'tmp')
+
+try {
+  await mkdir(base, { recursive: true })
+} catch {
+}
+
+test('compile with tsconfig custom flags', 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-custom-flags')
+  await cp(folder, tmpDir, { recursive: true })
+
+  const { stdout } = await execa(cliPath, ['compile'])
+
+  const lines = stdout.split('\n').map(JSON.parse)
+  const expected = [{
+    name: 'movies',
+    msg: 'Typescript compilation completed successfully.'
+  }, {
+    name: 'titles',
+    msg: 'Typescript compilation completed successfully.'
+  }]
+
+  for (let i = 0; i < expected.length; i++) {
+    assert.deepStrictEqual(lines[i].name, expected[i].name)
+    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/cli/compile.test.mjs

@@ -2,10 +2,9 @@ import { test } from 'node:test'
 import assert from 'node:assert'
 import { join } from 'desm'
 import path from 'node:path'
-import { cliPath } from './helper.mjs'
+import { cliPath, delDir } from './helper.mjs'
 import { execa } from 'execa'
-import { mkdtemp, rm, cp, mkdir } from 'node:fs/promises'
-import { setTimeout as sleep } from 'node:timers/promises'
+import { mkdtemp, cp, mkdir } from 'node:fs/promises'
 
 const base = join(import.meta.url, '..', 'tmp')
 
@@ -14,25 +13,6 @@ try {
 } catch {
 }
 
-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.
-    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
-        }
-      }
-    }
-  }
-}
-
 test('compile without tsconfigs', async () => {
   const config = join(import.meta.url, '..', '..', 'fixtures', 'configs', 'monorepo.json')
   await execa(cliPath, ['compile', '-c', config])

package/test/cli/helper.mjs

@@ -3,6 +3,7 @@ import { Agent, setGlobalDispatcher } from 'undici'
 import { execa } from 'execa'
 import split from 'split2'
 import { join } from 'desm'
+import { rm } from 'node:fs/promises'
 
 setGlobalDispatcher(new Agent({
   keepAliveTimeout: 10,
@@ -44,3 +45,22 @@ export async function start (...args) {
     }
   }
 }
+
+export function delDir (tmpDir) {
+  return async function () {
+    console.time('delDir')
+    // We give up after 10s.
+    // This is because on Windows, it's very hard to delete files if the file
+    // system is not collaborating.
+    try {
+      await rm(tmpDir, { recursive: true, force: true })
+    } catch (err) {
+      if (err.code !== 'EBUSY') {
+        throw err
+      } else {
+        console.log('Could not delete directory, retrying', tmpDir)
+      }
+    }
+    console.timeEnd('delDir')
+  }
+}

package/test/config.test.js

@@ -55,6 +55,14 @@ test('performs a topological sort on services depending on allowCycles', async (
       await loadConfig({}, ['-c', configFile], platformaticRuntime)
     })
   })
+
+  await t.test('throws by adding the most probable service ', async () => {
+    const configFile = join(fixturesDir, 'leven', 'platformatic.runtime.json')
+
+    await assert.rejects(async () => {
+      await loadConfig({}, ['-c', configFile], platformaticRuntime)
+    }, 'service \'rainy-empire\' has unordered dependency: \'deeply-splitte\'. Did you mean \'deeply-spittle\'?')
+  })
 })
 
 test('can resolve service id from client package.json if not provided', async () => {

package/test/start.test.js

@@ -68,7 +68,7 @@ test('composer', async (t) => {
     const res = await request(entryUrl)
 
     assert.strictEqual(res.statusCode, 200)
-    assert.deepStrictEqual(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
+    assert.deepStrictEqual(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' })
   }
 
   {