@toa.io/userland 1.0.0-alpha.28 → 1.0.0-alpha.283

package/example/stage/events.test.js

@@ -1,51 +1,98 @@
-'use strict'
+import { it, before, after } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { resolve } = require('node:path')
-const stage = require('@toa.io/userland/stage')
+import { resolve } from 'node:path'
+import * as boot from '@toa.io/boot'
+import { Connector, Locator } from '@toa.io/core'
+import { timeout } from '@toa.io/generic'
+import * as stage from '@toa.io/userland/stage'
 
-const binding = stage.binding.binding
-const root = resolve(__dirname, '../components')
+const root = resolve(import.meta.dirname, '../components')
 
 let remote
+let emitter
+let consumer
 
-beforeAll(async () => {
+before(async () => {
   process.env.TOA_DEV = '1'
+  process.env.TOA_CONFIGURATION_TEA_POTS = '{}'
+
+  // the outbox pumps on a tick; at the default five seconds a test would end before it ran
+  process.env.TOA_OUTBOX_INTERVAL = '100'
 
   const path = resolve(root, 'tea.pots')
 
   await stage.composition([path])
 
   remote = await stage.remote('tea.pots')
+
+  // what `store.orders` would emit, sent the way it would send it
+  emitter = await boot.bindings.emit(AMQP, new Locator('orders', 'store'), 'created')
+
+  await emitter.connect()
 })
 
-afterAll(async () => {
+after(async () => {
+  await consumer?.disconnect()
+  await emitter.disconnect()
   await stage.shutdown()
 
   delete process.env.TOA_DEV
+  delete process.env.TOA_CONFIGURATION_TEA_POTS
+  delete process.env.TOA_OUTBOX_INTERVAL
 })
 
 it('should receive event', async () => {
   const created = await remote.invoke('transit', { input: { material: 'glass' } })
   const id = created.id
-  const payload = { pot: id }
-  const message = { payload }
   const request = { query: { id } }
 
-  await binding.emit('store.orders.created', message)
+  await emitter.emit({ payload: { pot: id } })
+
+  // the receiver books the pot on delivery, which is asynchronous
+  const deadline = Date.now() + 5000
 
-  const reply = await remote.invoke('observe', request)
+  let reply
 
-  expect(reply.booked).toStrictEqual(true)
+  do {
+    await timeout(50)
+
+    reply = await remote.invoke('observe', request)
+  } while (reply.booked !== true && Date.now() < deadline)
+
+  assert.deepStrictEqual(reply.booked, true)
 })
 
 it('should emit event', async () => {
-  expect.assertions(1)
-
   const material = 'steel'
 
-  await binding.subscribe('tea.pots.created', (pot) => {
-    expect(pot.payload.material).toStrictEqual(material)
+  const received = new Promise((resolve) => {
+    consumer = boot.receive('tea.pots.created', new Subscriber(resolve))
   })
 
+  consumer = await consumer
+
+  await consumer.connect()
   await remote.invoke('transit', { input: { material } })
+
+  const payload = await received
+
+  assert.deepStrictEqual(payload.material, material)
 })
+
+/** What the event consumer hands deliveries to. */
+class Subscriber extends Connector {
+  #handler
+
+  constructor (handler) {
+    super()
+
+    this.#handler = handler
+  }
+
+  async receive (message) {
+    this.#handler(message.payload)
+  }
+}
+
+const AMQP = '@toa.io/bindings.amqp'

package/example/stage/invoke.test.js

@@ -1,22 +1,25 @@
-'use strict'
+import { it, before, after } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { resolve } = require('node:path')
-const stage = require('@toa.io/userland/stage')
+import { resolve } from 'node:path'
+import * as stage from '@toa.io/userland/stage'
 
-const root = resolve(__dirname, '../components')
+const root = resolve(import.meta.dirname, '../components')
 
 /** @type {toa.core.Component} */
 let component
 
-beforeAll(async () => {
+before(async () => {
   process.env.TOA_DEV = '1'
+  process.env.TOA_CONFIGURATION_DEFAULT_ECHO = '{}'
+  process.env.TOA_CONFIGURATION_TEA_POTS = '{}'
 
   const path = resolve(root, 'math.calculations')
 
   component = await stage.component(path)
 })
 
-afterAll(async () => {
+after(async () => {
   await stage.shutdown()
 
   delete process.env.TOA_DEV
@@ -28,6 +31,6 @@ it('should invoke', async () => {
 
   const reply = await component.invoke('add', { input: { a, b } })
 
-  expect(reply.exception).toBeUndefined()
-  expect(reply.output).toStrictEqual(a + b)
+  assert.strictEqual(reply.exception, undefined)
+  assert.deepStrictEqual(reply.output, a + b)
 })

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@toa.io/userland",
-  "version": "1.0.0-alpha.28",
+  "version": "1.0.0-alpha.283",
+  "type": "module",
   "description": "Toa development kit",
   "homepage": "https://toa.io",
   "author": {
@@ -16,23 +17,28 @@
     "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.28",
-    "@toa.io/core": "1.0.0-alpha.28",
-    "@toa.io/filesystem": "1.0.0-alpha.28",
-    "@toa.io/generic": "1.0.0-alpha.28",
-    "@toa.io/norm": "1.0.0-alpha.28",
-    "@toa.io/schemas": "1.0.0-alpha.28",
+    "@toa.io/boot": "1.0.0-alpha.283",
+    "@toa.io/core": "1.0.0-alpha.283",
+    "@toa.io/generic": "1.0.0-alpha.283",
+    "@toa.io/norm": "1.0.0-alpha.283",
+    "@toa.io/schemas": "1.0.0-alpha.283",
     "@toa.io/storages.null": "0.22.0",
-    "@toa.io/yaml": "1.0.0-alpha.28",
-    "tap": "16.3.4"
+    "js-yaml": "5.4.1"
   },
-  "gitHead": "89c3b7d1314e357c9e33df8d95f8d46954cd3bcf"
+  "gitHead": "2f52b023bed0ccb2ecdb2b82fe59fbe38bf282e1"
 }

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,8 @@
-'use strict'
+import { manifest } from './manifest.js'
+import { component } from './component.js'
+import { composition } from './composition.js'
+import { service } from './service.js'
+import { remote } from './remote.js'
+import { shutdown } from './shutdown.js'
 
-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, component, composition, composition as compose, service as serve, remote, shutdown }

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/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 } = await import(pathToFileURL(require.resolve(path)).href)
   const factory = new Factory(boot)
-  const service = factory.service()
+  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,10 +1,7 @@
-'use strict'
-
-const { state } = require('./state')
-const { binding } = require('./binding')
+import { state } from './state.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 services = state.services.map((service) => service.disconnect())
@@ -14,7 +11,4 @@ const shutdown = async () => {
   await Promise.all(disconnections)
 
   state.reset()
-  binding.reset()
 }
-
-exports.shutdown = shutdown

package/stage/src/state.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const state = {}
+export const state = {}
 
 const reset = () => {
   Object.assign(state, {
@@ -15,4 +13,3 @@ const reset = () => {
 reset()
 
 /** @type {toa.stage.State} */
-exports.state = state

package/stage/test/boot.mock.js

@@ -1,16 +1,14 @@
-'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 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,31 @@
-'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,6 @@ 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 })
 })