* add resolvePayloadStoreConfig (#294)

* * add resolvePayloadStoreConfig

* * raise version

Author: Dosexe

packages/s3-payload-store/lib/S3PayloadStore.ts

@@ -5,6 +5,28 @@ import type { S3 } from '@aws-sdk/client-s3'
 import { NoSuchKey } from '@aws-sdk/client-s3'
 import type { PayloadStoreTypes, SerializedPayload } from '@message-queue-toolkit/core'
 
+export type S3AwareDependencies = { s3?: S3 }
+export type MessageQueuePayloadOffloadingConfig = {
+  s3PayloadOffloadingBucket?: string
+  messageSizeThreshold: number
+}
+
+export function resolvePayloadStoreConfig(
+  dependencies: S3AwareDependencies,
+  config?: MessageQueuePayloadOffloadingConfig,
+) {
+  if (!config?.s3PayloadOffloadingBucket) return undefined
+  if (!dependencies.s3) throw new Error('AWS S3 client is required for payload offloading')
+
+  return {
+    store: new S3PayloadStore(
+      { s3: dependencies.s3 },
+      { bucketName: config.s3PayloadOffloadingBucket },
+    ),
+    messageSizeThreshold: config.messageSizeThreshold,
+  }
+}
+
 export type S3PayloadStoreDependencies = {
   s3: S3
 }

packages/s3-payload-store/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@message-queue-toolkit/s3-payload-store",
-    "version": "2.0.0",
+    "version": "2.1.0",
     "private": false,
     "license": "MIT",
     "description": "AWS S3-based message store implementation for message-queue-toolkit",

packages/s3-payload-store/test/store/S3PayloadStore.spec.ts

@@ -3,7 +3,7 @@ import { Readable } from 'node:stream'
 import { S3 } from '@aws-sdk/client-s3'
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest'
 
-import { S3PayloadStore } from '../../lib/S3PayloadStore.ts'
+import { S3PayloadStore, resolvePayloadStoreConfig } from '../../lib/S3PayloadStore.ts'
 import { assertEmptyBucket, getObjectContent, objectExists } from '../utils/s3Utils.ts'
 import { streamToString } from '../utils/streamUtils.ts'
 import { TEST_AWS_CONFIG } from '../utils/testS3Config.ts'
@@ -88,4 +88,31 @@ describe('S3PayloadStore', () => {
       await expect(store.deletePayload('non-existing-key')).resolves.not.toThrow()
     })
   })
+  describe('resolvePayloadStoreConfig', () => {
+    it('should return undefined if s3PayloadOffloadingBucket is not set', () => {
+      const result = resolvePayloadStoreConfig({ s3: {} as any })
+      expect(result).toBeUndefined()
+    })
+    it('should throw an error if S3 is not defined', () => {
+      expect(() =>
+        resolvePayloadStoreConfig(
+          { s3: undefined },
+          {
+            s3PayloadOffloadingBucket: 'test-bucket',
+            messageSizeThreshold: 1,
+          },
+        ),
+      ).toThrowError('AWS S3 client is required for payload offloading')
+    })
+    it('should payload store config', () => {
+      const result = resolvePayloadStoreConfig(
+        { s3: {} as any },
+        { s3PayloadOffloadingBucket: 'test-bucket', messageSizeThreshold: 1 },
+      )
+      expect(result).toEqual({
+        store: expect.any(S3PayloadStore),
+        messageSizeThreshold: 1,
+      })
+    })
+  })
 })