@zdavison/matador 2.0.8 → 2.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/dist/index.d.cts +1 -1
  2. package/dist/index.d.ts +1 -1
  3. package/dist/index.d.ts.map +1 -1
  4. package/package.json +6 -2
  5. package/examples/config.ts +0 -126
  6. package/examples/event.ts +0 -26
  7. package/examples/order-event.json +0 -19
  8. package/src/checkpoint/context.test.ts +0 -510
  9. package/src/checkpoint/context.ts +0 -213
  10. package/src/checkpoint/index.ts +0 -30
  11. package/src/checkpoint/stores/memory.ts +0 -47
  12. package/src/checkpoint/stores/noop.ts +0 -22
  13. package/src/checkpoint/stores/stores.test.ts +0 -177
  14. package/src/checkpoint/types.ts +0 -147
  15. package/src/codec/codec.ts +0 -42
  16. package/src/codec/header-aware-codec.ts +0 -41
  17. package/src/codec/index.ts +0 -11
  18. package/src/codec/json-codec.ts +0 -69
  19. package/src/codec/rabbitmq-codec.test.ts +0 -516
  20. package/src/codec/rabbitmq-codec.ts +0 -336
  21. package/src/core/fanout.test.ts +0 -1350
  22. package/src/core/fanout.ts +0 -184
  23. package/src/core/index.ts +0 -12
  24. package/src/core/matador.test.ts +0 -575
  25. package/src/core/matador.ts +0 -357
  26. package/src/core/shutdown.test.ts +0 -853
  27. package/src/core/shutdown.ts +0 -165
  28. package/src/errors/checkpoint-errors.ts +0 -62
  29. package/src/errors/has-description.ts +0 -25
  30. package/src/errors/index.ts +0 -58
  31. package/src/errors/matador-errors.ts +0 -477
  32. package/src/errors/retry-errors.test.ts +0 -175
  33. package/src/errors/retry-errors.ts +0 -188
  34. package/src/hooks/index.ts +0 -14
  35. package/src/hooks/safe-hooks.ts +0 -200
  36. package/src/hooks/types.ts +0 -226
  37. package/src/index.ts +0 -241
  38. package/src/pipeline/index.ts +0 -2
  39. package/src/pipeline/pipeline.test.ts +0 -1377
  40. package/src/pipeline/pipeline.ts +0 -393
  41. package/src/retry/index.ts +0 -4
  42. package/src/retry/policy.ts +0 -46
  43. package/src/retry/standard-policy.test.ts +0 -290
  44. package/src/retry/standard-policy.ts +0 -156
  45. package/src/schema/index.ts +0 -16
  46. package/src/schema/registry.test.ts +0 -339
  47. package/src/schema/registry.ts +0 -229
  48. package/src/schema/types.test.ts +0 -280
  49. package/src/schema/types.ts +0 -217
  50. package/src/topology/builder.test.ts +0 -451
  51. package/src/topology/builder.ts +0 -238
  52. package/src/topology/index.ts +0 -19
  53. package/src/topology/types.ts +0 -183
  54. package/src/transport/capabilities.ts +0 -88
  55. package/src/transport/connection-manager.ts +0 -218
  56. package/src/transport/index.ts +0 -42
  57. package/src/transport/local/local-transport.test.ts +0 -262
  58. package/src/transport/local/local-transport.ts +0 -330
  59. package/src/transport/multi/multi-transport.test.ts +0 -320
  60. package/src/transport/multi/multi-transport.ts +0 -294
  61. package/src/transport/rabbitmq/rabbitmq-transport.test.ts +0 -120
  62. package/src/transport/rabbitmq/rabbitmq-transport.ts +0 -782
  63. package/src/transport/transport.ts +0 -200
  64. package/src/types/common.ts +0 -53
  65. package/src/types/dispatcher.ts +0 -18
  66. package/src/types/envelope.ts +0 -244
  67. package/src/types/event.test.ts +0 -157
  68. package/src/types/event.ts +0 -112
  69. package/src/types/index.ts +0 -62
  70. package/src/types/subscriber.ts +0 -333
  71. package/test/e2e/multi-transport.e2e.test.ts +0 -237
  72. package/test/e2e/rabbitmq-transport.e2e.test.ts +0 -618
  73. package/test/e2e/transport-compliance.e2e.test.ts +0 -506
  74. package/test/integration/matador.integration.test.ts +0 -634
  75. package/tsconfig.json +0 -29
  76. package/tsconfig.tsbuildinfo +0 -1
  77. package/tsup.config.ts +0 -13
@@ -1,336 +0,0 @@
1
- import type { Docket, Envelope } from '../types/index.js';
2
- import { CodecDecodeError } from './codec.js';
3
- import type { EncodedMessage, HeaderAwareCodec } from './header-aware-codec.js';
4
-
5
- /**
6
- * Header names used by Matador in RabbitMQ messages.
7
- */
8
- const HEADERS = {
9
- // Routing
10
- EVENT_KEY: 'x-matador-event-key',
11
- TARGET_SUBSCRIBER: 'x-matador-subscriber',
12
- SCHEDULED_FOR: 'x-matador-scheduled-for',
13
- ORIGINAL_QUEUE: 'x-matador-original-queue',
14
-
15
- // Processing state
16
- ATTEMPTS: 'x-matador-attempts',
17
- CREATED_AT: 'x-matador-created-at',
18
- FIRST_ERROR: 'x-matador-first-error',
19
- LAST_ERROR: 'x-matador-last-error',
20
-
21
- // Observability
22
- IMPORTANCE: 'x-matador-importance',
23
- CORRELATION_ID: 'x-matador-correlation-id',
24
-
25
- // v1 compatibility headers
26
- V1_EVENT_ID: 'x-event-id',
27
- V1_CORRELATION_ID: 'x-correlation-id',
28
- V1_USER_ID: 'x-user-id',
29
- } as const;
30
-
31
- /**
32
- * Body structure for v2 messages.
33
- * Only contains id, data, and optionally metadata (since it can be large).
34
- */
35
- interface V2Body {
36
- readonly id: string;
37
- readonly data: unknown;
38
- readonly metadata?: Record<string, unknown>;
39
- }
40
-
41
- /**
42
- * v1 message format (for backwards compatibility).
43
- */
44
- interface V1Body {
45
- key: string;
46
- data: unknown;
47
- metadata: unknown;
48
- universal?: {
49
- event_id?: string | null;
50
- user_id?: string | null;
51
- correlation_id?: string | null;
52
- [key: string]: unknown;
53
- };
54
- before?: unknown;
55
- options?: { delayMs?: number };
56
- targetSubscriber: string;
57
- }
58
-
59
- /**
60
- * RabbitMQ-specific codec that stores routing/metadata in headers.
61
- *
62
- * Benefits:
63
- * - No duplication between body and headers
64
- * - RabbitMQ can route/filter based on headers
65
- * - Smaller message body
66
- * - v1 message format compatibility built-in
67
- */
68
- export class RabbitMQCodec implements HeaderAwareCodec {
69
- readonly contentType = 'application/json';
70
-
71
- encode(envelope: Envelope): EncodedMessage {
72
- const { docket } = envelope;
73
-
74
- // Body only contains id, data, and metadata (since metadata can be large)
75
- const body: V2Body = {
76
- id: envelope.id,
77
- data: envelope.data,
78
- ...(docket.metadata !== undefined && { metadata: docket.metadata }),
79
- };
80
-
81
- // All docket fields go in headers
82
- const headers: Record<string, unknown> = {
83
- // Routing
84
- [HEADERS.EVENT_KEY]: docket.eventKey,
85
- [HEADERS.TARGET_SUBSCRIBER]: docket.targetSubscriber,
86
-
87
- // Processing state
88
- [HEADERS.ATTEMPTS]: docket.attempts,
89
- [HEADERS.CREATED_AT]: docket.createdAt,
90
-
91
- // Observability
92
- [HEADERS.IMPORTANCE]: docket.importance,
93
- };
94
-
95
- // Optional fields
96
- if (docket.scheduledFor !== undefined) {
97
- headers[HEADERS.SCHEDULED_FOR] = docket.scheduledFor;
98
- }
99
- if (docket.originalQueue !== undefined) {
100
- headers[HEADERS.ORIGINAL_QUEUE] = docket.originalQueue;
101
- }
102
- if (docket.firstError !== undefined) {
103
- headers[HEADERS.FIRST_ERROR] = docket.firstError;
104
- }
105
- if (docket.lastError !== undefined) {
106
- headers[HEADERS.LAST_ERROR] = docket.lastError;
107
- }
108
- if (docket.correlationId !== undefined) {
109
- headers[HEADERS.CORRELATION_ID] = docket.correlationId;
110
- }
111
-
112
- return {
113
- body: new TextEncoder().encode(JSON.stringify(body)),
114
- headers,
115
- contentType: this.contentType,
116
- };
117
- }
118
-
119
- decode(body: Uint8Array, headers: Record<string, unknown>): Envelope {
120
- if (body.length === 0) {
121
- throw new CodecDecodeError('Cannot decode empty buffer');
122
- }
123
-
124
- let json: string;
125
- try {
126
- json = new TextDecoder('utf-8').decode(body);
127
- } catch (error) {
128
- throw new CodecDecodeError('Invalid UTF-8 encoding', error);
129
- }
130
-
131
- let parsed: unknown;
132
- try {
133
- parsed = JSON.parse(json);
134
- } catch (error) {
135
- throw new CodecDecodeError('Invalid JSON', error);
136
- }
137
-
138
- // Detect format: v1 has 'key' and 'targetSubscriber' at top level
139
- if (this.isV1Body(parsed)) {
140
- return this.decodeV1(parsed, headers);
141
- }
142
-
143
- // v2 format
144
- if (!this.isV2Body(parsed)) {
145
- throw new CodecDecodeError('Invalid message body structure');
146
- }
147
-
148
- return this.decodeV2(parsed, headers);
149
- }
150
-
151
- private isV1Body(value: unknown): value is V1Body {
152
- if (typeof value !== 'object' || value === null) return false;
153
- const obj = value as Record<string, unknown>;
154
- return (
155
- typeof obj['key'] === 'string' &&
156
- typeof obj['targetSubscriber'] === 'string' &&
157
- 'data' in obj &&
158
- !('payload' in obj)
159
- );
160
- }
161
-
162
- private isV2Body(value: unknown): value is V2Body {
163
- if (typeof value !== 'object' || value === null) return false;
164
- const obj = value as Record<string, unknown>;
165
- return (
166
- typeof obj['id'] === 'string' && 'data' in obj && !('key' in obj) // Distinguish from v1 which also has 'data'
167
- );
168
- }
169
-
170
- private decodeV2(body: V2Body, headers: Record<string, unknown>): Envelope {
171
- // Required headers
172
- const eventKey = this.requireStringHeader(headers, HEADERS.EVENT_KEY);
173
- const targetSubscriber = this.requireStringHeader(
174
- headers,
175
- HEADERS.TARGET_SUBSCRIBER,
176
- );
177
- const attempts = this.requireNumberHeader(headers, HEADERS.ATTEMPTS);
178
- const createdAt = this.requireStringHeader(headers, HEADERS.CREATED_AT);
179
- const importance = this.requireStringHeader(headers, HEADERS.IMPORTANCE);
180
-
181
- // Optional headers
182
- const scheduledFor = this.optionalStringHeader(
183
- headers,
184
- HEADERS.SCHEDULED_FOR,
185
- );
186
- const originalQueue = this.optionalStringHeader(
187
- headers,
188
- HEADERS.ORIGINAL_QUEUE,
189
- );
190
- const firstError = this.optionalStringHeader(headers, HEADERS.FIRST_ERROR);
191
- const lastError = this.optionalStringHeader(headers, HEADERS.LAST_ERROR);
192
- const correlationId = this.optionalStringHeader(
193
- headers,
194
- HEADERS.CORRELATION_ID,
195
- );
196
-
197
- const docket: Docket = {
198
- // Routing
199
- eventKey,
200
- targetSubscriber,
201
- ...(scheduledFor !== undefined && { scheduledFor }),
202
- ...(originalQueue !== undefined && { originalQueue }),
203
- // Processing state
204
- attempts,
205
- createdAt,
206
- ...(firstError !== undefined && { firstError }),
207
- ...(lastError !== undefined && { lastError }),
208
- // Observability
209
- importance: importance as Docket['importance'],
210
- ...(correlationId !== undefined && { correlationId }),
211
- ...(body.metadata !== undefined && { metadata: body.metadata }),
212
- };
213
-
214
- return {
215
- id: body.id,
216
- data: body.data,
217
- docket,
218
- };
219
- }
220
-
221
- /**
222
- * Decodes a v1 format message for backwards compatibility.
223
- * v1 format: { key, data, metadata, universal, targetSubscriber, ... }
224
- */
225
- private decodeV1(body: V1Body, headers: Record<string, unknown>): Envelope {
226
- const { event_id, user_id, correlation_id, ...otherUniversal } =
227
- body.universal ?? {};
228
-
229
- // Merge metadata: event metadata + remaining universal fields
230
- const mergedMetadata: Record<string, unknown> = {};
231
- if (body.metadata && typeof body.metadata === 'object') {
232
- Object.assign(mergedMetadata, body.metadata);
233
- }
234
- if (user_id !== undefined && user_id !== null) {
235
- mergedMetadata['user_id'] = user_id;
236
- }
237
- Object.assign(mergedMetadata, otherUniversal);
238
-
239
- // Try to get attempts from header (v1 also uses x-matador-attempts)
240
- const attempts =
241
- typeof headers[HEADERS.ATTEMPTS] === 'number'
242
- ? (headers[HEADERS.ATTEMPTS] as number)
243
- : 1;
244
-
245
- // Try to get importance from header
246
- const importance =
247
- typeof headers[HEADERS.IMPORTANCE] === 'string'
248
- ? (headers[HEADERS.IMPORTANCE] as string)
249
- : 'should-investigate';
250
-
251
- // Get correlation ID from either v1 or v2 header
252
- const correlationId =
253
- (headers[HEADERS.CORRELATION_ID] as string | undefined) ??
254
- (headers[HEADERS.V1_CORRELATION_ID] as string | undefined) ??
255
- correlation_id ??
256
- undefined;
257
-
258
- // Get event ID from v1 header or body
259
- const eventId =
260
- (headers[HEADERS.V1_EVENT_ID] as string | undefined) ??
261
- event_id ??
262
- crypto.randomUUID();
263
-
264
- const now = new Date().toISOString();
265
-
266
- // Calculate scheduledFor if delayMs was specified (though it's likely already passed)
267
- let scheduledFor: string | undefined;
268
- if (body.options?.delayMs) {
269
- scheduledFor = new Date(Date.now() + body.options.delayMs).toISOString();
270
- }
271
-
272
- const docket: Docket = {
273
- // Routing
274
- eventKey: body.key,
275
- targetSubscriber: body.targetSubscriber,
276
- ...(scheduledFor !== undefined && { scheduledFor }),
277
- // Processing state
278
- attempts,
279
- createdAt: now,
280
- // Observability
281
- importance: importance as Docket['importance'],
282
- ...(correlationId !== undefined && { correlationId }),
283
- ...(Object.keys(mergedMetadata).length > 0 && {
284
- metadata: mergedMetadata,
285
- }),
286
- };
287
-
288
- return {
289
- id: eventId,
290
- data: body.data,
291
- docket,
292
- };
293
- }
294
-
295
- private requireStringHeader(
296
- headers: Record<string, unknown>,
297
- name: string,
298
- ): string {
299
- const value = headers[name];
300
- if (value === undefined) {
301
- throw new CodecDecodeError(`Missing required header: ${name}`);
302
- }
303
- if (typeof value !== 'string') {
304
- throw new CodecDecodeError(
305
- `Header ${name} must be string, got ${typeof value}`,
306
- );
307
- }
308
- return value;
309
- }
310
-
311
- private requireNumberHeader(
312
- headers: Record<string, unknown>,
313
- name: string,
314
- ): number {
315
- const value = headers[name];
316
- if (value === undefined) {
317
- throw new CodecDecodeError(`Missing required header: ${name}`);
318
- }
319
- if (typeof value !== 'number') {
320
- throw new CodecDecodeError(
321
- `Header ${name} must be number, got ${typeof value}`,
322
- );
323
- }
324
- return value;
325
- }
326
-
327
- private optionalStringHeader(
328
- headers: Record<string, unknown>,
329
- name: string,
330
- ): string | undefined {
331
- const value = headers[name];
332
- if (value === undefined) return undefined;
333
- if (typeof value !== 'string') return undefined;
334
- return value;
335
- }
336
- }