Skip to content

Latest commit

 

History

History
200 lines (153 loc) · 5.38 KB

README.md

File metadata and controls

200 lines (153 loc) · 5.38 KB
Raw

tsed-bee-queue

Bee-queue for Ts.ED framework

Goals

This provides Redis-based job queueing services built on top of Bee-queue for use with Ts.ED framework. With some little configurations you can have your web service running as a queue system that handle different jobs as you define.

!! IMPORTANT NOTE !!

bee-queue does not seem to be actively maintained no more. It does NOT support redis v4 and up. So to use this lib it is highly recommended to use tsed-redis with ioredis or you need to handle redis instance yourself.

I also had to modify some bee-queue code here to make it work properly with ioredis.

Installation

npm install tsed-bee-queue tsed-redis ioredis
// or yarn
yarn add tsed-bee-queue tsed-redis ioredis

Getting started

Your application code structure could look like this:

.
├── ...
├── src -- TypeScript source
│   ├── controllers
│   ├── models
│   ├── queues -- Add this directory to store all of your jobs
│   │   ├── FooQueue.ts
│   │   ├── BarQueue.ts
│   │   └── index.ts -- Use barrelsby to generate index
│   ├── ...
│   ├── index.ts
│   └── Server.ts
├── package.json
├── tsconfig.json 
├── tsconfig.compile.json 
└── ...

(Optional) Use barrelsby to generate index

Add "./src/queues" to directory in .barrelsby.json

Create your jobs

import {Job} from "bee-queue";
import {Queue, QueueProvider} from "tsed-bee-queue";

@Queue({name: "foo", concurrency: 2})
export class FooQueue implements QueueProvider {

  $exec(job: Job<any>) {
    // do something
    // MUST return Promise
    return Promise.resolve();
  }

  // or with callback
  // $exec(job: Job<any>, done: DoneCallBack<any>) {
  //   // do something then call
  //   done(error, result);
  // }

}

Server configuration

You can do this in different ways, below is an example in Server.ts:

import {Configuration} from "@tsed/di";
import "tsed-redis"; // recommended as it use DI factory for Redis client to avoid creating many connections
import "tsed-bee-queue";
import "./queues"; // required
...

@Configuration({
  ...
  // refer to `tsed-redis` for configuration
  redis: {
    host: "localhost",
    port: 6379,
    ...
  },
  queue: {
    redis: "default", // redis connection
    getEvents: false, // see bee-queue configurations
    ...
  }
})
export class Server {
  ...
}

Usage

To create and send job

import {Controller, Get, Inject} from "@tsed/common";
import {QueueService} from "tsed-bee-queue";

@Controller("/foo")
export class FooController {
  @Inject()
  readonly queueService: QueueService;

  @Inject()
  readonly logger: Logger;

  @Get("/new")
  async index() {
    const queue = this.queueService.get("foo"); // name of the job queue
    await queue.createJob({hello: "world"}).save();
  }
}

This job will be sent to queue and handled by FooQueue. This doesn't have to be in the same application. You can send job from different apps as well.

Queue monitoring

This library also supports monitoring your queues using bee-queue/arena.

Usage

In Server.ts:

import {Configuration} from "@tsed/di";
import "tsed-redis";
import "tsed-bee-queue";
import "./queues";
import {ArenaMiddleware} from "tsed-bee-queue";

...
@Configuration({
  ...
  queue: {
    providers,
    arena: {
      enabled: true,
      basePath: "/arena",
      disableListen: true // to run it on your running server or you can set a different host/port to run another separate server
    }
  }
})
export class Server {
  $afterRoutesInit(): void {
    this.app.all("/arena*", ArenaMiddleware); // route all requests to Arena middleware
  }
}

Todos

  • Ts.ED CLI plugin to have some CLI commands to generate jobs and some other tasks
  • More instructions to use job events

Credits

License

MIT License

Copyright (c) 2021-2024 Alex Do

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.