Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davesag/amqp-simple-pub-sub
A simple Pub Sub system that uses AMQP Messaging to exchange data between services
https://github.com/davesag/amqp-simple-pub-sub
amqp message-queue pubsub
Last synced: 23 days ago
JSON representation
A simple Pub Sub system that uses AMQP Messaging to exchange data between services
- Host: GitHub
- URL: https://github.com/davesag/amqp-simple-pub-sub
- Owner: davesag
- License: mit
- Created: 2018-03-10T13:11:49.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-23T05:55:29.000Z (8 months ago)
- Last Synced: 2024-05-02T00:12:06.365Z (8 months ago)
- Topics: amqp, message-queue, pubsub
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/amqp-simple-pub-sub
- Size: 2.94 MB
- Stars: 20
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# AMQP Simple Pub Sub
A Pub Sub system that uses `AMQP` messaging to exchange data between services.
[](https://nodei.co/npm/amqp-simple-pub-sub/)
## To Use
You project needs to be using at least Node version 10, and ideally Node 18 (LTS) or later.
```sh
npm install amqp-simple-pub-sub
```
### Create a Publisher
```js
const { makePublisher } = require('amqp-simple-pub-sub')
const publisher = makePublisher({ exchange: 'testService' })
```
### Publish a message
```js
await publisher.start()
publisher.publish('test', 'Hello World')
```
### Create a Subscriber
```js
const { makeSubscriber } = require('amqp-simple-pub-sub')
const subscriber = makeSubscriber({
exchange: 'testService',
queueName: 'testQueue',
routingKeys: ['test']
})
```
### Subscribe to a queue and listen for messages
```js
const handler = message => {
console.log('Message Received', message)
subscriber.ack(message)
}
subscriber.start(handler)
```
#### Publisher
The full options object is as follows
```js
{
type: 'topic', // the default
url: 'amqp://localhost', // the default
exchange: 'you must provide this', // it's the name of your service usually
onError: err => { // optional
console.error('A connection error happened', err) // or do something clever
},
onClose: () => { // optional
console.log('The connection has closed.') // or do something clever
},
...otherOptions // anything else you pass in gets passed directly to `amqp.connect`
}
```
#### Subscriber
The full options object is as follows
```js
{
type: 'topic', // the default
url: 'amqp://localhost', // the default
exchange: 'you must provide this', // it's the name of your service usually
queueName: 'you must also provide this', // give your queue a name
routingKeys: ['an', 'array', 'of', 'routingKeys'], // optional. Uses [queueName] otherwise.
onError: err => { // optional
console.error('A connection error happened', err) // or do something clever
},
onClose: () => { // optional
console.log('The connection has closed.') // or do something clever
},
...otherOptions // anything else you pass in gets passed directly to `amqp.connect`
}
```
### Other Options
As outlined above both `createPublisher` and `createPublisher` also accept other options.
These are passed straight onto `amqp.connect` under the hood. The options are:
- `clientProperties`: see [`connect.js`](https://github.com/amqp-node/amqplib/blob/main/lib/connect.js#L30)
- `credentials`
- `keepAlive`
- `keepAliveDelay`
- `noDelay`
- `servername`
- `timeout`
#### Examples
See some examples in the tests, and also:
- [competing-services-example](https://github.com/davesag/competing-services-example)
- And the associated article: [itnext.io/connecting-competing-microservices-using-rabbitmq](https://itnext.io/connecting-competing-microservices-using-rabbitmq-28e5269861b6)
## Related Projects
- [`amqp-delegate`](https://github.com/davesag/amqp-delegate) — A library that simplifies, to the point of triviality, use of AMQP based remote workers.
- [`ampq-event-tester`](https://github.com/davesag/amqp-event-tester) — A Dockerised and configurable utility to help integration-test your AMQP services.
## Development
### Branches
| Branch | Tests | Code Coverage | Audit | Comments |
| ------ | ----- | ------------- | ----- | -------- |
| `develop` | [](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/develop) | [](https://codecov.io/gh/davesag/amqp-simple-pub-sub) | [](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/develop) | Work in progress |
| `main` | [](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/main) | [](https://codecov.io/gh/davesag/amqp-simple-pub-sub) | [](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/main) | Latest release |
### Prerequisites
- [NodeJS](https://nodejs.org), 10.0+ (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
- [Docker](https://www.docker.com) (Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the homebrew version)
### Initialisation
```sh
npm install
```
### To Start the queue server for integration testing
```sh
docker compose up -d
```
Runs Rabbit MQ.
### Test it
- `npm test` — runs the unit tests (quick and does not need `rabbitmq` running)
- `npm run test:unit:cov` — runs the unit tests with code coverage (does not need `rabbitmq`)
- `npm run test:integration` — runs the integration tests (needs `rabbitmq`)
### Lint it
```sh
npm run lint
```
## Contributing
Please see the [contributing notes](CONTRIBUTING.md).