@toa.io/bridges.node 0.20.0-dev.8 → 0.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/bridges.node",
-  "version": "0.20.0-dev.8",
+  "version": "0.20.0",
   "description": "Toa Node Bridge (inproc)",
   "homepage": "https://toa.io",
   "author": {
@@ -25,14 +25,17 @@
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
+  "peerDependencies": {
+    "nopeable": "*"
+  },
   "dependencies": {
-    "@toa.io/core": "0.20.0-dev.8",
-    "@toa.io/filesystem": "0.20.0-dev.8",
-    "@toa.io/generic": "0.20.0-dev.8",
+    "@toa.io/core": "0.20.0",
+    "@toa.io/filesystem": "0.20.0",
+    "@toa.io/generic": "0.20.0",
     "fast-glob": "3.2.7"
   },
   "devDependencies": {
     "clone-deep": "4.0.1"
   },
-  "gitHead": "d8c08ec7def70ad93de06541af497cce8c4c1b50"
+  "gitHead": "28fc4b45c224c3683acaaf0e4abd1eb04e07b408"
 }

package/readme.md

@@ -17,7 +17,7 @@ Factory. Module file name without extension is an operation name (endpoint).
 function transition (input, object, context) {
   // ...
 
-  return { output: { foo: 'bar' } }
+  return { foo: 'bar' }
 }
 
 exports.transition = transition
@@ -48,15 +48,15 @@ See [Operation properties](#).
 
 class Transition {
   #context
-  
-  async mount(context) {
+
+  async mount (context) {
     this.#context = context
   }
-  
+
   execute (input, object) {
     // ...
 
-    return { output: { foo: 'bar' } }
+    return { foo: 'bar' }
   }
 }
 
@@ -87,20 +87,6 @@ implement [Algorithm Factory interface](#).
 > Factory class name examples: `ObjectTransitionFactory`, `ObjectsObservationFactory`,
 > `ChangesetAssignmentFactory`.
 
-### Return value
-
-Algorithm's return value must match [UCP Response](#), that is, to be an object with either `output`
-or `error` properties. If return value is a primitive or an object without neither `output`
-nor `error` properties, then it is considered as the value of `output`.
-
-Next two return values are equivalent.
-
-```javascript
-return { ok: 1 }
-
-return { output: { ok: 1 } } 
-```
-
 ### Storing Context
 
 > Algorithm definition should store reference to the `context` object without copying its value

package/src/algorithms/class.js

@@ -1,6 +1,3 @@
 'use strict'
 
-/** @type {toa.node.define.algorithms.Constructor} */
-const create = (Class) => new Class()
-
-exports.create = create
+exports.create = (Class) => new Class()

package/src/algorithms/factory.js

@@ -1,6 +1,5 @@
 'use strict'
 
-/** @type {toa.node.define.algorithms.Constructor} */
 const create = (Factory) => {
   const factory = new Factory()
 

package/src/algorithms/runner.js

@@ -1,10 +1,9 @@
 'use strict'
 
+const { Nope } = require('nopeable')
 const { Connector } = require('@toa.io/core')
+const { Readable } = require('node:stream')
 
-/**
- * @implements {toa.core.bridges.Algorithm}
- */
 class Runner extends Connector {
   /** @type {toa.node.Algorithm} */
   #algorithm
@@ -12,10 +11,6 @@ class Runner extends Connector {
   /** @type {toa.node.Context} */
   #context
 
-  /**
-   * @param {toa.node.Algorithm} algorithm
-   * @param {toa.node.Context} context
-   */
   constructor (algorithm, context) {
     super()
 
@@ -30,23 +25,21 @@ class Runner extends Connector {
   }
 
   async execute (input, state) {
-    let reply = await this.#algorithm.execute(input, state)
+    const reply = await this.#algorithm.execute(input, state)
 
-    if (reply !== undefined) reply = normalize(reply)
-    else reply = {}
-
-    return reply
+    if (reply instanceof Nope) return { error: reply }
+    else if (isGenerator(reply)) return Readable.from(reply)
+    else if (reply instanceof Readable) return reply
+    else return { output: reply }
   }
 }
 
-function normalize (reply) {
-  const object = typeof reply === 'object'
-  const output = object && reply.output !== undefined
-  const error = object && reply.error !== undefined
-
-  if (!output && !error) reply = { output: reply }
+function isGenerator (object) {
+  const constructor = object?.constructor?.[Symbol.toStringTag]
 
-  return reply
+  return constructor !== undefined &&
+    (constructor === 'AsyncGeneratorFunction' ||
+      constructor === 'GeneratorFunction')
 }
 
 exports.Runner = Runner

package/src/define/.operations/define.js

@@ -10,6 +10,9 @@ const syntaxes = require('./syntaxes')
 const define = (module) => {
   const descriptor = extract(module)
 
+  if (descriptor === null)
+    return null
+
   return syntaxes[descriptor.syntax].define(descriptor)
 }
 

package/src/define/.operations/extract.js

@@ -8,7 +8,12 @@ const syntaxes = require('./syntaxes')
  * @returns {toa.node.define.algorithms.Descriptor}
  */
 const extract = (module) => {
-  const [name, func] = find(module)
+  const entry = find(module)
+
+  if (entry === null)
+    return null
+
+  const [name, func] = entry
   const statement = parse(func)
 
   /** @type {toa.node.define.algorithms.Descriptor} */
@@ -32,7 +37,7 @@ const find = (module) => {
     if (typeof value === 'function') return [key, value]
   }
 
-  throw new Error('Module does not export function')
+  return null
 }
 
 /**

package/src/define/.operations/syntaxes/function.js

@@ -10,7 +10,7 @@ const define = (descriptor) => {
   /** @type {toa.node.define.operations.Definition} */
   const definition = {}
 
-  definition.type = /** @type {typeof toa.norm.component.Operation.type} */ name
+  definition.type = name
 
   if (node.params.length > 1) definition.scope = scope(node.params[1].name)
   if (node.params.length === 0) definition.input = null
@@ -29,7 +29,7 @@ const test = (statement, type) => {
 
 /**
  * @param {string} name
- * @returns {typeof toa.norm.component.Operation.scope}
+ * @returns {string}
  */
 const scope = (name) => scopes.includes(name) ? name : undefined
 

package/src/define/operations.js

@@ -10,7 +10,11 @@ const operations = async (root) => {
   /** @type {toa.node.define.algorithms.List} */
   const algorithms = {}
 
-  for (const [name, module] of modules) algorithms[name] = algorithm.define(module)
+  for (const [name, module] of modules) {
+    const definition = algorithm.define(module)
+
+    if (definition !== null) algorithms[name] = definition
+  }
 
   return algorithms
 }

package/src/event.js

@@ -7,15 +7,19 @@ const { Connector } = require('@toa.io/core')
  */
 class Event extends Connector {
   #event
+  #context
 
-  constructor (event) {
+  constructor (event, context) {
     super()
 
     this.#event = event
+    this.#context = context
+
+    this.depends(context)
   }
 
-  condition = async (...args) => this.#event.condition(...args)
-  payload = async (...args) => this.#event.payload(...args)
+  condition = async (...args) => this.#event.condition(...args, this.#context)
+  payload = async (...args) => this.#event.payload(...args, this.#context)
 }
 
 exports.Event = Event

package/src/factory.js

@@ -7,9 +7,6 @@ const { Receiver } = require('./receiver')
 const { Context } = require('./context')
 const { extract } = require('./define/operations')
 
-/**
- * @implements {toa.core.bridges.Factory}
- */
 class Factory {
   algorithm (root, name, context) {
     const module = load.operation(root, name)
@@ -18,10 +15,11 @@ class Factory {
     return runner(module, ctx)
   }
 
-  event (root, label) {
+  event (root, label, context) {
     const event = load.event(root, label)
+    const ctx = new Context(context)
 
-    return new Event(event)
+    return new Event(event, ctx)
   }
 
   receiver (root, label) {

package/src/shortcuts/amqp.test.js

@@ -26,7 +26,7 @@ it('should define shortcut', async () => {
 })
 
 it('should call invoke', async () => {
-  const args = Array.from({ length: random(5) + 2 }, generate)
+  const args = Array.from({ length: random(5) + 2 }, () => generate())
 
   await context.amqp.test.emit(...args)
 

package/src/shortcuts/index.js

@@ -4,8 +4,10 @@ const { http } = require('./http')
 const { amqp } = require('./amqp')
 const { configuration } = require('./configuration')
 const { state } = require('./state')
+const { stash } = require('./stash')
 
 exports.http = http
 exports.amqp = amqp
 exports.configuration = configuration
 exports.state = state
+exports.stash = stash

package/src/shortcuts/stash.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const { underlay } = require('@toa.io/generic')
+
+/** @type {toa.node.shortcut} */
+const stash = (context, aspect) => {
+  context.stash = underlay(async (segs, args) => {
+    if (segs.length !== 1) throw new Error(`Stash aspect call should have 1 segment, [${segs.join(', ')}] given`)
+
+    const method = segs[0]
+
+    return aspect.invoke(method, ...args)
+  })
+}
+
+exports.stash = stash

package/test/algorithms.runner.test.js

@@ -42,18 +42,6 @@ it('should return output', async () => {
   }
 })
 
-it('should not return undefined output', async () => {
-  const execute = () => undefined
-  const algorithm = /** @type {toa.node.Algorithm} */ { execute }
-  const runner = new Runner(algorithm, context)
-
-  await runner.connect()
-
-  const reply = await runner.execute()
-
-  expect(reply).not.toStrictEqual(undefined)
-})
-
 it('should mount', async () => {
   const execute = () => undefined
   const mount = jest.fn(() => undefined)

package/test/define.operations.define.test.js

@@ -26,11 +26,11 @@ it('should throw if class does not match conventions', () => {
   expect(() => define(module)).toThrow('does not match conventions')
 })
 
-it('should throw if no function exported', () => {
+it('should return null if no function exported', () => {
   const foo = 'bar'
   const module = { foo }
 
-  expect(() => define(module)).toThrow('Module does not export function')
+  expect(define(module)).toBeNull()
 })
 
 describe('function', () => {

package/test/dummies/compute/operations/cls.js

@@ -11,7 +11,7 @@ class Computation {
   }
 
   async execute (input) {
-    return { output: { input, context: this.#context !== undefined } }
+    return { input, context: this.#context !== undefined }
   }
 }
 

package/test/dummies/compute/operations/fn.js

@@ -1,7 +1,7 @@
 'use strict'
 
 async function computation (input, object, context) {
-  return { output: { input, state: object, context: context !== undefined } }
+  return { input, state: object, context: context !== undefined }
 }
 
 exports.computation = computation

package/test/dummies/one/operations/cls.js

@@ -11,7 +11,7 @@ class Transition {
   }
 
   async execute (input, object) {
-    return { output: { input, state: object, context: this.#context !== undefined } }
+    return { input, state: object, context: this.#context !== undefined }
   }
 }
 

package/test/dummies/one/operations/fn.js

@@ -1,7 +1,7 @@
 'use strict'
 
 async function transition (input, object, context) {
-  return { output: { input, state: object, context: context !== undefined } }
+  return { input, state: object, context: context !== undefined }
 }
 
 exports.transition = transition

package/types/algorithms.d.ts

@@ -1,6 +1,6 @@
 import { bridges } from '@toa.io/core/types'
 import * as _context from './context'
-import * as _core from '@toa.io/core/types';
+import * as _core from '@toa.io/core/types'
 
 declare namespace toa.node {
 
@@ -16,11 +16,11 @@ declare namespace toa.node {
   }
 
   interface Algorithm {
-    mount?(context: _context.Context): Promise<void> | void
+    mount? (context: _context.Context): Promise<void> | void
 
-    execute(input: any, scope: object | object[]): Promise<_core.Reply>
+    execute (input: any, scope: object | object[]): Promise<any>
 
-    execute(input: any): Promise<_core.Reply>
+    execute (input: any): Promise<_core.Reply>
   }
 
 }