mkls / mock-amqplib Goto Github PK

the function assertExchange should return an AssertExchange type:
https://amqp-node.github.io/amqplib/channel_api.html#channel_assertExchange

 assertExchange(exchange: string, type: 'direct' | 'topic' | 'headers' | 'fanout' | 'match' | string, options?: Options.AssertExchange): Promise<Replies.AssertExchange>;

    interface AssertExchange {
        exchange: string;
    }

Hello folks! I hope you are doing well. 👋 😃

I'm currently working on a project that uses this awesome lib to mock the amqp connection and the amqplib instance. 🚀
Today, we've added an exchange layer because some messages must be delayed before being consumed by the consumers. Here's an example of how we are setting things up:

const connection = amqplib.connect('amqp://localhost')
const channel = connection.createChannel()

const queue = 'my-queue'
const exchange = `my-exchange-${queue}`
const binding = `${queue}-exchange-binding`

channel.assertExchange(exchange, 'x-delayed-message', {
  durable: true,
  arguments: { 'x-delayed-type': 'direct' },
})
channel.assertQueue(queue, { durable: true })
channel.bindQueue(queue, exchange, binding)

Here's our jest-setup file:

beforeAll(() => {
  amqplib.connect = mockAmqplib.connect
})

When we try to run the tests we receive the following error:

TypeError: Cannot read properties of undefined (reading 'bindQueue')
        at Object.bindQueue (/path/to/node_modules/mock-amqplib/src/main.js:119:14)

That happens because on the assertExchange mock it doesn't match to any type so the exchange is undefined.

// main.js:100

assertExchange: async (exchangeName, type) => {
  let exchange;

  switch(type) {
    case 'fanout':
      exchange = createFanoutExchange();
      break;
    case 'direct':
      exchange = createDirectExchange();
      break;
    case 'headers':
      exchange = createHeadersExchange();
      break;
  }

  exchanges[exchangeName] = exchange;
},

We did some tests using the same exchange as the case direct and it worked fine. So, my suggestion is to add x-delayed-message as the same as direct. We're going to have:

// main.js:100

assertExchange: async (exchangeName, type) => {
  let exchange;

  switch(type) {
    case 'fanout':
      exchange = createFanoutExchange();
      break;
    case 'direct':
    case 'x-delayed-message':
      exchange = createDirectExchange();
      break;
    case 'headers':
      exchange = createHeadersExchange();
      break;
  }

  exchanges[exchangeName] = exchange;
},

We're using the following versions of the libs:

• amqplib: "^0.8.0"
• mock-amqplib: "^1.4.0"

What do you folks think about that? Let me know if you have any questions.

Could you please add support for this method on Channel?

checkExchange(exchange: string): Promise<Replies.Empty>;

Thanks

Is there a way to test a callback on channel.consume?

1- create an exchange (topic, direct, header...)
2- create a queue and bind it with a binding key
3- publish a message to the exchange, using a routing key that does not match any binding key and the exchange binding logic.

it generates this error:

TypeError: Cannot read property 'targetQueue' of undefined
at Object.getTargetQueues .../node_modules/mock-amqplib/src/main.js:57:31) // for direct, similar error for others.

It should instead check the mandatory property of the message, and handle the logic described here: https://www.rabbitmq.com/publishers.html
In the meantime a more friendly error message would help :)

Could you please support topic exchanges? assertExchange() with a topic exchange yields an unassigned exchange.