@toa.io/core 0.20.0-dev.9 → 0.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/core",
-  "version": "0.20.0-dev.9",
+  "version": "0.20.0",
   "description": "Toa Core",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
@@ -12,18 +12,22 @@
     "url": "https://github.com/toa-io/toa/issues"
   },
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
+  "peerDependencies": {
+    "nopeable": "*"
+  },
   "dependencies": {
     "@rsql/parser": "1.2.4",
-    "@toa.io/console": "0.20.0-dev.9",
-    "@toa.io/generic": "0.20.0-dev.9",
-    "@toa.io/yaml": "0.20.0-dev.9",
+    "@toa.io/console": "0.20.0",
+    "@toa.io/generic": "0.20.0",
+    "@toa.io/yaml": "0.20.0",
     "clone-deep": "4.0.1"
   },
-  "gitHead": "4e503ffe4fe6dfab1165e795832d3d4fba711582"
+  "gitHead": "28fc4b45c224c3683acaaf0e4abd1eb04e07b408"
 }

package/src/call.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const { Connector } = require('./connector')
+const { Nope } = require('nopeable')
+const { Readable } = require('stream')
 
 class Call extends Connector {
   #transmitter
@@ -15,19 +17,25 @@ class Call extends Connector {
     this.depends(transmitter)
   }
 
-  /**
-   * @param {toa.core.Request} request
-   */
   async invoke (request = {}) {
     this.#contract.fit(request)
 
+    // avoid validation on the recipient's side
     request.authentic = true
 
-    const { exception, ...reply } = await this.#transmitter.request(request)
+    const reply = await this.#transmitter.request(request)
 
-    if (exception) throw exception
+    if (reply === null) return null
+    else if (reply instanceof Readable) return reply
+    else {
+      if (reply.exception !== undefined)
+        throw reply.exception
 
-    return reply
+      if (reply.error !== undefined)
+        return new Nope(reply.error)
+
+      return reply.output
+    }
   }
 }
 

package/src/cascade.js

@@ -5,27 +5,31 @@ const { Connector } = require('./connector')
 
 class Cascade extends Connector {
   #bridges
+  #last
 
   constructor (bridges) {
     super()
 
     this.#bridges = bridges
+    this.#last = bridges[bridges.length - 1]
 
     this.depends(bridges)
   }
 
   async run (...args) {
-    const reply = {}
-
-    for (const bridge of this.#bridges) {
-      const partial = await bridge.execute(...args)
-
-      if (partial.error) return { error: partial.error }
-
-      merge(reply, partial)
-    }
-
-    return reply
+    // const reply = {}
+    //
+    // for (const bridge of this.#bridges) {
+    //   const partial = await bridge.execute(...args)
+    //
+    //   if (partial.error) return { error: partial.error }
+    //
+    //   merge(reply, partial)
+    // }
+    //
+    // return reply
+
+    return this.#last.execute(...args)
   }
 }
 

package/src/context.js

@@ -38,7 +38,7 @@ class Context extends Connector {
   async #remote (namespace, name) {
     const key = namespace + '.' + name
 
-    if (this.#remotes[key] === undefined) this.#remotes[key] = this.#connect(namespace, name)
+    this.#remotes[key] ??= this.#connect(namespace, name)
 
     return this.#remotes[key]
   }

package/src/contract/schemas/error.yaml

@@ -1,8 +1,9 @@
 type: object
 properties:
   code:
-    type: integer
-    minimum: 0
+    anyOf:
+      - type: integer
+      - type: string
   message:
     type: string
-required: [ code, message ]
+required: [code]

package/src/discovery.js

@@ -30,7 +30,7 @@ class Discovery extends Connector {
     const warning = () => console.warn(`Waiting for lookup response from '${id}'...`)
     const timeout = setTimeout(warning, TIMEOUT)
 
-    const { output } = await this.#lookups[id].invoke()
+    const output = await this.#lookups[id].invoke()
 
     console.debug(`Lookup response from '${id}' received`)
     clearTimeout(timeout)

package/src/observation.js

@@ -14,6 +14,11 @@ class Observation extends Operation {
     store.scope = scope
     store.state = state
   }
+
+  async run (store) {
+    if (store.scope === null) store.reply = null
+    else await super.run(store)
+  }
 }
 
 exports.Observation = Observation

package/src/operation.js

@@ -24,10 +24,6 @@ class Operation extends Connector {
     this.depends(cascade)
   }
 
-  /**
-   * @param {toa.core.Request} request
-   * @return {Promise<toa.core.Reply>}
-   */
   async invoke (request) {
     try {
       if (request.authentic !== true) this.#contracts.request.fit(request)
@@ -57,7 +53,7 @@ class Operation extends Connector {
     const { request, state } = store
     const reply = await this.#cascade.run(request.input, state) || {}
 
-    this.#contracts.reply.fit(reply)
+    // this.#contracts.reply.fit(reply)
 
     store.reply = reply
   }

package/src/state.js

@@ -28,9 +28,9 @@ class State {
   }
 
   init (id) {
-    if (this.#initialized === true && id === undefined) {
-      throw new StateInitializationException('Cannot initialize entity which is initialized. Use request.query.id to access.')
-    }
+    // if (this.#initialized === true && id === undefined) {
+    //   throw new StateInitializationException('Cannot initialize entity which is initialized. Use request.query.id to access.')
+    // }
 
     return this.#entity.init(id)
   }
@@ -41,10 +41,10 @@ class State {
     if (record === null) {
       if (this.#initialized && query.id !== undefined && query.version === undefined) return this.init(query.id)
       else if (query.version !== undefined) throw new StatePreconditionException()
-      else throw new StateNotFoundException()
     }
 
-    return this.#entity.object(record)
+    if (record === null) return null
+    else return this.#entity.object(record)
   }
 
   async objects (query) {
@@ -94,7 +94,7 @@ class State {
       else throw new StateNotFoundException()
     }
 
-    // TODO: same as above
+    // same as above
     await this.#emission.emit({ changeset, state: result })
   }
 }

package/src/transition.js

@@ -3,7 +3,7 @@
 const { retry } = require('@toa.io/generic')
 
 const { Operation } = require('./operation')
-const { StateConcurrencyException } = require('./exceptions')
+const { StateConcurrencyException, StateNotFoundException } = require('./exceptions')
 
 class Transition extends Operation {
   #concurrency
@@ -22,6 +22,9 @@ class Transition extends Operation {
     const { request } = store
 
     store.scope = request.query ? await this.query(request.query) : this.scope.init()
+
+    if (store.scope === null) throw new StateNotFoundException()
+
     store.state = store.scope.get()
   }
 
@@ -47,7 +50,6 @@ class Transition extends Operation {
   }
 }
 
-/** @type {toa.generic.retry.Options} */
 const RETRY = {
   base: 10,
   max: 5000,

package/test/call.fixtures.js

@@ -4,7 +4,8 @@ const { generate } = require('randomstring')
 
 // noinspection JSCheckFunctionSignatures
 const transmission = {
-  request: jest.fn((request) => ({ [request.invalid ? 'exception' : generate()]: generate() }))
+  request: jest.fn((request) => ({ [request.invalid ? 'exception' : 'output']: generate() })),
+  link: jest.fn()
 }
 
 const contract = {

package/test/call.test.js

@@ -1,11 +1,7 @@
 'use strict'
 
-const { Call } = require('../src/call')
 const fixtures = require('./call.fixtures')
-
-jest.mock('../src/connector')
-
-const { Connector } = require('../src/connector')
+const { Call } = require('../src/call')
 
 let call
 
@@ -16,9 +12,7 @@ beforeEach(() => {
 })
 
 it('should depend on transmission', () => {
-  expect(call).toBeInstanceOf(Connector)
-  expect(call).toBe(Connector.mock.instances[0])
-  expect(Connector.mock.instances[0].depends).toHaveBeenCalledWith(fixtures.transmission)
+  expect(fixtures.transmission.link).toHaveBeenLastCalledWith(call)
 })
 
 it('should call transmission', async () => {
@@ -42,7 +36,7 @@ it('should return reply', async () => {
 
   const reply = await call.invoke(request)
 
-  expect(reply).toStrictEqual(fixtures.transmission.request.mock.results[0].value)
+  expect(reply).toStrictEqual(fixtures.transmission.request.mock.results[0].value.output)
 })
 
 it('should throw received exceptions', async () => {

package/types/bindings.d.ts

@@ -7,29 +7,29 @@ declare namespace toa.core.bindings {
   }
 
   interface Consumer extends _core.Connector {
-    request(request: Request): Promise<_core.Reply>
+    request (request: Request): Promise<_core.Reply>
   }
 
   interface Emitter extends _core.Connector {
-    emit(message: _core.Message): Promise<void>
+    emit (message: _core.Message): Promise<void>
   }
 
-  interface Broadcast extends _core.Connector {
-    transmit(label: string, payload: object): Promise<void>
+  interface Broadcast<L> extends _core.Connector {
+    transmit<T> (label: L, payload: T): Promise<void>
 
-    receive(label: string, callback: (payload: object) => Promise<void>): Promise<void>
+    receive<T> (label: L, callback: (payload: T) => void | Promise<void>): Promise<void>
   }
 
   interface Factory {
-    producer?(locator: _core.Locator, endpoints: Array<string>, producer: _core.Component): _core.Connector
+    producer? (locator: _core.Locator, endpoints: Array<string>, producer: _core.Component): _core.Connector
 
-    consumer?(locator: _core.Locator, endpoint: string): Consumer
+    consumer? (locator: _core.Locator, endpoint: string): Consumer
 
-    emitter?(locator: _core.Locator, label: string): Emitter
+    emitter? (locator: _core.Locator, label: string): Emitter
 
-    receiver?(locator: _core.Locator, label: string, group: string, receiver: _core.Receiver): _core.Connector
+    receiver? (locator: _core.Locator, label: string, group: string, receiver: _core.Receiver): _core.Connector
 
-    broadcast?(name: string, group?: string): Broadcast
+    broadcast? (name: string, group?: string): Broadcast
   }
 
 }
@@ -37,3 +37,4 @@ declare namespace toa.core.bindings {
 export type Emitter = toa.core.bindings.Emitter
 export type Factory = toa.core.bindings.Factory
 export type Properties = toa.core.bindings.Properties
+export type Broadcast<L> = toa.core.bindings.Broadcast<L>

package/types/component.d.ts

@@ -0,0 +1,9 @@
+import { Connector } from './connector'
+import { Locator } from './locator'
+import { Request } from './request'
+
+export interface Component extends Connector {
+  locator: Locator
+
+  invoke<T> (endpoint: string, request: Request): Promise<T>
+}

package/types/connector.d.ts

@@ -1,24 +1,18 @@
-declare namespace toa.core {
+export class Connector {
+  public id: string
+  public connected: boolean
 
-  interface Connector {
-    id: string
-    connected: boolean
+  public connect (): Promise<void>
 
-    depends(connector: Connector): Connector
+  public disconnect (interrupt?: boolean): Promise<void>
 
-    link(connector: Connector): void
+  public depends (connector: Connector | Connector[]): Connector
 
-    connect(): Promise<void>
+  link (connector: Connector): void
 
-    disconnect(interrupt?: boolean): Promise<void>
+  protected open (): Promise<void> | void
 
-    open(): Promise<void>
-
-    close(): Promise<void>
-
-    dispose(): Promise<void>
-  }
+  protected close (): Promise<void> | void
 
+  protected dispose (): Promise<void> | void
 }
-
-export type Connector = toa.core.Connector

package/types/exception.d.ts

@@ -1,10 +1,4 @@
-declare namespace toa.core {
-
-  interface Exception {
-    code: number
-    message: string
-  }
-
+export interface Exception {
+  code: number
+  message: string
 }
-
-export type Exception = toa.core.Exception

package/types/extensions.d.ts

@@ -7,21 +7,21 @@ import * as _bindings from './bindings'
 declare namespace toa.core.extensions {
 
   interface Factory {
-    tenant?(locator: _core.Locator, declaration: object): _core.Connector
+    tenant? (locator: _core.Locator, manifest: object): _core.Connector
 
-    aspect?(locator: _core.Locator, declaration: object): Aspect | Aspect[]
+    aspect? (locator: _core.Locator, manifest: object | null): Aspect | Aspect[]
 
-    service?(name?: string): _core.Connector
+    service? (name?: string): _core.Connector | null
 
-    component?(component: _component.Component): _component.Component
+    component? (component: _component.Component): _component.Component
 
-    context?(context: _context.Context): _context.Context
+    context? (context: _context.Context): _context.Context
 
-    storage?(storage: _storages.Storage): _storages.Storage
+    storage? (storage: _storages.Storage): _storages.Storage
 
-    emitter?(emitter: _bindings.Emitter, label: string): _bindings.Emitter
+    emitter? (emitter: _bindings.Emitter, label: string): _bindings.Emitter
 
-    receiver?(receiver: _core.Receiver, locator: _core.Locator): _core.Receiver
+    receiver? (receiver: _core.Receiver, locator: _core.Locator): _core.Receiver
   }
 
   interface Aspect extends _core.Connector {

package/types/index.d.ts

@@ -2,6 +2,7 @@ export * as bindings from './bindings'
 export * as extensions from './extensions'
 export * as storages from './storages'
 export * as bridges from './bridges'
+export * as operations from './operations'
 
 export { Component } from './component'
 export { Connector } from './connector'
@@ -10,5 +11,4 @@ export { Exception } from './exception'
 export { Locator } from './locator'
 export { Receiver } from './receiver'
 export { Message } from './message'
-export { Reply } from './reply'
-export { Request, Query } from './request'
+export { Request, Query, Reply } from './request'

package/types/locator.d.ts

@@ -1,16 +1,12 @@
-declare namespace toa.core {
+export class Locator {
+  public readonly name: string
+  public readonly namespace: string
 
-    interface Locator {
-        name: string
-        namespace: string
+  public readonly id: string
+  public readonly label: string
+  public readonly uppercase: string
 
-        id: string
-        label: string
-        uppercase: string
-
-        hostname(type?: string): string
-    }
+  constructor (name: string, namespace?: string)
 
+  hostname (type?: string): string
 }
-
-export type Locator = toa.core.Locator

package/types/message.d.ts

@@ -1,9 +1,3 @@
-declare namespace toa.core {
-
-  type Message = {
-    payload: Object
-  }
-
+export interface Message<T = any> {
+  payload: T
 }
-
-export type Message = toa.core.Message

package/types/operations.d.ts

@@ -0,0 +1,2 @@
+export type type = 'transition' | 'observation' | 'assignment' | 'computation' | 'effect'
+export type scope = 'object' | 'objects' | 'changeset'

package/types/request.d.ts

@@ -1,26 +1,23 @@
-declare namespace toa.core {
+import { Exception } from './exception'
 
-  namespace request {
-
-    interface Query {
-      id?: string
-      criteria?: string
-      omit?: number
-      limit?: number
-      sort?: Array<string>
-      projection?: Array<string>
-      version?: number
-    }
-
-  }
-
-  type Request = {
-    input?: any
-    query?: request.Query
-    authentic?: boolean
-  }
+export interface Query {
+  id?: string
+  criteria?: string
+  omit?: number
+  limit?: number
+  sort?: Array<string>
+  projection?: Array<string>
+  version?: number
+}
 
+export interface Request {
+  input?: any
+  query?: Query
+  authentic?: boolean
 }
 
-export type Request = toa.core.Request
-export type Query = toa.core.request.Query
+export interface Reply {
+  output?: any
+  error?: object
+  exception?: Exception
+}

package/test/cascade.fixtures.js

@@ -1,11 +0,0 @@
-'use strict'
-
-const bridges = ['a', 'b', 'c'].map((index) => ({
-  execute: jest.fn((request) => {
-    if (request?.error === index) return { error: index }
-
-    return { output: { [index]: true } }
-  })
-}))
-
-exports.bridges = bridges

package/test/cascade.test.js

@@ -1,42 +0,0 @@
-'use strict'
-
-jest.mock('../src/connector')
-
-const clone = require('clone-deep')
-
-const { Connector } = require('../src/connector')
-const { Cascade } = require('../src/cascade')
-const fixtures = require('./cascade.fixtures')
-
-let cascade
-
-beforeEach(() => {
-  jest.clearAllMocks()
-
-  cascade = new Cascade(clone(fixtures.bridges))
-})
-
-it('should depend on bridges', () => {
-  expect(cascade).toBeInstanceOf(Connector)
-  expect(Connector.mock.instances[0].depends).toHaveBeenCalledWith(fixtures.bridges)
-})
-
-it('should call bridges.execute', async () => {
-  const args = [1, 2]
-  await cascade.run(...args)
-
-  for (const bridge of fixtures.bridges) expect(bridge.execute).toHaveBeenCalledWith(...args)
-})
-
-it('should merge output', async () => {
-  const reply = await cascade.run()
-
-  expect(reply).toStrictEqual({ output: { a: true, b: true, c: true } })
-})
-
-it('should interrupt on error', async () => {
-  const reply = await cascade.run({ error: 'b' })
-
-  expect(reply).toStrictEqual({ error: 'b' })
-  expect(fixtures.bridges[2].execute).not.toHaveBeenCalled()
-})

package/types/component.ts

@@ -1,16 +0,0 @@
-import * as _connector from './connector'
-import * as _locator from './locator'
-import * as _request from './request'
-import * as _reply from './reply'
-
-declare namespace toa.core {
-
-  interface Component extends _connector.Connector {
-    locator: _locator.Locator
-
-    invoke(endpoint: string, request: _request.Request): Promise<_reply.Reply>
-  }
-
-}
-
-export type Component = toa.core.Component

package/types/reply.d.ts

@@ -1,15 +0,0 @@
-// noinspection ES6UnusedImports
-
-import { Exception } from './exception'
-
-declare namespace toa.core {
-
-    interface Reply {
-        output?: Object
-        error?: Object
-        exception?: Exception
-    }
-
-}
-
-export type Reply = toa.core.Reply