@platformatic/basic 2.0.0-alpha.3 → 2.0.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.5",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -15,27 +15,34 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "dependencies": {
-    "light-my-request": "^5.13.0",
+    "@fastify/error": "^4.0.0",
     "pino": "^9.3.2",
+    "semver": "^7.6.3",
     "undici": "^6.19.5",
-    "@platformatic/config": "2.0.0-alpha.3"
+    "@platformatic/config": "2.0.0-alpha.5",
+    "@platformatic/utils": "2.0.0-alpha.5",
+    "@platformatic/itc": "2.0.0-alpha.5"
   },
   "devDependencies": {
     "borp": "^0.17.0",
-    "express": "^4.19.2",
     "eslint": "9",
+    "express": "^4.19.2",
     "fastify": "^4.28.1",
+    "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.11.1",
+    "next": "^14.2.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "typescript": "^5.5.4",
-    "@platformatic/composer": "2.0.0-alpha.3",
-    "@platformatic/service": "2.0.0-alpha.3",
-    "@platformatic/utils": "2.0.0-alpha.3"
+    "vite": "^5.4.0",
+    "ws": "^8.18.0",
+    "@platformatic/composer": "2.0.0-alpha.5",
+    "@platformatic/service": "2.0.0-alpha.5"
   },
   "scripts": {
-    "test": "npm run lint && borp --concurrency=1 --timeout=180000",
-    "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout=180000",
-    "lint": "eslint",
     "gen-schema": "node lib/schema.js > schema.json",
-    "gen-types": "json2ts > config.d.ts < schema.json"
+    "gen-types": "json2ts > config.d.ts < schema.json",
+    "build": "pnpm run gen-schema && pnpm run gen-types",
+    "lint": "eslint"
   }
 }

package/schema.json

@@ -0,0 +1,12 @@
+{
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.0.0-alpha.5.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Platformatic Stackable",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": true
+}

package/test/helper.js

@@ -1,14 +1,49 @@
-import { deepStrictEqual, strictEqual } from 'node:assert'
-import { resolve } from 'node:path'
+import { createDirectory, withResolvers } from '@platformatic/utils'
+import { deepStrictEqual, ok, strictEqual } from 'node:assert'
+import { existsSync } from 'node:fs'
+import { readFile, symlink, writeFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
 import { setTimeout as sleep } from 'node:timers/promises'
 import { Client, request } from 'undici'
+import WebSocket from 'ws'
 import { loadConfig } from '../../config/index.js'
 import { buildServer, platformaticRuntime } from '../../runtime/index.js'
 
-export const fixturesDir = resolve(import.meta.dirname, './fixtures')
+export { setTimeout as sleep } from 'node:timers/promises'
 
-export async function createRuntime (t, path) {
+let hrmVersion = Date.now()
+export let fixturesDir
+
+export function setFixturesDir (directory) {
+  fixturesDir = directory
+}
+
+// This is used to debug tests
+export function pause (url, timeout = 300000) {
+  console.log(`Server is listening at ${url}`)
+  return sleep(timeout)
+}
+
+export async function ensureDependency (directory, pkg, source) {
+  const [namespace, name] = pkg.includes('/') ? pkg.split('/') : ['', pkg]
+  const basedir = resolve(fixturesDir, directory, `node_modules/${namespace}`)
+  const destination = resolve(basedir, name)
+
+  await createDirectory(basedir)
+  if (!existsSync(destination)) {
+    await symlink(source, destination, 'dir')
+  }
+}
+
+export async function createRuntime (t, path, packageRoot) {
   const configFile = resolve(fixturesDir, path)
+
+  if (packageRoot) {
+    const packageName = JSON.parse(await readFile(resolve(packageRoot, 'package.json'), 'utf-8')).name
+    const root = dirname(configFile)
+    await ensureDependency(root, packageName, packageRoot)
+  }
+
   const config = await loadConfig({}, ['-c', configFile], platformaticRuntime)
   const runtime = await buildServer(config.configManager.current)
   const url = await runtime.start()
@@ -20,18 +55,6 @@ export async function createRuntime (t, path) {
   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(
     {
@@ -63,3 +86,80 @@ export async function getLogs (app) {
     .filter(l => l)
     .map(m => JSON.parse(m))
 }
+
+export async function updateHMRVersion (versionFile) {
+  versionFile ??= resolve(fixturesDir, '../tmp/version.js')
+  await createDirectory(dirname(versionFile))
+  await writeFile(versionFile, `export const version = ${hrmVersion++}\n`, 'utf-8')
+}
+
+export async function verifyJSONViaHTTP (baseUrl, path, expectedCode, expectedContent) {
+  const { statusCode, body } = await request(baseUrl + path)
+  strictEqual(statusCode, expectedCode)
+  deepStrictEqual(await body.json(), expectedContent)
+}
+
+export async function verifyJSONViaInject (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 verifyHTMLViaHTTP (baseUrl, path, contents) {
+  const { statusCode, headers, body } = await request(baseUrl + path, { maxRedirections: 1 })
+  const html = await body.text()
+
+  deepStrictEqual(statusCode, 200)
+  ok(headers['content-type']?.startsWith('text/html'))
+
+  for (const content of contents) {
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content))
+  }
+}
+
+export async function verifyHTMLViaInject (app, serviceId, url, contents) {
+  const { statusCode, headers, body: html } = await app.inject(serviceId, { method: 'GET', url })
+
+  deepStrictEqual(statusCode, 200)
+  ok(headers['content-type'].startsWith('text/html'))
+
+  for (const content of contents) {
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content))
+  }
+}
+
+export async function verifyHMR (baseUrl, path, protocol, handler) {
+  const connection = withResolvers()
+  const reload = withResolvers()
+  const ac = new AbortController()
+  const timeout = sleep(10000, 'timeout', { signal: ac.signal })
+
+  const url = baseUrl.replace('http:', 'ws:') + path
+  const webSocket = new WebSocket(url, protocol)
+
+  webSocket.on('error', err => {
+    clearTimeout(timeout)
+    connection.reject(err)
+    reload.reject(err)
+  })
+
+  webSocket.on('message', data => {
+    handler(JSON.parse(data), connection.resolve, reload.resolve)
+  })
+
+  try {
+    if ((await Promise.race([connection.promise, timeout])) === 'timeout') {
+      throw new Error('Timeout while waiting for HMR connection')
+    }
+
+    await sleep(1000)
+    await updateHMRVersion()
+
+    if ((await Promise.race([reload.promise, timeout])) === 'timeout') {
+      throw new Error('Timeout while waiting for HMR reload')
+    }
+  } finally {
+    webSocket.terminate()
+    ac.abort()
+  }
+}

package/lib/server.js

@@ -1,135 +0,0 @@
-import inject from 'light-my-request'
-import { Server } from 'node:http'
-import { join } from 'node:path'
-import { pathToFileURL } from 'node:url'
-import { BaseStackable } from './base.js'
-import { createPortManager, getServerUrl, injectViaRequest, isFastify } from './utils.js'
-
-export class ServerStackable extends BaseStackable {
-  #entrypoint
-  #hadEntrypointField
-  #module
-  #app
-  #server
-  #dispatcher
-  #isFastify
-
-  constructor (options, root, configManager, entrypoint, hadEntrypointField) {
-    super(options, root, configManager)
-    this.#entrypoint = entrypoint
-    this.#hadEntrypointField = hadEntrypointField
-  }
-
-  async start ({ listen }) {
-    // Make this idempotent
-    if (this.url) {
-      return this.url
-    }
-
-    // Listen if entrypoint
-    if (this.#app && listen) {
-      await this.#listen()
-      return this.url
-    }
-
-    // Require the application
-    if (!this.#hadEntrypointField) {
-      this.logger.warn(
-        `The service ${this.id} had no valid entrypoint defined in the package.json file. Falling back to the file ${this.#entrypoint}.`
-      )
-    }
-
-    // The port manager must be created before requiring the entrypoint even if it's not going to be used
-    // at all. Otherwise there is chance we miss the listen event.
-    const portManager = createPortManager()
-    this.#module = await import(pathToFileURL(join(this.root, this.#entrypoint)))
-    this.#module = this.#module.default || this.#module
-
-    // Deal with application
-    if (typeof this.#module.build === 'function') {
-      // We have build function, this Stackable will not use HTTP unless it is the entrypoint
-      portManager.destroy()
-
-      this.#app = await this.#module.build()
-      this.#isFastify = isFastify(this.#app)
-
-      if (this.#isFastify) {
-        await this.#app.ready()
-      } else if (this.#app instanceof Server) {
-        this.#server = this.#app
-        this.#dispatcher = this.#server.listeners('request')[0]
-      }
-    } else {
-      // User blackbox function, we wait for it to listen on a port
-      this.#server = await portManager.getServer()
-      this.url = getServerUrl(this.#server)
-      portManager.destroy()
-    }
-
-    return this.url
-  }
-
-  async stop () {
-    if (this.#isFastify) {
-      return this.#app.close()
-    }
-
-    if (this.#server) {
-      if (!this.#server.listening) {
-        return
-      }
-
-      return new Promise((resolve, reject) => {
-        this.#server.close(error => {
-          if (error) {
-            return reject(error)
-          }
-
-          resolve(error)
-        })
-      })
-    }
-  }
-
-  async inject (injectParams, onInject) {
-    let res
-    if (this.#isFastify) {
-      res = await this.#app.inject(injectParams, onInject)
-    } else if (this.#dispatcher) {
-      res = await inject(this.#dispatcher, injectParams, onInject)
-    } else {
-      res = await injectViaRequest(this.url, injectParams, onInject)
-    }
-
-    if (onInject) {
-      return
-    }
-
-    // Since inject might be called from the main thread directly via ITC, let's clean it up
-    const { statusCode, headers, body, payload, rawPayload } = res
-
-    return { statusCode, headers, body, payload, rawPayload }
-  }
-
-  async #listen () {
-    const serverOptions = this.serverConfig
-
-    if (this.#isFastify) {
-      await this.#app.listen({ host: serverOptions?.hostname || '127.0.0.1', port: serverOptions?.port || 0 })
-      this.url = getServerUrl(this.#app.server)
-    } else {
-      // Express / Node
-      this.#server = await new Promise((resolve, reject) => {
-        return this.#app
-          .listen({ host: serverOptions?.hostname || '127.0.0.1', port: serverOptions?.port || 0 }, function () {
-            resolve(this)
-          })
-          .on('error', reject)
-      })
-
-      this.url = getServerUrl(this.#server)
-    }
-
-    return this.url
-  }
-}

package/test/express.test.js

@@ -1,34 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

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

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

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

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

@@ -1,19 +0,0 @@
-{
-  "$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

@@ -1,16 +0,0 @@
-{
-  "$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

@@ -1,17 +0,0 @@
-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

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

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

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

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

@@ -1,19 +0,0 @@
-{
-  "$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

@@ -1,16 +0,0 @@
-{
-  "$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

@@ -1,14 +0,0 @@
-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

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

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

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

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

@@ -1,19 +0,0 @@
-{
-  "$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

@@ -1,16 +0,0 @@
-{
-  "$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

@@ -1,15 +0,0 @@
-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

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

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

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