redis-smq-common 1.0.0-rc.0 → 1.0.0-rc.3

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 # CHANGELOG
 
-## 1.0.0-rc.0 (2022-05-24)
+## 1.0.0-rc.3 (2022-05-26)
+
+* Update README.md
+* Refactor and clean up Worker and WorkerRunner classes
+
+## 1.0.0-rc.2 (2022-05-25)
+
+* Allow children of Worker class to access worker params
+
+## 1.0.0-rc.1 (2022-05-24)
 
 * Update package keywords and description
 * Use codecov instead of coveralls

package/README.md

@@ -1,15 +1,16 @@
 <div align="center" style="text-align: center">
   <p><a href="https://github.com/weyoss/redis-smq-common"><img alt="RedisSMQ" src="./logo.png" /></a></p>
   <p>A simple high-performance Redis message queue for Node.js.</p>
-  <p>
-    <a href="https://github.com/weyoss/redis-smq-common/actions/workflows/tests.yml"><img src="https://github.com/weyoss/redis-smq-common/actions/workflows/tests.yml/badge.svg" alt="Tests" style="max-width:100%;" /></a>
-    <a href="https://codecov.io/github/weyoss/redis-smq-common?branch=master" rel="nofollow"><img src="https://img.shields.io/codecov/c/github/weyoss/redis-smq-common" alt="Coverage Status" /></a>
-    <a href="https://lgtm.com/projects/g/weyoss/redis-smq-common/context:javascript" rel="nofollow"><img src="https://img.shields.io/lgtm/grade/javascript/github/weyoss/redis-smq-common.svg?logo=lgtm&logoWidth=18" alt="Code quality" /></a>
-  </p>
 </div>
 
 ## RedisSMQ Common Library
 
+<p>
+    <a href="https://github.com/weyoss/redis-smq-common/actions/workflows/tests.yml"><img src="https://github.com/weyoss/redis-smq-common/actions/workflows/tests.yml/badge.svg" alt="Tests" style="max-width:100%;" /></a>
+    <a href="https://codecov.io/github/weyoss/redis-smq-common?branch=master" rel="nofollow"><img src="https://img.shields.io/codecov/c/github/weyoss/redis-smq-common" alt="Coverage Status" /></a>
+    <a href="https://lgtm.com/projects/g/weyoss/redis-smq-common/context:javascript" rel="nofollow"><img src="https://img.shields.io/lgtm/grade/javascript/github/weyoss/redis-smq-common.svg?logo=lgtm&logoWidth=18" alt="Code quality" /></a>
+</p>
+
 [RedisSMQ](https://github.com/weyoss/redis-smq) shared components that may be used by integrated applications and extensions.
 
 ## License

package/dist/src/worker/worker-runner/worker-runner.d.ts

@@ -1,25 +1,22 @@
 /// <reference types="node" />
-import { ICallback, ICompatibleLogger, TWorkerParameters } from '../../../types';
+import { ICallback, ICompatibleLogger } from '../../../types';
 import { EventEmitter } from 'events';
 import { RedisClient } from '../../redis-client/redis-client';
 import { WorkerPool } from './worker-pool';
-export declare class WorkerRunner<WorkerParameters extends TWorkerParameters = TWorkerParameters> extends EventEmitter {
-    private readonly workersDir;
-    private readonly workerParameters;
+import { Worker } from '../worker';
+export declare class WorkerRunner extends EventEmitter {
     private readonly powerManager;
     private readonly ticker;
     private readonly lockManager;
     private readonly redisClient;
     private readonly logger;
     private readonly workerPool;
-    constructor(redisClient: RedisClient, workersDir: string, keyLock: string, workerParameters: WorkerParameters, workerPool: WorkerPool, logger: ICompatibleLogger);
+    constructor(redisClient: RedisClient, keyLock: string, workerPool: WorkerPool, logger: ICompatibleLogger);
     private onTick;
-    private init;
-    private addToWorkerPool;
-    private createWorkerInstance;
     private clearWorkerPool;
     private stopTicker;
     private releaseLock;
+    addWorker(instance: Worker): void;
     run: () => void;
     quit: (cb: ICallback<void>) => void;
 }

package/dist/src/worker/worker-runner/worker-runner.js

@@ -1,19 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkerRunner = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
 const power_manager_1 = require("../../power-manager/power-manager");
 const events_1 = require("events");
 const ticker_1 = require("../../ticker/ticker");
 const lock_manager_1 = require("../../lock-manager/lock-manager");
 const events_2 = require("../../events/events");
-const empty_callback_reply_error_1 = require("../../errors/empty-callback-reply.error");
-const panic_error_1 = require("../../errors/panic.error");
 const async_1 = require("../../async/async");
 const lock_manager_acquire_error_1 = require("../../lock-manager/errors/lock-manager-acquire.error");
 class WorkerRunner extends events_1.EventEmitter {
-    constructor(redisClient, workersDir, keyLock, workerParameters, workerPool, logger) {
+    constructor(redisClient, keyLock, workerPool, logger) {
         super();
         this.onTick = () => {
             async_1.async.waterfall([
@@ -39,43 +35,6 @@ class WorkerRunner extends events_1.EventEmitter {
                     this.emit(events_2.events.ERROR, err);
             });
         };
-        this.init = (cb) => {
-            (0, fs_1.readdir)(this.workersDir, undefined, (err, reply) => {
-                if (err)
-                    cb(err);
-                else {
-                    async_1.async.each(reply !== null && reply !== void 0 ? reply : [], (filename, _, done) => {
-                        if (filename.match(/\.worker\.js$/)) {
-                            this.addToWorkerPool(filename, done);
-                        }
-                        else
-                            done();
-                    }, cb);
-                }
-            });
-        };
-        this.addToWorkerPool = (filename, cb) => {
-            this.createWorkerInstance(filename, (err, instance) => {
-                if (err)
-                    cb(err);
-                else if (!instance)
-                    cb(new empty_callback_reply_error_1.EmptyCallbackReplyError());
-                else if (!this.workerPool)
-                    cb(new panic_error_1.PanicError(`Expected an instance of WorkerPool`));
-                else {
-                    this.workerPool.add(instance);
-                    cb();
-                }
-            });
-        };
-        this.createWorkerInstance = (filename, cb) => {
-            const filepath = (0, path_1.join)(this.workersDir, filename);
-            Promise.resolve().then(() => require(filepath)).then((module) => {
-                const worker = new module.default(this.redisClient, this.workerParameters, true);
-                cb(null, worker);
-            })
-                .catch(cb);
-        };
         this.clearWorkerPool = (cb) => {
             this.workerPool.clear(cb);
         };
@@ -87,34 +46,25 @@ class WorkerRunner extends events_1.EventEmitter {
             this.lockManager.releaseLock(cb);
         };
         this.run = () => {
-            this.powerManager.goingUp();
-            this.init((err) => {
-                if (err)
-                    this.emit(events_2.events.ERROR, err);
-                else {
-                    this.powerManager.commit();
-                    this.emit(events_2.events.UP);
-                    this.ticker.nextTick();
-                }
-            });
+            this.emit(events_2.events.UP);
+            this.ticker.nextTick();
         };
         this.quit = (cb) => {
-            this.powerManager.goingDown();
             async_1.async.waterfall([this.stopTicker, this.clearWorkerPool, this.releaseLock], () => {
-                this.powerManager.commit();
                 this.emit(events_2.events.DOWN);
                 cb();
             });
         };
         this.powerManager = new power_manager_1.PowerManager();
         this.redisClient = redisClient;
-        this.workersDir = workersDir;
-        this.workerParameters = workerParameters;
         this.logger = logger;
         this.lockManager = new lock_manager_1.LockManager(redisClient, keyLock, 10000, false, true);
         this.ticker = new ticker_1.Ticker(this.onTick);
         this.workerPool = workerPool;
     }
+    addWorker(instance) {
+        this.workerPool.add(instance);
+    }
 }
 exports.WorkerRunner = WorkerRunner;
 //# sourceMappingURL=worker-runner.js.map

package/dist/src/worker/worker.d.ts

@@ -1,11 +1,9 @@
-import { RedisClient } from '../redis-client/redis-client';
-import { ICallback, TWorkerParameters } from '../../types';
-export declare abstract class Worker<T extends TWorkerParameters = TWorkerParameters> {
+import { ICallback } from '../../types';
+export declare abstract class Worker {
     private readonly ticker;
     private readonly powerManager;
     private readonly managed;
-    protected readonly redisClient: RedisClient;
-    constructor(redisClient: RedisClient, params: T, managed: boolean);
+    constructor(managed: boolean, timeout?: number);
     private getTicker;
     private getPowerManager;
     private onTick;

package/dist/src/worker/worker.js

@@ -6,7 +6,7 @@ const events_1 = require("../events/events");
 const power_manager_1 = require("../power-manager/power-manager");
 const panic_error_1 = require("../errors/panic.error");
 class Worker {
-    constructor(redisClient, params, managed) {
+    constructor(managed, timeout = 1000) {
         this.ticker = null;
         this.powerManager = null;
         this.getTicker = () => {
@@ -46,10 +46,8 @@ class Worker {
             else
                 cb();
         };
-        this.redisClient = redisClient;
         this.managed = managed;
         if (!managed) {
-            const { timeout = 1000 } = params;
             this.ticker = new ticker_1.Ticker(this.onTick, timeout);
             this.powerManager = new power_manager_1.PowerManager();
         }

package/dist/types/index.d.ts

@@ -1,7 +1,5 @@
 import { KeyType, Pipeline, Redis, RedisOptions } from 'ioredis';
 import { ClientOpts, Multi, RedisClient as NodeRedis } from 'redis';
-import { Worker } from '../src/worker/worker';
-import { RedisClient } from '../src/redis-client/redis-client';
 import * as Logger from 'bunyan';
 export interface IORedisConfig {
     client: RedisClientName.IOREDIS;
@@ -66,12 +64,6 @@ export declare type TCompatibleRedisClient = (NodeRedis | Redis) & {
 export declare type TRedisClientMulti = (Multi | Pipeline) & {
     hmset(key: string, args: (string | number)[]): void;
 };
-export declare type TWorkerParameters = {
-    timeout?: number;
-};
-export declare type TWorkerClassConstructor<T extends TWorkerParameters> = {
-    new (redisClient: RedisClient, params: T, managed: boolean): Worker<T>;
-};
 export interface ICompatibleLogger {
     info(message: unknown, ...params: unknown[]): void;
     warn(message: unknown, ...params: unknown[]): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-common",
-  "version": "1.0.0-rc.0",
+  "version": "1.0.0-rc.3",
   "description": "RedisSMQ shared components that may be used by integrated applications and extensions.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",