@toa.io/core 1.0.0-alpha.26 → 1.0.0-alpha.262

package/src/state.js

@@ -1,73 +1,109 @@
 'use strict'
 
-const { empty } = require('@toa.io/generic')
-
-const {
-  StatePreconditionException,
-  StateNotFoundException
-} = require('./exceptions')
+const { StatePreconditionException, StateNotFoundException } = require('./exceptions')
 
 class State {
+  storage
+
   #associated
-  #storage
-  #entity
+  #entities
   #emission
 
   constructor (storage, entity, emission, associated) {
-    this.#storage = storage
-    this.#entity = entity
+    this.storage = storage
+    this.#entities = entity
     this.#emission = emission
     this.#associated = associated === true
   }
 
   init (id) {
-    return this.#entity.init(id)
+    return this.#entities.init(id)
+  }
+
+  fit (values) {
+    return this.#entities.fit(values)
   }
 
   async object (query) {
-    const record = await this.#storage.get(query)
+    const record = await this.storage.get(query)
 
     if (record === null) {
-      if (this.#associated && query.id !== undefined && query.version === undefined) {
+      if (this.#associated && query.id !== undefined && query.criteria === undefined && query.version === undefined)
         return this.init(query.id)
-      } else if (query.version !== undefined) throw new StatePreconditionException()
-    }
+      else if (query.version !== undefined)
+        throw new StatePreconditionException()
 
-    if (record === null) {
       return null
-    } else {
-      return this.#entity.object(record)
-    }
+    } else
+      return this.#entities.object(record)
   }
 
   async objects (query) {
-    const recordset = await this.#storage.find(query)
+    const recordset = await this.storage.find(query)
+    const missing = this.#associated && query.ids !== undefined && recordset.length < query.ids.length
+    const init = missing ? query.ids.filter((id) => !recordset.some((record) => record.id === id)) : undefined
+    
+    return this.#entities.objects(recordset, init)
+  }
 
-    return this.#entity.objects(recordset)
+  async stream (query) {
+    return this.storage.stream(query)
   }
 
   changeset (query) {
-    return this.#entity.changeset(query)
+    return this.#entities.changeset(query)
   }
 
   none () {
     return null
   }
 
-  async commit (state) {
-    const event = state.event()
+  async ensure (query, properties, input) {
+    const object = this.#entities.init()
+    const blank = object.get()
 
-    let ok = true
+    Object.assign(blank, properties)
 
-    if (!empty(event.changeset)) {
-      const object = state.get()
+    object.set(blank)
 
-      ok = await this.#storage.store(object)
+    const record = await this.storage.ensure(query, properties, object.get())
 
-      // #20
-      if (ok === true) {
-        await this.#emission.emit(event)
-      }
+    if (record.id !== blank.id) // exists
+      return this.#entities.object(record)
+
+    const event = object.event(input)
+
+    await this.#emission.emit(event)
+
+    return object
+  }
+
+  async commit (state, input) {
+    if (state.constructor.name === 'EntitySet') 
+      return this.massCommit(state, input)
+
+    const data = state.get()
+    const ok = await this.storage.store(data)
+
+    // #20
+    if (ok === true) {
+      const event = state.event(input)
+
+      await this.#emission.emit(event)
+    }
+
+    return ok
+  }
+
+  async massCommit (state, input) {
+    const data = state.get()
+    const ok = await this.storage.massStore(data)
+
+    // #20
+    if (ok === true) {
+      const events = state.events(input)
+
+      await Promise.all(events.map((event) => this.#emission.emit(event)))
     }
 
     return ok
@@ -76,7 +112,7 @@ class State {
   async apply (state) {
     const changeset = state.export()
 
-    const result = await this.#storage.upsert(state.query, changeset)
+    const result = await this.storage.upsert(state.query, changeset)
 
     if (result === null) {
       if (state.query.version !== undefined) {

package/src/transition.js

@@ -1,12 +1,8 @@
 'use strict'
 
 const { retry } = require('@toa.io/generic')
-
 const { Operation } = require('./operation')
-const {
-  StateConcurrencyException,
-  StateNotFoundException
-} = require('./exceptions')
+const { StateConcurrencyException, StateNotFoundException } = require('./exceptions')
 
 class Transition extends Operation {
   #concurrency
@@ -26,33 +22,26 @@ class Transition extends Operation {
 
     store.scope = request.query ? await this.query(request.query) : this.scope.init()
 
-    if (store.scope === null) {
+    if (store.scope === null || (store.scope.deleted === true && request.query?.options?.deleted !== true))
       throw new StateNotFoundException()
-    }
-
+  
     store.state = store.scope.get()
   }
 
   async commit (store) {
-    const {
-      scope,
-      state,
-      reply,
-      retry
-    } = store
+    const { scope, state, reply, retry } = store
 
     if (reply.error !== undefined) return
 
     scope.set(state)
 
-    const result = await this.scope.commit(scope)
+    const result = await this.scope.commit(scope, store.request.input)
 
     if (result === false) {
-      if (this.#concurrency === 'retry') {
+      if (this.#concurrency === 'retry')
         return retry()
-      } else {
+      else
         throw new StateConcurrencyException()
-      }
     }
   }
 
@@ -67,7 +56,7 @@ const RETRY = {
   base: 10,
   max: 5000,
   dispersion: 1,
-  retries: Infinity
+  retries: 32
 }
 
 exports.Transition = Transition

package/src/transmission.js

@@ -18,13 +18,22 @@ class Transmission extends Connector {
     let i = 0
 
     while (reply === false && i < this.#bindings.length) {
-      reply = await this.#bindings[i].request(request)
+      const binding = this.#bindings[i]
+
       i++
+
+      if (request?.task === true) {
+        if (binding.task === undefined)
+          continue
+
+        await binding.task(request)
+        reply = null
+      } else
+        reply = await binding.request(request)
     }
 
-    if (reply === false) {
+    if (reply === false)
       throw new TransmissionException(`All (${this.#bindings.length}) bindings rejected.`)
-    }
 
     return reply
   }

package/src/unmanaged.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const { Operation } = require('./operation')
+
+class Unmanaged extends Operation {
+  acquire (context) {
+    context.state = this.scope.storage.raw
+  }
+}
+
+exports.Unmanaged = Unmanaged

package/test/component.test.js

@@ -3,6 +3,7 @@
 const { Component } = require('../src/component')
 const { codes } = require('../src/exceptions')
 const fixtures = require('./component.fixtures')
+const { AssertionError } = require('node:assert')
 
 describe('Invocations', () => {
   const name = ['foo', 'bar'][Math.floor(2 * Math.random())]
@@ -16,12 +17,12 @@ describe('Invocations', () => {
   it('should invoke', async () => {
     await component.invoke(name)
 
-    expect(invocation.invoke).toBeCalled()
+    expect(invocation.invoke).toHaveBeenCalled()
   })
 
   it('should throw on unknown invocation name', async () => {
     await expect(() => component.invoke('baz'))
-      .rejects.toMatchObject({ code: codes.NotImplemented })
+      .rejects.toThrow(AssertionError)
   })
 
   it('should invoke input and query', async () => {
@@ -29,7 +30,7 @@ describe('Invocations', () => {
     const query = { test: Math.random() }
     await component.invoke(name, { input, query })
 
-    expect(invocation.invoke).toBeCalledWith({ input, query })
+    expect(invocation.invoke).toHaveBeenCalledWith({ input, query })
   })
 
   it('should return io', async () => {

package/test/connector.fixtures.js

@@ -36,5 +36,13 @@ class FailingConnector extends Connector {
   }
 }
 
+/** Stands for a connector waiting for something that never arrives. */
+class StuckConnector extends Connector {
+  async open () {
+    return new Promise(() => undefined)
+  }
+}
+
 exports.TestConnector = TestConnector
 exports.FailingConnector = FailingConnector
+exports.StuckConnector = StuckConnector

package/test/connector.test.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { timeout } = require('@toa.io/generic')
+
 const fixtures = require('./connector.fixtures')
 
 let sequence
@@ -105,6 +107,7 @@ describe('dependencies', () => {
     a.depends(b).depends(c)
     b.depends(d)
 
+    await a.connect()
     await a.disconnect()
 
     expect(sequence.indexOf('-a')).toBeLessThan(sequence.indexOf('-b'))
@@ -146,6 +149,23 @@ describe('dependencies', () => {
     expect(() => a.depends({})).toThrow()
   })
 
+  it('should disconnect while still connecting', async () => {
+    const stuck = new fixtures.StuckConnector()
+
+    a.depends(stuck).depends(b)
+
+    void a.connect()
+
+    while (b.connected !== true) await timeout(1)
+
+    // `a` never connects, and disconnecting must not wait for it to
+    expect(a.connected).toStrictEqual(false)
+
+    await a.disconnect()
+
+    expect(sequence).toEqual(['+b', '-b', '*b', '*a'])
+  })
+
   describe('errors', () => {
     let f
 

package/test/contract/conditions.test.js

@@ -2,19 +2,19 @@
 
 const { generate } = require('randomstring')
 
-const { Conditions } = require('../../src/contract/conditions')
+const { Contract } = require('../../src/contract/contract')
 const fixtures = require('./contract.fixtures')
 
-let conditions
+let contract
 
 beforeEach(() => {
-  conditions = new Conditions(fixtures.schema)
+  contract = new Contract(fixtures.schema)
 })
 
 it('should fit value', () => {
   const value = { foo: generate() }
 
-  conditions.fit(value)
+  contract.fit(value)
 
   expect(fixtures.schema.fit).toHaveBeenCalledWith(value)
 })
@@ -22,5 +22,5 @@ it('should fit value', () => {
 it('should throw on invalid value', () => {
   const value = { invalid: true }
 
-  expect(() => conditions.fit(value)).toThrow()
+  expect(() => contract.fit(value)).toThrow()
 })

package/test/contract/request.test.js

@@ -3,10 +3,10 @@
 const clone = require('clone-deep')
 const { generate } = require('randomstring')
 
-jest.mock('../../src/contract/conditions')
+jest.mock('../../src/contract/contract')
 
 const { Request } = require('../../src/contract/request')
-const { Conditions } = require('../../src/contract/conditions')
+const { Contract } = require('../../src/contract/contract')
 const fixtures = require('./contract.fixtures')
 
 let contract
@@ -14,14 +14,14 @@ let contract
 beforeEach(() => {
   jest.clearAllMocks()
 
-  contract = new Request(fixtures.schema)
+  contract = new Request(fixtures.schema, {})
 })
 
 const dummy = { schema: { properties: {} } }
 
 it('should extend Conditions', () => {
-  expect(contract).toBeInstanceOf(Conditions)
-  expect(Conditions).toHaveBeenCalledWith(fixtures.schema)
+  expect(contract).toBeInstanceOf(Contract)
+  expect(Contract).toHaveBeenCalledWith(fixtures.schema)
 })
 
 it('should fit request', () => {
@@ -29,7 +29,7 @@ it('should fit request', () => {
 
   contract.fit(request)
 
-  expect(Conditions.mock.instances[0].fit).toHaveBeenCalledWith(request)
+  expect(Contract.mock.instances[0].fit).toHaveBeenCalledWith(request)
 })
 
 describe('schema', () => {
@@ -59,7 +59,7 @@ describe('schema', () => {
 
   it('should not contain query if declaration.query is false', () => {
     schema.properties.query = { type: 'null' }
-    expect(Request.schema({ query: false }, dummy)).toStrictEqual(schema)
+    expect(Request.schema({ query: false }, dummy)).toMatchObject(schema)
   })
 
   it('should require query if declaration.query is true', () => {
@@ -110,3 +110,42 @@ describe('schema', () => {
     expect(objects.limit).toBeDefined()
   })
 })
+
+describe('source', () => {
+  const schemas = require('@toa.io/schemas')
+
+  const compile = (definition, entity) =>
+    schemas.schema(Request.schema(definition, entity), { removeAdditional: true })
+
+  it('should declare source', () => {
+    const schema = Request.schema({}, dummy)
+
+    expect(schema.properties.source).toBeDefined()
+    expect(schema.properties.source.additionalProperties).toStrictEqual(false)
+  })
+
+  it('should pass known source variants', () => {
+    const schema = compile({}, undefined)
+
+    for (const source of [
+      { namespace: 'a', component: 'b', operation: 'c' },
+      { namespace: 'a', component: 'b', event: 'c' },
+      { service: 'exposition' }
+    ]) {
+      const request = { input: null, query: null, source }
+
+      expect(schema.fit(request)).toStrictEqual(null)
+      expect(request.source).toStrictEqual(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', () => {
+    const schema = compile({}, undefined)
+    const request = { input: null, query: null, source: { service: 'exposition', evil: 'x' } }
+
+    expect(schema.fit(request)).toStrictEqual(null)
+    expect(request.source).toStrictEqual({ service: 'exposition' })
+  })
+})

package/test/discovery.test.js

@@ -0,0 +1,56 @@
+'use strict'
+
+const { console } = require('openspan')
+const { Connector } = require('../src/connector')
+const { Discovery } = require('../src/discovery')
+
+class Lookup extends Connector {
+  invoke = jest.fn(async () => ({ operations: {} }))
+}
+
+/** @type {Lookup} */
+let lookup
+
+/** @type {Discovery} */
+let discovery
+
+/** @type {jest.SpyInstance} */
+let warn
+
+const locator = { id: 'dummies.one' }
+
+beforeEach(async () => {
+  jest.useFakeTimers()
+
+  warn = jest.spyOn(console, 'warn').mockImplementation(() => undefined)
+  lookup = new Lookup()
+  discovery = new Discovery(async () => lookup)
+
+  await discovery.connect()
+})
+
+afterEach(() => {
+  warn.mockRestore()
+  jest.useRealTimers()
+})
+
+it('should not warn if a lookup is answered', async () => {
+  await discovery.lookup(locator)
+
+  jest.advanceTimersByTime(60_000)
+
+  expect(warn).not.toHaveBeenCalled()
+})
+
+it('should keep warning while a lookup is unanswered', async () => {
+  lookup.invoke.mockImplementation(() => new Promise(() => undefined))
+
+  void discovery.lookup(locator)
+
+  await jest.advanceTimersByTimeAsync(12_000)
+
+  expect(warn).toHaveBeenCalledTimes(2)
+
+  expect(warn).toHaveBeenLastCalledWith('Waiting for lookup response',
+    { component: locator.id, waiting: 10 })
+})

package/test/entities/entity.test.js

@@ -7,40 +7,40 @@ beforeEach(() => {
   jest.clearAllMocks()
 })
 
-describe('new', () => {
-  it('should throw on schema error', () => {
-    const entity = new Entity(fixtures.schema)
-
-    expect(() => entity.set(fixtures.failed())).toThrow()
-  })
-
-  it('should provide state', () => {
-    const entity = new Entity(fixtures.schema)
+describe('argument', () => {
+  it('should set state', () => {
     const state = fixtures.state()
-
-    entity.set(state)
+    const entity = new Entity(fixtures.schema, state)
 
     expect(entity.get()).toEqual(state)
   })
 })
 
-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
-    }
+describe('tombstone', () => {
+  it('should lift tombstone when transition leaves _deleted untouched', () => {
+    const origin = fixtures.state()
+    const entity = new Entity(fixtures.schema, origin)
+    const state = entity.get()
+
+    state.foo = 'revived'
+    entity.set(state)
 
-    expect(entity.get()).toStrictEqual(expect.objectContaining(expected))
+    expect(entity.get()._deleted).toBeNull()
+    expect(entity.deleted).toBe(false)
+    expect(entity.event().changeset._deleted).toBeNull()
   })
 
-  it('should set state', () => {
-    const state = fixtures.state()
-    const entity = new Entity(fixtures.schema, state)
+  it('should keep tombstone written by transition', () => {
+    const origin = { ...fixtures.state(), _deleted: null }
+    const entity = new Entity(fixtures.schema, origin)
+    const state = entity.get()
+    const timestamp = Date.now()
 
-    expect(entity.get()).toEqual(state)
+    state._deleted = timestamp
+    entity.set(state)
+
+    expect(entity.get()._deleted).toBe(timestamp)
+    expect(entity.deleted).toBe(true)
   })
 })
 
@@ -63,20 +63,3 @@ it('should provide event', () => {
     })
   }))
 })
-
-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')
-})
-
-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 })
-
-  expect(redefine).toThrow('redefine property')
-})

package/test/entities/factory.test.js

@@ -23,14 +23,14 @@ it('should create initial', () => {
   const initial = factory.init(id)
 
   expect(initial).toBeInstanceOf(mock.Entity)
-  expect(initial.constructor).toHaveBeenCalledWith(fixtures.schema, id)
+  expect(initial.constructor).toHaveBeenCalledWith(fixtures.schema, id, expect.any(Function))
 })
 
 it('should create instance', () => {
   const object = factory.object(fixtures.entity)
 
   expect(object).toBeInstanceOf(mock.Entity)
-  expect(object.constructor).toHaveBeenCalledWith(fixtures.schema, fixtures.entity)
+  expect(object.constructor).toHaveBeenCalledWith(fixtures.schema, fixtures.entity, expect.any(Function))
 })
 
 it('should create set', () => {
@@ -39,7 +39,7 @@ it('should create set', () => {
   expect(objects).toBeInstanceOf(mock.EntitySet)
 
   const instances = fixtures.set.map((entity, index) => {
-    expect(mock.Entity).toHaveBeenNthCalledWith(index + 1, fixtures.schema, entity)
+    expect(mock.Entity).toHaveBeenNthCalledWith(index + 1, fixtures.schema, entity, expect.any(Function))
 
     return mock.Entity.mock.instances[index]
   })

package/test/event.test.js

@@ -41,7 +41,7 @@ describe('condition', () => {
       await emit()
 
       const payload = await fixtures.bridge.payload.mock.results[0].value
-      const message = { payload }
+      const message = { payload, telemetry: expect.any(String) }
       expect(fixtures.binding.emit).toHaveBeenCalledWith(message)
     })
 
@@ -71,7 +71,7 @@ describe('condition', () => {
       expect(fixtures.bridge.condition).not.toHaveBeenCalledWith()
 
       const payload = await fixtures.bridge.payload.mock.results[0].value
-      const message = { payload }
+      const message = { payload, telemetry: expect.any(String) }
 
       expect(fixtures.binding.emit).toHaveBeenCalledWith(message)
     })
@@ -84,7 +84,7 @@ describe('payload', () => {
       await emit()
 
       const payload = await fixtures.bridge.payload.mock.results[0].value
-      const message = { payload }
+      const message = { payload, telemetry: expect.any(String) }
 
       expect(fixtures.binding.emit).toHaveBeenCalledWith(message)
     })
@@ -110,7 +110,7 @@ describe('payload', () => {
       await emit()
 
       const payload = fixtures.event.state
-      const message = { payload }
+      const message = { payload, telemetry: expect.any(String) }
 
       expect(fixtures.binding.emit).toHaveBeenCalledWith(message)
     })

package/test/receiver.fixtures.js

@@ -9,6 +9,7 @@ const definition = /** @type {toa.norm.component.Receiver} */ {
 }
 
 const local = /** @type {toa.core.Component} */ {
+  locator: { id: 'default.dummy' },
   invoke: jest.fn()
 }