@forklaunch/implementation-worker-database 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,12 @@
+import { isTrue } from '@forklaunch/common';
+import { testSchemaEquality } from '@forklaunch/core/test';
+import { DatabaseWorkerOptionsSchema as TypeboxDatabaseWorkerOptionsSchema } from '../schemas/typebox/databaseWorker.schema';
+import { DatabaseWorkerOptionsSchema as ZodDatabaseWorkerOptionsSchema } from '../schemas/zod/databaseWorker.schema';
+describe('schema equality', () => {
+    it('should be equal for bullmq worker', () => {
+        expect(isTrue(testSchemaEquality(ZodDatabaseWorkerOptionsSchema, TypeboxDatabaseWorkerOptionsSchema, {
+            retries: 1,
+            interval: 1000
+        }))).toBeTruthy();
+    });
+});

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

@@ -0,0 +1,18 @@
+import { BaseEntity } from '@forklaunch/core/persistence';
+import { WorkerConsumer } from '@forklaunch/interfaces-worker/interfaces';
+import { WorkerEventEntity, WorkerFailureHandler, WorkerProcessFunction } from '@forklaunch/interfaces-worker/types';
+import { EntityManager } from '@mikro-orm/core';
+import { DatabaseWorkerOptions } from '../types/databaseWorker.types';
+export declare class DatabaseWorkerConsumer<EventEntity extends WorkerEventEntity & BaseEntity> implements WorkerConsumer<EventEntity> {
+    protected readonly entityName: string;
+    protected readonly em: EntityManager;
+    protected readonly options: DatabaseWorkerOptions;
+    protected readonly processEvents: WorkerProcessFunction<EventEntity>;
+    protected readonly failureHandler: WorkerFailureHandler<EventEntity>;
+    constructor(entityName: string, em: EntityManager, options: DatabaseWorkerOptions, processEvents: WorkerProcessFunction<EventEntity>, failureHandler: WorkerFailureHandler<EventEntity>);
+    private retrieveEvents;
+    private updateEvents;
+    peekEvents(): Promise<EventEntity[]>;
+    start(): Promise<void>;
+}
+//# sourceMappingURL=databaseWorker.consumer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"databaseWorker.consumer.d.ts","sourceRoot":"","sources":["../../consumers/databaseWorker.consumer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAEtE,qBAAa,sBAAsB,CACjC,WAAW,SAAS,iBAAiB,GAAG,UAAU,CAClD,YAAW,cAAc,CAAC,WAAW,CAAC;IAGpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM;IACrC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,aAAa;IACpC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,qBAAqB;IACjD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC,WAAW,CAAC;IACpE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;gBAJjD,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,aAAa,EACjB,OAAO,EAAE,qBAAqB,EAC9B,aAAa,EAAE,qBAAqB,CAAC,WAAW,CAAC,EACjD,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;YAGxD,cAAc;YAUd,YAAY;IASpB,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAIpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAS7B"}

package/lib/consumers/databaseWorker.consumer.js

@@ -0,0 +1,41 @@
+export class DatabaseWorkerConsumer {
+    entityName;
+    em;
+    options;
+    processEvents;
+    failureHandler;
+    constructor(entityName, em, options, processEvents, failureHandler) {
+        this.entityName = entityName;
+        this.em = em;
+        this.options = options;
+        this.processEvents = processEvents;
+        this.failureHandler = failureHandler;
+    }
+    async retrieveEvents() {
+        return await this.em.getRepository(this.entityName).find({
+            where: {
+                processed: false,
+                retryCount: { $lt: this.options.retries }
+            },
+            orderBy: { createdAt: 'ASC' }
+        });
+    }
+    async updateEvents(events) {
+        await this.em.getRepository(this.entityName).upsertMany(events.map((event) => ({
+            ...event,
+            retryCount: event.retryCount + 1
+        })));
+    }
+    async peekEvents() {
+        return await this.retrieveEvents();
+    }
+    async start() {
+        setInterval(async () => {
+            const events = await this.retrieveEvents();
+            const failedEvents = await this.processEvents(events);
+            await this.failureHandler(failedEvents);
+            await this.updateEvents(failedEvents.map((event) => event.value));
+            await this.em.flush();
+        }, this.options.interval);
+    }
+}

package/lib/consumers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './databaseWorker.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,2BAA2B,CAAC"}

package/lib/consumers/index.js

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

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

@@ -0,0 +1,55 @@
+import { BaseEntity } from '@forklaunch/core/persistence';
+import { WorkerConsumer } from '@forklaunch/interfaces-worker/interfaces';
+import {
+  WorkerEventEntity,
+  WorkerFailureHandler,
+  WorkerProcessFunction
+} from '@forklaunch/interfaces-worker/types';
+import { EntityManager } from '@mikro-orm/core';
+import { DatabaseWorkerOptions } from '../types/databaseWorker.types';
+
+export class DatabaseWorkerConsumer<
+  EventEntity extends WorkerEventEntity & BaseEntity
+> implements WorkerConsumer<EventEntity>
+{
+  constructor(
+    protected readonly entityName: string,
+    protected readonly em: EntityManager,
+    protected readonly options: DatabaseWorkerOptions,
+    protected readonly processEvents: WorkerProcessFunction<EventEntity>,
+    protected readonly failureHandler: WorkerFailureHandler<EventEntity>
+  ) {}
+
+  private async retrieveEvents(): Promise<EventEntity[]> {
+    return await this.em.getRepository<EventEntity>(this.entityName).find({
+      where: {
+        processed: false,
+        retryCount: { $lt: this.options.retries }
+      },
+      orderBy: { createdAt: 'ASC' }
+    });
+  }
+
+  private async updateEvents(events: EventEntity[]): Promise<void> {
+    await this.em.getRepository(this.entityName).upsertMany(
+      events.map((event) => ({
+        ...event,
+        retryCount: event.retryCount + 1
+      }))
+    );
+  }
+
+  async peekEvents(): Promise<EventEntity[]> {
+    return await this.retrieveEvents();
+  }
+
+  async start(): Promise<void> {
+    setInterval(async () => {
+      const events = await this.retrieveEvents();
+      const failedEvents = await this.processEvents(events);
+      await this.failureHandler(failedEvents);
+      await this.updateEvents(failedEvents.map((event) => event.value));
+      await this.em.flush();
+    }, this.options.interval);
+  }
+}

package/lib/eject/consumers/index.ts

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

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

@@ -0,0 +1,6 @@
+import { number } from '@{{app_name}}/core';
+
+export const DatabaseWorkerOptionsSchema = {
+  retries: number,
+  interval: number
+};

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

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

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

@@ -0,0 +1,17 @@
+import { BaseEntity } from '@forklaunch/core/persistence';
+import { WorkerEventEntity } from '@forklaunch/interfaces-worker/types';
+import { EntityManager } from '@mikro-orm/core';
+
+export class DatabaseWorkerProducer<
+  EventEntity extends WorkerEventEntity & BaseEntity
+> {
+  constructor(private readonly em: EntityManager) {}
+
+  async enqueueJob(event: EventEntity): Promise<void> {
+    await this.em.persistAndFlush(event);
+  }
+
+  async enqueueBatchJobs(events: EventEntity[]): Promise<void> {
+    await this.em.persistAndFlush(events);
+  }
+}

package/lib/eject/producers/index.ts

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

package/lib/eject/types/databaseWorker.types.ts

@@ -0,0 +1,4 @@
+export type DatabaseWorkerOptions = {
+  retries: number;
+  interval: number;
+};

package/lib/eject/types/index.ts

@@ -0,0 +1 @@
+export * from './databaseWorker.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/databaseWorker.producer.d.ts

@@ -0,0 +1,10 @@
+import { BaseEntity } from '@forklaunch/core/persistence';
+import { WorkerEventEntity } from '@forklaunch/interfaces-worker/types';
+import { EntityManager } from '@mikro-orm/core';
+export declare class DatabaseWorkerProducer<EventEntity extends WorkerEventEntity & BaseEntity> {
+    private readonly em;
+    constructor(em: EntityManager);
+    enqueueJob(event: EventEntity): Promise<void>;
+    enqueueBatchJobs(events: EventEntity[]): Promise<void>;
+}
+//# sourceMappingURL=databaseWorker.producer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"databaseWorker.producer.d.ts","sourceRoot":"","sources":["../../producers/databaseWorker.producer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,qBAAa,sBAAsB,CACjC,WAAW,SAAS,iBAAiB,GAAG,UAAU;IAEtC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAAF,EAAE,EAAE,aAAa;IAExC,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7D"}

package/lib/producers/databaseWorker.producer.js

@@ -0,0 +1,12 @@
+export class DatabaseWorkerProducer {
+    em;
+    constructor(em) {
+        this.em = em;
+    }
+    async enqueueJob(event) {
+        await this.em.persistAndFlush(event);
+    }
+    async enqueueBatchJobs(events) {
+        await this.em.persistAndFlush(events);
+    }
+}

package/lib/producers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './databaseWorker.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,2BAA2B,CAAC"}

package/lib/producers/index.js

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

package/lib/schemas/databaseWorker.schema.d.ts

@@ -0,0 +1,10 @@
+export declare const DatabaseWorkerSchemas: <SchemaValidator extends import("@forklaunch/validator").AnySchemaValidator>(options: Record<string, unknown> & {
+    validator: SchemaValidator;
+}) => import("@forklaunch/core/mappers").SchemasByValidator<SchemaValidator, (options: Record<string, unknown>) => {
+    retries: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TDate, import("@sinclair/typebox").TBigInt]>, number>;
+    interval: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TDate, import("@sinclair/typebox").TBigInt]>, number>;
+}, (options: Record<string, unknown>) => {
+    retries: import("zod").ZodNumber;
+    interval: import("zod").ZodNumber;
+}>;
+//# sourceMappingURL=databaseWorker.schema.d.ts.map

package/lib/schemas/databaseWorker.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseWorker.schema.d.ts","sourceRoot":"","sources":["../../schemas/databaseWorker.schema.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,qBAAqB;;;;;;;;EAGjC,CAAC"}

package/lib/schemas/databaseWorker.schema.js

@@ -0,0 +1,4 @@
+import { serviceSchemaResolver } from '@forklaunch/core/mappers';
+import { DatabaseWorkerOptionsSchema as TypeBoxSchemas } from './typebox/databaseWorker.schema';
+import { DatabaseWorkerOptionsSchema as ZodSchemas } from './zod/databaseWorker.schema';
+export const DatabaseWorkerSchemas = serviceSchemaResolver(() => TypeBoxSchemas, () => ZodSchemas);

package/lib/schemas/index.d.ts

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

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

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

package/lib/schemas/index.js

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

package/lib/schemas/typebox/databaseWorker.schema.d.ts

@@ -0,0 +1,5 @@
+export declare const DatabaseWorkerOptionsSchema: {
+    retries: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TDate, import("@sinclair/typebox").TBigInt]>, number>;
+    interval: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TString, import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TDate, import("@sinclair/typebox").TBigInt]>, number>;
+};
+//# sourceMappingURL=databaseWorker.schema.d.ts.map

package/lib/schemas/typebox/databaseWorker.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseWorker.schema.d.ts","sourceRoot":"","sources":["../../../schemas/typebox/databaseWorker.schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,2BAA2B;;;CAGvC,CAAC"}

package/lib/schemas/typebox/databaseWorker.schema.js

@@ -0,0 +1,5 @@
+import { number } from '@forklaunch/validator/typebox';
+export const DatabaseWorkerOptionsSchema = {
+    retries: number,
+    interval: number
+};

package/lib/schemas/zod/databaseWorker.schema.d.ts

@@ -0,0 +1,5 @@
+export declare const DatabaseWorkerOptionsSchema: {
+    retries: import("zod").ZodNumber;
+    interval: import("zod").ZodNumber;
+};
+//# sourceMappingURL=databaseWorker.schema.d.ts.map

package/lib/schemas/zod/databaseWorker.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseWorker.schema.d.ts","sourceRoot":"","sources":["../../../schemas/zod/databaseWorker.schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,2BAA2B;;;CAGvC,CAAC"}

package/lib/schemas/zod/databaseWorker.schema.js

@@ -0,0 +1,5 @@
+import { number } from '@forklaunch/validator/zod';
+export const DatabaseWorkerOptionsSchema = {
+    retries: number,
+    interval: number
+};