poolctl 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+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/README.md

@@ -0,0 +1,28 @@
+a simple task queue for javascript which ensures maximum concurrent tasks are
+less than the pool size it is mostly useful for requesting thousands of
+resources concurrently but avoid and keep maximum connections behind a boundary
+example :
+
+### example
+
+```typescript
+const pool = new Pool(5);
+const urls = [
+  "https://www.google.com/1",
+  "https://www.google.com/2",
+  "https://www.google.com/3",
+  "https://www.google.com/4",
+  "https://www.google.com/5",
+  "https://www.google.com/6",
+  "https://www.google.com/7",
+];
+// here maximum concurrent url being fetched is 5
+await Promise.all(urls.map((u) => pool.exec(() => fetch(u))));
+```
+
+### Api Docs
+
+https://doc.deno.land/https://raw.githubusercontent.com/ehsan2003/task-pool/main/mod.ts
+
+the code is simple so if you confused about anything read the code its most of
+the time best way to understand things or just open an issue

package/esm/FIFOQueue.d.ts

@@ -0,0 +1,11 @@
+export declare class FIFOQueue<T> {
+    private head;
+    private tail;
+    private size;
+    constructor();
+    enqueue(value: T): void;
+    dequeue(): T | undefined;
+    clear(): void;
+    getSize(): number;
+    [Symbol.iterator](): Generator<T, void, unknown>;
+}

package/esm/FIFOQueue.js

@@ -0,0 +1,59 @@
+export class FIFOQueue {
+    constructor() {
+        Object.defineProperty(this, "head", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
+        Object.defineProperty(this, "tail", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
+        Object.defineProperty(this, "size", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        this.clear();
+    }
+    enqueue(value) {
+        const node = { value, next: null };
+        if (this.head) {
+            this.tail.next = node;
+            this.tail = node;
+        }
+        else {
+            this.head = node;
+            this.tail = node;
+        }
+        this.size++;
+    }
+    dequeue() {
+        const current = this.head;
+        if (!current) {
+            return;
+        }
+        this.head = this.head.next;
+        this.size--;
+        return current.value;
+    }
+    clear() {
+        this.head = null;
+        this.tail = null;
+        this.size = 0;
+    }
+    getSize() {
+        return this.size;
+    }
+    *[Symbol.iterator]() {
+        let current = this.head;
+        while (current) {
+            yield current.value;
+            current = current.next;
+        }
+    }
+}

package/esm/mod.d.ts

@@ -0,0 +1,14 @@
+type Task<T> = () => Promise<T>;
+export declare class Pool {
+    private size;
+    private workingCount;
+    private waitQueue;
+    constructor(size: number);
+    exec<T>(task: Task<T>): Promise<T>;
+    private releaseFirstWaiter;
+    private waitForAvailability;
+    getSize(): number;
+    getWorkingCount(): number;
+    getPendingCount(): number;
+}
+export {};

package/esm/mod.js

@@ -0,0 +1,84 @@
+import { FIFOQueue } from "./FIFOQueue.js";
+class Deffered {
+    constructor() {
+        Object.defineProperty(this, "resolve", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reject", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "promise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.promise = new Promise((resolve, reject) => {
+            this.reject = reject;
+            this.resolve = resolve;
+        });
+    }
+}
+export class Pool {
+    constructor(size) {
+        Object.defineProperty(this, "size", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: size
+        });
+        Object.defineProperty(this, "workingCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "waitQueue", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new FIFOQueue()
+        });
+        if (size < 1) {
+            throw new Error("Pool size must be greater than 0");
+        }
+    }
+    async exec(task) {
+        if (this.workingCount >= this.size) {
+            await this.waitForAvailability();
+        }
+        this.workingCount++;
+        try {
+            return await task();
+        }
+        finally {
+            this.workingCount--;
+            if (this.workingCount < this.size) {
+                this.releaseFirstWaiter();
+            }
+        }
+    }
+    releaseFirstWaiter() {
+        this.waitQueue.dequeue()?.resolve();
+    }
+    async waitForAvailability() {
+        const wait = new Deffered();
+        this.waitQueue.enqueue(wait);
+        await wait.promise;
+    }
+    getSize() {
+        return this.size;
+    }
+    getWorkingCount() {
+        return this.workingCount;
+    }
+    getPendingCount() {
+        return this.waitQueue.getSize();
+    }
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "poolctl",
+  "version": "0.1.0",
+  "description": "A simple concurrency-limiting task pool for JavaScript. Runs at most N async tasks at a time.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dev-a-loper/task-pool.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dev-a-loper/task-pool/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0",
+    "picocolors": "^1.0.0",
+    "@deno/shim-deno": "~0.18.0"
+  },
+  "_generatedBy": "dnt@0.40.0"
+}

package/script/FIFOQueue.d.ts

@@ -0,0 +1,11 @@
+export declare class FIFOQueue<T> {
+    private head;
+    private tail;
+    private size;
+    constructor();
+    enqueue(value: T): void;
+    dequeue(): T | undefined;
+    clear(): void;
+    getSize(): number;
+    [Symbol.iterator](): Generator<T, void, unknown>;
+}

package/script/FIFOQueue.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FIFOQueue = void 0;
+class FIFOQueue {
+    constructor() {
+        Object.defineProperty(this, "head", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
+        Object.defineProperty(this, "tail", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: null
+        });
+        Object.defineProperty(this, "size", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        this.clear();
+    }
+    enqueue(value) {
+        const node = { value, next: null };
+        if (this.head) {
+            this.tail.next = node;
+            this.tail = node;
+        }
+        else {
+            this.head = node;
+            this.tail = node;
+        }
+        this.size++;
+    }
+    dequeue() {
+        const current = this.head;
+        if (!current) {
+            return;
+        }
+        this.head = this.head.next;
+        this.size--;
+        return current.value;
+    }
+    clear() {
+        this.head = null;
+        this.tail = null;
+        this.size = 0;
+    }
+    getSize() {
+        return this.size;
+    }
+    *[Symbol.iterator]() {
+        let current = this.head;
+        while (current) {
+            yield current.value;
+            current = current.next;
+        }
+    }
+}
+exports.FIFOQueue = FIFOQueue;

package/script/mod.d.ts

@@ -0,0 +1,14 @@
+type Task<T> = () => Promise<T>;
+export declare class Pool {
+    private size;
+    private workingCount;
+    private waitQueue;
+    constructor(size: number);
+    exec<T>(task: Task<T>): Promise<T>;
+    private releaseFirstWaiter;
+    private waitForAvailability;
+    getSize(): number;
+    getWorkingCount(): number;
+    getPendingCount(): number;
+}
+export {};

package/script/mod.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pool = void 0;
+const FIFOQueue_js_1 = require("./FIFOQueue.js");
+class Deffered {
+    constructor() {
+        Object.defineProperty(this, "resolve", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reject", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "promise", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.promise = new Promise((resolve, reject) => {
+            this.reject = reject;
+            this.resolve = resolve;
+        });
+    }
+}
+class Pool {
+    constructor(size) {
+        Object.defineProperty(this, "size", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: size
+        });
+        Object.defineProperty(this, "workingCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
+        Object.defineProperty(this, "waitQueue", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new FIFOQueue_js_1.FIFOQueue()
+        });
+        if (size < 1) {
+            throw new Error("Pool size must be greater than 0");
+        }
+    }
+    async exec(task) {
+        if (this.workingCount >= this.size) {
+            await this.waitForAvailability();
+        }
+        this.workingCount++;
+        try {
+            return await task();
+        }
+        finally {
+            this.workingCount--;
+            if (this.workingCount < this.size) {
+                this.releaseFirstWaiter();
+            }
+        }
+    }
+    releaseFirstWaiter() {
+        this.waitQueue.dequeue()?.resolve();
+    }
+    async waitForAvailability() {
+        const wait = new Deffered();
+        this.waitQueue.enqueue(wait);
+        await wait.promise;
+    }
+    getSize() {
+        return this.size;
+    }
+    getWorkingCount() {
+        return this.workingCount;
+    }
+    getPendingCount() {
+        return this.waitQueue.getSize();
+    }
+}
+exports.Pool = Pool;

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}