@platformatic/basic 2.0.0-alpha.3

package/test/express.test.js

@@ -0,0 +1,34 @@
+import { ifError } from 'node:assert'
+import { test } from 'node:test'
+import { createRuntime, verifyViaHTTP, verifyViaInject } from './helper.js'
+
+test('can detect and start an express application with no build function defined', async t => {
+  const { runtime, url } = await createRuntime(t, 'express/no-build/platformatic.as-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/direct', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/direct', 200, { ok: true })
+})
+
+test('can detect and start an express application with no build function and when not the entrypoint', async t => {
+  const { runtime, url } = await createRuntime(t, 'express/no-build/platformatic.no-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/mesh', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/mesh', 200, { ok: true })
+})
+
+test('can detect and start an express application with build function defined', async t => {
+  const { runtime, url } = await createRuntime(t, 'express/with-build/platformatic.as-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/direct', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/direct', 200, { ok: true })
+})
+
+test('can detect and start an express applicationwith build function defined and when not the entrypoint', async t => {
+  const { runtime, url } = await createRuntime(t, 'express/no-build/platformatic.no-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/mesh', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/mesh', 200, { ok: true })
+
+  const details = await runtime.getServiceDetails('internal')
+  ifError(details.url)
+})

package/test/fastify.test.js

@@ -0,0 +1,34 @@
+import { ifError } from 'node:assert'
+import { test } from 'node:test'
+import { createRuntime, verifyViaHTTP, verifyViaInject } from './helper.js'
+
+test('can detect and start a fastify application with no build function defined', async t => {
+  const { runtime, url } = await createRuntime(t, 'fastify/no-build/platformatic.as-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/direct', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/direct', 200, { ok: true })
+})
+
+test('can detect and start a fastify application with no build function and when not the entrypoint', async t => {
+  const { runtime, url } = await createRuntime(t, 'fastify/no-build/platformatic.no-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/mesh', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/mesh', 200, { ok: true })
+})
+
+test('can detect and start a fastify application with build function defined', async t => {
+  const { runtime, url } = await createRuntime(t, 'fastify/with-build/platformatic.as-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/direct', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/direct', 200, { ok: true })
+})
+
+test('can detect and start a fastify application with build function defined and when not the entrypoint', async t => {
+  const { runtime, url } = await createRuntime(t, 'fastify/no-build/platformatic.no-entrypoint.runtime.json')
+
+  await verifyViaHTTP(url, '/mesh', 200, { ok: true })
+  await verifyViaInject(runtime, 'main', 'GET', '/mesh', 200, { ok: true })
+
+  const details = await runtime.getServiceDetails('internal')
+  ifError(details.url)
+})

package/test/fixtures/express/no-build/index.js

@@ -0,0 +1,16 @@
+import express from 'express'
+
+const app = express()
+
+app.get('/direct', (req, res) => {
+  res.send({ ok: true })
+})
+
+app.get('/internal', (req, res) => {
+  fetch('http://main.plt.local/direct')
+    .then(response => response.json())
+    .then(res.json.bind(res))
+})
+
+// This would likely fail if our code doesn't work
+app.listen(1)

package/test/fixtures/express/no-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "express": "^4.19.2"
+  }
+}

package/test/fixtures/express/no-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/express/no-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/express/no-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/express/with-build/index.js

@@ -0,0 +1,17 @@
+import express from 'express'
+
+export function build () {
+  const app = express()
+
+  app.get('/direct', (req, res) => {
+    res.send({ ok: true })
+  })
+
+  app.get('/internal', (req, res) => {
+    fetch('http://main.plt.local/direct')
+      .then(response => response.json())
+      .then(res.json.bind(res))
+  })
+
+  return app
+}

package/test/fixtures/express/with-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "express": "^4.19.2"
+  }
+}

package/test/fixtures/express/with-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/express/with-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/express/with-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/fastify/no-build/index.js

@@ -0,0 +1,14 @@
+import fastify from 'fastify'
+
+const app = fastify()
+
+app.get('/direct', async () => {
+  return { ok: true }
+})
+
+app.get('/internal', () => {
+  return fetch('http://main.plt.local/direct').then(response => response.json())
+})
+
+// This would likely fail if our code doesn't work
+app.listen({ port: 1 })

package/test/fixtures/fastify/no-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "fastify": "^4.28.1"
+  }
+}

package/test/fixtures/fastify/no-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/fastify/no-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/fastify/no-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/fastify/with-build/index.js

@@ -0,0 +1,15 @@
+import fastify from 'fastify'
+
+export function build () {
+  const app = fastify()
+
+  app.get('/direct', async () => {
+    return { ok: true }
+  })
+
+  app.get('/internal', () => {
+    return fetch('http://main.plt.local/direct').then(response => response.json())
+  })
+
+  return app
+}

package/test/fixtures/fastify/with-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "fastify": "^4.28.1"
+  }
+}

package/test/fixtures/fastify/with-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/fastify/with-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/fastify/with-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": false,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/nodejs/no-build/index.js

@@ -0,0 +1,21 @@
+import { createServer } from 'node:http'
+
+const server = createServer((req, res) => {
+  if (req.url === '/direct') {
+    res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+    res.end(JSON.stringify({ ok: true }))
+  } else if (req.url === '/mesh') {
+    fetch('http://main.plt.local/direct')
+      .then(response => response.json())
+      .then(json => {
+        res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+        res.end(JSON.stringify({ ok: true }))
+      })
+  } else {
+    res.writeHead(404, { 'content-type': 'application/json', connection: 'close' })
+    res.end(JSON.stringify({ ok: false }))
+  }
+})
+
+// This would likely fail if our code doesn't work
+server.listen(1)

package/test/fixtures/nodejs/no-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "express": "^4.19.2"
+  }
+}

package/test/fixtures/nodejs/no-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/nodejs/no-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/nodejs/no-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/nodejs/no-configuration/index.js

@@ -0,0 +1,21 @@
+import { createServer } from 'node:http'
+
+const server = createServer((req, res) => {
+  if (req.url === '/direct') {
+    res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+    res.end(JSON.stringify({ ok: true }))
+  } else if (req.url === '/mesh') {
+    fetch('http://main.plt.local/direct')
+      .then(response => response.json())
+      .then(json => {
+        res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+        res.end(JSON.stringify({ ok: true }))
+      })
+  } else {
+    res.writeHead(404, { 'content-type': 'application/json', connection: 'close' })
+    res.end(JSON.stringify({ ok: false }))
+  }
+})
+
+// This would likely fail if our code doesn't work
+server.listen(1)

package/test/fixtures/nodejs/no-configuration/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": "."
+    }
+  ]
+}

package/test/fixtures/nodejs/no-configuration/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": "." }
+  ]
+}

package/test/fixtures/nodejs/with-build/index.js

@@ -0,0 +1,20 @@
+import { createServer } from 'node:http'
+
+export function build () {
+  return createServer((req, res) => {
+    if (req.url === '/direct') {
+      res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+      res.end(JSON.stringify({ ok: true }))
+    } else if (req.url === '/mesh') {
+      fetch('http://main.plt.local/direct')
+        .then(response => response.json())
+        .then(json => {
+          res.writeHead(200, { 'content-type': 'application/json', connection: 'close' })
+          res.end(JSON.stringify({ ok: true }))
+        })
+    } else {
+      res.writeHead(404, { 'content-type': 'application/json', connection: 'close' })
+      res.end(JSON.stringify({ ok: false }))
+    }
+  })
+}

package/test/fixtures/nodejs/with-build/package.json

@@ -0,0 +1,7 @@
+{
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {
+    "express": "^4.19.2"
+  }
+}

package/test/fixtures/nodejs/with-build/platformatic.app.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/basic/1.52.0.json"
+}

package/test/fixtures/nodejs/with-build/platformatic.as-entrypoint.runtime.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    {
+      "id": "main",
+      "path": ".",
+      "config": "platformatic.app.json"
+    }
+  ]
+}

package/test/fixtures/nodejs/with-build/platformatic.no-entrypoint.runtime.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "entrypoint": "main",
+  "watch": false,
+  "managementApi": true,
+  "metrics": false,
+  "server": {
+    "logger": {
+      "level": "warn"
+    }
+  },
+  "services": [
+    { "id": "main", "path": "../../platformatic-service", "config": "platformatic.service.json" },
+    { "id": "internal", "path": ".", "config": "platformatic.app.json" }
+  ]
+}

package/test/fixtures/platformatic-service/platformatic.service.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/service/1.52.0.json",
+  "server": {
+    "logger": {
+      "level": "error"
+    }
+  },
+  "plugins": {
+    "paths": [
+      {
+        "path": "./plugin.js"
+      }
+    ]
+  }
+}

package/test/fixtures/platformatic-service/plugin.js

@@ -0,0 +1,12 @@
+'use strict'
+
+export default async function (app) {
+  app.get('/mesh', async () => {
+    const response = await fetch('http://internal.plt.local/direct')
+    return response.json()
+  })
+
+  app.get('/direct', async () => {
+    return { ok: true }
+  })
+}

package/test/helper.js

@@ -0,0 +1,65 @@
+import { deepStrictEqual, strictEqual } from 'node:assert'
+import { resolve } from 'node:path'
+import { setTimeout as sleep } from 'node:timers/promises'
+import { Client, request } from 'undici'
+import { loadConfig } from '../../config/index.js'
+import { buildServer, platformaticRuntime } from '../../runtime/index.js'
+
+export const fixturesDir = resolve(import.meta.dirname, './fixtures')
+
+export async function createRuntime (t, path) {
+  const configFile = resolve(fixturesDir, path)
+  const config = await loadConfig({}, ['-c', configFile], platformaticRuntime)
+  const runtime = await buildServer(config.configManager.current)
+  const url = await runtime.start()
+
+  t.after(async () => {
+    await runtime.close()
+  })
+
+  return { runtime, url }
+}
+
+export async function verifyViaHTTP (baseUrl, path, expectedCode, expectedContent) {
+  const { statusCode, body } = await request(baseUrl + path)
+  strictEqual(statusCode, expectedCode)
+  deepStrictEqual(await body.json(), expectedContent)
+}
+
+export async function verifyViaInject (app, serviceId, method, url, expectedCode, expectedContent) {
+  const { statusCode, body } = await app.inject(serviceId, { method, url })
+  strictEqual(statusCode, expectedCode)
+  deepStrictEqual(JSON.parse(body), expectedContent)
+}
+
+export async function getLogs (app) {
+  const client = new Client(
+    {
+      hostname: 'localhost',
+      protocol: 'http:',
+    },
+    {
+      socketPath: app.getManagementApiUrl(),
+      keepAliveTimeout: 10,
+      keepAliveMaxTimeout: 10,
+    }
+  )
+
+  // Wait for logs to be written
+  await sleep(3000)
+
+  const { statusCode, body } = await client.request({
+    method: 'GET',
+    path: '/api/v1/logs/all',
+  })
+
+  strictEqual(statusCode, 200)
+
+  const rawLogs = await body.text()
+
+  return rawLogs
+    .trim()
+    .split('\n')
+    .filter(l => l)
+    .map(m => JSON.parse(m))
+}