Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LuxChanLu/moleculer-faktory
Moleculer connector to faktory queue management (http://contribsys.com/faktory/)
https://github.com/LuxChanLu/moleculer-faktory
faktory javascript moleculer moleculerjs
Last synced: 3 months ago
JSON representation
Moleculer connector to faktory queue management (http://contribsys.com/faktory/)
- Host: GitHub
- URL: https://github.com/LuxChanLu/moleculer-faktory
- Owner: LuxChanLu
- License: mit
- Created: 2019-04-30T16:42:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T09:22:59.000Z (almost 2 years ago)
- Last Synced: 2024-05-21T12:17:35.407Z (6 months ago)
- Topics: faktory, javascript, moleculer, moleculerjs
- Language: JavaScript
- Homepage:
- Size: 204 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-moleculer - moleculer-faktory - Task queue mixin for [Faktory](https://contribsys.com/faktory/) (Mixins / Tasks, Queues and Jobs)
README
# moleculer-faktory
[](https://travis-ci.org/LuxChanLu/moleculer-faktory)
[](https://coveralls.io/github/LuxChanLu/moleculer-faktory?branch=master)
[](https://www.codacy.com/app/Hugome/moleculer-faktory?utm_source=github.com&utm_medium=referral&utm_content=LuxChanLu/moleculer-faktory&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/LuxChanLu/moleculer-faktory/maintainability)
[](https://david-dm.org/LuxChanLu/moleculer-faktory)
[](https://snyk.io/test/github/LuxChanLu/moleculer-faktory)
[](https://www.npmjs.com/package/moleculer-faktory)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FLuxChanLu%2Fmoleculer-faktory?ref=badge_shield)
## How to use it
### Worker (Service with your jobes)
```js
const { WorkerMixin } = require('moleculer-faktory')
module.exports = {
name: 'images',
mixins: [WorkerMixin],
settings: {
faktory: {
/** @type {String} Faktory url (tcp://:passqueue@localhost:7419/) also FAKTORY_URL can be use. */
url: 'tcp://:passqueue@localhost:7419',
/** @type {Object?} Additional options for `new Worker()` */
options: {
concurrency: 5,
timeout: 25 * 1000
},
/** @type {Array?} Middlewares for faktory */
middlewares: [],
/** @type {Boolean?} Enable hooks middleware */
hooks: true
}
},
actions: {
resize: {
queue: true,
async handler(ctx) {
const { image, size } = ctx.params
const { user } = ctx.meta
// Do the magic here !
}
}
}
}
```
### Client (Service launching jobs)
```js
const { ClientMixin } = require('moleculer-faktory')
module.exports = {
name: 'web',
mixins: [ClientMixin],
settings: {
faktory: {
/** @type {String} Faktory url (tcp://:passqueue@localhost:7419/) also FAKTORY_URL can be use. */
url: 'tcp://:passqueue@localhost:7419',
/** @type {Object?} Additional options for `new Client()` */
options: {
labels: ['test'],
}
}
},
actions: {
async 'image.upload'(ctx) {
ctx.meta.user = {} // Meta will be passed to the job handler
await this.queue(ctx, 'images.resize', { image: ctx.params.image, size: 'landscape.large' })
return 'In progress...'
}
}
}
```
You can also use hooks (No native from faktory, middleware in this module : See src/worker.js#72)
```js
const { ClientMixin } = require('moleculer-faktory')
module.exports = {
name: 'web',
mixins: [ClientMixin],
settings: {
faktory: {
/** @type {String} Faktory url (tcp://:passqueue@localhost:7419/) also FAKTORY_URL can be use. */
url: 'tcp://:passqueue@localhost:7419',
/** @type {Object?} Additional options for `new Client()` */
options: {
labels: ['test'],
}
}
},
actions: {
async 'image.upload'(ctx) {
const { image } = ctx.params
ctx.meta.user = {} // Meta will be passed to the job handler and also the hooks
await this.queue(ctx, 'images.resize', { image: ctx.params.image, size: 'landscape.large' }, {
start: { handler: 'web.image.start' },
end: { handler: 'web.image.end', params: { image } }
})
return 'In progress...'
},
'image.start'() {
// Automagicaly send to the client notification ?
},
'image.end'(ctx) {
const { image } = ctx.params
const { user } = ctx.meta
// Automagicaly send to the client notification ?
}
}
}
```