|
| 1 | +/** |
| 2 | + * Regression tests for `AbstractQueueService.offloadMessagePayloadIfNeeded`. |
| 3 | + * |
| 4 | + * Identity fields (`messageIdField`, `messageTimestampField`, `messageDeduplicationIdField`, |
| 5 | + * `messageDeduplicationOptionsField`) all have defaulted names ('id', 'timestamp', ...) and |
| 6 | + * are unconditionally copied to the offloaded payload when present on the source message. |
| 7 | + * The `type` field — which downstream subscriptions rely on for routing/filtering, e.g. SNS |
| 8 | + * `FilterPolicyScope: 'MessageBody'` — must be handled the same way: present-on-source ⇒ |
| 9 | + * present-on-offloaded, regardless of which `messageTypeResolver` mode (or absence) is |
| 10 | + * configured. Otherwise large messages get silently dropped by SNS subscription filters. |
| 11 | + */ |
| 12 | +import type { CommonLogger, Either, ErrorReporter } from '@lokalise/node-core' |
| 13 | +import { describe, expect, it } from 'vitest' |
| 14 | +import type { ZodSchema } from 'zod/v4' |
| 15 | +import type { MessageInvalidFormatError, MessageValidationError } from '../../lib/errors/Errors.ts' |
| 16 | +import type { OffloadedPayloadPointerPayload } from '../../lib/payload-store/offloadedPayloadMessageSchemas.ts' |
| 17 | +import type { PayloadStore } from '../../lib/payload-store/payloadStoreTypes.ts' |
| 18 | +import { |
| 19 | + AbstractQueueService, |
| 20 | + type ResolvedMessage, |
| 21 | +} from '../../lib/queues/AbstractQueueService.ts' |
| 22 | +import type { BarrierResult } from '../../lib/queues/HandlerContainer.ts' |
| 23 | +import type { MessageTypeResolverConfig } from '../../lib/queues/MessageTypeResolver.ts' |
| 24 | +import type { QueueDependencies } from '../../lib/types/queueOptionsTypes.ts' |
| 25 | + |
| 26 | +type TestMessage = { type?: string; id: string; timestamp: string; payload: unknown } |
| 27 | + |
| 28 | +class TestQueueService extends AbstractQueueService< |
| 29 | + TestMessage, |
| 30 | + TestMessage, |
| 31 | + QueueDependencies, |
| 32 | + Record<string, never> |
| 33 | +> { |
| 34 | + protected resolveSchema(): Either<Error, ZodSchema<TestMessage>> { |
| 35 | + throw new Error('not used in this test') |
| 36 | + } |
| 37 | + protected resolveMessage(): Either< |
| 38 | + MessageInvalidFormatError | MessageValidationError, |
| 39 | + ResolvedMessage |
| 40 | + > { |
| 41 | + throw new Error('not used in this test') |
| 42 | + } |
| 43 | + protected resolveNextFunction(): () => void { |
| 44 | + throw new Error('not used in this test') |
| 45 | + } |
| 46 | + protected processPrehandlers(): Promise<undefined> { |
| 47 | + throw new Error('not used in this test') |
| 48 | + } |
| 49 | + protected preHandlerBarrier<BarrierOutput>(): Promise<BarrierResult<BarrierOutput>> { |
| 50 | + throw new Error('not used in this test') |
| 51 | + } |
| 52 | + processMessage(): Promise<Either<'retryLater', 'success'>> { |
| 53 | + throw new Error('not used in this test') |
| 54 | + } |
| 55 | + public close(): Promise<unknown> { |
| 56 | + return Promise.resolve() |
| 57 | + } |
| 58 | + |
| 59 | + // Expose protected method for direct testing. |
| 60 | + public callOffload(message: TestMessage, sizeFn: () => number) { |
| 61 | + return this.offloadMessagePayloadIfNeeded(message, sizeFn) |
| 62 | + } |
| 63 | +} |
| 64 | + |
| 65 | +const noopLogger: CommonLogger = { |
| 66 | + level: 'silent', |
| 67 | + fatal: () => undefined, |
| 68 | + error: () => undefined, |
| 69 | + warn: () => undefined, |
| 70 | + info: () => undefined, |
| 71 | + debug: () => undefined, |
| 72 | + trace: () => undefined, |
| 73 | + silent: () => undefined, |
| 74 | + child: () => noopLogger, |
| 75 | +} as unknown as CommonLogger |
| 76 | + |
| 77 | +const noopReporter: ErrorReporter = { report: () => undefined } |
| 78 | + |
| 79 | +const recordingStore = (storedKey: string): PayloadStore => ({ |
| 80 | + storePayload: () => Promise.resolve(storedKey), |
| 81 | + retrievePayload: () => Promise.resolve(null), |
| 82 | +}) |
| 83 | + |
| 84 | +const buildService = (messageTypeResolver?: MessageTypeResolverConfig) => |
| 85 | + new TestQueueService( |
| 86 | + { errorReporter: noopReporter, logger: noopLogger }, |
| 87 | + { |
| 88 | + messageTypeResolver, |
| 89 | + // any threshold; we'll always force size > threshold via sizeFn |
| 90 | + payloadStoreConfig: { |
| 91 | + messageSizeThreshold: 1, |
| 92 | + store: recordingStore('payload-id-1'), |
| 93 | + storeName: 's3', |
| 94 | + }, |
| 95 | + }, |
| 96 | + ) |
| 97 | + |
| 98 | +const baseMessage: TestMessage = { |
| 99 | + id: 'msg-1', |
| 100 | + timestamp: '2026-01-01T00:00:00.000Z', |
| 101 | + type: 'order.created', |
| 102 | + payload: { large: 'data' }, |
| 103 | +} |
| 104 | + |
| 105 | +describe('AbstractQueueService.offloadMessagePayloadIfNeeded — `type` preservation', () => { |
| 106 | + it('preserves `type` when no messageTypeResolver is configured', async () => { |
| 107 | + const svc = buildService(undefined) |
| 108 | + const result = (await svc.callOffload( |
| 109 | + baseMessage, |
| 110 | + () => 9999, |
| 111 | + )) as OffloadedPayloadPointerPayload |
| 112 | + expect((result as unknown as TestMessage).type).toBe('order.created') |
| 113 | + expect(result.payloadRef?.id).toBe('payload-id-1') |
| 114 | + expect(result.id).toBe('msg-1') |
| 115 | + expect(result.timestamp).toBe('2026-01-01T00:00:00.000Z') |
| 116 | + }) |
| 117 | + |
| 118 | + it('preserves `type` when messageTypeResolver is `literal` mode', async () => { |
| 119 | + const svc = buildService({ literal: 'order.created' }) |
| 120 | + const result = (await svc.callOffload( |
| 121 | + baseMessage, |
| 122 | + () => 9999, |
| 123 | + )) as OffloadedPayloadPointerPayload |
| 124 | + expect((result as unknown as TestMessage).type).toBe('order.created') |
| 125 | + }) |
| 126 | + |
| 127 | + it('preserves `type` when messageTypeResolver is custom `resolver` mode', async () => { |
| 128 | + const svc = buildService({ resolver: () => 'order.created' }) |
| 129 | + const result = (await svc.callOffload( |
| 130 | + baseMessage, |
| 131 | + () => 9999, |
| 132 | + )) as OffloadedPayloadPointerPayload |
| 133 | + expect((result as unknown as TestMessage).type).toBe('order.created') |
| 134 | + }) |
| 135 | + |
| 136 | + it('preserves `type` at the configured path when messageTypeResolver is `messageTypePath`', async () => { |
| 137 | + const svc = buildService({ messageTypePath: 'type' }) |
| 138 | + const result = (await svc.callOffload( |
| 139 | + baseMessage, |
| 140 | + () => 9999, |
| 141 | + )) as OffloadedPayloadPointerPayload |
| 142 | + expect((result as unknown as TestMessage).type).toBe('order.created') |
| 143 | + }) |
| 144 | + |
| 145 | + it('preserves `type` at a non-default nested path when configured via `messageTypePath`', async () => { |
| 146 | + const svc = buildService({ messageTypePath: 'metadata.eventName' }) |
| 147 | + const message = { |
| 148 | + id: 'msg-2', |
| 149 | + timestamp: '2026-01-01T00:00:00.000Z', |
| 150 | + payload: 'p', |
| 151 | + metadata: { eventName: 'shipment.dispatched' }, |
| 152 | + } as unknown as TestMessage |
| 153 | + const result = (await svc.callOffload(message, () => 9999)) as OffloadedPayloadPointerPayload |
| 154 | + expect((result as unknown as { metadata: { eventName: string } }).metadata.eventName).toBe( |
| 155 | + 'shipment.dispatched', |
| 156 | + ) |
| 157 | + }) |
| 158 | + |
| 159 | + it('does not invent a `type` when the source message has none', async () => { |
| 160 | + const svc = buildService(undefined) |
| 161 | + const message: TestMessage = { |
| 162 | + id: 'msg-3', |
| 163 | + timestamp: '2026-01-01T00:00:00.000Z', |
| 164 | + payload: 'p', |
| 165 | + } |
| 166 | + const result = (await svc.callOffload(message, () => 9999)) as OffloadedPayloadPointerPayload |
| 167 | + expect((result as unknown as TestMessage).type).toBeUndefined() |
| 168 | + }) |
| 169 | +}) |
0 commit comments