@forklaunch/implementation-worker-bullmq 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 forklaunch
+
+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/lib/__test__/schemaEquality.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=schemaEquality.test.d.ts.map

package/lib/__test__/schemaEquality.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaEquality.test.d.ts","sourceRoot":"","sources":["../../__test__/schemaEquality.test.ts"],"names":[],"mappings":""}

package/lib/__test__/schemaEquality.test.js

@@ -0,0 +1,16 @@
+import { isTrue } from '@forklaunch/common';
+import { testSchemaEquality } from '@forklaunch/core/test';
+import { BullMqWorkerOptionsSchema as TypeboxBullMqWorkerOptionsSchema } from '../schemas/typebox/bullMqWorker.schema';
+import { BullMqWorkerOptionsSchema as ZodBullMqWorkerOptionsSchema } from '../schemas/zod/bullMqWorker.schema';
+describe('schema equality', () => {
+    it('should be equal for bullmq worker', () => {
+        expect(isTrue(testSchemaEquality(ZodBullMqWorkerOptionsSchema, TypeboxBullMqWorkerOptionsSchema, {
+            backoffType: 'fixed',
+            retries: 1,
+            interval: 1000,
+            connection: {
+                url: 'redis://localhost:6379'
+            }
+        }))).toBeTruthy();
+    });
+});

package/lib/consumers/bullMqWorker.consumer.d.ts

@@ -0,0 +1,16 @@
+import { WorkerConsumer } from '@forklaunch/interfaces-worker/interfaces';
+import { WorkerEventEntity, WorkerFailureHandler, WorkerProcessFunction } from '@forklaunch/interfaces-worker/types';
+import { BullMqWorkerOptions } from '../types/bullMqWorker.types';
+export declare class BullMqWorkerConsumer<EventEntity extends WorkerEventEntity> implements WorkerConsumer<EventEntity> {
+    protected readonly queueName: string;
+    protected readonly options: BullMqWorkerOptions;
+    protected readonly processEvents: WorkerProcessFunction<EventEntity>;
+    protected readonly failureHandler: WorkerFailureHandler<EventEntity>;
+    private queue;
+    private worker?;
+    constructor(queueName: string, options: BullMqWorkerOptions, processEvents: WorkerProcessFunction<EventEntity>, failureHandler: WorkerFailureHandler<EventEntity>);
+    peekEvents(): Promise<EventEntity[]>;
+    start(): Promise<void>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=bullMqWorker.consumer.d.ts.map

package/lib/consumers/bullMqWorker.consumer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bullMqWorker.consumer.d.ts","sourceRoot":"","sources":["../../consumers/bullMqWorker.consumer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,qBAAa,oBAAoB,CAAC,WAAW,SAAS,iBAAiB,CACrE,YAAW,cAAc,CAAC,WAAW,CAAC;IAMpC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,mBAAmB;IAC/C,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC,WAAW,CAAC;IACpE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;IAPtE,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,MAAM,CAAC,CAAS;gBAGH,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB,EAC5B,aAAa,EAAE,qBAAqB,CAAC,WAAW,CAAC,EACjD,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;IAOhE,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAKpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAsBtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAI7B"}

package/lib/consumers/bullMqWorker.consumer.js

@@ -0,0 +1,42 @@
+import { Queue, Worker } from 'bullmq';
+export class BullMqWorkerConsumer {
+    queueName;
+    options;
+    processEvents;
+    failureHandler;
+    queue;
+    worker;
+    constructor(queueName, options, processEvents, failureHandler) {
+        this.queueName = queueName;
+        this.options = options;
+        this.processEvents = processEvents;
+        this.failureHandler = failureHandler;
+        this.queue = new Queue(this.queueName, {
+            connection: this.options.connection
+        });
+    }
+    async peekEvents() {
+        const jobs = await this.queue.getJobs(['waiting', 'active']);
+        return jobs.map((job) => job.data);
+    }
+    async start() {
+        this.worker = new Worker(this.queueName, async (job) => {
+            const event = job.data;
+            await this.processEvents([event]);
+        }, this.options);
+        this.worker.on('failed', (job, error) => {
+            if (job) {
+                this.failureHandler([
+                    {
+                        value: job.data,
+                        error
+                    }
+                ]);
+            }
+        });
+    }
+    async close() {
+        await this.worker?.close();
+        await this.queue.close();
+    }
+}

package/lib/consumers/index.d.ts

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

package/lib/consumers/index.d.ts.map

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

package/lib/consumers/index.js

@@ -0,0 +1 @@
+export * from './bullMqWorker.consumer';

package/lib/eject/consumers/bullMqWorker.consumer.ts

@@ -0,0 +1,58 @@
+import { WorkerConsumer } from '@forklaunch/interfaces-worker/interfaces';
+import {
+  WorkerEventEntity,
+  WorkerFailureHandler,
+  WorkerProcessFunction
+} from '@forklaunch/interfaces-worker/types';
+import { Job, Queue, Worker } from 'bullmq';
+import { BullMqWorkerOptions } from '../types/bullMqWorker.types';
+
+export class BullMqWorkerConsumer<EventEntity extends WorkerEventEntity>
+  implements WorkerConsumer<EventEntity>
+{
+  private queue: Queue;
+  private worker?: Worker;
+
+  constructor(
+    protected readonly queueName: string,
+    protected readonly options: BullMqWorkerOptions,
+    protected readonly processEvents: WorkerProcessFunction<EventEntity>,
+    protected readonly failureHandler: WorkerFailureHandler<EventEntity>
+  ) {
+    this.queue = new Queue(this.queueName, {
+      connection: this.options.connection
+    });
+  }
+
+  async peekEvents(): Promise<EventEntity[]> {
+    const jobs = await this.queue.getJobs(['waiting', 'active']);
+    return jobs.map((job) => job.data as EventEntity);
+  }
+
+  async start(): Promise<void> {
+    this.worker = new Worker(
+      this.queueName,
+      async (job: Job) => {
+        const event = job.data as EventEntity;
+        await this.processEvents([event]);
+      },
+      this.options
+    );
+
+    this.worker.on('failed', (job: Job | undefined, error: Error) => {
+      if (job) {
+        this.failureHandler([
+          {
+            value: job.data as EventEntity,
+            error
+          }
+        ]);
+      }
+    });
+  }
+
+  async close(): Promise<void> {
+    await this.worker?.close();
+    await this.queue.close();
+  }
+}

package/lib/eject/consumers/index.ts

@@ -0,0 +1 @@
+export * from './bullMqWorker.consumer';

package/lib/eject/domain/schemas/bullMqWorker.schema.ts

@@ -0,0 +1,153 @@
+import {
+  any,
+  array,
+  boolean,
+  date,
+  enum_,
+  function_,
+  literal,
+  null_,
+  number,
+  optional,
+  promise,
+  record,
+  string,
+  undefined_,
+  union,
+  unknown,
+  void_
+} from '@{{app_name}}/core';
+import { SpanKind } from 'bullmq';
+
+const BullMqWorkerKeepJobsSchema = {
+  age: optional(number),
+  count: optional(number)
+};
+
+const BullMqWorkerBackoffOptionsSchema = {
+  type: union([literal('fixed'), literal('exponential')]),
+  delay: optional(number)
+};
+
+const BullMqWorkerDefaultJobOptionsSchema = {
+  timestamp: optional(number),
+  priority: optional(number),
+  delay: optional(number),
+  attempts: optional(number),
+  backoff: optional(union([number, BullMqWorkerBackoffOptionsSchema])),
+  lifo: optional(boolean),
+  removeOnComplete: optional(
+    union([boolean, number, BullMqWorkerKeepJobsSchema])
+  ),
+  removeOnFail: optional(union([boolean, number, BullMqWorkerKeepJobsSchema])),
+  keepLogs: optional(number),
+  stackTraceLimit: optional(number),
+  sizeLimit: optional(number)
+};
+
+const BullMqWorkerAdvancedRepeatOptionsSchema = {
+  repeatStrategy: optional(
+    function_(
+      [
+        number,
+        {
+          pattern: optional(string),
+          key: optional(string),
+          limit: optional(number),
+          every: optional(number),
+          immediately: optional(boolean),
+          count: optional(number),
+          offset: optional(number),
+          prevMillis: optional(number),
+          jobId: optional(string),
+          currentDate: optional(date),
+          startDate: optional(date),
+          endDate: optional(date),
+          utc: optional(boolean),
+          tz: optional(string),
+          nthDayOfWeek: optional(number)
+        },
+        optional(string)
+      ],
+      union([number, undefined_, promise(union([number, undefined_]))])
+    )
+  ),
+  repeatKeyHashAlgorithm: optional(string)
+};
+
+const BullMqWorkerTelemetryAttributeValueSchema = union([
+  string,
+  number,
+  boolean,
+  array(union([string, null_, undefined_])),
+  array(union([number, null_, undefined_])),
+  array(union([boolean, null_, undefined_]))
+]);
+
+const BullMqWorkerTelemetryAttributesSchema = record(
+  string,
+  union([BullMqWorkerTelemetryAttributeValueSchema, undefined_])
+);
+
+const BullMqWorkerTelemetrySchema = optional({
+  tracer: {
+    startSpan: function_(
+      [
+        string,
+        optional({
+          kind: optional(enum_(SpanKind))
+        }),
+        optional(unknown)
+      ],
+      {
+        setSpanOnContext: function_([unknown], unknown),
+        setAttribute: function_(
+          [string, BullMqWorkerTelemetryAttributeValueSchema],
+          void_
+        ),
+        setAttributes: function_(
+          [BullMqWorkerTelemetryAttributesSchema],
+          void_
+        ),
+        addEvent: function_(
+          [string, optional(BullMqWorkerTelemetryAttributesSchema)],
+          void_
+        ),
+        recordException: function_([unknown, optional(number)], void_),
+        end: function_([], void_)
+      }
+    )
+  },
+  contextManager: {
+    with: function_([unknown, function_([any], any)], any),
+    active: function_([], unknown),
+    getMetadata: function_([unknown], string),
+    fromMetadata: function_([unknown, string], unknown)
+  }
+});
+
+const BullMqWorkerQueueOptionsSchema = {
+  connection: {
+    skipVersionCheck: optional(boolean),
+    url: optional(string)
+  },
+  blockingConnection: optional(boolean),
+  prefix: optional(string),
+  telemetry: BullMqWorkerTelemetrySchema,
+  skipWaitingForReady: optional(boolean),
+  defaultJobOptions: optional(BullMqWorkerDefaultJobOptionsSchema),
+  streams: optional({
+    events: {
+      maxLen: number
+    }
+  }),
+  skipMetasUpdate: optional(boolean),
+  settings: optional(BullMqWorkerAdvancedRepeatOptionsSchema)
+};
+
+export const BullMqWorkerOptionsSchema = {
+  ...BullMqWorkerQueueOptionsSchema,
+  backoffType: union([literal('exponential'), literal('fixed')]),
+  retries: number,
+  interval: number
+};

package/lib/eject/domain/schemas/index.ts

@@ -0,0 +1 @@
+export * from './bullMqWorker.schema';

package/lib/eject/producers/bullMqWorker.producer.ts

@@ -0,0 +1,44 @@
+import { WorkerProducer } from '@forklaunch/interfaces-worker/interfaces';
+import { WorkerEventEntity } from '@forklaunch/interfaces-worker/types';
+import { Queue } from 'bullmq';
+import { BullMqWorkerOptions } from '../types/bullMqWorker.types';
+
+export class BullMqWorkerProducer<EventEntity extends WorkerEventEntity>
+  implements WorkerProducer<EventEntity>
+{
+  private queue;
+
+  constructor(
+    private readonly queueName: string,
+    private readonly options: BullMqWorkerOptions
+  ) {
+    this.queue = new Queue(this.queueName, {
+      connection: this.options.connection
+    });
+  }
+
+  async enqueueJob(event: EventEntity): Promise<void> {
+    await this.queue.add(event.id, event, {
+      attempts: this.options.retries,
+      backoff: {
+        type: this.options.backoffType,
+        delay: this.options.interval
+      }
+    });
+  }
+  async enqueueBatchJobs(events: EventEntity[]): Promise<void> {
+    await this.queue.addBulk(
+      events.map((event) => ({
+        name: event.id,
+        data: event,
+        opts: {
+          attempts: this.options.retries,
+          backoff: {
+            type: this.options.backoffType,
+            delay: this.options.interval
+          }
+        }
+      }))
+    );
+  }
+}

package/lib/eject/producers/index.ts

@@ -0,0 +1 @@
+export * from './bullMqWorker.producer';

package/lib/eject/types/bullMqWorker.types.ts

@@ -0,0 +1,7 @@
+import { QueueOptions } from 'bullmq';
+
+export type BullMqWorkerOptions = QueueOptions & {
+  backoffType: 'exponential' | 'fixed';
+  retries: number;
+  interval: number;
+};

package/lib/eject/types/index.ts

@@ -0,0 +1 @@
+export * from './bullMqWorker.types';

package/lib/jest.config.d.ts

@@ -0,0 +1,4 @@
+import type { JestConfigWithTsJest } from 'ts-jest';
+declare const jestConfig: JestConfigWithTsJest;
+export default jestConfig;
+//# sourceMappingURL=jest.config.d.ts.map

package/lib/jest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.d.ts","sourceRoot":"","sources":["../jest.config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,QAAA,MAAM,UAAU,EAAE,oBAiBjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/lib/jest.config.js

@@ -0,0 +1,19 @@
+const jestConfig = {
+    preset: 'ts-jest/presets/default-esm', // or other ESM presets
+    moduleNameMapper: {
+        '^(\\.{1,2}/.*)\\.js$': '$1'
+    },
+    transform: {
+        // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
+        // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
+        '^.+\\.[tj]sx?$': [
+            'ts-jest',
+            {
+                useESM: true
+            }
+        ],
+        '^.+\\.js$': 'babel-jest'
+    },
+    testPathIgnorePatterns: ['.*dist/', '.*node_modules/']
+};
+export default jestConfig;

package/lib/producers/bullMqWorker.producer.d.ts

@@ -0,0 +1,12 @@
+import { WorkerProducer } from '@forklaunch/interfaces-worker/interfaces';
+import { WorkerEventEntity } from '@forklaunch/interfaces-worker/types';
+import { BullMqWorkerOptions } from '../types/bullMqWorker.types';
+export declare class BullMqWorkerProducer<EventEntity extends WorkerEventEntity> implements WorkerProducer<EventEntity> {
+    private readonly queueName;
+    private readonly options;
+    private queue;
+    constructor(queueName: string, options: BullMqWorkerOptions);
+    enqueueJob(event: EventEntity): Promise<void>;
+    enqueueBatchJobs(events: EventEntity[]): Promise<void>;
+}
+//# sourceMappingURL=bullMqWorker.producer.d.ts.map

package/lib/producers/bullMqWorker.producer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bullMqWorker.producer.d.ts","sourceRoot":"","sources":["../../producers/bullMqWorker.producer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAExE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,qBAAa,oBAAoB,CAAC,WAAW,SAAS,iBAAiB,CACrE,YAAW,cAAc,CAAC,WAAW,CAAC;IAKpC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJ1B,OAAO,CAAC,KAAK,CAAC;gBAGK,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,mBAAmB;IAOzC,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAS7C,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAe7D"}

package/lib/producers/bullMqWorker.producer.js

@@ -0,0 +1,35 @@
+import { Queue } from 'bullmq';
+export class BullMqWorkerProducer {
+    queueName;
+    options;
+    queue;
+    constructor(queueName, options) {
+        this.queueName = queueName;
+        this.options = options;
+        this.queue = new Queue(this.queueName, {
+            connection: this.options.connection
+        });
+    }
+    async enqueueJob(event) {
+        await this.queue.add(event.id, event, {
+            attempts: this.options.retries,
+            backoff: {
+                type: this.options.backoffType,
+                delay: this.options.interval
+            }
+        });
+    }
+    async enqueueBatchJobs(events) {
+        await this.queue.addBulk(events.map((event) => ({
+            name: event.id,
+            data: event,
+            opts: {
+                attempts: this.options.retries,
+                backoff: {
+                    type: this.options.backoffType,
+                    delay: this.options.interval
+                }
+            }
+        })));
+    }
+}

package/lib/producers/index.d.ts

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

package/lib/producers/index.d.ts.map

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

package/lib/producers/index.js

@@ -0,0 +1 @@
+export * from './bullMqWorker.producer';