techteamer / mq

A RabbitMQ wrapper for node

TechTeamer MQ

A RabbitMQ wrapper for node

Install

yarn add @techteamer/mq

Build

yarn run build

Tests

To run tests you need to rename test/config/TestConfig.js.config to TestConfig.js and provide valid configurations.

Then run:

yarn test

Publish

Before publish always run the build process! This will create the dist folder, which will be needed in the published package.

mq's Issues

Feature request: binary data transfer

Now its not efficient to push through a large amount of binary data through QueueMessage.

As you can see there the whole message sent through RabbitMQ has been stringified and later processed through json decoder. If you push a binary trough now it will convert the data to an json array of bytes, which is unefficient to encode and decode.

A better solution is to hanlde QueueMessage as binary.

QueueMessage needs serialization methods:

• QueueMessage.serialize gives back a Buffer (which should sent through RabbitMQ)
• static QueueMessage.unserialze(Buffer) returns a new QueueMessage instance. (how a buffer got through RabbitMQ should be processed)

QueueMessage needs new api to handle binary:

• addAttachment(name, buffer)
• getAttachments() returns a Map of [name, buffer] pairs.
• new this.attachments = new Map() property which will hold the attachments

serialize should work as:

• first byte should be a "+" character representing the new schema (see BC later)
• the next four bytes should be handled as integer contains the length of the json part
• the json content should be the same as now with a new property called attachments which contains the names of attachments and instead of the binary buffer, it should contains the length of the buffer
• attachments in binary form

unserialize:

• detect the new format (otherwise handle as an old message)
• extract the length of json content
• calculate the json start and end position - and process it
• calculate and populate the attachments array

Performance considerations: use Buffer.from for attachments and Buffer.toString('utf-8', start, end) for extracting json

backward compatibility:
At unserialization the first character of the buffer:

• "+" represents the new format
• "{" represents the old format which should be handled as before

TODO:

• test for buffer length consistency
• tests with random generated big (100MB) attachments

The automated release is failing 🚨

🚨 The automated release from the beta branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the beta branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀