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

package/lib/next.js

@@ -1,105 +0,0 @@
-import { once } from 'node:events'
-import { readFile } from 'node:fs/promises'
-import { createRequire } from 'node:module'
-import { dirname, resolve as pathResolve } from 'node:path'
-import { pathToFileURL } from 'node:url'
-import { satisfies } from 'semver'
-import { BaseStackable } from './base.js'
-import { UnsupportedVersion } from './errors.js'
-import { importFile } from './utils.js'
-import { ChildManager } from './worker/child-manager.js'
-
-const supportedVersions = '^14.0.0'
-
-export class NextStackable extends BaseStackable {
-  #basePath
-  #next
-  #manager
-
-  constructor (options, root, configManager) {
-    super(options, root, configManager)
-    this.type = 'next'
-  }
-
-  async init () {
-    globalThis[Symbol.for('plt.runtime.itc')].handle('getServiceMeta', this.getMeta.bind(this))
-
-    this.#next = pathResolve(dirname(createRequire(this.root).resolve('next')), '../..')
-    const nextPackage = JSON.parse(await readFile(pathResolve(this.#next, 'package.json')))
-
-    if (!satisfies(nextPackage.version, supportedVersions)) {
-      throw new UnsupportedVersion('next', nextPackage.version, supportedVersions)
-    }
-  }
-
-  async start () {
-    // Make this idempotent
-    if (this.url) {
-      return this.url
-    }
-
-    const config = this.configManager.current
-    const require = createRequire(this.root)
-    const nextRoot = require.resolve('next')
-
-    const { hostname, port } = this.serverConfig ?? {}
-    const serverOptions = {
-      host: hostname || '127.0.0.1',
-      port: port || 0,
-    }
-
-    this.#basePath = config.application?.base
-      ? `/${config.application?.base}`.replaceAll(/\/+/g, '/').replace(/\/$/, '')
-      : ''
-
-    this.#manager = new ChildManager({
-      loader: new URL('./worker/next-loader.js', import.meta.url),
-      context: {
-        // Always use URL to avoid serialization problem in Windows
-        root: pathToFileURL(this.root),
-        basePath: this.#basePath,
-        logger: { id: this.id, level: this.logger.level },
-      },
-    })
-
-    this.#manager.on('config', config => {
-      this.#basePath = config.basePath.replace(/(^\/)|(\/$)/g, '')
-    })
-
-    const promise = once(this.#manager, 'url')
-    await this.#startNext(nextRoot, serverOptions)
-    this.url = (await promise)[0]
-  }
-
-  async stop () {
-    const exitPromise = once(this.#manager, 'exit')
-
-    this.#manager.close()
-    await exitPromise
-  }
-
-  async getWatchConfig () {
-    return {
-      enabled: false,
-    }
-  }
-
-  getMeta () {
-    return {
-      composer: {
-        tcp: true,
-        url: this.url,
-        prefix: this.#basePath,
-        wantsAbsoluteUrls: true,
-      },
-    }
-  }
-
-  async #startNext (nextRoot, serverOptions) {
-    const { nextDev } = await importFile(pathResolve(this.#next, './dist/cli/next-dev.js'))
-
-    this.#manager.inject()
-    await nextDev(serverOptions, 'default', this.root)
-    this.#manager.eject()
-  }
-}

package/lib/server.js

@@ -1,134 +0,0 @@
-import inject from 'light-my-request'
-import { Server } from 'node:http'
-import { resolve as pathResolve } from 'node:path'
-import { BaseStackable } from './base.js'
-import { getServerUrl, importFile, injectViaRequest, isFastify } from './utils.js'
-import { createServerListener } from './worker/server-listener.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 server promise 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 serverPromise = createServerListener()
-    this.#module = await importFile(pathResolve(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
-      serverPromise.cancel()
-
-      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 serverPromise
-      this.url = getServerUrl(this.#server)
-    }
-
-    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/lib/vite.js

@@ -1,105 +0,0 @@
-import { createRequire } from 'node:module'
-import { dirname, resolve as pathResolve } from 'node:path'
-import { satisfies } from 'semver'
-import { BaseStackable } from './base.js'
-import { getServerUrl, importFile } from './utils.js'
-import { createServerListener } from './worker/server-listener.js'
-
-import { readFile } from 'node:fs/promises'
-import { UnsupportedVersion } from './errors.js'
-
-const supportedVersions = '^5.0.0'
-
-export class ViteStackable extends BaseStackable {
-  #vite
-  #app
-  #server
-  #basePath
-
-  constructor (options, root, configManager) {
-    super(options, root, configManager)
-    this.type = 'vite'
-  }
-
-  async init () {
-    globalThis[Symbol.for('plt.runtime.itc')].handle('getServiceMeta', this.getMeta.bind(this))
-
-    this.#vite = dirname(createRequire(this.root).resolve('vite'))
-    const vitePackage = JSON.parse(await readFile(pathResolve(this.#vite, 'package.json')))
-
-    if (!satisfies(vitePackage.version, supportedVersions)) {
-      throw new UnsupportedVersion('vite', vitePackage.version, supportedVersions)
-    }
-  }
-
-  async start () {
-    // Make this idempotent
-    if (this.url) {
-      return this.url
-    }
-
-    const config = this.configManager.current
-
-    // Prepare options
-    const { hostname, port, https, cors } = this.serverConfig ?? {}
-    const configFile = config.vite?.configFile ? pathResolve(this.root, config.vite?.configFile) : undefined
-    const basePath = config.application?.base
-      ? `/${config.application?.base}`.replaceAll(/\/+/g, '/').replace(/\/$/, '')
-      : undefined
-
-    const serverOptions = {
-      host: hostname || '127.0.0.1',
-      port: port || 0,
-      strictPort: false,
-      https,
-      cors,
-      origin: 'http://localhost',
-      hmr: true,
-    }
-
-    // Require Vite
-    const serverPromise = createServerListener()
-    const { createServer } = await importFile(pathResolve(this.#vite, 'dist/node/index.js'))
-
-    // Create the server and listen
-    this.#app = await createServer({
-      root: this.root,
-      base: basePath,
-      mode: 'development',
-      configFile,
-      logLevel: this.logger.level,
-      clearScreen: false,
-      optimizeDeps: { force: false },
-      server: serverOptions,
-    })
-
-    await this.#app.listen()
-    this.#server = await serverPromise
-    this.url = getServerUrl(this.#server)
-  }
-
-  async stop () {
-    return this.#app.close()
-  }
-
-  async getWatchConfig () {
-    return {
-      enabled: false,
-    }
-  }
-
-  getMeta () {
-    if (!this.#basePath) {
-      this.#basePath = this.#app.config.base.replace(/(^\/)|(\/$)/g, '')
-    }
-
-    return {
-      composer: {
-        tcp: true,
-        url: this.url,
-        prefix: this.#basePath,
-        wantsAbsoluteUrls: true,
-      },
-    }
-  }
-}

package/lib/worker/next-loader.js

@@ -1,137 +0,0 @@
-import generate from '@babel/generator'
-import { parse } from '@babel/parser'
-import traverse from '@babel/traverse'
-import {
-  blockStatement,
-  functionDeclaration,
-  identifier,
-  restElement,
-  returnStatement,
-  variableDeclaration,
-  variableDeclarator,
-} from '@babel/types'
-import { readFile } from 'node:fs/promises'
-
-const originalId = '__pltOriginalNextConfig'
-
-let candidates
-let basePath
-
-function parseSingleExpression (expr) {
-  return parse(expr, { allowAwaitOutsideFunction: true }).program.body[0]
-}
-
-/*
-  Generates:
-  async function (...args) {
-    let __pltOriginalNextConfig = $ORIGINAL;
-
-    if (typeof __pltOriginalNextConfig === 'function') {
-      __pltOriginalNextConfig = await __pltOriginalNextConfig(...args);
-    }
-
-    if(typeof __pltOriginalNextConfig === 'undefined') {
-      __pltOriginalNextConfig.basePath = basePath
-    }
-
-    return __pltOriginalNextConfig,
-      basePath: $BASEPATH
-    };
-  }
-*/
-function createEvaluatorWrapperFunction (original) {
-  return functionDeclaration(
-    null,
-    [restElement(identifier('args'))],
-    blockStatement([
-      variableDeclaration('let', [variableDeclarator(identifier(originalId), original)]),
-      parseSingleExpression(
-        `if (typeof ${originalId} === 'function') { ${originalId} = await ${originalId}(...args) }`
-      ),
-      parseSingleExpression(
-        `if (typeof ${originalId}.basePath === 'undefined') { ${originalId}.basePath = "${basePath}" }`
-      ),
-      parseSingleExpression(`globalThis[Symbol.for('plt.children.itc')].notify('config', ${originalId})`),
-      returnStatement(identifier(originalId)),
-    ]),
-    false,
-    true
-  )
-}
-
-function transformCJS (source) {
-  const ast = parse(source.toString(), { sourceType: 'module' })
-
-  // Manipulate the AST
-  traverse.default(ast, {
-    AssignmentExpression (path) {
-      const { left, right } = path.node
-
-      // module.exports = $EXPRESSION
-      if (left.object.name === 'module' && left.property.name === 'exports') {
-        path.node.right = createEvaluatorWrapperFunction(right)
-        path.skip()
-      }
-    },
-  })
-
-  return generate.default(ast).code
-}
-
-function transformESM (source) {
-  const ast = parse(source.toString(), { sourceType: 'module' })
-
-  // Manipulate the AST
-  traverse.default(ast, {
-    ExportDefaultDeclaration (path) {
-      const declaration = path.node.declaration
-
-      // export default [async] function
-      if (path.node.declaration.type === 'FunctionDeclaration') {
-        path.insertBefore(
-          functionDeclaration(
-            identifier(originalId + 'Function'),
-            declaration.params,
-            declaration.body,
-            declaration.generator,
-            declaration.async
-          )
-        )
-
-        path.node.declaration = createEvaluatorWrapperFunction(identifier(originalId + 'Function'))
-      } else {
-        // export default $EXPRESSION
-        path.node.declaration = createEvaluatorWrapperFunction(declaration)
-      }
-    },
-  })
-
-  return generate.default(ast).code
-}
-
-export function initialize (data) {
-  // Keep in sync with https://github.com/vercel/next.js/blob/main/packages/next/src/shared/lib/constants.ts
-  candidates = ['./next.config.js', './next.config.mjs'].map(c => new URL(c, data.root + '/').toString())
-  basePath = data.basePath ?? ''
-}
-
-export async function load (url, context, nextLoad) {
-  // Load the original file
-  const result = await nextLoad(url, context)
-
-  if (!url.startsWith('file:')) {
-    return result
-  }
-
-  if (!candidates.includes(url)) {
-    return result
-  }
-
-  if (result.format === 'commonjs') {
-    result.source = transformCJS(result.source ?? (await readFile(new URL(result.responseURL ?? url), 'utf-8')))
-  } else {
-    result.source = transformESM(result.source)
-  }
-
-  return result
-}

package/test/express.test.js

@@ -1,34 +0,0 @@
-import { ifError } from 'node:assert'
-import { test } from 'node:test'
-import { createRuntime, verifyJSONViaHTTP, verifyJSONViaInject } 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 verifyJSONViaHTTP(url, '/direct', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/mesh', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/direct', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/mesh', 200, { ok: true })
-  await verifyJSONViaInject(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, verifyJSONViaHTTP, verifyJSONViaInject } 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 verifyJSONViaHTTP(url, '/direct', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/mesh', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/direct', 200, { ok: true })
-  await verifyJSONViaInject(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 verifyJSONViaHTTP(url, '/mesh', 200, { ok: true })
-  await verifyJSONViaInject(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" }
-  ]
-}