comq 0.10.1 → 0.10.3

package/.github/workflows/codeql.yml

@@ -46,7 +46,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -60,7 +60,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -73,6 +73,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

package/.github/workflows/release.yaml

@@ -21,9 +21,9 @@ jobs:
 
     steps:
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           registry-url: 'https://registry.npmjs.org'
 
       - name: Checkout

package/features/rpc.feature

@@ -18,6 +18,19 @@ Feature: Request-reply (RPC)
       3
       """
 
+  Scenario: Getting `null` reply
+    Given function replying `add_numbers` queue:
+      """
+      () => { return null }
+      """
+    When the consumer sends the following request to the `add_numbers` queue:
+      """yaml
+      """
+    Then the consumer receives the reply:
+      """yaml
+      null
+      """
+
   Scenario: Request causing an exception is discarded
     Given function replying `throw_error` queue:
     """

package/features/steps/broker.js

@@ -32,7 +32,7 @@ Given('one of the brokers is/has {status}',
 const actions = {
   up: async (n = 0) => {
     await execute('docker start comq-rmq-' + n)
-    await healthy()
+    await healthy(n)
   },
   down: async (n = 0) => {
     await execute('docker stop comq-rmq-' + n)
@@ -42,16 +42,14 @@ const actions = {
   }
 }
 
-async function healthy () {
+async function healthy (n) {
   let process
 
   do {
     await timeout(HEALTHCHECK_INTERVAL)
 
-    process = await execute('docker inspect -f {{.State.Health.Status}} comq-rmq-0')
+    process = await execute('docker inspect -f {{.State.Health.Status}} comq-rmq-' + n)
   } while (process.output !== 'healthy')
-
-  await timeout(500)
 }
 
 const BROKERS_AMOUNT = 2

package/features/steps/events.js

@@ -4,7 +4,7 @@ const stream = require('node:stream')
 const assert = require('node:assert')
 const { randomBytes } = require('node:crypto')
 const { timeout, quantity, match } = require('@toa.io/generic')
-const { parse } = require('@toa.io/yaml')
+const { load: parse } = require('js-yaml')
 const { Given, When, Then } = require('@cucumber/cucumber')
 
 Given('(that ){token} is consuming events from the {token} exchange',
@@ -64,6 +64,7 @@ When('an event is emitted to the {token} exchange with properties:',
 
 When('a stream of {quantity} events is emitted to the {token} exchange',
   /**
+   * @param {string} amountQ
    * @param {string} exchange
    * @this {comq.features.Context}
    */

package/features/steps/rpc.js

@@ -3,7 +3,7 @@
 const stream = require('node:stream')
 const assert = require('node:assert')
 const { randomBytes } = require('node:crypto')
-const { parse } = require('@toa.io/yaml')
+const { load: parse } = require('js-yaml')
 const { match, timeout, quantity } = require('@toa.io/generic')
 const { Given, When, Then } = require('@cucumber/cucumber')
 const { Readable } = require('node:stream')

package/lerna.json

@@ -1,4 +1,4 @@
 {
-  "version": "0.10.1",
+  "version": "0.10.3",
   "conventionalCommits": true
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comq",
-  "version": "0.10.1",
+  "version": "0.10.3",
   "description": "ComQ",
   "author": {
     "name": "Artem Gurtovoi",
@@ -27,27 +27,28 @@
   "main": "source/index.js",
   "types": "types/index.d.ts",
   "devDependencies": {
-    "@cucumber/cucumber": "^9.1.2",
+    "@cucumber/cucumber": "^10.0.1",
     "@toa.io/command": "^0.4.0",
-    "@toa.io/tomato": "^0.4.0",
-    "@toa.io/yaml": "^0.4.0",
-    "@types/amqplib": "^0.10.1",
-    "@types/jest": "^29.5.2",
-    "husky": "^8.0.3",
+    "@toa.io/generic": "^1.0.0-alpha.0",
+    "@types/amqplib": "^0.10.3",
+    "@types/jest": "^29.5.8",
+    "husky": "^9.0.11",
     "jest": "^29.5.0",
+    "js-yaml": "^4.1.0",
     "randomstring": "^1.3.0",
     "snazzy": "^9.0.0",
     "standard": "^17.1.0"
   },
   "dependencies": {
-    "@toa.io/generic": "^0.4.0",
-    "amqplib": "^0.10.3",
-    "msgpackr": "^1.9.5"
+    "amqplib": "^0.10.4",
+    "msgpackr": "^1.10.2",
+    "promex": "^0.1.1",
+    "reretry": "^0.1.0"
   },
   "scripts": {
     "prepare": "echo run: husky install",
     "test": "standard && jest",
-    "features": "cucumber-js --publish-quiet",
+    "features": "cucumber-js --fail-fast",
     "lint": "standard --fix --verbose | snazzy"
   },
   "standard": {

package/readme.md

@@ -137,12 +137,6 @@ auto-generated name.
 // with a consumer function
 await io.consume('numbers_added', 'logger',
   ({ a, b }) => console.log(`${a} was added to ${b}`))
-
-// as a stream
-const events = await io.consume('numbers_added', 'logger')
-
-for await (const { a, b } of events)
-  console.log(`${a} was added to ${b}`)
 ```
 
 ## Emission
@@ -350,9 +344,6 @@ and it will be closed when the last instance of `IO` using that connection is [d
 Topology is designed to deliver maximum performance while ensuring that the **at least once**
 guarantee provided by RabbitMQ is maintained.
 
-> Topology design assumes that unanswered Requests and unconfirmed Events will be retransmitted
-> upon reconnection.
-
 ### Dynamic
 
 Static topology refers to the process of defining the complete topology declaration along with the

package/source/.io/ReplyStream.js

@@ -1,11 +1,11 @@
 'use strict'
 
 const { Readable } = require('node:stream')
-const { promex } = require('@toa.io/generic')
+const { Promex } = require('promex')
 const { IDLE_INTERVAL, control } = require('./const')
 
 class ReplyStream extends Readable {
-  confirmation = promex()
+  confirmation = new Promex()
 
   /** @type {ReturnType<setTimeout> | null} */
   #timeout = null
@@ -26,8 +26,8 @@ class ReplyStream extends Readable {
 
   #buffered = 0
 
-  /** @type {Record<number, unknown>} */
-  #queue = {}
+  /** @type {Map<number, unknown>} */
+  #queue = new Map()
 
   /**
    * @param {comq.Request} request
@@ -70,12 +70,12 @@ class ReplyStream extends Readable {
     if (this.#buffered > 0) {
       let message
 
-      while ((message = this.#queue[this.#index])) {
-        delete this.#queue[this.#index]
+      while ((message = this.#queue.get(this.#index))) {
+        this.#queue.delete(this.#index)
         this._add(message.payload, message.properties)
       }
 
-      this.#buffered = Object.keys(this.#queue).length
+      this.#buffered = this.#queue.size
     }
   }
 
@@ -98,7 +98,7 @@ class ReplyStream extends Readable {
     if (this.#buffered > MAX_BUFFER_SIZE) this.destroy()
 
     this.#buffered++
-    this.#queue[properties.headers.index] = { payload, properties }
+    this.#queue.set(properties.headers.index, { payload, properties })
   }
 
   /**

package/source/channel.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { promex, timeout } = require('@toa.io/generic')
+const { Promex } = require('promex')
 const { failsafe, lazy, recall } = require('./attributes')
 const emitter = require('./emitter')
 
@@ -25,16 +25,16 @@ class Channel {
   /** @type {string[]} */
   #tags = []
 
-  /** @type {toa.generic.Promex | null} */
+  /** @type {Promex | null} */
   #paused = null
 
   /** @type {boolean} */
   #sealed = false
 
-  /** @type {toa.generic.Promex} */
-  #recovery = promex()
+  /** @type {Promex} */
+  #recovery = new Promex()
 
-  /** @type {Set<toa.generic.Promex>} */
+  /** @type {Set<Promex>} */
   #confirmations = new Set()
 
   #diagnostics = emitter.create()
@@ -149,10 +149,11 @@ class Channel {
 
     for (const confirmation of this.#confirmations) confirmation.reject(INTERRUPTION)
 
-    await timeout(0) // handle interruptions
+    // handle interruptions
+    await new Promise(resolve => setTimeout(resolve, 0))
 
     this.#recovery.resolve()
-    this.#recovery = promex()
+    this.#recovery = new Promex()
     this.#diagnostics.emit('recover')
   }
 
@@ -222,10 +223,10 @@ class Channel {
   }
 
   /**
-   * @return {toa.generic.Promex}
+   * @return {Promex}
    */
   #confirmation () {
-    const confirmation = promex()
+    const confirmation = new Promex()
 
     this.#confirmations.add(confirmation)
 
@@ -292,7 +293,7 @@ class Channel {
   #pause () {
     if (this.#paused !== null) return
 
-    this.#paused = promex()
+    this.#paused = new Promex()
     this.#diagnostics.emit('flow')
     this.#diagnostics.emit('pause')
   }

package/source/connection.js

@@ -1,7 +1,8 @@
 'use strict'
 
 const amqp = require('amqplib')
-const { retry, promex } = require('@toa.io/generic')
+const { Promex } = require('promex')
+const { retry } = require('reretry')
 
 const { failsafe } = require('./attributes')
 const presets = require('./topology')
@@ -21,8 +22,8 @@ class Connection {
   /** @type {comq.Channel[]} */
   #channels = []
 
-  /** @type {toa.generic.Promex} */
-  #recovery = promex()
+  /** @type {Promex} */
+  #recovery = new Promex()
 
   /** @type {boolean} */
   #running = false
@@ -37,7 +38,7 @@ class Connection {
   }
 
   async open () {
-    await retry(this.#open, RETRY)
+    await retry(this.#open)
 
     this.#running = true
   }
@@ -69,14 +70,11 @@ class Connection {
     this.#diagnostics.on(event, listener)
   }
 
-  /**
-   * @type {toa.generic.retry.Task}
-   */
   #open = async (retry) => {
     try {
       this.#connection = await amqp.connect(this.#url)
     } catch (exception) {
-      if (this.#transient(exception)) return retry()
+      if (this.#transient(exception)) return retry
       else throw exception
     }
 
@@ -90,7 +88,7 @@ class Connection {
     for (const channel of this.#channels) await channel.recover(this.#connection)
 
     this.#recovery.resolve()
-    this.#recovery = promex()
+    this.#recovery = new Promex()
   }
 
   /**
@@ -117,9 +115,4 @@ class Connection {
 
 function noop () {}
 
-/** @type {toa.generic.retry.Options} */
-const RETRY = {
-  retries: Infinity
-}
-
 exports.Connection = Connection

package/source/io.js

@@ -3,7 +3,8 @@
 const stream = require('node:stream')
 const { EventEmitter } = require('node:events')
 const { randomBytes } = require('node:crypto')
-const { promex, timeout } = require('@toa.io/generic')
+const { setTimeout } = require('node:timers/promises')
+const { Promex } = require('promex')
 const { memo, failsafe, lazy, track } = require('./attributes')
 
 const { decode } = require('./decode')
@@ -34,7 +35,7 @@ class IO {
   /** @type {comq.ReplyEmitter | null} */
   #control = null
 
-  /** @type {Set<toa.generic.Promex>} */
+  /** @type {Set<Promex>} */
   #pendingReplies = new Set()
 
   /** @type {Set<comq.Destroyable>} */
@@ -217,7 +218,7 @@ class IO {
 
         if (request.properties.replyTo === undefined) return
 
-        const iterator = typeof reply === 'object' &&
+        const iterator = typeof reply === 'object' && reply !== null &&
           (Symbol.asyncIterator in reply ||
             (Symbol.iterator in reply && !Array.isArray(reply) && !Buffer.isBuffer(reply)))
 
@@ -279,7 +280,7 @@ class IO {
 
   /**
    * @param {comq.Request} request
-   * @return {Promise<any>}
+   * @return {Promex<any>}
    */
   #createReply (request) {
     const reply = this.#createPendingReply()
@@ -290,10 +291,10 @@ class IO {
   }
 
   /**
-   * @return {toa.generic.Promex}
+   * @return {Promex}
    */
   #createPendingReply () {
-    const reply = promex()
+    const reply = new Promex()
 
     this.#pendingReplies.add(reply)
 
@@ -383,7 +384,7 @@ class IO {
     Even if these messages are lost, the reply stream will be closed anyway,
     either due to missing heartbeat or the deletion of the stream queue.
     */
-    await timeout(50)
+    await setTimeout(50)
   }
 
   /**

package/source/shards/channel.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { promex, sample } = require('@toa.io/generic')
+const { Promex } = require('promex')
 const events = require('../events')
 const emitter = require('../emitter')
 
@@ -22,13 +22,13 @@ class Channel {
   /** @type {Set<Promise<comq.Channel>>} */
   #pending = new Set()
 
-  /** @type {Map<comq.Channel, toa.generic.Promex>} */
+  /** @type {Map<comq.Channel, Promex>} */
   #bench = new Map()
 
   /** @type {comq.topology.type} */
   #type
 
-  #recovery = promex()
+  #recovery = new Promex()
 
   #diagnostics = emitter.create()
 
@@ -134,7 +134,7 @@ class Channel {
   #remove (channel) {
     if (!this.#channels.has(channel)) return
 
-    this.#bench.set(channel, promex())
+    this.#bench.set(channel, new Promex())
     this.#channels.delete(channel)
     this.#update()
     this.#diagnostics.emit('remove', channel.index)
@@ -162,7 +162,7 @@ class Channel {
     this.#add(channel)
 
     this.#recovery.resolve()
-    this.#recovery = promex()
+    this.#recovery = new Promex()
   }
 
   #comeback (channel) {
@@ -209,7 +209,7 @@ class Channel {
   async #one (fn) {
     if (this.#pool.length === 0) await this.#recovery
 
-    const channel = sample(this.#pool)
+    const channel = this.#pool[Math.floor(Math.random() * this.#pool.length)]
 
     try {
       return await fn(channel)

package/features/steps/.test/backpressure.test.js

@@ -1,79 +0,0 @@
-'use strict'
-
-const { AssertionError } = require('node:assert')
-const { generate } = require('randomstring')
-const { random, quantity } = require('@toa.io/generic')
-const tomato = require('@toa.io/tomato')
-const { io } = require('./io.mock')
-const mock = { tomato }
-
-jest.mock('@cucumber/cucumber', () => mock.tomato)
-
-require('../backpressure')
-
-/** @type {comq.features.Context} */
-let context
-
-describe('When I\'m sending {quantity}B requests to the {token} queue at {quantity}Hz for {number} second(s)', () => {
-  const step = tomato.steps.Wh('I\'m sending {quantity}B requests to the {token} queue at {quantity}Hz for {number} second(s)')
-
-  it('should be', async () => undefined)
-
-  const bytesQ = (random(5) + 1) + 'k'
-  const frequencyQ = String((random(5) + 1) / 10) + 'k' // not too high
-  const seconds = (random(3) + 1) / 10
-  const queue = generate()
-
-  const bytes = quantity(bytesQ)
-  const frequency = quantity(frequencyQ)
-
-  beforeAll(async () => {
-    jest.clearAllMocks()
-
-    context = /** @type {comq.features.Context} */ { io, requestCount: 0, replyCount: 0 }
-
-    await step.call(context, bytesQ, queue, frequencyQ, seconds)
-  })
-
-  it('should send request', async () => {
-    expect(io.request).toHaveBeenCalled()
-  })
-
-  it('should sent request to specified queue', async () => {
-    const call = io.request.mock.calls[0]
-
-    expect(call[0]).toStrictEqual(queue)
-  })
-
-  it('should send buffer of given size', async () => {
-    const buffer = io.request.mock.calls[0][1]
-
-    expect(Buffer.byteLength(buffer)).toStrictEqual(bytes)
-  })
-
-  it('should send expected amount of requests', async () => {
-    const times = Math.ceil(seconds * frequency)
-
-    expect(io.request).toHaveBeenCalledTimes(times)
-  })
-})
-
-describe('Then back pressure was applied', () => {
-  const step = tomato.steps.Th('back pressure was applied')
-
-  beforeEach(() => {
-    context = /** @type {comq.features.Context} */ { io, events: {} }
-  })
-
-  it('should be', async () => undefined)
-
-  it('should fail if flag is not set', async () => {
-    expect(() => step.call(context)).toThrow(AssertionError)
-  })
-
-  it('should pass if flag is true', async () => {
-    context.events = { flow: true }
-
-    expect(() => step.call(context)).not.toThrow()
-  })
-})

package/features/steps/.test/broker.test.js

@@ -1,101 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-const tomato = require('@toa.io/tomato')
-const { command } = require('./command.mock')
-const mock = { tomato, command }
-
-jest.mock('@cucumber/cucumber', () => mock.tomato)
-jest.mock('@toa.io/command', () => mock.command)
-
-jest.setTimeout(10000)
-
-global.COMQ_TESTING_HEALTHCHECK_INTERVAL = 0
-
-require('../broker')
-
-const context = /** @type {comq.features.Context} */ {}
-
-beforeEach(() => {
-  jest.clearAllMocks()
-})
-
-describe.each([false, true])('Given the broker is/has {status} #shards:%s', (sharded) => {
-  const step = tomato.steps.Gi('the broker is/has {status}')
-
-  const containerNumber = sharded ? 1 : 0
-
-  it('should be', async () => undefined)
-
-  beforeEach(() => {
-    context.io = generate()
-
-    if (sharded) {
-      context.sharded = true
-      context.shard = containerNumber
-    }
-  })
-
-  it('should start comq-rmq container', async () => {
-    command.execute.mockImplementationOnce(async () => undefined)
-    command.execute.mockImplementationOnce(async () => ({ output: 'healthy' }))
-
-    await step.call(context, 'up')
-
-    expect(command.execute).toHaveBeenCalledWith('docker start comq-rmq-' + containerNumber)
-  })
-
-  it('should wait for healthy state', async () => {
-    let starting = false
-    let healthy = false
-
-    command.execute.mockImplementationOnce(async () => undefined)
-
-    command.execute.mockImplementationOnce(async () => {
-      starting = true
-
-      return { output: 'starting' }
-    })
-
-    command.execute.mockImplementationOnce(async () => {
-      healthy = true
-
-      return { output: 'healthy' }
-    })
-
-    await step.call(context, 'up')
-
-    expect(command.execute).toHaveBeenCalledTimes(3)
-  })
-
-  it('should stop comq-rmq container', async () => {
-    await step.call(context, 'down')
-
-    expect(command.execute).toHaveBeenCalledWith('docker stop comq-rmq-' + containerNumber)
-  })
-
-  it('should kill comq-rmq-0 container', async () => {
-    await step.call(context, 'crashed')
-
-    expect(command.execute).toHaveBeenCalledWith('docker kill comq-rmq-' + containerNumber)
-  })
-})
-
-describe('Given one of the brokers is/has {status}', () => {
-  const step = tomato.steps.Gi('one of the brokers is/has {status}')
-
-  it('should store picked broker', async () => {
-    await step.call(context, 'down')
-
-    expect(context.shard).toStrictEqual(expect.any(Number))
-  })
-
-  it('should start one of the containers', async () => {
-    command.execute.mockImplementationOnce(async () => undefined)
-    command.execute.mockImplementationOnce(async () => ({ output: 'healthy' }))
-
-    await step.call(context, 'up')
-
-    expect(command.execute).toHaveBeenCalledWith('docker start comq-rmq-' + context.shard)
-  })
-})

package/features/steps/.test/command.mock.js

@@ -1,5 +0,0 @@
-'use strict'
-
-const execute = jest.fn(async () => undefined)
-
-exports.command = { execute }

package/features/steps/.test/comq.mock.js

@@ -1,10 +0,0 @@
-'use strict'
-
-const io = () => ({
-  diagnose: jest.fn(() => undefined),
-  close: jest.fn(async () => undefined)
-})
-
-const connect = jest.fn(async () => io())
-
-exports.comq = { connect }