AP-5046 WIP prisma adapter.

Author: kamilwylegala

packages/outbox-prisma-adapter/README.md

@@ -0,0 +1,42 @@
+# outbox-core
+
+Main package that contains the core functionality of the Outbox pattern to provide "at least once" delivery semantics for messages.
+
+## Installation
+
+```bash
+npm i -S @message-queue-toolkit/outbox-core
+```
+
+## Usage
+
+To process outbox entries and emit them to the message queue, you need to create an instance of the `OutboxPeriodicJob` class:
+
+```typescript
+import { OutboxPeriodicJob } from '@message-queue-toolkit/outbox-core';
+
+const job = new OutboxPeriodicJob(
+    //Implementation of OutboxStorage interface, TODO: Point to other packages in message-queue-toolkit
+    outboxStorage, 
+    //Default available accumulator for gathering outbox entries as the process job is progressing.
+    new InMemoryOutboxAccumulator(),
+    //DomainEventEmitter, it will be used to publish events, see @message-queue-toolkit/core
+    eventEmitter,
+    //See PeriodicJobDependencies from @lokalise/background-jobs-common
+    dependencies,
+    //Retry count, how many times outbox entries should be retried to be processed
+    3,
+    //emitBatchSize - how many outbox entries should be emitted at once
+    10,
+    //internalInMs - how often the job should be executed, e.g. below it runs every 1sec
+    1000
+)
+```
+
+Job will take care of processing outbox entries emitted by:
+```typescript
+const emitter = new OutboxEventEmitter(
+    //Same instance of outbox storage that is used by OutboxPeriodicJob
+    outboxStorage
+)
+```

packages/outbox-prisma-adapter/index.ts

@@ -0,0 +1 @@
+export * from './lib/outbox-prisma-adapter'

packages/outbox-prisma-adapter/lib/outbox-prisma-adapter.ts

@@ -0,0 +1,21 @@
+import type { OutboxAccumulator, OutboxEntry } from '@message-queue-toolkit/outbox-core'
+import type { OutboxStorage } from '@message-queue-toolkit/outbox-core/dist/lib/storage'
+import type { CommonEventDefinition } from '@message-queue-toolkit/schemas'
+
+export class OutboxPrismaAdapter<SupportedEvents extends CommonEventDefinition[]>
+  implements OutboxStorage<SupportedEvents>
+{
+  createEntry(
+    outboxEntry: OutboxEntry<SupportedEvents[number]>,
+  ): Promise<OutboxEntry<SupportedEvents[number]>> {
+    return Promise.resolve(undefined)
+  }
+
+  flush(outboxAccumulator: OutboxAccumulator<SupportedEvents>): Promise<void> {
+    return Promise.resolve(undefined)
+  }
+
+  getEntries(maxRetryCount: number): Promise<OutboxEntry<SupportedEvents[number]>[]> {
+    return Promise.resolve([])
+  }
+}

packages/outbox-prisma-adapter/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@message-queue-toolkit/outbox-prisma-adapter",
+  "version": "0.1.0",
+  "private": false,
+  "license": "MIT",
+  "description": "OutboxStorage implementation for @message-queue-toolkit/outbox-core package.",
+  "maintainers": [
+    {
+      "name": "Igor Savin",
+      "email": "kibertoad@gmail.com"
+    }
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "del-cli dist && tsc",
+    "build:release": "del-cli dist && del-cli coverage && npm run lint && tsc --project tsconfig.release.json",
+    "test": "vitest",
+    "test:coverage": "npm test -- --coverage",
+    "test:ci": "npm run docker:start:dev && npm run test:coverage && npm run docker:stop:dev",
+    "lint": "biome check . && tsc --project tsconfig.json --noEmit",
+    "lint:fix": "biome check --write .",
+    "docker:start:dev": "docker compose up -d",
+    "docker:stop:dev": "docker compose down",
+    "prepublishOnly": "npm run build:release"
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@message-queue-toolkit/core": ">=14.0.0",
+    "@message-queue-toolkit/schemas": ">=4.0.0",
+    "@message-queue-toolkit/outbox-core": ">=0.1.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.8.3",
+    "@kibertoad/biome-config": "^1.2.1",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^2.0.4",
+    "del-cli": "^5.1.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.4",
+    "zod": "^3.23.8"
+  },
+  "homepage": "https://github.com/kibertoad/message-queue-toolkit",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kibertoad/message-queue-toolkit.git"
+  },
+  "keywords": [
+    "message",
+    "queue",
+    "queues",
+    "abstract",
+    "common",
+    "utils",
+    "notification",
+    "outbox",
+    "pattern"
+  ],
+  "files": ["README.md", "LICENSE", "dist/*"]
+}

packages/outbox-prisma-adapter/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "ES2022",
+    "lib": ["ES2022", "dom"],
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": false,
+    "types": ["node", "vitest/globals"],
+    "strict": true,
+    "moduleResolution": "node",
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noFallthroughCasesInSwitch": true,
+    "strictNullChecks": true,
+    "importHelpers": true,
+    "baseUrl": ".",
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["lib/**/*.ts", "test/**/*.ts", "index.ts"],
+  "exclude": ["node_modules", "dist"]
+}

packages/outbox-prisma-adapter/tsconfig.release.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["lib/**/*.ts", "index.ts"],
+  "exclude": ["node_modules", "dist", "lib/**/*.spec.ts"]
+}

packages/outbox-prisma-adapter/vitest.config.mts

@@ -0,0 +1,23 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    globals: true,
+    watch: false,
+    environment: 'node',
+    reporters: ['default'],
+    coverage: {
+      provider: 'v8',
+      include: ['lib/**/*.ts'],
+      exclude: ['lib/**/*.spec.ts', 'lib/**/*.test.ts', 'test/**/*.*'],
+      reporter: ['text'],
+      all: true,
+      thresholds: {
+        lines: 100,
+        functions: 100,
+        branches: 91.66,
+        statements: 100,
+      },
+    },
+  },
+})