feat: Switch from Jackrabbit to Rabbot #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
beeman
suggested changes
Jan 16, 2017
| @@ -6,6 +6,8 @@ machine: | |||
| pre: | |||
| # Stop rabbitmq that comes with circle by default. | |||
| - sudo service rabbitmq-server stop | |||
| environment: | |||
| DEBUG: loopback:componenet:mq,rabbot* | |||
|
|
||
| This component provides a convenient way to work with a RabbitMQ within a loopback application. This includes: | ||
|
|
||
| - Defining a RabbitMQ topology using the componenet-config.json |
|
|
||
| // Wait the app to be booted | ||
| app.once('booted', () => { | ||
| debug('initializing message queue componenet with settings: %o', settings) |
| Inside this queue definition you can define a `consumer`, a `producer`, or both. The `consumer` and `producer` objects | ||
| both accept 2 properties, `model` and `method`. | ||
| ```bash | ||
| DEBUG=loopback:componenet:mq npm run dev |
|
|
||
| - Add support for more types of Queues in the topology | ||
| ```bash | ||
| DEBUG=loopback:componenet:mq npm test |
| const loopback = require('loopback') | ||
| const url = require('url') | ||
| const rabbit = require('rabbot') | ||
| const queueDef = require('./models/rabbitmq.json') |
There was a problem hiding this comment.
I think modelDef makes more sense here as it's not the definition of a queue but a model.
| "name": "RabbitMQ", | ||
| "plural": "RabbitMQ", | ||
| "base": "Model", | ||
| "description": "Provide access to data about the queues and the rabbitmq server." |
There was a problem hiding this comment.
Let's change the description: Provide access to the queues and the RabbitMQ server.. It says the same and make it fit on 1 line in the explorer.
| ## Installation | ||
| # Overview | ||
|
|
||
| This component provides a convenient way to work with a RabbitMQ within a loopback application. This includes: |
There was a problem hiding this comment.
with a RabbitMQ => with RabbitMQ or with a RabbitMQ server
| - Defining a RabbitMQ topology using the componenet-config.json | ||
| - Registering message producers and consumers handlers using a mixin. | ||
| - Inspecting RabbitMQ stats and queue statuses using a RabbitMQ loopback model. | ||
|
|
There was a problem hiding this comment.
I think we should mention why this package provides both a component and a mixin. Just one or two lines that explains the design choice for having both.
BREAKING CHANGE: Switch from Jackrabbit to Rabbot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE: Switch from Jackrabbit to Rabbot