@toa.io/core 1.0.0-alpha.283 → 1.0.0-alpha.286

package/test/context.test.js

@@ -1,10 +1,10 @@
-import { describe, it, beforeEach, mock } from 'node:test'
+import { describe, it, beforeEach } from 'node:test'
 import assert from 'node:assert/strict'
 
 import * as fixtures from './context.fixtures.js'
-import { Context } from '../src/context.js'
+import { Context } from '../source/context.js'
 
-/** @type {toa.core.Context} */
+/** @type {import('@toa.io/core').Context} */
 let context
 
 beforeEach(() => {
@@ -29,7 +29,7 @@ describe('call', () => {
   })
 })
 
-function resetCalls (target = [assert, fixtures], seen = new Set()) {
+function resetCalls(target = [assert, fixtures], seen = new Set()) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/test/contract/conditions.test.js

@@ -4,7 +4,7 @@ import { isDeepStrictEqual } from 'node:util'
 
 import { generate } from 'randomstring'
 
-import { Contract } from '../../src/contract/contract.js'
+import { Contract } from '../../source/contract/contract.js'
 import * as fixtures from './contract.fixtures.js'
 
 let contract
@@ -18,7 +18,11 @@ it('should fit value', () => {
 
   contract.fit(value)
 
-  assert.ok(fixtures.schema.fit.mock.calls.some((call) => call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], value)))
+  assert.ok(
+    fixtures.schema.fit.mock.calls.some(
+      (call) => call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], value)
+    )
+  )
 })
 
 it('should throw on invalid value', () => {

package/test/contract/contract.fixtures.js

@@ -1,9 +1,8 @@
 import { mock } from 'node:test'
 
 import { generate } from 'randomstring'
-import { readFileSync } from 'node:fs'
-import { load as parseYAML } from 'js-yaml'
-import { resolve } from 'path'
+
+import { query as querySchema } from '../../source/contract/schemas.js'
 
 // noinspection JSCheckFunctionSignatures
 export const schema = {
@@ -21,7 +20,7 @@ export const schemas = {
     type: 'object',
     properties: {
       input: { type: 'null' },
-      query: parseYAML(readFileSync(resolve(import.meta.dirname, '../../src/contract/schemas/query.yaml'), 'utf8')),
+      query: querySchema,
       authentic: { type: 'boolean' }
     },
     additionalProperties: true

package/test/contract/request.test.js

@@ -6,8 +6,8 @@ import { isDeepStrictEqual } from 'node:util'
 import clone from 'clone-deep'
 import { generate } from 'randomstring'
 
-import { Request } from '../../src/contract/request.js'
-import { Contract } from '../../src/contract/contract.js'
+import { Request } from '../../source/contract/request.js'
+import { Contract } from '../../source/contract/contract.js'
 import * as fixtures from './contract.fixtures.js'
 
 // the base is real; what it was constructed with and told to fit is observable
@@ -22,7 +22,7 @@ beforeEach(() => {
   contract = new Request(fixtures.schema, {})
 })
 
-const dummy = { schema: { properties: {} } }
+const dummy = { properties: {} }
 
 it('should extend Conditions', () => {
   assert.ok(contract instanceof Contract)
@@ -34,8 +34,11 @@ it('should fit request', () => {
 
   contract.fit(request)
 
-  assert.ok(fit.mock.calls.some((call) =>
-    call.this === contract && isDeepStrictEqual(call.arguments[0], request)))
+  assert.ok(
+    fit.mock.calls.some(
+      (call) => call.this === contract && isDeepStrictEqual(call.arguments[0], request)
+    )
+  )
 })
 
 describe('schema', () => {
@@ -70,21 +73,45 @@ describe('schema', () => {
 
   it('should require query if declaration.query is true', () => {
     schema.required = ['query']
-    assert.ok(['query'].every((item) => Request.schema({ query: true }, dummy).required.some((candidate) => isDeepStrictEqual(candidate, item))))
+    assert.ok(
+      ['query'].every((item) =>
+        Request.schema({ query: true }, dummy).required.some((candidate) =>
+          isDeepStrictEqual(candidate, item)
+        )
+      )
+    )
   })
 
   it('should forbid projection for non observations', () => {
-    assert.strictEqual(Request.schema({ type: 'transition' }, dummy).properties.query.properties.projection, undefined)
-
-    assert.strictEqual(Request.schema({ type: 'assignment' }, dummy).properties.query.properties.projection, undefined)
-
-    assert.notStrictEqual(Request.schema({ type: 'observation' }, dummy).properties.query.properties.projection, undefined)
+    assert.strictEqual(
+      Request.schema({ type: 'transition' }, dummy).properties.query.properties
+        .projection,
+      undefined
+    )
+
+    assert.strictEqual(
+      Request.schema({ type: 'assignment' }, dummy).properties.query.properties
+        .projection,
+      undefined
+    )
+
+    assert.notStrictEqual(
+      Request.schema({ type: 'observation' }, dummy).properties.query.properties
+        .projection,
+      undefined
+    )
   })
 
   it('should forbid version for observations', () => {
-    assert.notStrictEqual(Request.schema({ type: 'transition' }, dummy).properties.query.properties.version, undefined)
-
-    assert.strictEqual(Request.schema({ type: 'observation' }, dummy).properties.query.properties.version, undefined)
+    assert.notStrictEqual(
+      Request.schema({ type: 'transition' }, dummy).properties.query.properties.version,
+      undefined
+    )
+
+    assert.strictEqual(
+      Request.schema({ type: 'observation' }, dummy).properties.query.properties.version,
+      undefined
+    )
   })
 
   it('should allow omit, limit only for set observations', () => {
@@ -94,18 +121,24 @@ describe('schema', () => {
     assert.strictEqual(transition.omit, undefined)
     assert.strictEqual(transition.limit, undefined)
 
-    const object = Request.schema({
-      type: 'observation',
-      scope: 'object'
-    }, dummy).properties.query.properties
+    const object = Request.schema(
+      {
+        type: 'observation',
+        scope: 'object'
+      },
+      dummy
+    ).properties.query.properties
 
     assert.strictEqual(object.omit, undefined)
     assert.strictEqual(object.limit, undefined)
 
-    const objects = Request.schema({
-      type: 'observation',
-      scope: 'objects'
-    }, dummy).properties.query.properties
+    const objects = Request.schema(
+      {
+        type: 'observation',
+        scope: 'objects'
+      },
+      dummy
+    ).properties.query.properties
 
     assert.notStrictEqual(objects.omit, undefined)
     assert.notStrictEqual(objects.limit, undefined)
@@ -113,16 +146,13 @@ describe('schema', () => {
 })
 
 describe('source', () => {
-
-
   const compile = (definition, entity) =>
-    schemas.schema(Request.schema(definition, entity), { removeAdditional: true })
+    schemas.schema(Request.schema(definition, entity))
 
-  it('should declare source', () => {
+  it('should not hold source to a schema', () => {
     const schema = Request.schema({}, dummy)
 
-    assert.notStrictEqual(schema.properties.source, undefined)
-    assert.deepStrictEqual(schema.properties.source.additionalProperties, false)
+    assert.strictEqual(schema.properties.source, undefined)
   })
 
   it('should pass known source variants', () => {
@@ -140,18 +170,22 @@ describe('source', () => {
     }
   })
 
-  // `source` crosses the wire and keys the introspection map, so whatever
-  // a peer adds to it must not survive
-  it('should strip unknown source properties', () => {
+  // whatever a peer puts beside the keys this release knows travels through: what reads
+  // `source` takes the keys it knows, and the contract does not fail a call over the rest
+  it('should pass a source a peer added to', () => {
     const schema = compile({}, undefined)
-    const request = { input: null, query: null, source: { service: 'exposition', evil: 'x' } }
+    const request = {
+      input: null,
+      query: null,
+      source: { service: 'exposition', mystery: 'x' }
+    }
 
     assert.deepStrictEqual(schema.fit(request), null)
-    assert.deepStrictEqual(request.source, { service: 'exposition' })
+    assert.deepStrictEqual(request.source, { service: 'exposition', mystery: 'x' })
   })
 })
 
-function resetCalls (target = [assert, clone, fixtures, dummy], seen = new Set()) {
+function resetCalls(target = [assert, clone, fixtures, dummy], seen = new Set()) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/test/discovery.test.js

@@ -3,8 +3,8 @@ import assert from 'node:assert/strict'
 import { isDeepStrictEqual } from 'node:util'
 
 import { console } from 'openspan'
-import { Connector } from '../src/connector.js'
-import { Discovery } from '../src/discovery.js'
+import { Connector } from '../source/connector.js'
+import { Discovery } from '../source/discovery.js'
 
 class Lookup extends Connector {
   invoke = mock.fn(async () => ({ operations: {} }))
@@ -60,5 +60,12 @@ it('should keep warning while a lookup is unanswered', async () => {
 
   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: [] }))
+  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.test.js

@@ -4,15 +4,16 @@ import { isDeepStrictEqual } from 'node:util'
 
 import clone from 'clone-deep'
 
-import { Connector } from '../src/connector.js'
+import { Connector } from '../source/connector.js'
 
 // 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 '../src/emission.js'
+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
@@ -33,15 +34,22 @@ it('should depend on events', () => {
 })
 
 it('should emit events', async () => {
-  
   await emission.emit(event)
 
   for (const evt of fixtures.events) {
-    assert.ok(evt.emit.mock.calls.some((call) => call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], 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()) {
+function resetCalls(
+  target = [assert, clone, depends, dependencies, fixtures],
+  seen = new Set()
+) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/test/entities/entity.fixtures.js

@@ -4,8 +4,7 @@ import { generate } from 'randomstring'
 
 // noinspection JSCheckFunctionSignatures
 export const schema = {
-  fit: mock.fn((object) =>
-    (object.fail ? { [generate()]: generate() } : null)),
+  fit: mock.fn((object) => (object.fail ? { [generate()]: generate() } : null)),
 
   defaults: mock.fn(() => ({ [generate()]: generate() }))
 }
@@ -13,10 +12,10 @@ export const schema = {
 export const state = () => ({
   id: generate(),
   foo: generate(),
-  _created: generate(),
-  _updated: generate(),
-  _deleted: generate(),
-  _version: 0
+  CREATED: generate(),
+  UPDATED: generate(),
+  DELETED: generate(),
+  VERSION: 0
 })
 
 export const failed = () => ({

package/test/entities/entity.test.js

@@ -1,9 +1,11 @@
-import { describe, it, beforeEach, mock } from 'node:test'
+import { describe, it, beforeEach } from 'node:test'
 import assert from 'node:assert/strict'
 
-import { Entity } from '../../src/entities/entity.js'
+import { Entity } from '../../source/entities/entity.js'
 import * as fixtures from './entity.fixtures.js'
 
+const BLANK = {}
+
 beforeEach(() => {
   resetCalls()
 })
@@ -11,74 +13,106 @@ beforeEach(() => {
 describe('argument', () => {
   it('should set state', () => {
     const state = fixtures.state()
-    const entity = new Entity(fixtures.schema, state)
+    const entity = new Entity(fixtures.schema, BLANK, state)
 
     assert.deepStrictEqual(entity.get(), state)
   })
 
   it('should snapshot the record it may commit', () => {
     const record = fixtures.state()
-    const entity = new Entity(fixtures.schema, record)
+    const entity = new Entity(fixtures.schema, BLANK, record)
 
     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)
+
+    assert.notStrictEqual(one.get().foo, other.get().foo)
+    assert.notStrictEqual(one.get().foo, blank.foo)
+  })
+})
+
 describe('read-only', () => {
   it('should take the record as it came', () => {
     const record = fixtures.state()
-    const entity = new Entity(fixtures.schema, record, undefined, false)
+    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 still report a tombstone', () => {
-    const record = { ...fixtures.state(), _deleted: Date.now() }
-    const entity = new Entity(fixtures.schema, record, undefined, false)
+    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, fixtures.state(), undefined, false)
+    const entity = new Entity(fixtures.schema, BLANK, fixtures.state(), undefined, false)
 
-    assert.throws(() => entity.set(entity.get()), (error) => /read-only/.test(error.message))
+    assert.throws(
+      () => entity.set(entity.get()),
+      (error) => /read-only/.test(error.message)
+    )
   })
 })
 
 describe('tombstone', () => {
-  it('should lift tombstone when transition leaves _deleted untouched', () => {
+  it('should lift tombstone when transition leaves DELETED untouched', () => {
     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 = 'revived'
     entity.set(state)
 
-    assert.strictEqual(entity.get()._deleted, null)
+    assert.strictEqual(entity.get().DELETED, null)
     assert.strictEqual(entity.deleted, false)
-    assert.strictEqual(entity.event().state._deleted, null)
+    assert.strictEqual(entity.event().state.DELETED, null)
   })
 
   it('should keep tombstone written by transition', () => {
-    const origin = { ...fixtures.state(), _deleted: null }
-    const entity = new Entity(fixtures.schema, origin)
+    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
+    state.DELETED = timestamp
     entity.set(state)
 
-    assert.strictEqual(entity.get()._deleted, timestamp)
+    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'
@@ -88,11 +122,11 @@ it('should provide event', () => {
 
   assert.partialDeepStrictEqual(event, { state, origin })
   assert.strictEqual(event.state.foo, 'new value')
-  assert.strictEqual(event.state._version, 1)
+  assert.strictEqual(event.state.VERSION, 1)
   assert.notStrictEqual(event.origin.foo, 'new value')
 })
 
-function resetCalls (target = [assert, fixtures], seen = new Set()) {
+function resetCalls(target = [assert, fixtures], seen = new Set()) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/test/entities/factory.fixtures.js

@@ -2,11 +2,18 @@ import { mock } from 'node:test'
 
 import randomstring from 'randomstring'
 
-const schema = { [randomstring.generate()]: 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 = []
@@ -18,13 +25,7 @@ const Entity = mock.fn(function () {
 
 const EntitySet = mock.fn(function () {})
 
-
-
-
-
-
-
 // named `mock` for its consumers, which is what node:test calls its own tracker
 const mocks = { Entity, EntitySet }
 
-export { schema, storage, entity, set, entities, mocks as mock }
+export { schemas, blank, storage, entity, set, entities, mocks as mock }

package/test/entities/factory.test.js

@@ -7,11 +7,14 @@ import { generate } from 'randomstring'
 import * as fixtures from './factory.fixtures.js'
 const mock = fixtures.mock
 
-mocking.module('../../src/entities/entity', { namedExports: ({ Entity: mock.Entity }) })
-mocking.module('../../src/entities/set', { namedExports: ({ EntitySet: mock.EntitySet }) })
-
-const { Factory } = await import('../../src/entities/factory.js')
+mocking.module('../../source/entities/entity.js', {
+  namedExports: { Entity: mock.Entity }
+})
+mocking.module('../../source/entities/set.js', {
+  namedExports: { EntitySet: mock.EntitySet }
+})
 
+const { Factory } = await import('../../source/entities/factory.js')
 
 let factory
 
@@ -19,7 +22,7 @@ beforeEach(async () => {
   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', () => {
@@ -27,14 +30,33 @@ it('should create initial', () => {
   const initial = factory.init(id)
 
   assert.ok(initial instanceof mock.Entity)
-  assert.ok(mock.Entity.mock.calls.some((call) => call.arguments.length === 3 && isDeepStrictEqual(call.arguments[0], fixtures.schema) && isDeepStrictEqual(call.arguments[1], id) && typeof call.arguments[2] === 'function'))
+  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)
 
   assert.ok(object instanceof mock.Entity)
-  assert.ok(mock.Entity.mock.calls.some((call) => call.arguments.length === 4 && isDeepStrictEqual(call.arguments[0], fixtures.schema) && isDeepStrictEqual(call.arguments[1], fixtures.entity) && typeof call.arguments[2] === 'function' && isDeepStrictEqual(call.arguments[3], true)))
+  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', () => {
@@ -43,15 +65,30 @@ it('should create set', () => {
   assert.ok(objects instanceof mock.EntitySet)
 
   const instances = fixtures.set.map((entity, index) => {
-    assert.ok(((call) => call.arguments.length === 4 && isDeepStrictEqual(call.arguments[0], fixtures.schema) && isDeepStrictEqual(call.arguments[1], entity) && typeof call.arguments[2] === 'function' && isDeepStrictEqual(call.arguments[3], true))(mock.Entity.mock.calls[index + 1 - 1] ?? { arguments: [] }))
+    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]
   })
 
-  assert.ok(mock.EntitySet.mock.calls.some((call) => call.arguments.length === 1 && isDeepStrictEqual(call.arguments[0], 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()) {
+function resetCalls(target = [assert, fixtures, mock], seen = new Set()) {
   if (target === null || typeof target !== 'object' || seen.has(target)) return
 
   seen.add(target)

package/test/entities/set.test.js

@@ -1,7 +1,7 @@
 import { it } from 'node:test'
 import assert from 'node:assert/strict'
 
-import { EntitySet } from '../../src/entities/set.js'
+import { EntitySet } from '../../source/entities/set.js'
 import * as fixtures from './set.fixtures.js'
 
 it('should provide state', () => {