atomic-queues 1.0.13

package/dist/utils/helpers.js

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAtomicJobData = createAtomicJobData;
+exports.createDefaultJobOptions = createDefaultJobOptions;
+exports.createHighPriorityJobOptions = createHighPriorityJobOptions;
+exports.sleep = sleep;
+exports.retry = retry;
+exports.getEntityQueueName = getEntityQueueName;
+exports.getEntityWorkerName = getEntityWorkerName;
+exports.parseQueueName = parseQueueName;
+exports.createSigtermPayload = createSigtermPayload;
+exports.isSigtermJob = isSigtermJob;
+exports.batch = batch;
+exports.createTimeout = createTimeout;
+exports.withTimeout = withTimeout;
+exports.debounce = debounce;
+exports.throttle = throttle;
+const uuid_1 = require("uuid");
+/**
+ * Create an atomic job data payload.
+ *
+ * @example
+ * ```typescript
+ * const jobData = createAtomicJobData({
+ *   entityType: 'user',
+ *   entityId: '123',
+ *   type: 'command',
+ *   commandName: 'SendMessageCommand',
+ *   payload: { message: 'Hello!' },
+ * });
+ *
+ * await queueManager.addJob('user-123-queue', 'send-message', jobData);
+ * ```
+ */
+function createAtomicJobData(options) {
+    return {
+        uuid: (0, uuid_1.v4)(),
+        entityId: options.entityId,
+        entityType: options.entityType,
+        type: options.type,
+        commandName: options.commandName,
+        payload: options.payload,
+        metadata: options.metadata,
+    };
+}
+/**
+ * Create default job options with common settings.
+ *
+ * @example
+ * ```typescript
+ * const options = createDefaultJobOptions({
+ *   priority: 0, // Highest priority
+ *   attempts: 5,
+ * });
+ * ```
+ */
+function createDefaultJobOptions(overrides) {
+    return {
+        removeOnComplete: true,
+        removeOnFail: false,
+        attempts: Number.MAX_SAFE_INTEGER,
+        backoff: {
+            type: 'fixed',
+            delay: 1000,
+        },
+        priority: 1,
+        ...overrides,
+    };
+}
+/**
+ * Create high-priority job options (for SIGTERM signals, etc.)
+ */
+function createHighPriorityJobOptions(overrides) {
+    return createDefaultJobOptions({
+        priority: 0, // Highest priority
+        ...overrides,
+    });
+}
+/**
+ * Sleep utility for async operations.
+ */
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+/**
+ * Retry utility with exponential backoff.
+ *
+ * @example
+ * ```typescript
+ * const result = await retry(
+ *   () => someUnreliableOperation(),
+ *   { maxAttempts: 3, baseDelay: 1000 },
+ * );
+ * ```
+ */
+async function retry(fn, options) {
+    const { maxAttempts, baseDelay, maxDelay = 30000, exponential = true, onRetry } = options;
+    let lastError;
+    for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+        try {
+            return await fn();
+        }
+        catch (error) {
+            lastError = error;
+            if (attempt === maxAttempts) {
+                throw lastError;
+            }
+            if (onRetry) {
+                onRetry(attempt, lastError);
+            }
+            const delay = exponential
+                ? Math.min(baseDelay * Math.pow(2, attempt - 1), maxDelay)
+                : baseDelay;
+            await sleep(delay);
+        }
+    }
+    throw lastError;
+}
+/**
+ * Generate a queue name for an entity.
+ */
+function getEntityQueueName(entityType, entityId, prefix = 'aq') {
+    return `${prefix}:${entityType}:${entityId}:queue`;
+}
+/**
+ * Generate a worker name for an entity.
+ */
+function getEntityWorkerName(entityType, entityId, prefix = 'aq') {
+    return `${prefix}:${entityType}:${entityId}:worker`;
+}
+/**
+ * Parse a queue name to extract entity info.
+ */
+function parseQueueName(queueName) {
+    const parts = queueName.split(':');
+    if (parts.length >= 4 && parts[3] === 'queue') {
+        return {
+            prefix: parts[0],
+            entityType: parts[1],
+            entityId: parts[2],
+        };
+    }
+    return null;
+}
+/**
+ * Create a SIGTERM job payload for worker termination.
+ */
+function createSigtermPayload(entityType, entityId) {
+    return {
+        uuid: (0, uuid_1.v4)(),
+        entityId,
+        entityType,
+        type: 'custom',
+        payload: { type: 'SIGTERM' },
+        metadata: { signal: 'SIGTERM' },
+    };
+}
+/**
+ * Check if a job is a SIGTERM signal.
+ */
+function isSigtermJob(data) {
+    return (data.type === 'custom' &&
+        data.payload?.type === 'SIGTERM');
+}
+/**
+ * Batch utility for processing items in chunks.
+ *
+ * @example
+ * ```typescript
+ * await batch(items, 10, async (chunk) => {
+ *   await Promise.all(chunk.map(processItem));
+ * });
+ * ```
+ */
+async function batch(items, batchSize, processor) {
+    for (let i = 0; i < items.length; i += batchSize) {
+        const chunk = items.slice(i, i + batchSize);
+        await processor(chunk);
+    }
+}
+/**
+ * Create a timeout promise that rejects after specified ms.
+ */
+function createTimeout(ms, message = 'Operation timed out') {
+    return new Promise((_, reject) => {
+        setTimeout(() => reject(new Error(message)), ms);
+    });
+}
+/**
+ * Run an operation with a timeout.
+ *
+ * @example
+ * ```typescript
+ * const result = await withTimeout(
+ *   someAsyncOperation(),
+ *   5000,
+ *   'Operation took too long',
+ * );
+ * ```
+ */
+async function withTimeout(promise, ms, message) {
+    return Promise.race([promise, createTimeout(ms, message)]);
+}
+/**
+ * Debounce utility for functions.
+ */
+function debounce(fn, ms) {
+    let timeoutId = null;
+    return (...args) => {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        timeoutId = setTimeout(() => fn(...args), ms);
+    };
+}
+/**
+ * Throttle utility for functions.
+ */
+function throttle(fn, ms) {
+    let lastCall = 0;
+    return (...args) => {
+        const now = Date.now();
+        if (now - lastCall >= ms) {
+            lastCall = now;
+            fn(...args);
+        }
+    };
+}
+//# sourceMappingURL=helpers.js.map

package/dist/utils/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":";;AAmBA,kDAiBC;AAaD,0DAcC;AAKD,oEAOC;AAKD,sBAEC;AAaD,sBAqCC;AAKD,gDAMC;AAKD,kDAMC;AAKD,wCAcC;AAKD,oDAYC;AAKD,oCAKC;AAYD,sBASC;AAKD,sCAIC;AAcD,kCAMC;AAKD,4BAYC;AAKD,4BAaC;AA7RD,+BAAoC;AAGpC;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,mBAAmB,CAAc,OAOhD;IACC,OAAO;QACL,IAAI,EAAE,IAAA,SAAM,GAAE;QACd,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CACrC,SAAgC;IAEhC,OAAO;QACL,gBAAgB,EAAE,IAAI;QACtB,YAAY,EAAE,KAAK;QACnB,QAAQ,EAAE,MAAM,CAAC,gBAAgB;QACjC,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,IAAI;SACZ;QACD,QAAQ,EAAE,CAAC;QACX,GAAG,SAAS;KACb,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,4BAA4B,CAC1C,SAAgC;IAEhC,OAAO,uBAAuB,CAAC;QAC7B,QAAQ,EAAE,CAAC,EAAE,mBAAmB;QAChC,GAAG,SAAS;KACb,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAgB,KAAK,CAAC,EAAU;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,KAAK,CACzB,EAAoB,EACpB,OAMC;IAED,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE1F,IAAI,SAA4B,CAAC;IAEjC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAc,CAAC;YAE3B,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;gBAC5B,MAAM,SAAS,CAAC;YAClB,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAC9B,CAAC;YAED,MAAM,KAAK,GAAG,WAAW;gBACvB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC;gBAC1D,CAAC,CAAC,SAAS,CAAC;YAEd,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,MAAM,SAAS,CAAC;AAClB,CAAC;AAED;;GAEG;AACH,SAAgB,kBAAkB,CAChC,UAAkB,EAClB,QAAgB,EAChB,MAAM,GAAG,IAAI;IAEb,OAAO,GAAG,MAAM,IAAI,UAAU,IAAI,QAAQ,QAAQ,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,UAAkB,EAClB,QAAgB,EAChB,MAAM,GAAG,IAAI;IAEb,OAAO,GAAG,MAAM,IAAI,UAAU,IAAI,QAAQ,SAAS,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,SAAiB;IAK9C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;QAC9C,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;YAChB,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;YACpB,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;SACnB,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAClC,UAAkB,EAClB,QAAgB;IAEhB,OAAO;QACL,IAAI,EAAE,IAAA,SAAM,GAAE;QACd,QAAQ;QACR,UAAU;QACV,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAO;QACjC,QAAQ,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE;KAChC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAoB;IAC/C,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,QAAQ;QACrB,IAAI,CAAC,OAA6B,EAAE,IAAI,KAAK,SAAS,CACxD,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,KAAK,CACzB,KAAU,EACV,SAAiB,EACjB,SAAwC;IAExC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;QACjD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC;QAC5C,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,EAAU,EAAE,OAAO,GAAG,qBAAqB;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QAC/B,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,WAAW,CAC/B,OAAmB,EACnB,EAAU,EACV,OAAgB;IAEhB,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ,CACtB,EAAK,EACL,EAAU;IAEV,IAAI,SAAS,GAA0B,IAAI,CAAC;IAE5C,OAAO,CAAC,GAAG,IAAmB,EAAE,EAAE;QAChC,IAAI,SAAS,EAAE,CAAC;YACd,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QACD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ,CACtB,EAAK,EACL,EAAU;IAEV,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,OAAO,CAAC,GAAG,IAAmB,EAAE,EAAE;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,QAAQ,IAAI,EAAE,EAAE,CAAC;YACzB,QAAQ,GAAG,GAAG,CAAC;YACf,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QACd,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './helpers';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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("./helpers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "atomic-queues",
+  "version": "1.0.13",
+  "description": "A plug-and-play NestJS library for atomic process handling per entity with BullMQ, Redis distributed locking, and dynamic worker management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Marce1o/nestjs-atomicQueues.git"
+  },
+  "homepage": "https://github.com/Marce1o/nestjs-atomicQueues#readme",
+  "bugs": {
+    "url": "https://github.com/Marce1o/nestjs-atomicQueues/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "dev": "tsc --watch",
+    "copy-package": "node -e \"const p=require('./package.json'); p.main='index.js'; p.types='index.d.ts'; p.files=['**/*.js','**/*.d.ts','**/*.js.map','**/*.d.ts.map']; require('fs').writeFileSync('./dist/package.json', JSON.stringify(p, null, 2));\"",
+    "publish": "cd dist && npm publish --ignore-scripts",
+    "print:local:instructions": "FOLDER=$(echo \"$PWD\"/atomicqueues-core*.tgz) && echo 'Reinstall with -> npm uninstall @atomicqueues/core && npm i file:'\"$FOLDER\"",
+    "pack": "npm run build && npm run copy-package && cd dist && npm pack --ignore-scripts && npm run print:local:instructions",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "lint": "eslint src/**/*.ts"
+  },
+  "keywords": [
+    "nestjs",
+    "queue",
+    "bullmq",
+    "redis",
+    "atomic",
+    "distributed-lock",
+    "worker-management",
+    "cqrs"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "@nestjs/bullmq": ">=10.0.0",
+    "@nestjs/common": ">=10.0.0",
+    "@nestjs/core": ">=10.0.0",
+    "@nestjs/cqrs": ">=10.0.0",
+    "bullmq": ">=5.0.0",
+    "ioredis": ">=5.0.0",
+    "reflect-metadata": ">=0.1.13",
+    "rxjs": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/bullmq": "^10.2.0",
+    "@nestjs/common": "^10.3.0",
+    "@nestjs/core": "^10.3.0",
+    "@nestjs/cqrs": "^10.2.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "@types/uuid": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "bullmq": "^5.1.0",
+    "eslint": "^8.0.0",
+    "ioredis": "^5.3.0",
+    "jest": "^29.5.0",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^6.1.2",
+    "rxjs": "^7.8.0",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.3.0",
+    "uuid": "^9.0.0"
+  },
+  "dependencies": {
+    "class-transformer": "^0.5.1",
+    "uuid": "^9.0.0"
+  }
+}