hive-cycle 0.1.1 → 0.2.1

package/README.md

@@ -11,6 +11,7 @@ A modular, type-safe TypeScript framework for running background task queues. `H
 - **Modular**: Abstract `QueueAdapter` allowing you to swap the default In-Memory queue for Redis, RabbitMQ, or SQL/NoSQL databases.
 - **Concurrency Control**: Limit how many tasks are processed simultaneously.
 - **Recurring Tasks**: Built-in support for tasks that automatically requeue themselves (cron-like behavior).
+- **Health Monitoring**: Optional HTTP endpoint to monitor service health and metrics.
 
 ## Installation
 
@@ -82,7 +83,7 @@ await app.enqueue(
   {
     requeue: true,
     requeueDelay: 5000, // Run again 5 seconds after completion
-  }
+  },
 );
 ```
 
@@ -101,11 +102,32 @@ const app = new HiveCycle({
   // Custom logger (defaults to console)
   logger: myLogger,
 
+  // Start a health check server on this port
+  healthPort: 3000,
+
   // Custom Queue Adapter (defaults to MemoryQueue)
   queue: new RedisQueueAdapter(),
 });
 ```
 
+### Health Check
+
+If you provide a `healthPort` in the configuration, an HTTP server will start and expose a `/health` endpoint.
+
+```bash
+curl http://localhost:3000/health
+```
+
+**Response:**
+
+```json
+{
+  "status": "ok",
+  "running": true,
+  "activeCount": 2
+}
+```
+
 ### Custom Queue Adapter
 
 To use a persistent store (like Redis), implement the `QueueAdapter` interface.

package/dist/src/HiveCycle.d.ts

@@ -5,6 +5,7 @@ export declare class HiveCycle<TaskMap extends Record<string, any> = Record<stri
     private isRunning;
     private options;
     private activeCount;
+    private server?;
     constructor(options?: HiveCycleOptions);
     /**
      * Register a handler for a specific task type.
@@ -22,7 +23,10 @@ export declare class HiveCycle<TaskMap extends Record<string, any> = Record<stri
      * Stop the worker loop.
      */
     stop(): void;
+    private startHealthServer;
+    private stopHealthServer;
     private loop;
     private handleTask;
     private sleep;
 }
+//# sourceMappingURL=HiveCycle.d.ts.map

package/dist/src/HiveCycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HiveCycle.d.ts","sourceRoot":"","sources":["../../src/HiveCycle.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAEhB,IAAI,EACJ,WAAW,EAEZ,MAAM,SAAS,CAAC;AAcjB,qBAAa,SAAS,CACpB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAEzD,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,QAAQ,CAAuC;IACvD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,OAAO,CAEb;IACF,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,OAAO,GAAE,gBAAqB;IAW1C;;OAEG;IACI,eAAe,CAAC,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,EACrD,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAC/B,IAAI;IAIP;;OAEG;IACU,OAAO,CAAC,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,EACnD,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GACtB,OAAO,CAAC,MAAM,CAAC;IAYlB;;OAEG;IACI,KAAK,IAAI,IAAI;IAYpB;;OAEG;IACI,IAAI,IAAI,IAAI;IAMnB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,gBAAgB;YAOV,IAAI;YA0BJ,UAAU;IAyCxB,OAAO,CAAC,KAAK;CAGd"}

package/dist/src/HiveCycle.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HiveCycle = void 0;
+const http_1 = require("http");
 const MemoryQueue_1 = require("./MemoryQueue");
 // I will implement a simple ID generator to avoid deps for now if I didn't install uuid.
 // Wait, I haven't installed `uuid`. I should probably implement a simple random ID or install it later.
@@ -21,6 +22,7 @@ class HiveCycle {
             pollingInterval: options.pollingInterval || 1000,
             maxConcurrency: options.maxConcurrency || 1,
             logger: options.logger || console,
+            healthPort: options.healthPort,
         };
         this.queue = this.options.queue;
     }
@@ -52,6 +54,9 @@ class HiveCycle {
             return;
         this.isRunning = true;
         this.options.logger.log("HiveCycle engine started.");
+        if (this.options.healthPort) {
+            this.startHealthServer(this.options.healthPort);
+        }
         this.loop();
     }
     /**
@@ -60,6 +65,35 @@ class HiveCycle {
     stop() {
         this.isRunning = false;
         this.options.logger.log("HiveCycle engine stopping...");
+        this.stopHealthServer();
+    }
+    startHealthServer(port) {
+        this.server = (0, http_1.createServer)((req, res) => {
+            if (req.url === "/health" && req.method === "GET") {
+                res.writeHead(200, { "Content-Type": "application/json" });
+                res.end(JSON.stringify({
+                    status: "ok",
+                    running: this.isRunning,
+                    activeCount: this.activeCount,
+                }));
+            }
+            else {
+                res.writeHead(404);
+                res.end();
+            }
+        });
+        this.server.listen(port, () => {
+            this.options.logger.log(`Health check server listening on port ${port}`);
+        });
+        this.server.on("error", (err) => {
+            this.options.logger.error("Health server error:", err);
+        });
+    }
+    stopHealthServer() {
+        if (this.server) {
+            this.server.close();
+            this.server = undefined;
+        }
     }
     async loop() {
         while (this.isRunning) {

package/dist/src/MemoryQueue.d.ts

@@ -7,3 +7,4 @@ export declare class MemoryQueue implements QueueAdapter {
     acknowledge(taskId: string): Promise<void>;
     reject(taskId: string, error?: Error): Promise<void>;
 }
+//# sourceMappingURL=MemoryQueue.d.ts.map

package/dist/src/MemoryQueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryQueue.d.ts","sourceRoot":"","sources":["../../src/MemoryQueue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE7C,qBAAa,WAAY,YAAW,YAAY;IAC9C,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,UAAU,CAAgC;IAE5C,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAQ/B,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ3D"}

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./types";
 export * from "./HiveCycle";
 export * from "./MemoryQueue";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC"}

package/dist/src/types.d.ts

@@ -34,9 +34,14 @@ export interface HiveCycleOptions {
     pollingInterval?: number;
     maxConcurrency?: number;
     logger?: Logger;
+    /**
+     * If provided, starts a health check HTTP server on this port.
+     */
+    healthPort?: number;
 }
 export interface Logger {
     log(message: string, ...args: any[]): void;
     error(message: string, ...args: any[]): void;
     warn(message: string, ...args: any[]): void;
 }
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI,CAAC,CAAC,GAAG,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAEhC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CAC7C"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hive-cycle",
-    "version": "0.1.1",
+    "version": "0.2.1",
     "description": "A modular TypeScript framework for background task processing",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",