@toa.io/bindings.amqp 0.20.0-dev.31 → 0.20.0-dev.34

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@toa.io/bindings.amqp",
-  "version": "0.20.0-dev.31",
+  "version": "0.20.0-dev.34",
   "description": "Toa AMQP Binding",
   "author": "temich <tema.gurtovoy@gmail.com>",
   "homepage": "https://github.com/toa-io/toa#readme",
-  "main": "source/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/toa-io/toa.git"
@@ -15,15 +14,22 @@
   "publishConfig": {
     "access": "public"
   },
+  "main": "transpiled/index.js",
+  "types": "transpiled/index.d.ts",
+  "dependencies": {
+    "@toa.io/console": "0.20.0-dev.34",
+    "@toa.io/core": "0.20.0-dev.34",
+    "@toa.io/generic": "0.20.0-dev.34",
+    "@toa.io/pointer": "0.20.0-dev.34",
+    "comq": "0.8.0"
+  },
   "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1"
+    "prepublishOnly": "npm run transpile",
+    "transpile": "tsc"
   },
-  "dependencies": {
-    "@toa.io/console": "0.20.0-dev.31",
-    "@toa.io/core": "0.20.0-dev.31",
-    "@toa.io/generic": "0.20.0-dev.31",
-    "@toa.io/generics.amqp": "0.20.0-dev.31",
-    "@toa.io/pointer": "0.20.0-dev.31"
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
   },
-  "gitHead": "f9ad6bf2bab1298b96ca52557b7e36b6041cfc88"
+  "gitHead": "7035b1985fe9bb844069308a272d061bfbd38bf0"
 }

package/readme.md

@@ -1,54 +1,19 @@
-# Toa AMQP Binding
+# Toa AMQP binding
 
 AMQP asynchronous binding on top of [ComQ](/libraries/comq).
 
-## Deployment
-
-AMQP deployment must be declared with
-the [Pointer annotation](/libraries/pointer/readme.md#annotation). Either `system` or `default`
-pointers must be defined.
-
-Well-known annotation shortcut `amqp` is available.
-
-```yaml
-# context.toa.yaml
-annotations:
-  "@toa.io/bindings.amqp":
-    system: url0          # the runtime 
-    default: url1         # all undeclared
-    dummies: url2         # namespace-wide
-    dummies.dummy1: url  # component exclusive
-```
-
-### Concise Declaration
-
-Well-known shortcut `amqp` is available. The next two declarations are equivalent:
+## Annotation
 
 ```yaml
-# context.toa.yaml
-annotations:
-  "@toa.io/bindings.amqp":
-    system: url0
-    dummies: url1
-```
-
-```yaml
-# context.toa.yaml
 amqp:
-  system: url0
-  dummies: url1
+  context:
+    .: amqp://com.example.com
+    dummies.dummy: amqp://dummmy.example.com
+  sources:
+    somewhere: amqp://queues.somewhere.com
 ```
 
-`string` annotation value is considered as `default`. The next two declarations are equivalent:
+Context annotaition is a [Pointer](/libraries/pointer) with `amqp-context` ID.
 
-```yaml
-# context.toa.yaml
-annotations:
-  "@toa.io/bindings.amqp":
-    default: url1
-``` 
-
-```yaml
-# context.toa.yaml
-amqp: url1
-``` 
+Sources annotation is a set of Pointers, declared by components consuming foreign events.
+Each Pointer ID is as follows: `amqp-sources-{source}`.

package/schemas/annotation.cos.yaml

@@ -0,0 +1,2 @@
+context*: <string>
+sources: <string>

package/source/broadcast.js

@@ -17,11 +17,6 @@ class Broadcast extends Connector {
   /** @type {string} */
   #group
 
-  /**
-   * @param {toa.amqp.Communication} comm
-   * @param {toa.core.Locator} locator
-   * @param {string} [group]
-   */
   constructor (comm, locator, group) {
     super()
 

package/source/communication.js

@@ -0,0 +1,49 @@
+'use strict'
+
+const { assert } = require('comq')
+const { Connector } = require('@toa.io/core')
+
+class Communication extends Connector {
+  #resolve
+
+  /** @type {comq.IO} */
+  #io
+
+  constructor (resolve) {
+    super()
+
+    this.#resolve = resolve
+  }
+
+  async open () {
+    const references = await this.#resolve()
+
+    this.#io = await assert(...references)
+  }
+
+  async close () {
+    await this.#io.seal()
+  }
+
+  async dispose () {
+    if (this.#io !== undefined) await this.#io.close()
+  }
+
+  async reply (queue, process) {
+    await this.#io.reply(queue, process)
+  }
+
+  async request (queue, request) {
+    return this.#io.request(queue, request)
+  }
+
+  async emit (exchange, message, properties) {
+    await this.#io.emit(exchange, message, properties)
+  }
+
+  async consume (exchange, group, consumer) {
+    await this.#io.consume(exchange, group, consumer)
+  }
+}
+
+exports.Communication = Communication

package/source/constants.js

@@ -1,4 +1,3 @@
 'use strict'
 
-exports.PREFIX = 'bindings-amqp'
 exports.SYSTEM = 'system'

package/source/consumer.js

@@ -13,11 +13,6 @@ class Consumer extends Connector {
   /** @type {toa.amqp.Communication} */
   #comm
 
-  /**
-   * @param {toa.amqp.Communication} comm
-   * @param {toa.core.Locator} locator
-   * @param {string} endpoint
-   */
   constructor (comm, locator, endpoint) {
     super()
 

package/source/deployment/annotation.test.ts

@@ -0,0 +1,40 @@
+import { generate } from 'randomstring'
+import { normalize } from './annotation'
+
+it('should expand string', async () => {
+  const declaration = uri()
+  const annotation = normalize(declaration)
+
+  expect(annotation).toMatchObject({
+    context: {
+      '.': [declaration]
+    }
+  })
+})
+
+it('should expand context default', async () => {
+  const declaration = { context: uri() }
+  const annotation = normalize(declaration)
+
+  expect(annotation).toMatchObject({
+    context: {
+      '.': [declaration.context]
+    }
+  })
+})
+
+it('should expand context with sources', async () => {
+  const declaration = { context: uri(), sources: { foo: [uri()] } }
+  const annotation = normalize(declaration)
+
+  expect(annotation).toMatchObject({
+    context: {
+      '.': [declaration.context]
+    },
+    sources: declaration.sources
+  })
+})
+
+function uri (): string {
+  return 'http://host-' + generate()
+}

package/source/deployment/annotation.ts

@@ -0,0 +1,26 @@
+import * as pointer from '@toa.io/pointer'
+import { type URIMap } from '@toa.io/pointer'
+
+export function normalize (declaration: string | Declaration): Annotation {
+  const annotation = expand(declaration)
+  const context = pointer.normalize(annotation.context)
+  const sources = pointer.normalize(annotation.sources)
+
+  return { context, sources }
+}
+
+function expand (declaration: string | Declaration): Declaration {
+  if (typeof declaration === 'string') return { context: { '.': [declaration] } }
+  else if (Array.isArray(declaration)) return { context: { '.': declaration } }
+  else return declaration
+}
+
+export interface Annotation {
+  context: URIMap
+  sources?: URIMap
+}
+
+export interface Declaration {
+  context: string | Record<string, string | string[]>
+  sources?: Record<string, string | string[]>
+}

package/source/deployment/context.ts

@@ -0,0 +1,112 @@
+import { type Dependency, type Variable } from '@toa.io/operations'
+import { encode, decode } from '@toa.io/generic'
+import { resolveRecord, naming } from '@toa.io/pointer'
+import { type Locator } from '@toa.io/core'
+import { type AnnotationRecord } from '@toa.io/pointer/transpiled/Deployment'
+import { dedupe } from '@toa.io/dns'
+import { type Annotation } from './annotation'
+
+export function createDependency (context: Context): Dependency {
+  const global: Variable[] = []
+  const variables = { global }
+
+  const contextVariables = createVariables(context)
+
+  global.push(...contextVariables)
+
+  return { variables }
+}
+
+export async function resolveURIs (locator: Locator): Promise<string[]> {
+  if (process.env.TOA_DEV === '1') return ['amqp://developer:secret@localhost']
+
+  const value = process.env[VARIABLE]
+
+  if (value === undefined) throw new Error(`Environment variable ${VARIABLE} is not specified`)
+
+  const map = decode(value)
+  const record = resolveRecord(map, locator.id)
+
+  return await parseRecord(record)
+}
+
+function createVariables (context: Context): Variable[] {
+  const variables: Variable[] = []
+  const uris = encode(context)
+
+  const contextVariable: Variable = {
+    name: VARIABLE,
+    value: uris
+  }
+
+  const secrets = createSecrets(context)
+
+  variables.push(contextVariable, ...secrets)
+
+  return variables
+}
+
+function createSecrets (context: Context): Variable[] {
+  const secrets: Variable[] = []
+
+  for (const key of Object.keys(context)) {
+    const keySecrets = createKeySecrets(key)
+
+    secrets.push(...keySecrets)
+  }
+
+  return secrets
+}
+
+function createKeySecrets (key: string): Variable[] {
+  const username = createSecretVariable(key, 'username')
+  const password = createSecretVariable(key, 'password')
+
+  return [username, password]
+}
+
+function createSecretVariable (key: string, secretKey: string): Variable {
+  const varKey = key === '.' ? '' : key
+  const varName = naming.nameVariable(ID, varKey, secretKey.toUpperCase())
+  const secName = naming.nameSecret(ID, key)
+
+  return {
+    name: varName,
+    secret: {
+      name: secName,
+      key: secretKey
+    }
+  }
+}
+
+async function parseRecord (record: AnnotationRecord): Promise<string[]> {
+  const unique = await dedupe(record.references)
+  const urls = new Array(unique.length)
+  const key = record.key === '.' ? '' : record.key
+  const username = readEnv(key, 'USERNAME')
+  const password = readEnv(key, 'PASSWORD')
+
+  for (let i = 0; i < record.references.length; i++) {
+    const url = new URL(record.references[i])
+
+    url.username = username
+    url.password = password
+
+    urls[i] = url.href
+  }
+
+  return urls
+}
+
+function readEnv (key: string, name: string): string {
+  const variable = naming.nameVariable(ID, key, name)
+  const value = process.env[variable]
+
+  if (value === undefined) throw new Error(variable + ' is not set')
+  else return value
+}
+
+const ID = 'amqp-context'
+const VARIABLE = 'TOA_AMQP_CONTEXT'
+
+type Context = Annotation['context']

package/source/deployment/index.ts

@@ -0,0 +1,10 @@
+import { type Dependency } from '@toa.io/operations'
+import { type Declaration, normalize } from './annotation'
+import * as sources from './sources'
+import { type Instance } from './instance'
+
+export function deployment (instances: Instance[], declaration: Declaration): Dependency {
+  const annotation = normalize(declaration)
+
+  return sources.createDependency(annotation.sources, instances)
+}

package/source/deployment/instance.ts

@@ -0,0 +1,3 @@
+import { type context } from '@toa.io/norm'
+
+export type Instance = context.Dependency

package/source/deployment/sources.ts

@@ -0,0 +1,44 @@
+import { createVariables, resolve, type Request } from '@toa.io/pointer'
+import { type component } from '@toa.io/norm'
+import { type Dependency } from '@toa.io/operations'
+import { type Locator } from '@toa.io/core'
+import { type Instance } from './instance'
+import { type Annotation } from './annotation'
+
+export function createDependency (sources: Sources, instances: Instance[]): Dependency {
+  const requests = []
+
+  for (const instance of instances) {
+    const request = createRequest(instance)
+
+    if (request !== null) requests.push(request)
+  }
+
+  const variables = createVariables(ID, sources, requests)
+
+  return { variables }
+}
+
+export async function resolveURIs (locator: Locator, label: string): Promise<string[]> {
+  return await resolve(ID, locator.id)
+}
+
+function createRequest (instance: Instance): Request | null {
+  const group = instance.locator.label
+  const selectors = createSelectors(instance.component)
+
+  if (selectors === null) return null
+  else return { group, selectors }
+}
+
+function createSelectors (component: component.Component): string[] | null {
+  if (component.receivers === undefined) return null
+
+  const sources = Object.values(component.receivers).map((receiver) => receiver.source)
+
+  return sources.filter((source) => source !== undefined) as string[]
+}
+
+const ID = 'amqp-sources'
+
+type Sources = Annotation['sources']

package/source/deployment.ts

@@ -0,0 +1,14 @@
+import { type Dependency } from '@toa.io/operations'
+import { merge } from '@toa.io/generic'
+import { type Declaration, normalize } from './deployment/annotation'
+import * as sources from './deployment/sources'
+import * as context from './deployment/context'
+import { type Instance } from './deployment/instance'
+
+export function deployment (instances: Instance[], declaration: Declaration): Dependency {
+  const annotation = normalize(declaration)
+  const contextDependency = context.createDependency(annotation.context)
+  const sourcesDependency = sources.createDependency(annotation.sources, instances)
+
+  return merge(contextDependency, sourcesDependency)
+}

package/source/emitter.js

@@ -14,11 +14,6 @@ class Emitter extends Connector {
   /** @type {toa.amqp.Communication} */
   #comm
 
-  /**
-   * @param {toa.amqp.Communication} comm
-   * @param {toa.core.Locator} locator
-   * @param {string} label
-   */
   constructor (comm, locator, label) {
     super()
 

package/source/factory.js

@@ -1,70 +1,62 @@
 'use strict'
 
 const { Locator } = require('@toa.io/core')
-const { connector } = require('@toa.io/generics.amqp')
 
 const { Producer } = require('./producer')
 const { Consumer } = require('./consumer')
 const { Emitter } = require('./emitter')
 const { Receiver } = require('./receiver')
 const { Broadcast } = require('./broadcast')
+const context = require('./deployment/context')
+const sources = require('./deployment/sources')
 
-const { SYSTEM, PREFIX } = require('./constants')
+const { SYSTEM } = require('./constants')
+const { Communication } = require('./communication')
 
-/**
- * @implements {toa.core.bindings.Factory}
- */
 class Factory {
   producer (locator, endpoints, component) {
-    const comm = this.#getCommunication(locator)
+    const comm = this.#getContext(locator)
 
     return new Producer(comm, locator, endpoints, component)
   }
 
   consumer (locator, endpoint) {
-    const comm = this.#getCommunication(locator)
+    const comm = this.#getContext(locator)
 
     return new Consumer(comm, locator, endpoint)
   }
 
-  /**
-   * @param {toa.core.Locator} locator
-   * @param {string} label
-   * @return {Emitter}
-   */
   emitter (locator, label) {
-    const comm = this.#getCommunication(locator)
+    const comm = this.#getContext(locator)
 
     return new Emitter(comm, locator, label)
   }
 
-  /**
-   * @param {toa.core.Locator} source
-   * @param {string} label
-   * @param {string} group
-   * @param {toa.core.Receiver} receiver
-   * @return {Receiver}
-   */
-  receiver (source, label, group, receiver) {
-    const comm = this.#getCommunication(source)
+  receiver (locator, label, group, receiver) {
+    const comm = this.#getSource(locator, label)
 
     return new Receiver(comm, label, group, receiver)
   }
 
   broadcast (name, group) {
     const locator = new Locator(name, SYSTEM)
-    const comm = this.#getCommunication(locator)
+    const comm = this.#getContext(locator)
 
     return new Broadcast(comm, locator, group)
   }
 
-  /**
-   *
-   * @param {toa.core.Locator} source
-   * @return {toa.amqp.Communication}
-   */
-  #getCommunication (source) {
-    return connector(PREFIX, source)
+  #getContext (locator) {
+    const resolve = async () => context.resolveURIs(locator)
+
+    return new Communication(resolve)
+  }
+
+  #getSource (locator, label) {
+    const resolve = (locator.namespace === undefined)
+      ? async () => sources.resolveURIs(locator, label)
+      : async () => context.resolveURIs(locator)
+
+    return new Communication(resolve)
   }
 }
 

package/source/index.js

@@ -1,13 +1,11 @@
 'use strict'
 
 const { deployment } = require('./deployment')
-const { annotation } = require('./annotation')
 const { Factory } = require('./factory')
 
 /** @type {toa.core.bindings.Properties} */
 const properties = { async: true }
 
 exports.properties = properties
-exports.annotation = annotation
 exports.deployment = deployment
 exports.Factory = Factory

package/source/producer.js

@@ -17,12 +17,6 @@ class Producer extends Connector {
   /** @type {toa.core.Component} */
   #component
 
-  /**
-   * @param {toa.amqp.Communication} comm
-   * @param {toa.core.Locator} locator
-   * @param {string[]} endpoints
-   * @param {toa.core.Component} component
-   */
   constructor (comm, locator, endpoints, component) {
     super()
 

package/source/receiver.js

@@ -15,12 +15,6 @@ class Receiver extends Connector {
   /** @type {toa.core.Receiver} */
   #receiver
 
-  /**
-   * @param {toa.amqp.Communication} comm
-   * @param {string} exchange
-   * @param {string} group
-   * @param {toa.core.Receiver} receiver
-   */
   constructor (comm, exchange, group, receiver) {
     super()
 

package/transpiled/broadcast.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @implements {toa.core.bindings.Broadcast}
+ */
+export class Broadcast extends Connector implements toa.core.bindings.Broadcast {
+    constructor(comm: any, locator: any, group: any);
+    transmit(label: any, payload: any): Promise<void>;
+    receive(label: any, callback: any): Promise<void>;
+    #private;
+}
+import { Connector } from "@toa.io/core";

package/transpiled/broadcast.js

@@ -0,0 +1,31 @@
+'use strict';
+const { Connector } = require('@toa.io/core');
+const { name } = require('./queues');
+/**
+ * @implements {toa.core.bindings.Broadcast}
+ */
+class Broadcast extends Connector {
+    /** @type {toa.amqp.Communication} */
+    #comm;
+    /** @type {toa.core.Locator} */
+    #locator;
+    /** @type {string} */
+    #group;
+    constructor(comm, locator, group) {
+        super();
+        this.#comm = comm;
+        this.#locator = locator;
+        this.#group = group;
+        this.depends(comm);
+    }
+    async transmit(label, payload) {
+        const exchange = name(this.#locator, label);
+        await this.#comm.emit(exchange, payload);
+    }
+    async receive(label, callback) {
+        const exchange = name(this.#locator, label);
+        await this.#comm.consume(exchange, this.#group, callback);
+    }
+}
+exports.Broadcast = Broadcast;
+//# sourceMappingURL=broadcast.js.map

package/transpiled/broadcast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcast.js","sourceRoot":"","sources":["../source/broadcast.js"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;AAE7C,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAEpC;;GAEG;AACH,MAAM,SAAU,SAAQ,SAAS;IAC/B,qCAAqC;IACrC,KAAK,CAAA;IAEL,+BAA+B;IAC/B,QAAQ,CAAA;IAER,qBAAqB;IACrB,MAAM,CAAA;IAEN,YAAa,IAAI,EAAE,OAAO,EAAE,KAAK;QAC/B,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAEnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,KAAK,EAAE,OAAO;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QAE3C,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO,CAAE,KAAK,EAAE,QAAQ;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QAE3C,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,OAAO,CAAC,SAAS,GAAG,SAAS,CAAA"}

package/transpiled/communication.d.ts

@@ -0,0 +1,9 @@
+export class Communication extends Connector {
+    constructor(resolve: any);
+    reply(queue: any, process: any): Promise<void>;
+    request(queue: any, request: any): Promise<any>;
+    emit(exchange: any, message: any, properties: any): Promise<void>;
+    consume(exchange: any, group: any, consumer: any): Promise<void>;
+    #private;
+}
+import { Connector } from "@toa.io/core";