https://github.com/zaiste/blezer
:confetti_ball: :battery: Simple background job/task processing queue for Node.js (>= 7.6) using `cluster` & separate Node processes.
https://github.com/zaiste/blezer
background-jobs background-worker cluster job job-queue nodejs queue worker worker-queue
Last synced: 4 months ago
JSON representation
:confetti_ball: :battery: Simple background job/task processing queue for Node.js (>= 7.6) using `cluster` & separate Node processes.
- Host: GitHub
- URL: https://github.com/zaiste/blezer
- Owner: zaiste
- Created: 2016-11-21T17:15:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T20:32:29.000Z (about 3 years ago)
- Last Synced: 2025-10-06T15:40:43.657Z (5 months ago)
- Topics: background-jobs, background-worker, cluster, job, job-queue, nodejs, queue, worker, worker-queue
- Language: JavaScript
- Homepage: https://blezer.org
- Size: 602 KB
- Stars: 16
- Watchers: 5
- Forks: 5
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blezer
[](https://www.npmjs.com/package/blezer)
[](https://www.npmjs.com/package/blezer)
Blezer is a simple background job/task processing queue for Node.js (>= 7.6) using `cluster` & separate Node processes, powered by Redis.
## Features
- [x] each worker runs its tasks in a separate Node.js process
- [x] RESTful JSON API
- [x] integrated UI
- [x] logging per job/task
- [ ] delay job/task execution
- [ ] job/task expiry value for being in active state
## Install
npm install -g blezer
## Usage
### Step 1: Create a task
Each job triggers an execution of a *Task* i.e. a recipe what to do for that job. It is defined as a `class` with `perform` method. `Task` corresponds to `Worker` from similar projects such as [resque][1] or [sidekiq][2]. It is named this way to avoid the clash with `cluster` workers.
```js
const { Task } = require('blezer');
class LoopTask extends Task {
perform(args) {
this.log(`Running inside: ${process.pid}`);
this.log(`Args: ${args}`);
let progress = 0;
for (var i = 0; i < 1e10; i++) {
if (i % 1e8 == 0) {
this.log(i)
this.progress(progress, 100);
progress++;
}
}
}
}
module.exports = LoopTask
```
### Step 2: Run the server
Put your tasks in `tasks/` directory and run
blezer start
By default, it checks available number of cores and it instantiates the number of Node processes accordingly. You can specify number of process by hand using `-c` option. Type `blezer start --help` to see all available options.
### Step 3: Enqueue a job
You can enqueue a job to perform given task from a JavaScript application
```js
const { enqueue } = require('blezer');
enqueue('LoopTask', '[1, 2, 3]');
```
By default, the `enqueue` function puts the new job on `default` queue; this can be changed with the `name` parameter from `options`.
```js
enqueue('LoopTask', '[1, 2, 3]', { name: 'high' });
```
A job can be scheduled to run at a specific time using `scheduledAt` parameter.
```js
enqueue('LoopTask', '[1, 2, 3]', { name: 'high', scheduledAt: Date.now() + Sugar.Number.days(4) });
```
It is also possible to enqueue a job through Blezer REST API
http POST :3000/api/enqueue task=LoopTask args='[1,2,3]'
### (optional) Step 4: Check the progress via UI
Go to `localhost:3000` to check the job proegress through Blezer UI.
[1]: https://github.com/resque/resque
[2]: https://github.com/mperham/sidekiq
## Blezer UI
Blezer comes with a built-in web UI that allows to quickly see the status of all jobs. Here's a preview of what it looks like:
### Environments
You can distinguish visually the UI between `staging` and `production` environments by specifying `BLEZER_ENV` variable accordingly. You can set this variable when launching Blezer with `blezer start` e.g.
```
BLEZER_ENV=production blezer start
```
It will add a small color bar at the top to help you identify at a glance which UI instance you are currently using.
---
## Concepts
### Queues
*Queue* is a list of *Job* items, stored so as to be retrievable and handled in the order of insertion. You can create a *Queue* by giving it a name. This is a lower level API which usually shouldn't be used directly - it's advised to use `enqueue` helper.
```js
const { Queue } = require('blezer');
const highQueue = new Queue('high');
```
### Logging
You can log on per job/task basis by using `this.log(message)` method, where `message` is an object or a string.
```
this.log("This is my log message");
this.log({ a: 1, b: 2});
```
### Create tasks from CLI
You can create a task in `tasks` using CLI
```
blezer create foo
```
This command will create `FooTask.js` task in `tasks/` directory.
## Roadmap
Blezer keeps track of the upcoming fixes and features on GitHub Projects: [Blezer Roadmap](https://github.com/zaiste/blezer/projects/1)
## Bug reports
We use *Github Issues* for managing bug reports and feature requests. If you run
into problems, please search the *issues* or submit a new one here:
https://github.com/zaiste/blezer/issues
Detailed bug reports are always great; it's event better if you are able to
include test cases.
## Roadmap
- [ ] visualisation with Clui https://github.com/nathanpeck/clui
## Contributing
- run the code through `prettier`