Support deep partial

kibertoad · Dec 7, 2023 · 9b3f611 · 9b3f611
1 parent e09190c
commit 9b3f611
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 4 deletions.
diff --git a/packages/core/lib/queues/HandlerSpy.ts b/packages/core/lib/queues/HandlerSpy.ts
@@ -23,7 +23,7 @@ type SpyResultCacheEntry<MessagePayloadSchemas extends object> = {
 }
 
 type SpyPromiseMetadata<MessagePayloadSchemas extends object> = {
-  fields: Partial<MessagePayloadSchemas>
+  fields: DeepPartial<MessagePayloadSchemas>
   processingResult?: MessageProcessingResult
   promise: Promise<SpyResult<MessagePayloadSchemas>>
   resolve: (
@@ -43,6 +43,19 @@ export type PublicHandlerSpy<MessagePayloadSchemas extends object> = Omit<
   'addProcessedMessage'
 >
 
+// eslint-disable-next-line @typescript-eslint/ban-types
+type DeepPartial<T> = T extends Function
+  ? T
+  : T extends object
+    ? {
+        [P in keyof T]?: T[P] extends Array<infer U>
+          ? Array<DeepPartial<U>>
+          : T[P] extends ReadonlyArray<infer U>
+            ? ReadonlyArray<DeepPartial<U>>
+            : DeepPartial<T[P]>
+      }
+    : T
+
 export class HandlerSpy<MessagePayloadSchemas extends object> {
   public name = 'HandlerSpy'
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -59,7 +72,7 @@ export class HandlerSpy<MessagePayloadSchemas extends object> {
 
   private messageMatchesFilter(
     spyResult: SpyResult<object>,
-    fields: Partial<MessagePayloadSchemas>,
+    fields: DeepPartial<MessagePayloadSchemas>,
     processingResult?: MessageProcessingResult,
   ) {
     return (
@@ -80,7 +93,7 @@ export class HandlerSpy<MessagePayloadSchemas extends object> {
   }
 
   waitForMessage(
-    fields: Partial<MessagePayloadSchemas>,
+    fields: DeepPartial<MessagePayloadSchemas>,
     processingResult?: MessageProcessingResult,
   ): Promise<SpyResult<MessagePayloadSchemas>> {
     const processedMessageEntry = Object.values(this.messageBuffer.items).find(

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "private": false,
   "license": "MIT",
   "description": "Useful utilities, interfaces and base classes for message queue handling. Supports AMQP and SQS with a common abstraction on top currently",

diff --git a/packages/core/test/queues/HandlerSpy.spec.ts b/packages/core/test/queues/HandlerSpy.spec.ts
@@ -8,6 +8,17 @@ type Message = {
   payload?: Record<string, unknown>
 }
 
+type DeepMessage = {
+  id: string
+  status: string
+  payload?: {
+    fieldA: number
+    fieldB: string[]
+    fieldC: string
+    fieldD: boolean
+  }
+}
+
 const TEST_MESSAGE: Message = {
   id: 'abc',
   status: 'done',
@@ -133,6 +144,35 @@ describe('HandlerSpy', () => {
       expect(message.message).toEqual(TEST_MESSAGE_4)
     })
 
+    it('Finds previously consumed event with a deep partial match, with incomplete fields', async () => {
+      const spy = new HandlerSpy<DeepMessage>()
+      const message: DeepMessage = {
+        id: 'abc',
+        status: 'good',
+        payload: {
+          fieldA: 1,
+          fieldB: ['w'],
+          fieldC: 're',
+          fieldD: true,
+        },
+      }
+
+      spy.addProcessedMessage({
+        processingResult: 'consumed',
+        message,
+      })
+
+      const messageResult = await spy.waitForMessage({
+        payload: {
+          fieldA: 1,
+          fieldB: ['w'],
+          fieldC: 're',
+        },
+      })
+
+      expect(messageResult.message).toEqual(message)
+    })
+
     it('Finds previously consumed event with an array match in order', async () => {
       const spy = new HandlerSpy<Message>()