@shrub/queue-local 0.5.50

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 jjvainav
+
+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.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./module";

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./module"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCIn0=

package/dist/module.d.ts

@@ -0,0 +1,19 @@
+import { IModule, IModuleConfigurator, IModuleInitializer } from "@shrub/core";
+import { QueueModule } from "@shrub/queue";
+export declare const IQueueLocalConfiguration: import("@shrub/core").IModuleConfigurationType<IQueueLocalConfiguration>;
+export interface IQueueLocalConfiguration {
+    /** Enables the use of the local job queue. */
+    useLocalQueue(options?: IQueueLocalOptions): void;
+}
+/** Defines options for the local job queue. */
+export interface IQueueLocalOptions {
+    /** A set of queue name patterns defining the queues the local adapter will handle; if not defined, local job queue will be used for all queues. */
+    readonly queueNamePatterns?: string[];
+}
+export declare class QueueLocalModule implements IModule {
+    private readonly adapter;
+    readonly name = "queue-local";
+    readonly dependencies: (typeof QueueModule)[];
+    initialize(init: IModuleInitializer): void;
+    configure({ config }: IModuleConfigurator): void;
+}

package/dist/module.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueLocalModule = exports.IQueueLocalConfiguration = void 0;
+const core_1 = require("@shrub/core");
+const queue_1 = require("@shrub/queue");
+const async_queue_1 = require("@sprig/async-queue");
+const event_emitter_1 = require("@sprig/event-emitter");
+const unique_id_1 = __importDefault(require("@sprig/unique-id"));
+const cron_parser_1 = require("cron-parser");
+exports.IQueueLocalConfiguration = core_1.createConfig();
+class QueueLocalModule {
+    constructor() {
+        this.adapter = new LocalQueueAdapter([]);
+        this.name = "queue-local";
+        this.dependencies = [queue_1.QueueModule];
+    }
+    initialize(init) {
+        init.config(exports.IQueueLocalConfiguration).register(() => ({
+            useLocalQueue: options => this.adapter.addQueueNamePatterns(options && options.queueNamePatterns || ["*"])
+        }));
+    }
+    configure({ config }) {
+        config.get(queue_1.IQueueConfiguration).useQueue(this.adapter);
+    }
+}
+exports.QueueLocalModule = QueueLocalModule;
+class LocalQueueAdapter extends queue_1.QueueAdapter {
+    constructor() {
+        super(...arguments);
+        this.queues = new Map();
+    }
+    getQueueInstance(name) {
+        let queue = this.queues.get(name);
+        if (!queue) {
+            const jobCompleted = new event_emitter_1.EventEmitter();
+            const jobFailed = new event_emitter_1.EventEmitter();
+            const jobProgress = new event_emitter_1.EventEmitter();
+            const asyncQueue = new async_queue_1.AsyncQueue();
+            const callbacks = [];
+            let index = 0;
+            const getCallback = () => {
+                // round robin
+                index = callbacks.length >= index ? 0 : index;
+                return callbacks.length ? callbacks[index++] : undefined;
+            };
+            const pushJob = (job, onFinished) => asyncQueue.push(async () => {
+                // TODO: how to handle if there are no handlers for the queue?
+                const callback = getCallback();
+                if (callback) {
+                    await callback(job)
+                        .then(returnValue => jobCompleted.emit({ job, returnValue }))
+                        .catch(error => jobFailed.emit({ job, error }))
+                        .finally(() => onFinished());
+                }
+            });
+            queue = {
+                get onJobCompleted() {
+                    return jobCompleted.event;
+                },
+                get onJobFailed() {
+                    return jobFailed.event;
+                },
+                get onJobProgress() {
+                    return jobProgress.event;
+                },
+                add: options => {
+                    const job = {
+                        id: unique_id_1.default(),
+                        data: options.data || {},
+                        progress: 0,
+                        updateProgress(progress) {
+                            this.progress = progress;
+                            jobProgress.emit({ job, progress });
+                            return Promise.resolve();
+                        }
+                    };
+                    const getDelay = (options) => {
+                        if (options.delay) {
+                            return options.delay;
+                        }
+                        if (options.repeat && options.repeat.cron) {
+                            // if we want to execute immediately simply skip returning a delay
+                            if (!options.repeat.immediate) {
+                                const now = Date.now();
+                                const next = cron_parser_1.parseExpression(options.repeat.cron).next().getTime();
+                                return next - now;
+                            }
+                        }
+                        return undefined;
+                    };
+                    const onFinished = () => {
+                        if (options.repeat && options.repeat.cron) {
+                            queue.add({
+                                name: options.name,
+                                data: options.data,
+                                delay: getDelay({ repeat: { cron: options.repeat.cron } }),
+                                // make sure immediate is not set
+                                repeat: { cron: options.repeat.cron }
+                            });
+                        }
+                    };
+                    const delay = getDelay(options);
+                    if (delay !== undefined) {
+                        setTimeout(() => pushJob(job, onFinished), delay);
+                    }
+                    else {
+                        pushJob(job, onFinished);
+                    }
+                    return Promise.resolve(job);
+                },
+                // TODO: need to support concurrent job processing
+                process: options => {
+                    callbacks.push(options.callback);
+                    return {
+                        close: () => {
+                            this.queues.delete(name);
+                            return new Promise(resolve => {
+                                if (asyncQueue.isIdle) {
+                                    resolve();
+                                }
+                                else {
+                                    asyncQueue.onIdle.once(() => resolve());
+                                }
+                            });
+                        }
+                    };
+                }
+            };
+            this.queues.set(name, queue);
+        }
+        return queue;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kdWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL21vZHVsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSxzQ0FBNkY7QUFDN0Ysd0NBR3NCO0FBQ3RCLG9EQUFnRDtBQUNoRCx3REFBb0Q7QUFDcEQsaUVBQXdDO0FBQ3hDLDZDQUE4QztBQUlqQyxRQUFBLHdCQUF3QixHQUFHLG1CQUFZLEVBQTRCLENBQUM7QUFZakYsTUFBYSxnQkFBZ0I7SUFBN0I7UUFDcUIsWUFBTyxHQUFHLElBQUksaUJBQWlCLENBQUMsRUFBRSxDQUFDLENBQUM7UUFFNUMsU0FBSSxHQUFHLGFBQWEsQ0FBQztRQUNyQixpQkFBWSxHQUFHLENBQUMsbUJBQVcsQ0FBQyxDQUFDO0lBVzFDLENBQUM7SUFURyxVQUFVLENBQUMsSUFBd0I7UUFDL0IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxnQ0FBd0IsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1lBQ2xELGFBQWEsRUFBRSxPQUFPLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsb0JBQW9CLENBQUMsT0FBTyxJQUFJLE9BQU8sQ0FBQyxpQkFBaUIsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1NBQzdHLENBQUMsQ0FBQyxDQUFDO0lBQ1IsQ0FBQztJQUVELFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBdUI7UUFDckMsTUFBTSxDQUFDLEdBQUcsQ0FBQywyQkFBbUIsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDM0QsQ0FBQztDQUNKO0FBZkQsNENBZUM7QUFFRCxNQUFNLGlCQUFrQixTQUFRLG9CQUFZO0lBQTVDOztRQUNxQixXQUFNLEdBQUcsSUFBSSxHQUFHLEVBQWtCLENBQUM7SUFtSHhELENBQUM7SUFqSGEsZ0JBQWdCLENBQUMsSUFBWTtRQUNuQyxJQUFJLEtBQUssR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUVsQyxJQUFJLENBQUMsS0FBSyxFQUFFO1lBQ1IsTUFBTSxZQUFZLEdBQUcsSUFBSSw0QkFBWSxFQUEwQixDQUFDO1lBQ2hFLE1BQU0sU0FBUyxHQUFHLElBQUksNEJBQVksRUFBdUIsQ0FBQztZQUMxRCxNQUFNLFdBQVcsR0FBRyxJQUFJLDRCQUFZLEVBQXlCLENBQUM7WUFDOUQsTUFBTSxVQUFVLEdBQUcsSUFBSSx3QkFBVSxFQUFFLENBQUM7WUFDcEMsTUFBTSxTQUFTLEdBQXlCLEVBQUUsQ0FBQztZQUMzQyxJQUFJLEtBQUssR0FBRyxDQUFDLENBQUM7WUFFZCxNQUFNLFdBQVcsR0FBRyxHQUFHLEVBQUU7Z0JBQ3JCLGNBQWM7Z0JBQ2QsS0FBSyxHQUFHLFNBQVMsQ0FBQyxNQUFNLElBQUksS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQztnQkFDOUMsT0FBTyxTQUFTLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDO1lBQzdELENBQUMsQ0FBQztZQUVGLE1BQU0sT0FBTyxHQUFHLENBQUMsR0FBUyxFQUFFLFVBQXNCLEVBQUUsRUFBRSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsS0FBSyxJQUFJLEVBQUU7Z0JBQzlFLDhEQUE4RDtnQkFDOUQsTUFBTSxRQUFRLEdBQUcsV0FBVyxFQUFFLENBQUM7Z0JBQy9CLElBQUksUUFBUSxFQUFFO29CQUNWLE1BQU0sUUFBUSxDQUFDLEdBQUcsQ0FBQzt5QkFDZCxJQUFJLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLEVBQUUsR0FBRyxFQUFFLFdBQVcsRUFBRSxDQUFDLENBQUM7eUJBQzVELEtBQUssQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQzt5QkFDOUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFDLFVBQVUsRUFBRSxDQUFDLENBQUM7aUJBQ3BDO1lBQ0wsQ0FBQyxDQUFDLENBQUM7WUFFSCxLQUFLLEdBQUc7Z0JBQ0osSUFBSSxjQUFjO29CQUNkLE9BQU8sWUFBWSxDQUFDLEtBQUssQ0FBQztnQkFDOUIsQ0FBQztnQkFDRCxJQUFJLFdBQVc7b0JBQ1gsT0FBTyxTQUFTLENBQUMsS0FBSyxDQUFDO2dCQUMzQixDQUFDO2dCQUNELElBQUksYUFBYTtvQkFDYixPQUFPLFdBQVcsQ0FBQyxLQUFLLENBQUM7Z0JBQzdCLENBQUM7Z0JBQ0QsR0FBRyxFQUFFLE9BQU8sQ0FBQyxFQUFFO29CQUNYLE1BQU0sR0FBRyxHQUFTO3dCQUNkLEVBQUUsRUFBRSxtQkFBUSxFQUFFO3dCQUNkLElBQUksRUFBRSxPQUFPLENBQUMsSUFBSSxJQUFJLEVBQUU7d0JBQ3hCLFFBQVEsRUFBRSxDQUFDO3dCQUNYLGNBQWMsQ0FBQyxRQUF5Qjs0QkFDcEIsSUFBSyxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7NEJBQzFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsUUFBUSxFQUFFLENBQUMsQ0FBQzs0QkFDcEMsT0FBTyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUM7d0JBQzdCLENBQUM7cUJBQ0osQ0FBQztvQkFFRixNQUFNLFFBQVEsR0FBRyxDQUFDLE9BQW9CLEVBQUUsRUFBRTt3QkFDdEMsSUFBSSxPQUFPLENBQUMsS0FBSyxFQUFFOzRCQUNmLE9BQU8sT0FBTyxDQUFDLEtBQUssQ0FBQzt5QkFDeEI7d0JBRUQsSUFBSSxPQUFPLENBQUMsTUFBTSxJQUFJLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFOzRCQUN2QyxrRUFBa0U7NEJBQ2xFLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFNBQVMsRUFBRTtnQ0FDM0IsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO2dDQUN2QixNQUFNLElBQUksR0FBRyw2QkFBZSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUM7Z0NBQ25FLE9BQU8sSUFBSSxHQUFHLEdBQUcsQ0FBQzs2QkFDckI7eUJBQ0o7d0JBRUQsT0FBTyxTQUFTLENBQUM7b0JBQ3JCLENBQUMsQ0FBQztvQkFFRixNQUFNLFVBQVUsR0FBRyxHQUFHLEVBQUU7d0JBQ3BCLElBQUksT0FBTyxDQUFDLE1BQU0sSUFBSSxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRTs0QkFDdkMsS0FBTSxDQUFDLEdBQUcsQ0FBQztnQ0FDUCxJQUFJLEVBQUUsT0FBTyxDQUFDLElBQUk7Z0NBQ2xCLElBQUksRUFBRSxPQUFPLENBQUMsSUFBSTtnQ0FDbEIsS0FBSyxFQUFFLFFBQVEsQ0FBQyxFQUFFLE1BQU0sRUFBRSxFQUFFLElBQUksRUFBRSxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUM7Z0NBQzFELGlDQUFpQztnQ0FDakMsTUFBTSxFQUFFLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxFQUFFOzZCQUN4QyxDQUFDLENBQUM7eUJBQ047b0JBQ0wsQ0FBQyxDQUFDO29CQUVGLE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyxPQUFPLENBQUMsQ0FBQztvQkFDaEMsSUFBSSxLQUFLLEtBQUssU0FBUyxFQUFFO3dCQUNyQixVQUFVLENBQUMsR0FBRyxFQUFFLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztxQkFDckQ7eUJBQ0k7d0JBQ0QsT0FBTyxDQUFDLEdBQUcsRUFBRSxVQUFVLENBQUMsQ0FBQztxQkFDNUI7b0JBRUQsT0FBTyxPQUFPLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUNoQyxDQUFDO2dCQUNELGtEQUFrRDtnQkFDbEQsT0FBTyxFQUFFLE9BQU8sQ0FBQyxFQUFFO29CQUNmLFNBQVMsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO29CQUNqQyxPQUFPO3dCQUNILEtBQUssRUFBRSxHQUFHLEVBQUU7NEJBQ1IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7NEJBQ3pCLE9BQU8sSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUU7Z0NBQ3pCLElBQUksVUFBVSxDQUFDLE1BQU0sRUFBRTtvQ0FDbkIsT0FBTyxFQUFFLENBQUM7aUNBQ2I7cUNBQ0k7b0NBQ0QsVUFBVSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztpQ0FDM0M7NEJBQ0wsQ0FBQyxDQUFDLENBQUM7d0JBQ1AsQ0FBQztxQkFDSixDQUFDO2dCQUNOLENBQUM7YUFDSixDQUFDO1lBRUYsSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1NBQ2hDO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztDQUNKIn0=

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@shrub/queue-local",
+    "description": "Provides a job/worker queue that runs locally.",
+    "version": "0.5.50",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/jjvainav/shrub.git"
+    },
+    "main": "dist/index.js",
+    "module": "dist/esm/index.js",
+    "typings": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">=10.18.0"
+    },
+    "scripts": {
+        "build": "tsc -b .",
+        "clean": "rimraf ./dist && rimraf tsconfig.tsbuildinfo"
+    },
+    "dependencies": {
+        "@shrub/core": "0.5.50",
+        "@shrub/logging": "0.5.50",
+        "@shrub/queue": "0.5.50",
+        "@sprig/async-queue": "0.2.0",
+        "@sprig/event-emitter": "^0.2.0",
+        "@sprig/unique-id": "^0.2.0",
+        "cron-parser": "^4.3.0"
+    },
+    "gitHead": "e32c3a3fc3cbbbfdebf6847a313f623de4976af1"
+}