@toa.io/bridges.node 1.0.0-alpha.6 → 1.0.0-alpha.63

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/bridges.node",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0-alpha.63",
   "description": "Toa Node Bridge (inproc)",
   "homepage": "https://toa.io",
   "author": {
@@ -16,7 +16,7 @@
     "url": "https://github.com/toa-io/toa/issues"
   },
   "engines": {
-    "node": ">= 18.0.0"
+    "node": ">= 20.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -26,14 +26,15 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/core": "1.0.0-alpha.6",
-    "@toa.io/filesystem": "1.0.0-alpha.6",
-    "@toa.io/generic": "1.0.0-alpha.6",
+    "@babel/parser": "7.24.7",
+    "@toa.io/core": "1.0.0-alpha.63",
+    "@toa.io/filesystem": "1.0.0-alpha.63",
+    "@toa.io/generic": "1.0.0-alpha.63",
     "fast-glob": "3.2.7",
     "matchacho": "0.3.5"
   },
   "devDependencies": {
     "clone-deep": "4.0.1"
   },
-  "gitHead": "f28d629a9477646e267a8af8479cc1bb10d62c80"
+  "gitHead": "9acf69d3135ea69bb9080c4f2f654d119f7b8a82"
 }

package/readme.md

@@ -72,7 +72,7 @@ it defines operation's `scope`.
 
 ```javascript
 class ObjectTransitionFactory {
-  create () {
+  async create () {
     // ...
   }
 }

package/src/algorithms/runner.js

@@ -24,6 +24,10 @@ class Runner extends Connector {
     await this.#algorithm.mount?.(this.#context)
   }
 
+  async close () {
+    await this.#algorithm.unmount?.()
+  }
+
   async execute (input, state) {
     const reply = await this.#algorithm.execute(input, state)
 

package/src/context.js

@@ -5,29 +5,23 @@ const { underlay } = require('@toa.io/generic')
 
 const shortcuts = require('./shortcuts')
 
-/**
- * @implements {toa.node.Context}
- */
 class Context extends Connector {
+  operation
   aspects
-  configuration
-  origins
 
   #context
 
-  /**
-   * @param {toa.core.Context} context
-   */
-  constructor (context) {
+  constructor (context, operation) {
     super()
 
+    this.operation = operation
     this.#context = context
 
     this.depends(context)
   }
 
   async open () {
-    this.aspects = this.#aspects(/** @type {toa.core.extensions.Aspect[]} */ this.#context.aspects)
+    this.aspects = this.#aspects(this.#context.aspects)
   }
 
   local = underlay(async ([endpoint], [request]) => {
@@ -42,10 +36,6 @@ class Context extends Connector {
     return this.#context.call(namespace, name, endpoint, request)
   })
 
-  /**
-   * @param {toa.core.extensions.Aspect[]} aspects
-   * @returns {{ [key: string]: Function}}
-   */
   #aspects (aspects) {
     const map = {}
 
@@ -54,7 +44,8 @@ class Context extends Connector {
 
       map[aspect.name] = aspect.invoke.bind(aspect)
 
-      if (aspect.name in shortcuts) shortcuts[aspect.name](this, aspect)
+      if (aspect.name in shortcuts)
+        shortcuts[aspect.name](this, aspect)
     }
 
     return map

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

@@ -1,4 +1,4 @@
 'use strict'
 
 exports.types = ['transition', 'observation', 'assignment', 'computation', 'effect']
-exports.scopes = ['object', 'objects', 'changeset']
+exports.scopes = ['object', 'objects', 'changeset', 'stream']

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

@@ -13,6 +13,8 @@ const define = (descriptor) => {
   definition.type = name
 
   if (node.params.length > 1) definition.scope = scope(node.params[1].name)
+  else definition.scope = 'none'
+
   if (node.params.length === 0) definition.input = null
 
   return definition
@@ -27,11 +29,15 @@ const test = (statement, type) => {
   return func && known
 }
 
-/**
- * @param {string} name
- * @returns {string}
- */
-const scope = (name) => scopes.includes(name) ? name : undefined
+function scope (name) {
+  if (scopes.includes(name))
+    return name
+
+  if (name === 'context')
+    return 'none'
+
+  return undefined
+}
 
 const nodes = ['FunctionDeclaration', 'ArrowFunctionExpression', 'ClassMethod']
 

package/src/factory.js

@@ -8,9 +8,9 @@ const { Context } = require('./context')
 const { extract } = require('./define/operations')
 
 class Factory {
-  algorithm (root, name, context) {
+  async algorithm (root, name, context) {
     const module = load.operation(root, name)
-    const ctx = new Context(context)
+    const ctx = new Context(context, name)
 
     return runner(module, ctx)
   }
@@ -36,11 +36,11 @@ class Factory {
  * @param {toa.node.Context} context
  * @returns {Runner}
  */
-function runner (module, context) {
+async function runner (module, context) {
   const descriptor = extract(module)
   const func = module[descriptor.name]
   const factory = require('./algorithms/' + descriptor.syntax)
-  const instance = factory.create(func)
+  const instance = await factory.create(func)
 
   return new Runner(instance, context)
 }

package/src/index.js

@@ -1,8 +1,6 @@
 'use strict'
 
 const { Factory } = require('./factory')
-const { version } = require('./version')
 
 exports.define = require('./define')
 exports.Factory = Factory
-exports.version = version

package/src/shortcuts/amqp.js

@@ -1,11 +1,12 @@
 'use strict'
 
 const { underlay } = require('@toa.io/generic')
+const assert = require('node:assert')
 
 /** @type {toa.node.shortcut} */
-const amqp = (context, aspect) => {
+function amqp (context, aspect) {
   context.amqp = underlay(async (segs, args) => {
-    if (segs.length !== 2) throw new Error(`AMQP aspect call should have 2 segments [${segs.join(', ')}] given`)
+    assert(segs.length === 2, `AMQP aspect call should have 2 segments [${segs.join(', ')}] given`)
 
     const [origin, method] = segs
 

package/src/shortcuts/configuration.js

@@ -1,7 +1,7 @@
 'use strict'
 
 /** @type {toa.node.shortcut} */
-const configuration = (context, aspect) => {
+function configuration (context, aspect) {
   Object.defineProperty(context, 'configuration', {
     get: () => aspect.invoke()
   })

package/src/shortcuts/http.js

@@ -3,7 +3,7 @@
 const { underlay } = require('@toa.io/generic')
 
 /** @type {toa.node.shortcut} */
-const http = (context, aspect) => {
+function http (context, aspect) {
   context.http = underlay(async (segs, args) => {
     if (segs.length < 2) throw new Error(`Origins call requires at least 2 arguments, ${segs.length} given`)
 

package/src/shortcuts/index.js

@@ -6,6 +6,8 @@ const { configuration } = require('./configuration')
 const { state } = require('./state')
 const { stash } = require('./stash')
 const { storages } = require('./storages')
+const { pubsub } = require('./pubsub')
+const { logs } = require('./logs')
 
 exports.http = http
 exports.amqp = amqp
@@ -13,3 +15,5 @@ exports.configuration = configuration
 exports.state = state
 exports.stash = stash
 exports.storages = storages
+exports.pubsub = pubsub
+exports.logs = logs

package/src/shortcuts/logs.js

@@ -0,0 +1,17 @@
+'use strict'
+
+function logs (context, aspect) {
+  function invoke (severity) {
+    return (message, attributes) => aspect.invoke(context.operation, severity, message, attributes)
+  }
+
+  context.logs = CHANNELS.reduce((logs, channel) => {
+    logs[channel] = invoke(channel)
+
+    return logs
+  }, {})
+}
+
+const CHANNELS = ['debug', 'info', 'warn', 'error']
+
+exports.logs = logs

package/src/shortcuts/pubsub.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const { underlay } = require('@toa.io/generic')
+const assert = require('node:assert')
+
+function pubsub (context, aspect) {
+  context.pubsub = underlay(async (segs, args) => {
+    assert(segs.length === 2, `Pub/Sub aspect call should have 2 segments [${segs.join(', ')}] given`)
+
+    const [origin, method] = segs
+
+    return aspect.invoke(method, origin, ...args)
+  })
+}
+
+exports.pubsub = pubsub

package/src/shortcuts/stash.js

@@ -3,7 +3,7 @@
 const { underlay } = require('@toa.io/generic')
 
 /** @type {toa.node.shortcut} */
-const stash = (context, aspect) => {
+function 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`)

package/src/shortcuts/state.js

@@ -3,7 +3,7 @@
 const { generate } = require('@toa.io/generic')
 
 /** @type {toa.node.shortcut} */
-const state = (context, aspect) => {
+function state (context, aspect) {
   context.state = generate((segs, value) => {
     if (value === undefined) return get(aspect, segs)
     else set(aspect, segs, value)

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

@@ -67,7 +67,7 @@ describe('function', () => {
     const module = { computation }
     const definition = define(module)
 
-    expect(definition).toMatchObject({ type: 'computation', scope: undefined })
+    expect(definition).toMatchObject({ type: 'computation', scope: 'none' })
   })
 
   it('should parse effect declaration', () => {
@@ -76,7 +76,7 @@ describe('function', () => {
     const module = { effect }
     const definition = define(module)
 
-    expect(definition).toMatchObject({ type: 'effect', scope: undefined })
+    expect(definition).toMatchObject({ type: 'effect', scope: 'none' })
   })
 
   it('should parse expression', () => {
@@ -103,8 +103,8 @@ describe('function', () => {
     expect(definition.scope).toStrictEqual(undefined)
   })
 
-  it('should not define scope', async () => {
-    const observation = (input) => null
+  it('should not define unknown scope', async () => {
+    const observation = (input, message) => null
     const module = { observation }
     const definition = define(module)
 
@@ -168,7 +168,7 @@ describe('class', () => {
     expect(() => define(module)).toThrow('does not match conventions')
   })
 
-  it('should define not define default scope', async () => {
+  it('should define none scope', async () => {
     class Observation {
       execute (input) {}
     }
@@ -176,7 +176,7 @@ describe('class', () => {
     const module = { Observation }
     const definition = define(module)
 
-    expect(definition.scope).toBeUndefined()
+    expect(definition.scope).toBe('none')
   })
 
   it('should define null input', async () => {

package/test/factory.algorithm.test.js

@@ -26,7 +26,7 @@ it('should be', () => {
 
 for (const sample of ['fn', 'cls', 'fct']) {
   it(`should create '${sample}' operation`, async () => {
-    const algorithm = factory.algorithm(root, sample, context)
+    const algorithm = await factory.algorithm(root, sample, context)
 
     expect(algorithm).toBeDefined()
 

package/types/algorithms.d.ts

@@ -2,22 +2,24 @@ import { bridges } from '@toa.io/core'
 import * as _context from './context'
 import * as _core from '@toa.io/core'
 
-declare namespace toa.node{
+declare namespace toa.node {
 
-  namespace algorithms{
+  namespace algorithms {
 
     type Constructor = () => bridges.Algorithm
 
-    interface Factory{
+    interface Factory {
       create: Constructor
     }
 
     type func = (input?: any, scope?: object | object[], context?: _context.Context) => Promise<_core.Reply>
   }
 
-  interface Algorithm{
+  interface Algorithm {
     mount? (context: _context.Context): Promise<void> | void
 
+    unmount? (): Promise<void> | void
+
     execute (input: any, scope: object | object[]): Promise<any>
 
     execute (input: any): Promise<_core.Reply>

package/src/version.js

@@ -1,15 +0,0 @@
-'use strict'
-
-const { join } = require('node:path')
-
-exports.version = function(manifest) {
-  const pkgPath = join(manifest.path, 'package.json')
-
-  try {
-    const pkg = require(pkgPath)
-
-    return pkg.version
-  } catch {
-    return undefined
-  }
-}