@boringnode/queue 0.3.1 → 0.3.2

package/README.md

@@ -215,6 +215,34 @@ The adapter automatically creates tables on first use.
 
 </details>
 
+### Fake (testing + assertions)
+
+```typescript
+import { QueueManager } from '@boringnode/queue'
+import { redis } from '@boringnode/queue/drivers/redis_adapter'
+
+await QueueManager.init({
+  default: 'redis',
+  adapters: {
+    redis: redis({ host: 'localhost' }),
+  },
+  locations: ['./app/jobs/**/*.ts'],
+})
+
+const adapter = QueueManager.fake()
+
+await SendEmailJob.dispatch({ to: 'user@example.com' })
+
+adapter.assertPushed(SendEmailJob)
+adapter.assertPushed(SendEmailJob, {
+  queue: 'default',
+  payload: (payload) => payload.to === 'user@example.com',
+})
+adapter.assertPushedCount(1)
+
+QueueManager.restore()
+```
+
 ### Sync (for testing)
 
 ```typescript

package/build/{chunk-SMOKFZ46.js → chunk-3BIR4IQD.js}

@@ -93,8 +93,36 @@ var DEFAULT_STALLED_INTERVAL = "30s";
 var DEFAULT_STALLED_THRESHOLD = "30s";
 var DEFAULT_ERROR_RETRY_DELAY = "5s";
 
+// src/utils.ts
+import { parse as parseDuration } from "@lukeed/ms";
+function resolveRetention(retention) {
+  if (retention === void 0 || retention === true) {
+    return { keep: false, maxAge: 0, maxCount: 0 };
+  }
+  if (retention === false) {
+    return { keep: true, maxAge: 0, maxCount: 0 };
+  }
+  return {
+    keep: true,
+    maxAge: retention.age ? parse(retention.age) : 0,
+    maxCount: retention.count ?? 0
+  };
+}
+function parse(duration) {
+  if (typeof duration === "number") {
+    return duration;
+  }
+  const milliseconds = parseDuration(duration);
+  if (typeof milliseconds === "undefined") {
+    throw new E_INVALID_DURATION_EXPRESSION([duration]);
+  }
+  return milliseconds;
+}
+function calculateScore(priority, timestamp) {
+  return priority * PRIORITY_SCORE_MULTIPLIER + timestamp;
+}
+
 export {
-  E_INVALID_DURATION_EXPRESSION,
   E_INVALID_BASE_DELAY,
   E_INVALID_MAX_DELAY,
   E_INVALID_MULTIPLIER,
@@ -108,10 +136,12 @@ export {
   E_INVALID_SCHEDULE_CONFIG,
   exceptions_exports,
   DEFAULT_PRIORITY,
-  PRIORITY_SCORE_MULTIPLIER,
   DEFAULT_IDLE_DELAY,
   DEFAULT_STALLED_INTERVAL,
   DEFAULT_STALLED_THRESHOLD,
-  DEFAULT_ERROR_RETRY_DELAY
+  DEFAULT_ERROR_RETRY_DELAY,
+  resolveRetention,
+  parse,
+  calculateScore
 };
-//# sourceMappingURL=chunk-SMOKFZ46.js.map
+//# sourceMappingURL=chunk-3BIR4IQD.js.map

package/build/chunk-3BIR4IQD.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/exceptions.ts","../src/constants.ts","../src/utils.ts"],"sourcesContent":["import { createError } from '@poppinss/utils'\n\nexport const E_INVALID_DURATION_EXPRESSION = createError(\n  'Invalid duration expression: \"%s\"',\n  'E_INVALID_DURATION_EXPRESSION',\n  500\n)\n\nexport const E_INVALID_BASE_DELAY = createError<[reason: string]>(\n  'Invalid base delay. Reason: %s',\n  'E_INVALID_BASE_DELAY',\n  500\n)\n\nexport const E_INVALID_MAX_DELAY = createError<[reason: string]>(\n  'Invalid max delay. Reason: %s',\n  'E_INVALID_MAX_DELAY',\n  500\n)\n\nexport const E_INVALID_MULTIPLIER = createError<[reason: string]>(\n  'Invalid multiplier. Reason: %s',\n  'E_INVALID_MULTIPLIER',\n  500\n)\n\nexport const E_CONFIGURATION_ERROR = createError<[reason: string]>(\n  'Configuration error. Reason: %s',\n  'E_CONFIGURATION_ERROR',\n  500\n)\n\nexport const E_JOB_NOT_FOUND = createError<[jobName: string]>(\n  'Requested job \"%s\" is not registered',\n  'E_JOB_NOT_FOUND'\n)\n\nexport const E_JOB_MAX_ATTEMPTS_REACHED = createError<[jobName: string]>(\n  'The job \"%s\" has reached the maximum number of retry attempts',\n  'E_JOB_MAX_ATTEMPTS_REACHED'\n)\n\nexport const E_JOB_TIMEOUT = createError<[jobName: string, timeout: number]>(\n  'The job \"%s\" has exceeded the timeout of %dms',\n  'E_JOB_TIMEOUT'\n)\n\nexport const E_QUEUE_NOT_INITIALIZED = createError(\n  'QueueManager is not initialized. Call QueueManager.init() before using it.',\n  'E_QUEUE_NOT_INITIALIZED',\n  500\n)\n\nexport const E_ADAPTER_INIT_ERROR = createError<[adapterName: string, originalMessage: string]>(\n  'Failed to initialize adapter \"%s\". Reason: %s',\n  'E_ADAPTER_INIT_ERROR',\n  500\n)\n\nexport const E_NO_JOBS_FOUND = createError<[patterns: string]>(\n  'No jobs found for the specified locations: %s. Verify your glob patterns match your job files.',\n  'E_NO_JOBS_FOUND',\n  500\n)\n\nexport const E_INVALID_CRON_EXPRESSION = createError<[expression: string, reason: string]>(\n  'Invalid cron expression \"%s\": %s',\n  'E_INVALID_CRON_EXPRESSION',\n  500\n)\n\nexport const E_INVALID_SCHEDULE_CONFIG = createError<[reason: string]>(\n  'Invalid schedule configuration: %s',\n  'E_INVALID_SCHEDULE_CONFIG',\n  500\n)\n","/**\n * Default job priority (1-10 scale, lower = higher priority)\n */\nexport const DEFAULT_PRIORITY = 5\n\n/**\n * Multiplier used in score calculation: priority * multiplier + timestamp\n *\n * This ensures higher priority jobs are processed first,\n * while preserving FIFO order within the same priority.\n * The value (1e13) leaves room for ~300 years of millisecond timestamps.\n */\nexport const PRIORITY_SCORE_MULTIPLIER = 1e13\n\n/**\n * Default delay when the worker is idle (no jobs in queue)\n */\nexport const DEFAULT_IDLE_DELAY = '2s'\n\n/**\n * Default interval between stalled job checks\n */\nexport const DEFAULT_STALLED_INTERVAL = '30s'\n\n/**\n * Default threshold after which a job is considered stalled\n */\nexport const DEFAULT_STALLED_THRESHOLD = '30s'\n\n/**\n * Default delay before retrying after an error\n */\nexport const DEFAULT_ERROR_RETRY_DELAY = '5s'\n","import { parse as parseDuration } from '@lukeed/ms'\nimport type { Duration, JobRetention } from './types/main.js'\nimport * as errors from './exceptions.js'\nimport { PRIORITY_SCORE_MULTIPLIER } from './constants.js'\n\nexport interface ResolvedRetention {\n  keep: boolean\n  maxAge: number\n  maxCount: number\n}\n\nexport function resolveRetention(retention?: JobRetention): ResolvedRetention {\n  if (retention === undefined || retention === true) {\n    return { keep: false, maxAge: 0, maxCount: 0 }\n  }\n\n  if (retention === false) {\n    return { keep: true, maxAge: 0, maxCount: 0 }\n  }\n\n  return {\n    keep: true,\n    maxAge: retention.age ? parse(retention.age) : 0,\n    maxCount: retention.count ?? 0,\n  }\n}\n\nexport function parse(duration: Duration): number {\n  if (typeof duration === 'number') {\n    return duration\n  }\n\n  const milliseconds = parseDuration(duration)\n\n  if (typeof milliseconds === 'undefined') {\n    throw new errors.E_INVALID_DURATION_EXPRESSION([duration])\n  }\n\n  return milliseconds\n}\n\n/**\n * Calculate the score for job ordering in the queue.\n * Lower scores are processed first.\n *\n * @param priority - Job priority (1-10, lower = higher priority)\n * @param timestamp - Timestamp in milliseconds\n * @returns Score for queue ordering\n */\nexport function calculateScore(priority: number, timestamp: number): number {\n  return priority * PRIORITY_SCORE_MULTIPLIER + timestamp\n}\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;AAErB,IAAM,gCAAgC;AAAA,EAC3C;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,uBAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,sBAAsB;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,uBAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,wBAAwB;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AACF;AAEO,IAAM,6BAA6B;AAAA,EACxC;AAAA,EACA;AACF;AAEO,IAAM,gBAAgB;AAAA,EAC3B;AAAA,EACA;AACF;AAEO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,uBAAuB;AAAA,EAClC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,kBAAkB;AAAA,EAC7B;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,4BAA4B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,4BAA4B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AACF;;;ACxEO,IAAM,mBAAmB;AASzB,IAAM,4BAA4B;AAKlC,IAAM,qBAAqB;AAK3B,IAAM,2BAA2B;AAKjC,IAAM,4BAA4B;AAKlC,IAAM,4BAA4B;;;AChCzC,SAAS,SAAS,qBAAqB;AAWhC,SAAS,iBAAiB,WAA6C;AAC5E,MAAI,cAAc,UAAa,cAAc,MAAM;AACjD,WAAO,EAAE,MAAM,OAAO,QAAQ,GAAG,UAAU,EAAE;AAAA,EAC/C;AAEA,MAAI,cAAc,OAAO;AACvB,WAAO,EAAE,MAAM,MAAM,QAAQ,GAAG,UAAU,EAAE;AAAA,EAC9C;AAEA,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,UAAU,MAAM,MAAM,UAAU,GAAG,IAAI;AAAA,IAC/C,UAAU,UAAU,SAAS;AAAA,EAC/B;AACF;AAEO,SAAS,MAAM,UAA4B;AAChD,MAAI,OAAO,aAAa,UAAU;AAChC,WAAO;AAAA,EACT;AAEA,QAAM,eAAe,cAAc,QAAQ;AAE3C,MAAI,OAAO,iBAAiB,aAAa;AACvC,UAAM,IAAW,8BAA8B,CAAC,QAAQ,CAAC;AAAA,EAC3D;AAEA,SAAO;AACT;AAUO,SAAS,eAAe,UAAkB,WAA2B;AAC1E,SAAO,WAAW,4BAA4B;AAChD;","names":[]}