comq 0.4.0-dev.0 → 0.4.0-dev.5

package/.github/workflows/release.yaml

@@ -0,0 +1,53 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+      - dev
+
+jobs:
+  publish:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Run tests
+        run: npm i && npm test
+
+      - name: Bump version
+        run: |
+          git config user.name "toabot"
+          git config user.email "127577558+toabot@users.noreply.github.com"
+          
+          if [ ${{ github.base_ref }} = main ]; then
+            npx lerna@6.5.1 version --conventional-graduate --no-commit-hooks --no-changelog --yes --message "chore(release): %s"
+            git fetch
+            git checkout dev
+            git merge main
+            git push --all origin --no-verify
+          else
+            npx lerna@6.5.1 version --conventional-prerelease --preid dev --no-commit-hooks --no-changelog --yes --message "chore(prerelease): %s"
+          fi
+
+      - name: Publish packages
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          if [ ${{ github.base_ref }} = main ]; then
+            npm publish
+          else
+            npm publish --tag dev
+          fi

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Toa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs/notes.md

@@ -21,7 +21,7 @@ The current message is acknowledged once the Producer function is completed, whi
 considered to be published when a confirmation is received from the broker.
 
 In summary, the next "cause" message will be consumed from the queue only after the "effect" message
-publication has been confirmed. Due to the ["at least once" effect](#-at-least-once-), *there is a
+publication has been confirmed. Due to the "at least once" effect, *there is a
 delay between the moment when a Reply **is delivered** to the Consumer and the moment when the
 next Request is consumed from the Request queue*.
 

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

@@ -3,11 +3,11 @@
 const { AssertionError } = require('node:assert')
 const { generate } = require('randomstring')
 const { random, quantity } = require('@toa.io/generic')
-const { gherkin } = require('@toa.io/mock')
+const tomato = require('@toa.io/tomato')
 const { io } = require('./io.mock')
-const mock = { gherkin }
+const mock = { tomato }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 
 require('../backpressure')
 
@@ -15,7 +15,7 @@ require('../backpressure')
 let context
 
 describe('When I\'m sending {quantity}B requests to the {token} queue at {quantity}Hz for {number} second(s)', () => {
-  const step = gherkin.steps.Wh('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)
 
@@ -59,7 +59,7 @@ describe('When I\'m sending {quantity}B requests to the {token} queue at {quanti
 })
 
 describe('Then back pressure was applied', () => {
-  const step = gherkin.steps.Th('back pressure was applied')
+  const step = tomato.steps.Th('back pressure was applied')
 
   beforeEach(() => {
     context = /** @type {comq.features.Context} */ { io }

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

@@ -1,11 +1,11 @@
 'use strict'
 
 const { generate } = require('randomstring')
-const { gherkin } = require('@toa.io/mock')
+const tomato = require('@toa.io/tomato')
 const { command } = require('./command.mock')
-const mock = { gherkin, command }
+const mock = { tomato, command }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 jest.mock('@toa.io/command', () => mock.command)
 
 jest.setTimeout(10000)
@@ -19,7 +19,7 @@ beforeEach(() => {
 })
 
 describe('the broker is/has {status}', () => {
-  const step = gherkin.steps.Gi('the broker is/has {status}')
+  const step = tomato.steps.Gi('the broker is/has {status}')
 
   it('should be', async () => undefined)
 

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

@@ -1,7 +1,5 @@
 'use strict'
 
-const { generate } = require('randomstring')
-
 const io = () => ({
   diagnose: jest.fn(() => undefined),
   close: jest.fn(async () => undefined)

package/features/steps/.test/connection.test.js

@@ -3,12 +3,12 @@
 const { AssertionError } = require('node:assert')
 const { generate } = require('randomstring')
 const { random, promex } = require('@toa.io/generic')
-const { gherkin } = require('@toa.io/mock')
+const tomato = require('@toa.io/tomato')
 const { comq } = require('./comq.mock')
 const world = require('./context.mock')
-const mock = { gherkin, comq }
+const mock = { tomato, comq }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 jest.mock('comq', () => mock.comq)
 
 require('../connection')
@@ -23,7 +23,7 @@ beforeEach(() => {
 })
 
 describe('Given an active connection to the broker', () => {
-  const step = gherkin.steps.Gi('an active connection to the broker')
+  const step = tomato.steps.Gi('an active connection to the broker')
 
   it('should be', async () => undefined)
 
@@ -37,7 +37,7 @@ describe('Given an active connection to the broker', () => {
 })
 
 describe('When I attempt to connect to the broker for {number} second(s)', () => {
-  const step = gherkin.steps.Wh('I attempt to connect to the broker for {number} second(s)')
+  const step = tomato.steps.Wh('I attempt to connect to the broker for {number} second(s)')
 
   it('should be', async () => undefined)
 
@@ -89,7 +89,7 @@ describe('When I attempt to connect to the broker for {number} second(s)', () =>
 })
 
 describe('When I attempt to connect to the broker', () => {
-  const step = gherkin.steps.Wh('I attempt to connect to the broker')
+  const step = tomato.steps.Wh('I attempt to connect to the broker')
 
   it('should be', async () => undefined)
 
@@ -111,7 +111,7 @@ describe('When I attempt to connect to the broker', () => {
 })
 
 describe('When I attempt to connect to the broker as {string} with password {string}', () => {
-  const step = gherkin.steps.Wh('I attempt to connect to the broker as {string} with password {string}')
+  const step = tomato.steps.Wh('I attempt to connect to the broker as {string} with password {string}')
 
   it('should be', async () => undefined)
 
@@ -126,7 +126,7 @@ describe('When I attempt to connect to the broker as {string} with password {str
 })
 
 describe.each([['', true], [' not', false]])('Then the connection is%s established', (not, defined) => {
-  const step = gherkin.steps.Th(`the connection is${not} established`)
+  const step = tomato.steps.Th(`the connection is${not} established`)
 
   it('should be', async () => undefined)
 
@@ -144,7 +144,7 @@ describe.each([['', true], [' not', false]])('Then the connection is%s establish
 })
 
 describe('Then no exceptions are thrown', () => {
-  const step = gherkin.steps.Th('no exceptions are thrown')
+  const step = tomato.steps.Th('no exceptions are thrown')
 
   it('should be', async () => undefined)
 
@@ -160,7 +160,7 @@ describe('Then no exceptions are thrown', () => {
 })
 
 describe('Then an exception is thrown: {string}', () => {
-  const step = gherkin.steps.Th('an exception is thrown: {string}')
+  const step = tomato.steps.Th('an exception is thrown: {string}')
 
   const message = generate()
 

package/features/steps/.test/events.test.js

@@ -3,11 +3,11 @@
 const { AssertionError } = require('node:assert')
 const { generate } = require('randomstring')
 const { promex } = require('@toa.io/generic')
-const { gherkin } = require('@toa.io/mock')
+const tomato = require('@toa.io/tomato')
 const { io } = require('./io.mock')
-const mock = { gherkin }
+const mock = { tomato }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 
 require('../events')
 
@@ -21,7 +21,7 @@ beforeEach(() => {
 })
 
 describe('Given (that ){token} is consuming events from the {token} exchange', () => {
-  const step = gherkin.steps.Gi('(that ){token} is consuming events from the {token} exchange')
+  const step = tomato.steps.Gi('(that ){token} is consuming events from the {token} exchange')
 
   it('should be', async () => undefined)
 
@@ -52,13 +52,13 @@ describe('Given (that ){token} is consuming events from the {token} exchange', (
 })
 
 describe('Given {token} consuming events from the {token} exchange is expected', () => {
-  const step = gherkin.steps.Gi('{token} consuming events from the {token} exchange is expected')
+  tomato.steps.Gi('{token} consuming events from the {token} exchange is expected')
 
   it('should be', async () => undefined)
 })
 
 describe('When I emit an event to the {token} exchange', () => {
-  const step = gherkin.steps.Wh('I emit an event to the {token} exchange')
+  const step = tomato.steps.Wh('I emit an event to the {token} exchange')
 
   it('should be', async () => undefined)
 
@@ -98,7 +98,7 @@ describe('When I emit an event to the {token} exchange', () => {
 })
 
 describe('Then {token} receives the event', () => {
-  const step = gherkin.steps.Th('{token} receives the event')
+  const step = tomato.steps.Th('{token} receives the event')
 
   const payload = generate()
   const group = generate()

package/features/steps/.test/poison.test.js

@@ -1,10 +1,10 @@
 'use strict'
 
 const { AssertionError } = require('node:assert')
-const { gherkin } = require('@toa.io/mock')
-const mock = { gherkin }
+const tomato = require('@toa.io/tomato')
+const mock = { tomato }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 
 require('../poison')
 
@@ -16,7 +16,7 @@ beforeEach(() => {
 })
 
 describe('Then the message is discarded', () => {
-  const step = gherkin.steps.Th('the message is discarded')
+  const step = tomato.steps.Th('the message is discarded')
 
   it('should be', async () => undefined)
 

package/features/steps/.test/rpc.test.js

@@ -4,11 +4,11 @@ const { AssertionError } = require('node:assert')
 const { generate } = require('randomstring')
 const { promex } = require('@toa.io/generic')
 const { dump } = require('@toa.io/yaml')
-const { gherkin } = require('@toa.io/mock')
+const tomato = require('@toa.io/tomato')
 const { io } = require('./io.mock')
-const mock = { gherkin }
+const mock = { tomato }
 
-jest.mock('@cucumber/cucumber', () => mock.gherkin)
+jest.mock('@cucumber/cucumber', () => mock.tomato)
 
 require('../rpc')
 
@@ -24,7 +24,7 @@ beforeEach(() => {
 })
 
 describe('Given function replying {token} queue:', () => {
-  const step = gherkin.steps.Gi('function replying {token} queue:')
+  const step = tomato.steps.Gi('function replying {token} queue:')
 
   it('should be', () => undefined)
 
@@ -43,13 +43,13 @@ describe('Given function replying {token} queue:', () => {
 })
 
 describe('Given function replying {token} queue is expected:', () => {
-  gherkin.steps.Gi('function replying {token} queue is expected:')
+  tomato.steps.Gi('function replying {token} queue is expected:')
 
   it('should be', () => undefined)
 })
 
 describe('When the consumer sends the following request to the {token} queue:', () => {
-  const step = gherkin.steps.Wh('the consumer sends the following request to the {token} queue:')
+  const step = tomato.steps.Wh('the consumer sends the following request to the {token} queue:')
 
   it('should be', async () => undefined)
 
@@ -90,7 +90,7 @@ describe('When the consumer sends the following request to the {token} queue:',
 })
 
 describe('When the consumer sends a request to the {token} queue', () => {
-  const step = gherkin.steps.Wh('the consumer sends a request to the {token} queue')
+  const step = tomato.steps.Wh('the consumer sends a request to the {token} queue')
 
   it('should be', async () => undefined)
 
@@ -102,7 +102,7 @@ describe('When the consumer sends a request to the {token} queue', () => {
 })
 
 describe('Then the consumer receives the reply:', () => {
-  const step = gherkin.steps.Th('the consumer receives the reply:')
+  const step = tomato.steps.Th('the consumer receives the reply:')
 
   it('should be', async () => undefined)
 
@@ -141,7 +141,7 @@ describe('Then the consumer receives the reply:', () => {
 })
 
 describe('Then the consumer does not receive the reply', () => {
-  const step = gherkin.steps.Th('the consumer does not receive the reply')
+  const step = tomato.steps.Th('the consumer does not receive the reply')
 
   it('should be', async () => undefined)
 

package/features/steps/broker.js

@@ -15,7 +15,7 @@ Given('the broker is/has {status}',
   })
 
 const actions = {
-  up: async (context) => {
+  up: async () => {
     await execute('docker start comq-rmq')
     await healthy()
   },

package/features/steps/context.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { World } = require('@cucumber/cucumber')
-const { connect } = require('comq')
+const { connect } = require('../../')
 
 /**
  * @implements {comq.features.Context}

package/lerna.json

@@ -0,0 +1,5 @@
+{
+  "useWorkspaces": true,
+  "version": "0.4.0-dev.0",
+  "conventionalCommits": true
+}

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "comq",
-  "version": "0.4.0-dev.0",
+  "version": "0.4.0-dev.5",
   "description": "ComQ",
-  "homepage": "https://toa.io",
   "author": {
     "name": "Artem Gurtovoi",
     "url": "https://github.com/temich"
@@ -10,10 +9,10 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/toa-io/toa.git"
+    "url": "git+https://github.com/toa-io/comq.git"
   },
   "bugs": {
-    "url": "https://github.com/toa-io/toa/issues"
+    "url": "https://github.com/toa-io/comq/issues"
   },
   "engines": {
     "node": ">= 12.0.0"
@@ -24,13 +23,36 @@
   "main": "source/index.js",
   "types": "types/index.d.ts",
   "devDependencies": {
-    "@toa.io/command": "0.4.0-dev.0",
-    "@toa.io/mock": "0.4.0-dev.0",
-    "@toa.io/yaml": "0.4.0-dev.0"
+    "@cucumber/cucumber": "9.0.0",
+    "@toa.io/command": "0.3.0",
+    "@toa.io/mock": "0.3.0",
+    "@toa.io/tomato": "0.4.0-dev.2",
+    "@toa.io/yaml": "0.4.0-dev.2",
+    "@types/amqplib": "0.10.1",
+    "@types/jest": "29.4.2",
+    "husky": "8.0.3",
+    "jest": "29.5.0",
+    "randomstring": "1.2.3",
+    "snazzy": "9.0.0",
+    "standard": "17.0.0"
   },
   "dependencies": {
-    "@toa.io/generic": "0.4.0-dev.0",
+    "@toa.io/generic": "0.3.0",
     "amqplib": "0.10.3",
     "msgpackr": "1.8.5"
-  }
+  },
+  "scripts": {
+    "prepare": "husky install",
+    "test": "npm run lint && jest",
+    "test:features": "npx cucumber-js",
+    "lint": "npx standard --verbose | npx snazzy"
+  },
+  "standard": {
+    "env": [
+      "jest"
+    ]
+  },
+  "workspaces": [
+    "."
+  ]
 }

package/readme.md

@@ -51,7 +51,8 @@ await io.close()
 
 The following documentation refers to a few terms:
 
-**Request** is an AMQP message that has the `replyTo` and `correlationId` properties set.
+**Request** is an AMQP message that is sent to a queue and has the `replyTo` and `correlationId`
+properties set.
 
 **Reply** is an AMQP message sent in response to a Request and sent to the queue specified in
 the `replyTo` property of the Request. The `correlationId` property of the Reply is set to the same
@@ -93,7 +94,7 @@ await io.reply('add_numbers', ({ a, b }) => (a + b))
 
 ## Request
 
-`async IO.request(queue: string, payload: any, [encoding: string])`
+`async IO.request(queue: string, payload: any, [encoding: string, replyTo: string])`
 
 Send encoded Request message with `replyTo` and `correlationId` properties set and
 return decoded Reply content.

package/source/io.js

@@ -61,13 +61,16 @@ class IO {
        * @param {string} queue
        * @param {any} payload
        * @param {comq.encoding} [encoding]
+       * @param {string} replyTo
        * @returns {Promise<void>}
        */
-      async (queue, payload, encoding) => {
+      async (queue, payload, encoding, replyTo) => {
         const [buffer, contentType] = this.#encode(payload, encoding)
         const correlationId = randomBytes(8).toString('hex')
         const emitter = this.#emitters[queue]
-        const replyTo = emitter.queue
+
+        replyTo ??= emitter.queue
+
         const properties = { contentType, correlationId, replyTo }
         const reply = this.#createReply()
 

package/test/io.close.test.js

@@ -1,11 +1,11 @@
 'use strict'
 
+const { randomBytes } = require('node:crypto')
 const { generate } = require('randomstring')
 const { promex, immediate } = require('@toa.io/generic')
 
 const mock = require('./connection.mock')
 const { IO } = require('../source/io')
-const { randomBytes } = require('crypto')
 
 /** @type {comq.IO} */
 let io

package/test/io.reply.test.js

@@ -29,7 +29,7 @@ const produce = jest.fn(async () => generate())
 
 // endregion
 
-describe('channels', (type) => {
+describe('channels', () => {
   it('should create request-reply channels', async () => {
     await io.reply(queue, produce)
 

package/test/io.request.test.js

@@ -43,6 +43,8 @@ let promise
 const REPLY = new RegExp(`^${queue}..[0-9a-f]+$`)
 
 beforeEach(async () => {
+  jest.clearAllMocks()
+
   promise = io.request(queue, payload)
 
   // allows initializers to run
@@ -81,11 +83,36 @@ describe('send', () => {
     expect(typeof properties.correlationId).toStrictEqual('string')
   })
 
-  it('should set replyTo', async () => {
-    const request = call[2]
+  it('should set default replyTo', async () => {
+    const properties = call[2]
+    const rx = new RegExp(`^${queue}..[a-z0-9]+`)
+
+    expect(properties.replyTo).toMatch(rx)
+  })
+
+  it('should set specified replyTo', async () => {
+    jest.clearAllMocks()
+
+    /** @type {comq.encoding} */
+    const encoding = 'application/json'
+    const replyTo = generate()
+
+    promise = io.request(queue, payload, encoding, replyTo)
+
+    await immediate()
+
+    call = requests.send.mock.calls[0]
+
+    const properties = requests.send.mock.calls[0][2]
+
+    expect(properties.replyTo).toStrictEqual(replyTo)
+  })
+
+  it('should consume replyTo', async () => {
+    const properties = call[2]
     const queue = replies.consume.mock.calls[0][0]
 
-    expect(request.replyTo).toStrictEqual(queue)
+    expect(properties.replyTo).toStrictEqual(queue)
   })
 
   it('should encode message with msgpack by default', async () => {

package/types/io.d.ts

@@ -19,7 +19,7 @@ declare namespace comq {
   interface IO {
     reply(queue: string, produce: producer): Promise<void>
 
-    request(queue: string, payload: any, encoding?: _encoding.encoding): Promise<any>
+    request(queue: string, payload: any, encoding?: _encoding.encoding, replyTo?: string): Promise<any>
 
     consume(exchange: string, group: string, consumer: consumer): Promise<void>