Repository: cmseaton42/task-easy
Branch: master
Commit: b960a6f10535
Files: 12
Total size: 22.9 KB
Directory structure:
gitextract_wedwjsnx/
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── src/
├── __snapshots__/
│ └── task-easy.spec.js.snap
├── index.d.ts
├── index.js
└── task-easy.spec.js
================================================
FILE CONTENTS
================================================
================================================
FILE: .eslintignore
================================================
node_modules/**
coverage/**
scripts/**
================================================
FILE: .eslintrc.js
================================================
module.exports = {
env: {
"jest/globals": true,
es6: true,
node: true
},
extends: ["eslint:recommended"],
parserOptions: {
ecmaVersion: 8,
sourceType: "module",
ecmaFeatures: {
jsx: true,
experimentalObjectRestSpread: true
}
},
rules: {
indent: ["error", 4],
"no-console": 0,
quotes: ["error", "double"],
semi: ["error", "always"],
"jest/no-disabled-tests": "warn",
"jest/no-focused-tests": "error",
"jest/no-identical-title": "error",
"jest/prefer-to-have-length": "warn",
"jest/valid-expect": "error"
},
plugins: ["jest"]
};
================================================
FILE: .gitignore
================================================
/node_modules/
# Ignore Jest Coverage Reports
/coverage
/assets
================================================
FILE: .npmignore
================================================
**/*.spec.js
/coverage
/assets
**/__snapshots__
================================================
FILE: .travis.yml
================================================
language: node_js
node_js:
- "node"
notifications:
webhooks:
urls:
- https://webhooks.gitter.im/e/7cce00f2d081132a34c2
on_success: change # options: [always|never|change] default: always
on_failure: always # options: [always|never|change] default: always
on_start: never # options: [always|never|change] default: always
================================================
FILE: LICENSE
================================================
Copyright (c) 2018
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.
================================================
FILE: README.md
================================================
# Task Easy - Promise Queue Made Easy ✅
A simple, customizable, and lightweight priority queue for promise based tasks.
> Now with types!!! Big thanks to [Emiliano Heyns](https://github.com/retorquere) :beers:
>
> - See below example for typescript version
## Getting Started
Install with npm
```
npm install task-easy --save
```
## How it Works
**TaskEasy** is built as an extension of a simple heap data structure. Tasks are queued by simply passing a task (function) to the `.schedule` method along with an array of arguments to be called as well as an object to describe the task's relative priority. The caller is returned a promise which will resolve once the scheduled task has ran. Priority determination is left up to the user via a function that accepts task priority object and returns a judgement.
### Usage
The usage of **TaskEasy** is best given by example so that is the route we will take.
In this example, we will be passing priority objects to the scheduler that will be marked by the following signature.
```js
{
// An integer representing priority,
// the higher the number the higher the priority
priority: Number,
// A timestamp to illustrate when the task
// was scheduled, used as a 'tie-breaker' for
// tasks of the same priority
timestamp: Date
}
```
> **NOTE**
>
> The priority object's signature that you want to queue your items with is 100% up to you. 😄
Now, let's create a function that will receive our priority objects and output a priority judgment so that _TaskEasy_ knows how to handle queued tasks. Our function will be passed two arguments (the priority objects of two scheduled tasks) and return a judgement indicating which task is of _higher_ priority. If we return `true`, then we are communicating to _TaskEasy_ that the first task is higher priority than the second task or vice versa
```js
// This function is passed to the TaskEasy contructor and will be used internally to determine tasks order.
const prioritize = (obj1, obj2) => {
return obj1.priority === obj2.priority
? obj1.timestamp.getTime() < obj2.timestamp.getTime() // Return true if task 1 is older than task 2
: obj1.priority > obj2.priority; // return true if task 1 is higher priority than task 2
};
```
Now, we can initialize a new _TaskEasy_ instance.
```js
const { TaskEasy } = require("task-easy");
const max_tasks = 200; // How many tasks will we allow to be queued at a time (defaults to 100)
const queue = new TaskEasy(prioritize, max_tasks);
```
Now, lets build an async function to demo the scheduler.
```js
const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
```
> **NOTE**
>
> Scheduled tasks _MUST_ be functions that return _promises_. This works well with async functions or with ES2017 `ASYNC/AWAIT` functions.
Now, that we have a task to schedule, let's schedule some tasks. The `.schedule` method takes three arguments, the task to call, an array of arguments, and a priority object that is associated with the scheduled task. It will return a promise that will resolve or reject once the task has been ran.
```js
// .schedule accepts the task signature,
// an array or arguments, and a priority object
const task1 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 1 ran..."));
const task2 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 2 ran..."));
const task3 = queue
.schedule(delay, [100], { priority: 2, timestamp: new Date() })
.then(() => console.log("Task 3 ran..."));
const task4 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 4 ran..."));
const task5 = queue
.schedule(delay, [100], { priority: 3, timestamp: new Date() })
.then(() => console.log("Task 5 ran..."));
// OUTPUT
// Task 1 ran...
// Task 5 ran...
// Task 3 ran...
// Task 2 ran...
// Task 4 ran...
```
> **NOTE**
>
> In the above example, `task1` resolved first as it once put onto the queue first and was immediately called as it was the only task on the queue at that time.
## Now with _Typescript_
```typescript
import { TaskEasy } from "task-easy";
// Define interface for priority
// objects to be used in the
// TaskEasy instance
interface IPriority {
priority: number;
timestamp: Date;
}
// Define delay function type
// -> Must extend Task: (...args) => Promise
type delayFn = (ms: number) => Promise;
// Define delay function of type 'delayFn' defined above
const delay: delayFn = ms => new Promise(resolve => setTimeout(resolve, ms));
// Define priority function
// -> Must extend (obj1: T, obj2: T) =>
const prioritize = (obj1: IPriority, obj2: IPriority) => {
return obj1.priority === obj2.priority
? obj1.timestamp.getTime() < obj2.timestamp.getTime() // Return true if task 1 is older than task 2
: obj1.priority > obj2.priority; // return true if task 1 is higher priority than task 2
};
// Initialize new queue
const queue = new TaskEasy(prioritize); // equivalent of TaskEasy(prioritize) via type inference
// .schedule accepts the task signature,
// an array or arguments, and a priority object
// -> with type inference
const task1 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 1 ran..."));
const task2 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 2 ran..."));
// Definitely typed
const task3 = queue
.schedule(delay, [100], { priority: 2, timestamp: new Date() })
.then(() => console.log("Task 3 ran..."));
const task4 = queue
.schedule(delay, [100], { priority: 1, timestamp: new Date() })
.then(() => console.log("Task 4 ran..."));
const task5 = queue
.schedule(delay, [100], { priority: 3, timestamp: new Date() })
.then(() => console.log("Task 5 ran..."));
// OUTPUT
// Task 1 ran...
// Task 5 ran...
// Task 3 ran...
// Task 2 ran...
// Task 4 ran...
```
## Built With
- [NodeJS](https://nodejs.org/en/) - The Engine
- [javascript - ES2017](https://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf) - The Language
## Contributers
- **Canaan Seaton** - _Owner_ - [GitHub Profile](https://github.com/cmseaton42) - [Personal Website](http://www.canaanseaton.com/)
## License
This project is licensed under the MIT License - see the [LICENCE](https://github.com/cmseaton42/task-easy/blob/master/LICENSE) file for details
================================================
FILE: package.json
================================================
{
"name": "task-easy",
"version": "1.0.1",
"description": "A simple, customizable, and lightweight priority queue for promise based tasks.",
"main": "./src/index.js",
"types": "./src/index.d.ts",
"scripts": {
"test": "npm run lint && jest && npm run test:coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
"test:local": "npm run lint && jest && npm run test:coverage",
"test:watch": "jest --watch",
"test:coverage": "jest --coverage",
"test:detailed": "jest --verbose",
"test:update": "jest -u",
"lint": "./node_modules/.bin/eslint . --ext .js",
"lint:fix": "npm run lint -- --fix"
},
"keywords": [
"queue",
"task",
"worker",
"job",
"in-memory",
"priority",
"manager",
"utility",
"promise",
"Async"
],
"repository": {
"type": "git",
"url": "https://github.com/cmseaton42/task-easy"
},
"author": "Canaan Seaton",
"license": "MIT",
"devDependencies": {
"coveralls": "^3.0.9",
"eslint": "^6.8.0",
"eslint-plugin-jest": "^23.4.0",
"jest": "^24.9.0"
}
}
================================================
FILE: src/__snapshots__/task-easy.spec.js.snap
================================================
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Micro Worker Private Methods Reorder Method Produces Correct Output 1`] = `
Array [
Object {
"args": Array [
200,
],
"priority_obj": Object {
"value": 2,
},
"task": [Function],
},
Object {
"args": Array [
100,
],
"priority_obj": Object {
"value": 1,
},
"task": [Function],
},
Object {
"args": Array [
600,
],
"priority_obj": Object {
"value": 6,
},
"task": [Function],
},
Object {
"args": Array [
300,
],
"priority_obj": Object {
"value": 3,
},
"task": [Function],
},
Object {
"args": Array [
400,
],
"priority_obj": Object {
"value": 4,
},
"task": [Function],
},
Object {
"args": Array [
500,
],
"priority_obj": Object {
"value": 5,
},
"task": [Function],
},
Object {
"args": Array [
1400,
],
"priority_obj": Object {
"value": 14,
},
"task": [Function],
},
Object {
"args": Array [
700,
],
"priority_obj": Object {
"value": 7,
},
"task": [Function],
},
Object {
"args": Array [
800,
],
"priority_obj": Object {
"value": 8,
},
"task": [Function],
},
Object {
"args": Array [
900,
],
"priority_obj": Object {
"value": 9,
},
"task": [Function],
},
Object {
"args": Array [
1000,
],
"priority_obj": Object {
"value": 10,
},
"task": [Function],
},
Object {
"args": Array [
1100,
],
"priority_obj": Object {
"value": 11,
},
"task": [Function],
},
Object {
"args": Array [
1200,
],
"priority_obj": Object {
"value": 12,
},
"task": [Function],
},
Object {
"args": Array [
1300,
],
"priority_obj": Object {
"value": 13,
},
"task": [Function],
},
Object {
"args": Array [
0,
],
"priority_obj": Object {
"value": 0,
},
"task": [Function],
},
]
`;
================================================
FILE: src/index.d.ts
================================================
// Task Easy Class
export declare class TaskEasy {
constructor(compare_func: (ob1: C, obj2: C) => boolean, max_queue_size?: number);
schedule>(task: T, args: TaskEasy.Arguments, priority_obj: C): Promise
;
}
declare namespace TaskEasy {
// Extract argument types from passed function type
export type Arguments = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
// Generic task type, must return promise
export type Task = (...args: any[]) => Promise;
}
================================================
FILE: src/index.js
================================================
/**
* A simple in memory priority queue
*
* @class TaskEasy
* @param {Function} compare_func - Function to handle comparison objects passed to Scheduler
* @param {Number} [max_queue_size=100] Max number of tasks allowed in queue
*/
class TaskEasy {
constructor(compare_func, max_queue_size = 100) {
this.tasks = [];
this.taskRunning = false;
if (typeof compare_func !== "function")
throw new Error(
`Task Easy Comparison Function must be of Type instead got ${typeof compare_func}`
);
if (typeof max_queue_size !== "number")
throw new Error(`Task Easy Max Queue Size must be of Type instead got ${typeof max_queue_size}`);
if (max_queue_size <= 0) throw new Error("Task Easy Max Queue Size must be greater than 0");
this.compare = compare_func;
this.max = max_queue_size;
}
/**
* Schedules a new "Task" to be Performed
*
* @param {function} task - task to schedule
* @param {Array} args - array of arguments to pass to task
* @param {object} priority_obj - object that will be passed to comparison handler provided in the constructor
* @returns
* @memberof TaskQueue
*/
schedule(task, args, priority_obj) {
if (typeof task !== "function")
throw new Error(`Scheduler Task must be of Type instead got ${typeof task}`);
if (!Array.isArray(args)) throw new Error(`Scheduler args must be of Type instead got ${typeof args}`);
if (typeof priority_obj !== "object")
throw new Error(`Scheduler Task must be of Type
