@toa.io/userland 1.0.0-alpha.31 → 1.0.0-alpha.310

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@toa.io/userland",
-  "version": "1.0.0-alpha.31",
+  "version": "1.0.0-alpha.310",
+  "type": "module",
   "description": "Toa development kit",
   "homepage": "https://toa.io",
   "author": {
@@ -16,23 +17,27 @@
     "url": "https://github.com/toa-io/toa/issues"
   },
   "engines": {
-    "node": ">= 18.0.0"
+    "node": ">= 24.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "main": "src/index.js",
-  "types": "types/index.d.ts",
+  "exports": {
+    ".": "./src/index.js",
+    "./stage": {
+      "types": "./stage/types/index.d.ts",
+      "default": "./stage/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "dependencies": {
-    "@toa.io/boot": "1.0.0-alpha.31",
-    "@toa.io/core": "1.0.0-alpha.31",
-    "@toa.io/filesystem": "1.0.0-alpha.31",
-    "@toa.io/generic": "1.0.0-alpha.31",
-    "@toa.io/norm": "1.0.0-alpha.31",
-    "@toa.io/schemas": "1.0.0-alpha.31",
-    "@toa.io/storages.null": "0.22.0",
-    "@toa.io/yaml": "1.0.0-alpha.31",
-    "tap": "16.3.4"
+    "@toa.io/boot": "1.0.0-alpha.310",
+    "@toa.io/core": "1.0.0-alpha.310",
+    "@toa.io/generic": "1.0.0-alpha.310",
+    "@toa.io/norm": "1.0.0-alpha.310",
+    "@toa.io/schemas": "1.0.0-alpha.310",
+    "@toa.io/storages.null": "1.0.0-alpha.310"
   },
-  "gitHead": "91839a488176853a0731f49abc70dc7103ed7cca"
+  "gitHead": "d952c57f77279729e26d52d50c6df47138ad0a4f"
 }

package/stage/package.json

@@ -1,4 +1,5 @@
 {
+  "type": "module",
   "private": true,
   "main": "src/index.js",
   "types": "types/index.d.ts"

package/stage/src/component.js

@@ -1,12 +1,8 @@
-'use strict'
-
-const boot = require('@toa.io/boot')
-const { state } = require('./state')
+import * as boot from '@toa.io/boot'
+import { state } from './state.js'
 
 /** @type {toa.stage.Component} */
-const component = async (path, options) => {
-  options = Object.assign({}, DEFAULTS, options)
-
+export const component = async (path, options) => {
   const manifest = await boot.manifest(path, options)
   const component = await boot.component(manifest)
 
@@ -16,8 +12,3 @@ const component = async (path, options) => {
 
   return component
 }
-
-const binding = require.resolve('./binding')
-const DEFAULTS = { bindings: [binding] }
-
-exports.component = component

package/stage/src/composition.js

@@ -1,19 +1,11 @@
-'use strict'
-
-const boot = require('@toa.io/boot')
-const { state } = require('./state')
-
-const binding = require.resolve('./binding')
+import * as boot from '@toa.io/boot'
+import { state } from './state.js'
 
 /** @type {toa.stage.Composition} */
-const composition = async (paths, options) => {
-  options ??= { bindings: [binding] }
-
+export const composition = async (paths, options) => {
   const composition = await boot.composition(paths, options)
 
   await composition.connect()
 
   state.compositions.push(composition)
 }
-
-exports.composition = composition

package/stage/src/index.js

@@ -1,18 +1,9 @@
-'use strict'
-
-const { manifest } = require('./manifest')
-const { component } = require('./component')
-const { composition } = require('./composition')
-const { service } = require('./service')
-const { remote } = require('./remote')
-const { shutdown } = require('./shutdown')
-const binding = require('./binding')
-
-exports.manifest = manifest
-exports.component = component
-exports.composition = composition
-exports.compose = composition
-exports.serve = service
-exports.remote = remote
-exports.shutdown = shutdown
-exports.binding = binding
+export { manifest } from './manifest.js'
+export { map } from './map.js'
+export { component } from './component.js'
+export { composition, composition as compose } from './composition.js'
+export { workload } from './workload.js'
+export { service as serve } from './service.js'
+export { remote } from './remote.js'
+export { halt, restore } from './quiescence.js'
+export { shutdown } from './shutdown.js'

package/stage/src/manifest.js

@@ -1,12 +1,8 @@
-'use strict'
-
-const boot = require('@toa.io/boot')
+import * as boot from '@toa.io/boot'
 
 /**
  * @type {toa.stage.Manifest}
  */
-const manifest = async (path) => {
+export const manifest = async (path) => {
   return boot.manifest(path)
 }
-
-exports.manifest = manifest

package/stage/src/map.js

@@ -0,0 +1,15 @@
+import * as boot from '@toa.io/boot'
+
+/**
+ * What this process is given about the components it calls: the contract of the version each of
+ * them runs.
+ *
+ * A composition staged here is given none unless a test states one, and a component the map
+ * states nothing of is asked what it provides — which is what a run outside a deployment gets.
+ *
+ * @param {Record<string, import('@toa.io/core').Contract> | undefined} contracts
+ * @returns {void}
+ */
+export const map = (contracts) => {
+  boot.map.use(contracts)
+}

package/stage/src/quiescence.js

@@ -0,0 +1,16 @@
+import { state } from './state.js'
+
+/**
+ * Stops what everything staged does of its own accord, holding every connection open — what a
+ * process does when it is told to go quiet. A component's `stop` run command runs here.
+ */
+export const halt = async () => {
+  for (const composition of state.compositions) await composition.halt()
+  for (const workload of state.workloads) await workload.halt()
+}
+
+/** Starts it again, running the `resume` command. */
+export const restore = async () => {
+  for (const composition of state.compositions) await composition.restore()
+  for (const workload of state.workloads) await workload.restore()
+}

package/stage/src/remote.js

@@ -1,19 +1,17 @@
-'use strict'
+import * as boot from '@toa.io/boot'
+import { Locator } from '@toa.io/core'
 
-const boot = require('@toa.io/boot')
-const { Locator } = require('@toa.io/core')
-
-const { state } = require('./state')
+import { state } from './state.js'
 
 /** @type {toa.stage.Remote} */
-const remote = async (id) => {
+export const remote = async (id) => {
   const segments = id.split('.')
 
   if (segments.length === 1) segments.unshift('default')
 
   const [namespace, name] = segments
   const locator = new Locator(name, namespace)
-  const remote = await boot.remote(locator)
+  const remote = await boot.remote(locator, SOURCE)
 
   await remote.connect()
 
@@ -22,4 +20,9 @@ const remote = async (id) => {
   return remote
 }
 
-exports.remote = remote
+/**
+ * A feature suite calls components the way a service does, so it says so: without this
+ * every call it makes is attributed to an unidentified origin, and a test run leaves
+ * `unknown` on the application's map.
+ */
+const SOURCE = { service: 'features' }

package/stage/src/service.js

@@ -1,14 +1,17 @@
-'use strict'
+import { createRequire } from 'node:module'
+import { pathToFileURL } from 'node:url'
+import * as boot from '@toa.io/boot'
+import { state } from './state.js'
+import { shortcuts } from '@toa.io/norm'
 
-const boot = require('@toa.io/boot')
-const { state } = require('./state')
-const { shortcuts } = require('@toa.io/norm')
+// a shortcut resolves to a package name, which is not a path
+const require = createRequire(import.meta.url)
 
-const service = async (ref) => {
+export const service = async (ref) => {
   const path = shortcuts.resolve(ref)
-  const { Factory } = require(path)
-  const factory = new Factory(boot)
-  const service = factory.service()
+  const { Factory } = await import(pathToFileURL(require.resolve(path)).href)
+  const factory = new Factory(boot.host())
+  const service = await factory.service()
 
   await service.connect()
 
@@ -16,5 +19,3 @@ const service = async (ref) => {
 
   return service
 }
-
-exports.service = service

package/stage/src/shutdown.js

@@ -1,20 +1,28 @@
-'use strict'
+import * as boot from '@toa.io/boot'
 
-const { state } = require('./state')
-const { binding } = require('./binding')
+import { state } from './state.js'
+import { map } from './map.js'
 
 /** @type {toa.stage.Shutdown} */
-const shutdown = async () => {
+export const shutdown = async () => {
   const components = state.components.map((component) => component.disconnect())
   const compositions = state.compositions.map((composition) => composition.disconnect())
+  const workloads = state.workloads.map((workload) => workload.disconnect())
   const services = state.services.map((service) => service.disconnect())
   const remotes = state.remotes.map((remote) => remote.disconnect())
-  const disconnections = [...components, ...compositions, ...services, ...remotes]
+  const disconnections = [
+    ...components,
+    ...compositions,
+    ...workloads,
+    ...services,
+    ...remotes
+  ]
 
   await Promise.all(disconnections)
 
+  // whatever a test stated is not carried into the next one, and what it composed is gone
+  map(undefined)
+  boot.map.forget()
+
   state.reset()
-  binding.reset()
 }
-
-exports.shutdown = shutdown

package/stage/src/state.js

@@ -1,12 +1,11 @@
-'use strict'
-
-const state = {}
+export const state = {}
 
 const reset = () => {
   Object.assign(state, {
     reset,
     components: [],
     compositions: [],
+    workloads: [],
     remotes: [],
     services: []
   })
@@ -15,4 +14,3 @@ const reset = () => {
 reset()
 
 /** @type {toa.stage.State} */
-exports.state = state

package/stage/src/workload.js

@@ -0,0 +1,55 @@
+import { createRequire } from 'node:module'
+import { pathToFileURL } from 'node:url'
+import * as boot from '@toa.io/boot'
+import { Connector } from '@toa.io/core'
+import { shortcuts } from '@toa.io/norm'
+import { state } from './state.js'
+
+// a shortcut resolves to a package name, which is not a path
+const require = createRequire(import.meta.url)
+
+/** The services, made against this process rather than against no process. */
+const create = async (references, workload) => {
+  const services = []
+
+  for (const reference of references) {
+    const path = shortcuts.resolve(reference)
+    const { Factory } = await import(pathToFileURL(require.resolve(path)).href)
+    const service = await new Factory(boot.host(workload)).service()
+
+    if (service !== null) services.push(service)
+  }
+
+  return services
+}
+
+/**
+ * A process, as `toa compose` runs one: the composition behind a gate, whatever services it
+ * was told to run beside it, and whatever the extensions keep in a process — the readiness
+ * probe, the ear a halt arrives at.
+ *
+ * `composition` is the other way to boot the same components, and the difference is the point
+ * of this one: what belongs to a process is here and not there. So is what a halt takes,
+ * which is why a service that has to be halted is run from here rather than staged apart.
+ */
+export const workload = async (paths, options, services = []) => {
+  const workload = new boot.Workload(async (workload) => {
+    const composition = workload.gate(
+      async () => await boot.composition(paths, options)
+    )
+
+    if (services.length === 0) return composition
+
+    const root = new Connector()
+
+    root.depends([composition, ...(await create(services, workload))])
+
+    return root
+  })
+
+  await workload.connect()
+
+  state.workloads.push(workload)
+
+  return workload
+}

package/stage/test/boot.mock.js

@@ -1,16 +1,15 @@
-'use strict'
+import { mock } from 'node:test'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
 const connector = () => ({
-  connect: jest.fn(),
-  disconnect: jest.fn(),
-  link: jest.fn()
+  connect: mock.fn(),
+  disconnect: mock.fn(),
+  link: mock.fn()
 })
 
-const manifest = jest.fn(async () => generate())
-const component = jest.fn(async () => connector())
-const composition = jest.fn(async () => connector())
-const remote = jest.fn(async () => connector())
-
-module.exports = { manifest, component, composition, remote }
+export const map = { use: mock.fn(), forget: mock.fn() }
+export const manifest = mock.fn(async () => generate())
+export const component = mock.fn(async () => connector())
+export const composition = mock.fn(async () => connector())
+export const remote = mock.fn(async () => connector())

package/stage/test/component.test.js

@@ -1,25 +1,35 @@
-'use strict'
+import { it, mock as mocking } from 'node:test'
+import assert from 'node:assert/strict'
+import { isDeepStrictEqual } from 'node:util'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
+import * as _boot from './boot.mock.js'
 
 const mock = {
-  boot: require('./boot.mock')
+  boot: _boot
 }
 
-jest.mock('@toa.io/boot', () => mock.boot)
+mocking.module('@toa.io/boot', { namedExports: mock.boot })
 
-const stage = require('../')
+const stage = await import('../src/index.js')
 
 it('should be', () => {
-  expect(stage.component).toBeDefined()
+  assert.notStrictEqual(stage.component, undefined)
 })
 
 it('should boot component', async () => {
   const path = generate()
   const component = await stage.component(path)
 
-  expect(mock.boot.manifest.mock.calls[0][0]).toStrictEqual(path)
-  expect(mock.boot.component).toHaveBeenCalledWith(await mock.boot.manifest.mock.results[0].value)
-  expect(component).toStrictEqual(await mock.boot.component.mock.results[0].value)
-  expect(component.connect).toHaveBeenCalled()
+  assert.deepStrictEqual(mock.boot.manifest.mock.calls[0].arguments[0], path)
+  const manifest = await mock.boot.manifest.mock.calls[0].result
+
+  assert.ok(
+    mock.boot.component.mock.calls.some(
+      (call) =>
+        call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], manifest)
+    )
+  )
+  assert.deepStrictEqual(component, await mock.boot.component.mock.calls[0].result)
+  assert.ok(component.connect.mock.callCount() > 0)
 })

package/stage/test/composition.test.js

@@ -1,38 +1,29 @@
-'use strict'
+import { it, mock as mocking } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
+import * as _boot from './boot.mock.js'
 
 const mock = {
-  boot: require('./boot.mock')
+  boot: _boot
 }
 
-jest.mock('@toa.io/boot', () => mock.boot)
+mocking.module('@toa.io/boot', { namedExports: mock.boot })
 
-const stage = require('../')
+const stage = await import('../src/index.js')
 
 const paths = [generate(), generate()]
 
 it('should be', () => {
-  expect(stage.composition).toBeDefined()
+  assert.notStrictEqual(stage.composition, undefined)
 })
 
 it('should boot composition', async () => {
   await stage.composition(paths)
 
-  expect(mock.boot.composition.mock.calls[0][0]).toStrictEqual(paths)
+  assert.deepStrictEqual(mock.boot.composition.mock.calls[0].arguments[0], paths)
 
-  const composition = await mock.boot.composition.mock.results[0].value
+  const composition = await mock.boot.composition.mock.calls[0].result
 
-  expect(composition.connect).toHaveBeenCalled()
-})
-
-it('should override bindings', async () => {
-  await stage.composition(paths)
-
-  const path = require.resolve('../src/binding')
-
-  /** @type {toa.boot.composition.Options} */
-  const options = { bindings: [path] }
-
-  expect(mock.boot.composition.mock.calls[0][1]).toStrictEqual(options)
+  assert.ok(composition.connect.mock.callCount() > 0)
 })

package/stage/test/manifest.test.js

@@ -1,17 +1,20 @@
-'use strict'
+import { it, mock as mocking } from 'node:test'
+import assert from 'node:assert/strict'
+import { isDeepStrictEqual } from 'node:util'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
+import * as _boot from './boot.mock.js'
 
 const mock = {
-  boot: require('./boot.mock')
+  boot: _boot
 }
 
-jest.mock('@toa.io/boot', () => mock.boot)
+mocking.module('@toa.io/boot', { namedExports: mock.boot })
 
-const stage = require('../')
+const stage = await import('../src/index.js')
 
 it('should be', () => {
-  expect(stage.manifest).toBeDefined()
+  assert.notStrictEqual(stage.manifest, undefined)
 })
 
 it('should boot manifest', async () => {
@@ -19,6 +22,10 @@ it('should boot manifest', async () => {
 
   const manifest = await stage.manifest(path)
 
-  expect(mock.boot.manifest).toHaveBeenCalledWith(path)
-  expect(manifest).toStrictEqual(await mock.boot.manifest.mock.results[0].value)
+  assert.ok(
+    mock.boot.manifest.mock.calls.some(
+      (call) => call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], path)
+    )
+  )
+  assert.deepStrictEqual(manifest, await mock.boot.manifest.mock.calls[0].result)
 })

package/stage/test/remote.test.js

@@ -1,17 +1,19 @@
-'use strict'
+import { it, mock as mocking } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
+import * as _boot from './boot.mock.js'
 
 const mock = {
-  boot: require('./boot.mock')
+  boot: _boot
 }
 
-jest.mock('@toa.io/boot', () => mock.boot)
+mocking.module('@toa.io/boot', { namedExports: mock.boot })
 
-const stage = require('../')
+const stage = await import('../src/index.js')
 
 it('should be', () => {
-  expect(stage.remote).toBeDefined()
+  assert.notStrictEqual(stage.remote, undefined)
 })
 
 it('should connect remote', async () => {
@@ -21,12 +23,12 @@ it('should connect remote', async () => {
 
   const remote = await stage.remote(id)
 
-  expect(mock.boot.remote).toHaveBeenCalled()
-  expect(remote).toStrictEqual(await mock.boot.remote.mock.results[0].value)
-  expect(remote.connect).toHaveBeenCalled()
+  assert.ok(mock.boot.remote.mock.callCount() > 0)
+  assert.deepStrictEqual(remote, await mock.boot.remote.mock.calls[0].result)
+  assert.ok(remote.connect.mock.callCount() > 0)
 
-  const locator = mock.boot.remote.mock.calls[0][0]
+  const locator = mock.boot.remote.mock.calls[0].arguments[0]
 
-  expect(locator).toBeDefined()
-  expect(locator).toMatchObject({ name, namespace })
+  assert.notStrictEqual(locator, undefined)
+  assert.partialDeepStrictEqual(locator, { name, namespace })
 })