@toa.io/core 1.0.0-alpha.29 → 1.0.0-alpha.291

package/test/discovery.test.js

@@ -0,0 +1,71 @@
+import { it, beforeEach, afterEach, mock } from 'node:test'
+import assert from 'node:assert/strict'
+import { isDeepStrictEqual } from 'node:util'
+
+import { console } from 'openspan'
+import { Connector } from '../source/connector.js'
+import { Discovery } from '../source/discovery.js'
+
+class Lookup extends Connector {
+  invoke = mock.fn(async () => ({ operations: {} }))
+}
+
+/** @type {Lookup} */
+let lookup
+
+/** @type {Discovery} */
+let discovery
+
+/** @type {import('node:test').Mock<any>} */
+let warn
+
+const locator = { id: 'dummies.one' }
+
+beforeEach(async () => {
+  mock.timers.enable()
+
+  warn = mock.method(console, 'warn', () => undefined)
+  lookup = new Lookup()
+  discovery = new Discovery(async () => lookup)
+
+  await discovery.connect()
+})
+
+afterEach(() => {
+  warn.mock.restore()
+  mock.timers.reset()
+})
+
+it('should not warn if a lookup is answered', async () => {
+  await discovery.lookup(locator)
+
+  mock.timers.tick(60_000)
+
+  assert.strictEqual(warn.mock.callCount(), 0)
+})
+
+it('should keep warning while a lookup is unanswered', async () => {
+  lookup.invoke.mock.mockImplementation(() => new Promise(() => undefined))
+
+  void discovery.lookup(locator)
+
+  // the interval is set after the lookup is resolved, so it has to exist
+  // before time is advanced
+  await new Promise((resolve) => process.nextTick(resolve))
+
+  // node:test moves the clock before running the callbacks it releases, so the
+  // elapsed time each warning reports is only right when time advances by steps
+  mock.timers.tick(5_000)
+  mock.timers.tick(5_000)
+
+  assert.strictEqual(warn.mock.callCount(), 2)
+
+  assert.ok(
+    ((call) =>
+      call.arguments.length === 2 &&
+      isDeepStrictEqual(call.arguments[0], 'Waiting for lookup response') &&
+      isDeepStrictEqual(call.arguments[1], { component: locator.id, waiting: 10 }))(
+      warn.mock.calls.at(-1) ?? { arguments: [] }
+    )
+  )
+})

package/test/emission.fixtures.js

@@ -1,17 +1,13 @@
-'use strict'
+import { mock } from 'node:test'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
 // noinspection JSCheckFunctionSignatures
-const events = [0, 1, 2].map((index) => ({
-  emit: jest.fn(async (state) => ({ ...state, event: index }))
+export const events = [0, 1, 2].map((index) => ({
+  emit: mock.fn(async (state) => ({ ...state, event: index }))
 }))
 
-const event = {
+export const event = {
   origin: { [generate()]: generate() },
-  state: { [generate()]: generate() },
-  changeset: { [generate()]: generate() }
+  state: { [generate()]: generate() }
 }
-
-exports.events = events
-exports.event = event

package/test/emission.test.js

@@ -1,17 +1,26 @@
-'use strict'
+import { it, beforeEach, mock } from 'node:test'
+import assert from 'node:assert/strict'
+import { isDeepStrictEqual } from 'node:util'
 
-jest.mock('../src/connector')
+import clone from 'clone-deep'
 
-const clone = require('clone-deep')
+import { Connector } from '../source/connector.js'
 
-const { Connector } = require('../src/connector')
-const { Emission } = require('../src/emission')
-const fixtures = require('./emission.fixtures')
+// the fixtures are not connectors, so a dependency is recorded rather than linked
+const depends = mock.method(Connector.prototype, 'depends', () => undefined)
+
+const dependencies = (instance) =>
+  depends.mock.calls
+    .filter((call) => call.this === instance)
+    .map((call) => call.arguments[0])
+import { Emission } from '../source/emission.js'
+import * as fixtures from './emission.fixtures.js'
 
 let emission, event
 
 beforeEach(async () => {
-  jest.clearAllMocks()
+  resetCalls()
+  depends.mock.resetCalls()
 
   emission = new Emission(fixtures.events)
   event = clone(fixtures.event)
@@ -20,16 +29,32 @@ beforeEach(async () => {
 })
 
 it('should depend on events', () => {
-  expect(emission).toBeInstanceOf(Connector)
-  expect(Connector.mock.instances[0].depends).toHaveBeenCalledWith(fixtures.events)
+  assert.ok(emission instanceof Connector)
+  assert.ok(dependencies(emission).some((one) => isDeepStrictEqual(one, fixtures.events)))
 })
 
 it('should emit events', async () => {
-  expect.assertions(fixtures.events.length)
-
   await emission.emit(event)
 
   for (const evt of fixtures.events) {
-    expect(evt.emit).toHaveBeenCalledWith(event)
+    assert.ok(
+      evt.emit.mock.calls.some(
+        (call) =>
+          call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], event)
+      )
+    )
   }
 })
+
+function resetCalls(
+  target = [assert, clone, depends, dependencies, fixtures],
+  seen = new Set()
+) {
+  if (target === null || typeof target !== 'object' || seen.has(target)) return
+
+  seen.add(target)
+
+  for (const value of Object.values(target))
+    if (typeof value === 'function' && value.mock !== undefined) value.mock.resetCalls()
+    else resetCalls(value, seen)
+}

package/test/entities/entity.fixtures.js

@@ -1,29 +1,24 @@
-'use strict'
+import { mock } from 'node:test'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
 // noinspection JSCheckFunctionSignatures
-const schema = {
-  fit: jest.fn((object) =>
-    (object.fail ? { [generate()]: generate() } : null)),
+export const schema = {
+  fit: mock.fn((object) => (object.fail ? { [generate()]: generate() } : null)),
 
-  defaults: jest.fn(() => ({ [generate()]: generate() }))
+  defaults: mock.fn(() => ({ [generate()]: generate() }))
 }
 
-const state = () => ({
+export const state = () => ({
   id: generate(),
   foo: generate(),
-  _created: generate(),
-  _updated: generate(),
-  _deleted: generate(),
-  _version: 0
+  CREATED: generate(),
+  UPDATED: generate(),
+  DELETED: generate(),
+  VERSION: 0
 })
 
-const failed = () => ({
+export const failed = () => ({
   ...state(),
   fail: true
 })
-
-exports.schema = schema
-exports.state = state
-exports.failed = failed

package/test/entities/entity.test.js

@@ -1,52 +1,118 @@
-'use strict'
+import { describe, it, beforeEach } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { Entity } = require('../../src/entities/entity')
-const fixtures = require('./entity.fixtures')
+import { Entity } from '../../source/entities/entity.js'
+import * as fixtures from './entity.fixtures.js'
+
+const BLANK = {}
 
 beforeEach(() => {
-  jest.clearAllMocks()
+  resetCalls()
 })
 
-describe('new', () => {
-  it('should throw on schema error', () => {
-    const entity = new Entity(fixtures.schema)
+describe('argument', () => {
+  it('should set state', () => {
+    const state = fixtures.state()
+    const entity = new Entity(fixtures.schema, BLANK, state)
 
-    expect(() => entity.set(fixtures.failed())).toThrow()
+    assert.deepStrictEqual(entity.get(), state)
   })
 
-  it('should provide state', () => {
-    const entity = new Entity(fixtures.schema)
-    const state = fixtures.state()
+  it('should snapshot the record it may commit', () => {
+    const record = fixtures.state()
+    const entity = new Entity(fixtures.schema, BLANK, record)
 
-    entity.set(state)
+    assert.notStrictEqual(entity.get(), record)
+    assert.strictEqual(entity.event().origin, record)
+  })
+})
+
+describe('blank', () => {
+  it('should write what the component declares a record starts as', () => {
+    const entity = new Entity(fixtures.schema, { foo: 'declared' })
+    const state = entity.get()
+
+    assert.strictEqual(state.foo, 'declared')
+    assert.strictEqual(state.VERSION, 0)
+    assert.strictEqual(state.DELETED, null)
+    assert.strictEqual(typeof state.id, 'string')
+    assert.strictEqual(entity.event().origin, null)
+  })
+
+  it('should not validate it', () => {
+    const entity = new Entity(fixtures.schema, { fail: true })
+
+    assert.strictEqual(entity.get().fail, true)
+    assert.strictEqual(fixtures.schema.fit.mock.callCount(), 0)
+  })
+
+  it('should give every record its own copy', () => {
+    const blank = { foo: { bar: 'nested' } }
+    const one = new Entity(fixtures.schema, blank)
+    const other = new Entity(fixtures.schema, blank)
 
-    expect(entity.get()).toEqual(state)
+    assert.notStrictEqual(one.get().foo, other.get().foo)
+    assert.notStrictEqual(one.get().foo, blank.foo)
   })
 })
 
-describe('argument', () => {
-  it('should provide initial state if no argument passed', () => {
-    const entity = new Entity(fixtures.schema)
-    const defaults = fixtures.schema.defaults.mock.results[0].value
-    const expected = {
-      ...defaults,
-      _version: 0
-    }
-
-    expect(entity.get()).toStrictEqual(expect.objectContaining(expected))
+describe('read-only', () => {
+  it('should take the record as it came', () => {
+    const record = fixtures.state()
+    const entity = new Entity(fixtures.schema, BLANK, record, undefined, false)
+
+    // no pre-image to diff against, hence no copy of it
+    assert.strictEqual(entity.get(), record)
   })
 
-  it('should set state', () => {
-    const state = fixtures.state()
-    const entity = new Entity(fixtures.schema, state)
+  it('should still report a tombstone', () => {
+    const record = { ...fixtures.state(), DELETED: Date.now() }
+    const entity = new Entity(fixtures.schema, BLANK, record, undefined, false)
+
+    assert.strictEqual(entity.deleted, true)
+  })
+
+  it('should refuse to be modified', () => {
+    const entity = new Entity(fixtures.schema, BLANK, fixtures.state(), undefined, false)
+
+    assert.throws(
+      () => entity.set(entity.get()),
+      (error) => /read-only/.test(error.message)
+    )
+  })
+})
+
+describe('tombstone', () => {
+  it('should lift tombstone when transition leaves DELETED untouched', () => {
+    const origin = fixtures.state()
+    const entity = new Entity(fixtures.schema, BLANK, origin)
+    const state = entity.get()
+
+    state.foo = 'revived'
+    entity.set(state)
+
+    assert.strictEqual(entity.get().DELETED, null)
+    assert.strictEqual(entity.deleted, false)
+    assert.strictEqual(entity.event().state.DELETED, null)
+  })
 
-    expect(entity.get()).toEqual(state)
+  it('should keep tombstone written by transition', () => {
+    const origin = { ...fixtures.state(), DELETED: null }
+    const entity = new Entity(fixtures.schema, BLANK, origin)
+    const state = entity.get()
+    const timestamp = Date.now()
+
+    state.DELETED = timestamp
+    entity.set(state)
+
+    assert.strictEqual(entity.get().DELETED, timestamp)
+    assert.strictEqual(entity.deleted, true)
   })
 })
 
 it('should provide event', () => {
   const origin = fixtures.state()
-  const entity = new Entity(fixtures.schema, origin)
+  const entity = new Entity(fixtures.schema, BLANK, origin)
   const state = entity.get()
 
   state.foo = 'new value'
@@ -54,29 +120,18 @@ it('should provide event', () => {
 
   const event = entity.event()
 
-  expect(event).toEqual(expect.objectContaining({
-    state,
-    origin,
-    changeset: expect.objectContaining({
-      foo: 'new value',
-      _version: 1
-    })
-  }))
+  assert.partialDeepStrictEqual(event, { state, origin })
+  assert.strictEqual(event.state.foo, 'new value')
+  assert.strictEqual(event.state.VERSION, 1)
+  assert.notStrictEqual(event.origin.foo, 'new value')
 })
 
-it('should define `id` as readonly', async () => {
-  const origin = fixtures.state()
-  const entity = new Entity(fixtures.schema, origin)
-  const state = entity.get()
-
-  expect(() => (state.id = 1)).toThrow('assign to read only property')
-})
+function resetCalls(target = [assert, fixtures], seen = new Set()) {
+  if (target === null || typeof target !== 'object' || seen.has(target)) return
 
-it('should seal id', async () => {
-  const origin = fixtures.state()
-  const entity = new Entity(fixtures.schema, origin)
-  const state = entity.get()
-  const redefine = () => Object.defineProperty(state, 'id', { writable: true })
+  seen.add(target)
 
-  expect(redefine).toThrow('redefine property')
-})
+  for (const value of Object.values(target))
+    if (typeof value === 'function' && value.mock !== undefined) value.mock.resetCalls()
+    else resetCalls(value, seen)
+}

package/test/entities/factory.fixtures.js

@@ -1,18 +1,31 @@
-'use strict'
+import { mock } from 'node:test'
 
-const randomstring = require('randomstring')
+import randomstring from 'randomstring'
 
-const schema = { [randomstring.generate()]: randomstring.generate() }
-const storage = { id: jest.fn(() => randomstring.generate()) }
+const schemas = {
+  entity: { [randomstring.generate()]: randomstring.generate() },
+  changeset: { [randomstring.generate()]: randomstring.generate() }
+}
+
+const blank = { [randomstring.generate()]: randomstring.generate() }
+const storage = { id: mock.fn(() => randomstring.generate()) }
 const entity = { [randomstring.generate()]: randomstring.generate() }
-const set = Array.from(Array(5))
-  .map((_, index) => ({ id: index, [randomstring.generate()]: randomstring.generate() }))
+const set = Array.from(Array(5)).map((_, index) => ({
+  id: index,
+  [randomstring.generate()]: randomstring.generate()
+}))
+
+// node:test records a mock's calls but not the instances it constructed
+const entities = []
+
+const Entity = mock.fn(function () {
+  this.id = randomstring.generate()
+  entities.push(this)
+})
+
+const EntitySet = mock.fn(function () {})
 
-const Entity = jest.fn().mockImplementation(function () { this.id = randomstring.generate() })
-const EntitySet = jest.fn().mockImplementation(function () {})
+// named `mock` for its consumers, which is what node:test calls its own tracker
+const mocks = { Entity, EntitySet }
 
-exports.schema = schema
-exports.storage = storage
-exports.entity = entity
-exports.set = set
-exports.mock = { Entity, EntitySet }
+export { schemas, blank, storage, entity, set, entities, mocks as mock }

package/test/entities/factory.test.js

@@ -1,48 +1,99 @@
-'use strict'
+import { it, beforeEach, 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'
 
-const fixtures = require('./factory.fixtures')
+import * as fixtures from './factory.fixtures.js'
 const mock = fixtures.mock
 
-jest.mock('../../src/entities/entity', () => ({ Entity: mock.Entity }))
-jest.mock('../../src/entities/set', () => ({ EntitySet: mock.EntitySet }))
+mocking.module('../../source/entities/entity.js', {
+  namedExports: { Entity: mock.Entity }
+})
+mocking.module('../../source/entities/set.js', {
+  namedExports: { EntitySet: mock.EntitySet }
+})
 
-const { Factory } = require('../../src/entities/factory')
+const { Factory } = await import('../../source/entities/factory.js')
 
 let factory
 
 beforeEach(async () => {
-  jest.clearAllMocks()
+  resetCalls()
+  fixtures.entities.length = 0
 
-  factory = new Factory(fixtures.schema, () => fixtures.storage.id())
+  factory = new Factory(fixtures.schemas, fixtures.blank, () => fixtures.storage.id())
 })
 
 it('should create initial', () => {
   const id = generate()
   const initial = factory.init(id)
 
-  expect(initial).toBeInstanceOf(mock.Entity)
-  expect(initial.constructor).toHaveBeenCalledWith(fixtures.schema, id)
+  assert.ok(initial instanceof mock.Entity)
+  assert.ok(
+    mock.Entity.mock.calls.some(
+      (call) =>
+        call.arguments.length === 4 &&
+        isDeepStrictEqual(call.arguments[0], fixtures.schemas.entity) &&
+        isDeepStrictEqual(call.arguments[1], fixtures.blank) &&
+        isDeepStrictEqual(call.arguments[2], id) &&
+        typeof call.arguments[3] === 'function'
+    )
+  )
 })
 
 it('should create instance', () => {
   const object = factory.object(fixtures.entity)
 
-  expect(object).toBeInstanceOf(mock.Entity)
-  expect(object.constructor).toHaveBeenCalledWith(fixtures.schema, fixtures.entity)
+  assert.ok(object instanceof mock.Entity)
+  assert.ok(
+    mock.Entity.mock.calls.some(
+      (call) =>
+        call.arguments.length === 5 &&
+        isDeepStrictEqual(call.arguments[0], fixtures.schemas.entity) &&
+        isDeepStrictEqual(call.arguments[1], fixtures.blank) &&
+        isDeepStrictEqual(call.arguments[2], fixtures.entity) &&
+        typeof call.arguments[3] === 'function' &&
+        isDeepStrictEqual(call.arguments[4], true)
+    )
+  )
 })
 
 it('should create set', () => {
   const objects = factory.objects(fixtures.set)
 
-  expect(objects).toBeInstanceOf(mock.EntitySet)
+  assert.ok(objects instanceof mock.EntitySet)
 
   const instances = fixtures.set.map((entity, index) => {
-    expect(mock.Entity).toHaveBeenNthCalledWith(index + 1, fixtures.schema, entity)
-
-    return mock.Entity.mock.instances[index]
+    assert.ok(
+      ((call) =>
+        call.arguments.length === 5 &&
+        isDeepStrictEqual(call.arguments[0], fixtures.schemas.entity) &&
+        isDeepStrictEqual(call.arguments[1], fixtures.blank) &&
+        isDeepStrictEqual(call.arguments[2], entity) &&
+        typeof call.arguments[3] === 'function' &&
+        isDeepStrictEqual(call.arguments[4], true))(
+        mock.Entity.mock.calls[index + 1 - 1] ?? { arguments: [] }
+      )
+    )
+
+    return fixtures.entities[index]
   })
 
-  expect(objects.constructor).toHaveBeenCalledWith(instances)
+  assert.ok(
+    mock.EntitySet.mock.calls.some(
+      (call) =>
+        call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], instances)
+    )
+  )
 })
+
+function resetCalls(target = [assert, fixtures, mock], seen = new Set()) {
+  if (target === null || typeof target !== 'object' || seen.has(target)) return
+
+  seen.add(target)
+
+  for (const value of Object.values(target))
+    if (typeof value === 'function' && value.mock !== undefined) value.mock.resetCalls()
+    else resetCalls(value, seen)
+}

package/test/entities/set.fixtures.js

@@ -1,11 +1,9 @@
-'use strict'
+import { mock } from 'node:test'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
-const set = [
-  { get: jest.fn(() => ({ [generate()]: generate() })) },
-  { get: jest.fn(() => ({ [generate()]: generate() })) },
-  { get: jest.fn(() => ({ [generate()]: generate() })) }
+export const set = [
+  { get: mock.fn(() => ({ [generate()]: generate() })) },
+  { get: mock.fn(() => ({ [generate()]: generate() })) },
+  { get: mock.fn(() => ({ [generate()]: generate() })) }
 ]
-
-exports.set = set

package/test/entities/set.test.js

@@ -1,12 +1,13 @@
-'use strict'
+import { it } from 'node:test'
+import assert from 'node:assert/strict'
 
-const { EntitySet } = require('../../src/entities/set')
-const fixtures = require('./set.fixtures')
+import { EntitySet } from '../../source/entities/set.js'
+import * as fixtures from './set.fixtures.js'
 
 it('should provide state', () => {
   const set = new EntitySet(fixtures.set)
   const state = set.get()
-  const expected = fixtures.set.map((entity) => entity.get.mock.results[0].value)
+  const expected = fixtures.set.map((entity) => entity.get.mock.calls[0].result)
 
-  expect(state).toStrictEqual(expected)
+  assert.deepStrictEqual(state, expected)
 })

package/test/event.fixtures.js

@@ -1,29 +1,24 @@
-'use strict'
+import { mock } from 'node:test'
 
-const { generate } = require('randomstring')
+import { generate } from 'randomstring'
 
-const definition = {
+export const definition = {
   conditioned: true,
   subjective: true
 }
 
 // noinspection JSCheckFunctionSignatures
-const bridge = {
-  condition: jest.fn(async (origin) => !origin.falsy),
-  payload: jest.fn(async () => ({ [generate()]: generate() }))
+export const bridge = {
+  condition: mock.fn(async (origin) => !origin.falsy),
+  payload: mock.fn(async () => ({ [generate()]: generate() }))
 }
 
-const binding = {
-  emit: jest.fn()
+export const binding = {
+  emit: mock.fn()
 }
 
-const event = {
+export const event = {
   origin: { [generate()]: generate() },
   state: { [generate()]: generate() },
   changeset: { [generate()]: generate() }
 }
-
-exports.bridge = bridge
-exports.binding = binding
-exports.definition = definition
-exports.event = event