comq 0.4.0-dev.7 → 0.4.1-dev.3

package/.github/workflows/release.yaml

@@ -27,6 +27,10 @@ jobs:
       - name: Run tests
         run: npm i && npm test
 
+      - name: Run features
+        if: github.ref == 'refs/heads/main'
+        run: docker-compose up -d && npx cucumber-js --fail-fast --exit --format summary --publish-quiet
+
       - name: Bump version
         run: |
           git config user.name "toabot"
@@ -39,7 +43,7 @@ jobs:
             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"
+            npx lerna@6.5.1 version --conventional-prerelease --preid dev --no-commit-hooks --no-changelog --yes --message "chore(prerelease): %s" --git-tag-command "echo %s"
           fi
 
       - name: Publish packages

package/features/recovery.feature

@@ -87,14 +87,14 @@ Feature: Request-Reply Topology Recovery
     Given the broker is down
     And `logger` consuming events from the `numbers_added` exchange is expected
     When the broker is up
-    And I emit an event to the `numbers_added` exchange
+    And an event is emitted to the `numbers_added` exchange
     Then `logger` receives the event
 
   Scenario: Defining emitter while broker crashed
     Given `someone` consuming events from the `numbers_added` exchange is expected
     And the broker has crashed
     When the broker is up
-    Then I emit an event to the `numbers_added` exchange
+    Then an event is emitted to the `numbers_added` exchange
     And `someone` receives the event
 
   Scenario: Start consuming events while broker is down
@@ -105,5 +105,5 @@ Feature: Request-Reply Topology Recovery
     And `second` consuming events from the `numbers_added` exchange is expected
     When the broker has crashed
     And the broker is up
-    Then I emit an event to the `numbers_added` exchange
+    Then an event is emitted to the `numbers_added` exchange
     And `second` receives the event

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

@@ -125,23 +125,24 @@ 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 = tomato.steps.Th(`the connection is${not} established`)
+describe.each([['', true], [' not', false]])('Then the connection is%s established',
+  (not, connected) => {
+    const step = tomato.steps.Th(`the connection is${not} established`)
 
-  it('should be', async () => undefined)
+    it('should be', async () => undefined)
 
-  it(`should fail if io is${defined ? 'n\'t' : ''} defined`, async () => {
-    context.io = defined ? undefined : generate()
+    it(`should fail if is${connected ? 'n\'t' : ''} connected`, async () => {
+      context.connected = !connected
 
-    await expect(step.call(context)).rejects.toThrow(AssertionError)
-  })
+      await expect(step.call(context)).rejects.toThrow(AssertionError)
+    })
 
-  it(`should pass if io is${defined ? '' : 'n\'t'} defined`, async () => {
-    context.io = defined ? generate() : undefined
+    it(`should pass if is${connected ? '' : 'n\'t'} connected`, async () => {
+      context.connected = connected
 
-    await expect(step.call(context)).resolves.not.toThrow()
+      await expect(step.call(context)).resolves.not.toThrow()
+    })
   })
-})
 
 describe('Then no exceptions are thrown', () => {
   const step = tomato.steps.Th('no exceptions are thrown')

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

@@ -3,5 +3,12 @@
 const { generate } = require('randomstring')
 
 const connect = jest.fn(async () => generate())
+const disconnect = jest.fn(async () => undefined)
 
-exports.context = () => ({ connect })
+/**
+ * @return {jest.MockedObject<comq.features.Context>}
+ */
+exports.context = () => (/** @type {jest.MockedObject<comq.features.Context>} */{
+  connect,
+  disconnect
+})

package/features/steps/.test/context.test.js

@@ -40,21 +40,12 @@ describe('connect', () => {
     expect(comq.connect).toHaveBeenCalledWith('amqp://developer:secret@localhost:5673')
   })
 
-  it('should not connect twice', async () => {
-    await context.connect()
-
-    expect(comq.connect).toHaveBeenCalledTimes(1)
-  })
-
-  it('should reconnect with credentials', async () => {
+  it('should connect with credentials', async () => {
     const user = generate()
     const password = generate()
 
     await context.connect(user, password)
 
-    expect(io.close).toHaveBeenCalled()
-
-    expect(comq.connect).toHaveBeenCalledTimes(2)
     expect(comq.connect).toHaveBeenCalledWith(`amqp://${user}:${password}@localhost:5673`)
   })
 

package/features/steps/.types/context.d.ts

@@ -4,16 +4,17 @@ import * as _io from '../../../types/io'
 declare namespace comq.features {
 
   interface Context {
-    url?: string
     io?: _io.IO
+    connected?: boolean
     reply?: Promise<any>
     consumed?: Record<string, any>
     published?: any
     events?: { [K in _diagnostics.event]?: boolean }
     exception?: Error
-    expected: Promise<any>
+    expected?: Promise<any>
 
     connect(user?: string, password?: string): Promise<void>
+    disconnect(): Promise<void>
   }
 
 }

package/features/steps/connection.js

@@ -51,7 +51,7 @@ Then('the connection is not established',
    * @this {comq.features.Context}
    */
   async function () {
-    assert.equal(this.io, undefined, 'connection is established contrary to expectations')
+    assert.equal(this.connected, false, 'connection is established contrary to expectations')
   })
 
 Then('the connection is established',
@@ -59,9 +59,9 @@ Then('the connection is established',
    * @this {comq.features.Context}
    */
   async function () {
-    if (this.connecting) await this.connecting
+    if (this.connecting !== undefined) await this.connecting
 
-    assert.notEqual(this.io, undefined, 'connection is not established')
+    assert.equal(this.connected, true, 'connection is not established')
   })
 
 Then('no exceptions are thrown',

package/features/steps/context.js

@@ -7,11 +7,8 @@ const { connect } = require('../../')
  * @implements {comq.features.Context}
  */
 class Context extends World {
-  /** @type {comq.IO} */
-  static io
-  static url
-
   io
+  connected = false
   connecting
   reply
   consumed
@@ -23,26 +20,33 @@ class Context extends World {
   async connect (user, password) {
     const url = locator(user, password)
 
-    if (url !== Context.url) await this.#connect(url)
+    await this.#connect(url)
+  }
+
+  async disconnect () {
+    if (this.io === undefined) return
 
-    this.io = Context.io
+    await this.io.close()
 
-    for (const event of EVENTS) this.io.diagnose(event, () => (this.events[event] = true))
+    this.io = undefined
+    this.connected = false
+    this.events = {}
   }
 
+  /**
+   * @param {string} url
+   * @return {Promise<void>}
+   */
   async #connect (url) {
-    if (Context.url !== undefined) await Context.disconnect()
+    if (this.io !== undefined) await this.disconnect()
 
-    Context.url = url
-    Context.io = await connect(url)
-  }
-
-  static async disconnect () {
-    if (Context.io === undefined) return
+    this.io = await connect(url)
+    this.connected = true
 
-    await Context.io.close()
+    for (const event of EVENTS) this.io.diagnose(event, () => (this.events[event] = true))
 
-    Context.io = undefined
+    this.io.diagnose('close', () => (this.connected = false))
+    this.io.diagnose('open', () => (this.connected = true))
   }
 }
 

package/features/steps/hooks.js

@@ -1,12 +1,11 @@
 'use strict'
 
-const { AfterAll } = require('@cucumber/cucumber')
-const { Context } = require('./context')
+const { After } = require('@cucumber/cucumber')
 
-AfterAll(
+After(
   /**
    * @this {comq.features.Context}
    */
   async function () {
-    await Context.disconnect()
+    await this.disconnect()
   })

package/lerna.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "comq",
-  "version": "0.4.0-dev.7",
+  "version": "0.4.1-dev.3",
   "description": "ComQ",
   "author": {
     "name": "Artem Gurtovoi",

package/readme.md

@@ -10,7 +10,7 @@ Node.js.
 3. Events (pub/sub)
 4. Content encoding
 5. Flow control and back pressure handling
-6. Consumer acknowledgements and publisher confirms
+6. Consumer acknowledgments and publisher confirms
 7. Poison message handling
 8. Connection tolerance
 9. Broker restart resilience
@@ -225,7 +225,7 @@ requests and are expecting replies.
   *persistent* ([delivery mode 2](https://www.rabbitmq.com/publishers.html#message-properties)),
   while Requests and Replies are not (mode 1).
 - Events and Requests are consumed using
-  manual [acknowledgment mode](https://www.rabbitmq.com/confirms.html#acknowledgement-modes),
+  manual [acknowledgment mode](https://www.rabbitmq.com/confirms.html#acknowledgment-modes),
   and Replies are consumed using automatic mode.
 
 If incoming message causes an exception, then it is "negative acknowledged" and requeued. If it
@@ -237,13 +237,13 @@ causes an exception again, it will be discarded.
 
 See:
 
-- [Consumer Acknowledgements and Publisher Confirms](https://www.rabbitmq.com/confirms.html).
-- [Negative Acknowledgement and Requeuing of Deliveries](https://www.rabbitmq.com/confirms.html#consumer-nacks-requeue)
+- [Consumer Acknowledgments and Publisher Confirms](https://www.rabbitmq.com/confirms.html).
+- [Negative Acknowledgment and Requeuing of Deliveries](https://www.rabbitmq.com/confirms.html#consumer-nacks-requeue)
 - [Dead Letter Exchanges](https://www.rabbitmq.com/dlx.html)
 
 ### Cheatsheet
 
-| Message | Prefetch  | Confirms | Queue     | Acknowledgement | Persistent |
+| Message | Prefetch  | Confirms | Queue     | Acknowledgment | Persistent |
 |---------|-----------|----------|-----------|-----------------|------------|
 | Request | limited   | no       | durable   | manual          | no         |
 | Reply   | unlimited | no       | exclusive | automatic       | no         |

package/source/channel.js

@@ -211,7 +211,7 @@ class Channel {
     /** @type {import('amqplib').Options.Consume} */
     const options = {}
 
-    if (this.#topology.acknowledgements) consumer = this.#getAcknowledgingConsumer(consumer)
+    if (this.#topology.acknowledgments) consumer = this.#getAcknowledgingConsumer(consumer)
     else options.noAck = true
 
     const response = await this.#channel.consume(queue, consumer, options)
@@ -230,6 +230,8 @@ class Channel {
 
         this.#channel.ack(message)
       } catch (exception) {
+        if (exception.message === 'Channel closed') return // message will be requeued by the broker
+
         if (message.fields.redelivered) this.#discard(message, exception)
         else this.#requeue(message)
       }

package/source/connection.js

@@ -37,7 +37,11 @@ class Connection {
   }
 
   async close () {
-    await this.#connection.close()
+    try {
+      await this.#connection.close()
+    } catch (e) {
+      // connection already closed
+    }
   }
 
   createChannel = failsafe(this, this.#recover,

package/source/presets/event.json

@@ -2,6 +2,6 @@
   "prefetch": 300,
   "confirms": true,
   "durable": true,
-  "acknowledgements": true,
+  "acknowledgments": true,
   "persistent": true
 }

package/source/presets/reply.json

@@ -2,6 +2,6 @@
   "prefetch": 0,
   "confirms": false,
   "durable": false,
-  "acknowledgements": false,
+  "acknowledgments": false,
   "persistent": false
 }

package/source/presets/request.json

@@ -2,6 +2,6 @@
   "prefetch": 300,
   "confirms": false,
   "durable": true,
-  "acknowledgements": true,
+  "acknowledgments": true,
   "persistent": false
 }

package/test/channel.fixtures.js

@@ -6,7 +6,7 @@ const preset = () => ({
   prefetch: random(10),
   confirms: flip(),
   durable: flip(),
-  acknowledgements: flip(),
+  acknowledgments: flip(),
   persistent: flip()
 })
 

package/test/channel.test.js

@@ -92,7 +92,7 @@ describe('consume', () => {
   })
 })
 
-describe('acknowledgements', () => {
+describe('acknowledgments', () => {
   const consumer = /** @type {comq.channel.consumer} */ jest.fn(async () => undefined)
   const queue = generate()
 
@@ -100,7 +100,7 @@ describe('acknowledgements', () => {
     ['', true],
     ['not ', false]
   ])('should %sack incoming messages', async (_, ack) => {
-    topology.acknowledgements = ack
+    topology.acknowledgments = ack
     channel = await create(connection, topology)
     chan = await getCreatedChannel()
 
@@ -119,8 +119,8 @@ describe('acknowledgements', () => {
   it.each([
     ['manual', true],
     ['automatic', false]
-  ])('should create consumer with %s acknowledgements', async (_, ack) => {
-    topology.acknowledgements = ack
+  ])('should create consumer with %s acknowledgments', async (_, ack) => {
+    topology.acknowledgments = ack
     channel = await create(connection, topology)
     chan = await getCreatedChannel()
 
@@ -136,7 +136,7 @@ describe('acknowledgements', () => {
     ['nack', true],
     ['discard', false]
   ])('should %s the message caused an exception', async (_, requeue) => {
-    topology.acknowledgements = true
+    topology.acknowledgments = true
 
     channel = await create(connection, topology)
     chan = await getCreatedChannel()
@@ -157,6 +157,28 @@ describe('acknowledgements', () => {
 
     expect(chan.nack).toHaveBeenCalledWith(message, false, requeue)
   })
+
+  it('should ignore Channel ended exception', async () => {
+    topology.acknowledgments = true
+
+    channel = await create(connection, topology)
+    chan = await getCreatedChannel()
+
+    const consumer = /** @type {Function} */ jest.fn(async () => generate())
+
+    await channel.consume(queue, consumer)
+
+    const callback = chan.consume.mock.calls[0][1]
+    const content = randomBytes(8)
+    const properties = {}
+    const fields = {}
+    const message = /** @type {import('amqplib').ConsumeMessage} */ { content, properties, fields }
+
+    chan.ack.mockImplementation(() => { throw new Error('Channel closed') })
+    chan.nack.mockImplementation(() => { throw new Error('Channel closed') })
+
+    await expect(callback(message)).resolves.not.toThrow()
+  })
 })
 
 describe('send', () => {
@@ -352,10 +374,10 @@ describe.each(['group', 'exclusive'])('%s subscribe', (option) => {
   })
 
   it.each([
-    ['with acknowledgements', true],
-    ['without acknowledgements', false]
+    ['with acknowledgments', true],
+    ['without acknowledgments', false]
   ])('should start consuming %s', async (_, ack) => {
-    topology.acknowledgements = ack
+    topology.acknowledgments = ack
 
     jest.clearAllMocks()
 
@@ -764,7 +786,7 @@ describe('diagnostics', () => {
   ])('should%s emit `discard` event', async (_, redelivered) => {
     jest.clearAllMocks()
 
-    topology.acknowledgements = true
+    topology.acknowledgments = true
     channel = await create(connection, topology)
     chan = await getCreatedChannel()
 

package/test/connection.test.js

@@ -154,13 +154,26 @@ describe('create channel', () => {
   })
 })
 
-it('should close connection', async () => {
-  await connection.open()
-  await connection.close()
+describe('close', () => {
+  it('should close connection', async () => {
+    await connection.open()
+    await connection.close()
+
+    const amqp = await amqplib.connect.mock.results[0].value
+
+    expect(amqp.close).toHaveBeenCalled()
+  })
 
-  const amqp = await amqplib.connect.mock.results[0].value
+  it('should ignore exceptions', async () => {
+    await connection.open()
+
+    /** @type {jest.MockedObject<import('amqplib').Connection>} */
+    const amqp = await amqplib.connect.mock.results[0].value
 
-  expect(amqp.close).toHaveBeenCalled()
+    amqp.close.mockImplementation(async () => { throw new Error() })
+
+    await expect(connection.close()).resolves.not.toThrow()
+  })
 })
 
 describe('diagnostics', () => {

package/test/presets.test.js

@@ -7,7 +7,7 @@ it('should define request preset', async () => {
     prefetch: 300,
     confirms: false,
     durable: true,
-    acknowledgements: true,
+    acknowledgments: true,
     persistent: false
   })
 })
@@ -17,7 +17,7 @@ it('should define reply preset', async () => {
     prefetch: 0,
     confirms: false,
     durable: false,
-    acknowledgements: false,
+    acknowledgments: false,
     persistent: false
   })
 })
@@ -27,7 +27,7 @@ it('should define event preset', async () => {
     prefetch: 300,
     confirms: true,
     durable: true,
-    acknowledgements: true,
+    acknowledgments: true,
     persistent: true
   })
 })

package/types/topology.d.ts

@@ -10,7 +10,7 @@ declare namespace comq {
     prefetch: number
     confirms: boolean
     durable: boolean
-    acknowledgements: boolean
+    acknowledgments: boolean
     persistent: boolean
   }