@message-queue-toolkit/core 18.0.0 → 19.0.0
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.
|
@@ -4,7 +4,7 @@ import type { MessageInvalidFormatError, MessageValidationError } from '../error
|
|
|
4
4
|
import type { OffloadedPayloadPointerPayload } from '../payload-store/offloadedPayloadMessageSchemas';
|
|
5
5
|
import type { PayloadStoreConfig } from '../payload-store/payloadStoreTypes';
|
|
6
6
|
import type { MessageProcessingResult } from '../types/MessageQueueTypes';
|
|
7
|
-
import type { DeletionConfig, QueueDependencies, QueueOptions } from '../types/queueOptionsTypes';
|
|
7
|
+
import type { DeletionConfig, MessageMetricsManager, QueueDependencies, QueueOptions } from '../types/queueOptionsTypes';
|
|
8
8
|
import type { BarrierCallback, BarrierResult, MessageHandlerConfig, PreHandlingOutputs, Prehandler, PrehandlerResult } from './HandlerContainer';
|
|
9
9
|
import type { HandlerSpy, PublicHandlerSpy } from './HandlerSpy';
|
|
10
10
|
import { MessageSchemaContainer } from './MessageSchemaContainer';
|
|
@@ -37,9 +37,10 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
|
|
|
37
37
|
protected readonly deletionConfig?: DeletionConfig;
|
|
38
38
|
protected readonly payloadStoreConfig?: Omit<PayloadStoreConfig, 'serializer'> & Required<Pick<PayloadStoreConfig, 'serializer'>>;
|
|
39
39
|
protected readonly _handlerSpy?: HandlerSpy<MessagePayloadSchemas>;
|
|
40
|
+
protected readonly messageMetricsManager?: MessageMetricsManager<MessagePayloadSchemas>;
|
|
40
41
|
protected isInitted: boolean;
|
|
41
42
|
get handlerSpy(): PublicHandlerSpy<MessagePayloadSchemas>;
|
|
42
|
-
constructor({ errorReporter, logger }: DependenciesType, options: OptionsType);
|
|
43
|
+
constructor({ errorReporter, logger, messageMetricsManager }: DependenciesType, options: OptionsType);
|
|
43
44
|
protected resolveConsumerMessageSchemaContainer(options: {
|
|
44
45
|
handlers: MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[];
|
|
45
46
|
messageTypeField: string;
|
|
@@ -58,9 +59,15 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
|
|
|
58
59
|
* Log preformatted and potentially presanitized message payload
|
|
59
60
|
*/
|
|
60
61
|
protected logMessage(messageLogEntry: unknown): void;
|
|
61
|
-
protected logProcessedMessage(message: MessagePayloadSchemas | null, processingResult: MessageProcessingResult, messageId?: string): void;
|
|
62
62
|
protected handleError(err: unknown, context?: Record<string, unknown>): void;
|
|
63
|
-
protected handleMessageProcessed(
|
|
63
|
+
protected handleMessageProcessed(params: {
|
|
64
|
+
message: MessagePayloadSchemas | null;
|
|
65
|
+
processingResult: MessageProcessingResult;
|
|
66
|
+
messageProcessingStartTimestamp: number;
|
|
67
|
+
queueName: string;
|
|
68
|
+
messageId?: string;
|
|
69
|
+
}): void;
|
|
70
|
+
private resolveProcessedMessageMetadata;
|
|
64
71
|
protected processPrehandlersInternal(preHandlers: Prehandler<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput>[], message: MessagePayloadSchemas): Promise<PrehandlerOutput>;
|
|
65
72
|
protected preHandlerBarrierInternal<BarrierOutput>(barrier: BarrierCallback<MessagePayloadSchemas, ExecutionContext, PrehandlerOutput, BarrierOutput> | undefined, message: MessagePayloadSchemas, executionContext: ExecutionContext, preHandlerOutput: PrehandlerOutput): Promise<BarrierResult<BarrierOutput>>;
|
|
66
73
|
shouldBeRetried(message: MessagePayloadSchemas, maxRetryDuration: number): boolean;
|
|
@@ -32,6 +32,7 @@ class AbstractQueueService {
|
|
|
32
32
|
deletionConfig;
|
|
33
33
|
payloadStoreConfig;
|
|
34
34
|
_handlerSpy;
|
|
35
|
+
messageMetricsManager;
|
|
35
36
|
isInitted;
|
|
36
37
|
get handlerSpy() {
|
|
37
38
|
if (!this._handlerSpy) {
|
|
@@ -39,9 +40,10 @@ class AbstractQueueService {
|
|
|
39
40
|
}
|
|
40
41
|
return this._handlerSpy;
|
|
41
42
|
}
|
|
42
|
-
constructor({ errorReporter, logger }, options) {
|
|
43
|
+
constructor({ errorReporter, logger, messageMetricsManager }, options) {
|
|
43
44
|
this.errorReporter = errorReporter;
|
|
44
45
|
this.logger = logger;
|
|
46
|
+
this.messageMetricsManager = messageMetricsManager;
|
|
45
47
|
this.messageIdField = options.messageIdField ?? 'id';
|
|
46
48
|
this.messageTypeField = options.messageTypeField;
|
|
47
49
|
this.messageTimestampField = options.messageTimestampField ?? 'timestamp';
|
|
@@ -90,25 +92,6 @@ class AbstractQueueService {
|
|
|
90
92
|
logMessage(messageLogEntry) {
|
|
91
93
|
this.logger.debug(messageLogEntry);
|
|
92
94
|
}
|
|
93
|
-
logProcessedMessage(message, processingResult, messageId) {
|
|
94
|
-
if (!this.logger.isLevelEnabled('debug')) {
|
|
95
|
-
return;
|
|
96
|
-
}
|
|
97
|
-
const messageTimestamp = message ? this.tryToExtractTimestamp(message) : undefined;
|
|
98
|
-
const messageProcessingMilliseconds = messageTimestamp
|
|
99
|
-
? Date.now() - messageTimestamp.getTime()
|
|
100
|
-
: undefined;
|
|
101
|
-
const messageType = message && this.messageTypeField in message
|
|
102
|
-
? // @ts-ignore
|
|
103
|
-
message[this.messageTypeField]
|
|
104
|
-
: undefined;
|
|
105
|
-
this.logger.debug({
|
|
106
|
-
processingResult,
|
|
107
|
-
messageId,
|
|
108
|
-
messageProcessingTime: messageProcessingMilliseconds,
|
|
109
|
-
messageType,
|
|
110
|
-
}, `Finished processing message ${messageId ?? `(unknown id)`}`);
|
|
111
|
-
}
|
|
112
95
|
handleError(err, context) {
|
|
113
96
|
const logObject = (0, node_core_1.resolveGlobalErrorLogObject)(err);
|
|
114
97
|
this.logger.error({
|
|
@@ -119,18 +102,45 @@ class AbstractQueueService {
|
|
|
119
102
|
this.errorReporter.report({ error: err, context });
|
|
120
103
|
}
|
|
121
104
|
}
|
|
122
|
-
handleMessageProcessed(
|
|
105
|
+
handleMessageProcessed(params) {
|
|
106
|
+
const { message, processingResult, messageId } = params;
|
|
107
|
+
const messageProcessingEndTimestamp = Date.now();
|
|
123
108
|
if (this._handlerSpy) {
|
|
124
109
|
this._handlerSpy.addProcessedMessage({
|
|
125
110
|
message,
|
|
126
111
|
processingResult,
|
|
127
112
|
}, messageId);
|
|
128
113
|
}
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
this.logProcessedMessage(message, processingResult, resolvedMessageId);
|
|
114
|
+
const debugLoggingEnabled = this.logMessages && this.logger.isLevelEnabled('debug');
|
|
115
|
+
if (!debugLoggingEnabled && !this.messageMetricsManager) {
|
|
116
|
+
return;
|
|
133
117
|
}
|
|
118
|
+
const processedMessageMetadata = this.resolveProcessedMessageMetadata(message, processingResult, params.messageProcessingStartTimestamp, messageProcessingEndTimestamp, params.queueName, messageId);
|
|
119
|
+
if (debugLoggingEnabled) {
|
|
120
|
+
this.logger.debug(processedMessageMetadata, `Finished processing message ${processedMessageMetadata.messageId}`);
|
|
121
|
+
}
|
|
122
|
+
if (this.messageMetricsManager) {
|
|
123
|
+
this.messageMetricsManager.registerProcessedMessage(processedMessageMetadata);
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
resolveProcessedMessageMetadata(message, processingResult, messageProcessingStartTimestamp, messageProcessingEndTimestamp, queueName, messageId) {
|
|
127
|
+
// @ts-ignore
|
|
128
|
+
const resolvedMessageId = message?.[this.messageIdField] ?? messageId;
|
|
129
|
+
const messageTimestamp = message ? this.tryToExtractTimestamp(message)?.getTime() : undefined;
|
|
130
|
+
const messageType = message && this.messageTypeField in message
|
|
131
|
+
? // @ts-ignore
|
|
132
|
+
message[this.messageTypeField]
|
|
133
|
+
: undefined;
|
|
134
|
+
return {
|
|
135
|
+
processingResult,
|
|
136
|
+
messageId: resolvedMessageId ?? '(unknown id)',
|
|
137
|
+
messageType,
|
|
138
|
+
queueName,
|
|
139
|
+
message,
|
|
140
|
+
messageTimestamp,
|
|
141
|
+
messageProcessingStartTimestamp,
|
|
142
|
+
messageProcessingEndTimestamp,
|
|
143
|
+
};
|
|
134
144
|
}
|
|
135
145
|
processPrehandlersInternal(preHandlers, message) {
|
|
136
146
|
if (preHandlers.length === 0) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAKjE,kGAA8F;AAC9F,oGAA0G;AAG1G,0EAAkE;
|
|
1
|
+
{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAKjE,kGAA8F;AAC9F,oGAA0G;AAG1G,0EAAkE;AASlE,kDAAwD;AACxD,sDAAkE;AAClE,8DAA6D;AAW7D,6CAAgD;AAChD,qEAAiE;AAiBjE,MAAsB,oBAAoB;IAaxC;;;OAGG;IACc,2BAA2B,GAAG,0BAA0B,CAAA;IACzE;;;OAGG;IACgB,qBAAqB,CAAQ;IAE7B,aAAa,CAAe;IAC/B,MAAM,CAAc;IACjB,cAAc,CAAQ;IACtB,gBAAgB,CAAQ;IACxB,WAAW,CAAS;IACpB,cAAc,CAAqB;IACnC,aAAa,CAAmB;IAChC,cAAc,CAAiB;IAC/B,kBAAkB,CACa;IAC/B,WAAW,CAAoC;IAC/C,qBAAqB,CAA+C;IAE7E,SAAS,CAAS;IAE5B,IAAI,UAAU;QACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED,YACE,EAAE,aAAa,EAAE,MAAM,EAAE,qBAAqB,EAAoB,EAClE,OAAoB;QAEpB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAA;QAElD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAA;QACpD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,IAAI,WAAW,CAAA;QACzE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAA;QAC1C,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC5C,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB;YAClD,CAAC,CAAC;gBACE,UAAU,EAAE,6DAA6B;gBACzC,GAAG,OAAO,CAAC,kBAAkB;aAC9B;YACH,CAAC,CAAC,SAAS,CAAA;QAEb,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,IAAA,8BAAiB,EAAwB,OAAO,CAAC,CAAA;QACpE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;IACxB,CAAC;IAES,qCAAqC,CAAC,OAG/C;QACC,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACpE,MAAM,kBAAkB,GAA4B,OAAO,CAAC,QAAQ;aACjE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC;aAChC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAAA;QAEzC,OAAO,IAAI,+CAAsB,CAAwB;YACvD,cAAc;YACd,kBAAkB;YAClB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC3C,CAAC,CAAA;IACJ,CAAC;IAES,sCAAsC,CAAC,OAGhD;QACC,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;QAC7C,MAAM,kBAAkB,GAAqC,EAAE,CAAA;QAE/D,OAAO,IAAI,+CAAsB,CAAwB;YACvD,cAAc;YACd,kBAAkB;YAClB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;SAC3C,CAAC,CAAA;IACJ,CAAC;IAUD;;OAEG;IACO,iBAAiB,CAAC,OAA8B,EAAE,YAAoB;QAC9E,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACO,UAAU,CAAC,eAAwB;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;IACpC,CAAC;IAES,WAAW,CAAC,GAAY,EAAE,OAAiC;QACnE,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAChB,GAAG,SAAS;YACZ,GAAG,OAAO;SACX,CAAC,CAAA;QACF,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAA;QACpD,CAAC;IACH,CAAC;IAES,sBAAsB,CAAC,MAMhC;QACC,MAAM,EAAE,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,MAAM,CAAA;QACvD,MAAM,6BAA6B,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEhD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAClC;gBACE,OAAO;gBACP,gBAAgB;aACjB,EACD,SAAS,CACV,CAAA;QACH,CAAC;QAED,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QACnF,IAAI,CAAC,mBAAmB,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACxD,OAAM;QACR,CAAC;QAED,MAAM,wBAAwB,GAAG,IAAI,CAAC,+BAA+B,CACnE,OAAO,EACP,gBAAgB,EAChB,MAAM,CAAC,+BAA+B,EACtC,6BAA6B,EAC7B,MAAM,CAAC,SAAS,EAChB,SAAS,CACV,CAAA;QACD,IAAI,mBAAmB,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,wBAAwB,EACxB,+BAA+B,wBAAwB,CAAC,SAAS,EAAE,CACpE,CAAA;QACH,CAAC;QACD,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,IAAI,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,wBAAwB,CAAC,CAAA;QAC/E,CAAC;IACH,CAAC;IAEO,+BAA+B,CACrC,OAAqC,EACrC,gBAAyC,EACzC,+BAAuC,EACvC,6BAAqC,EACrC,SAAiB,EACjB,SAAkB;QAElB,aAAa;QACb,MAAM,iBAAiB,GAAuB,OAAO,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,SAAS,CAAA;QAEzF,MAAM,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QAC7F,MAAM,WAAW,GACf,OAAO,IAAI,IAAI,CAAC,gBAAgB,IAAI,OAAO;YACzC,CAAC,CAAC,aAAa;gBACb,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC;YAChC,CAAC,CAAC,SAAS,CAAA;QAEf,OAAO;YACL,gBAAgB;YAChB,SAAS,EAAE,iBAAiB,IAAI,cAAc;YAC9C,WAAW;YACX,SAAS;YACT,OAAO;YACP,gBAAgB;YAChB,+BAA+B;YAC/B,6BAA6B;SAC9B,CAAA;IACH,CAAC;IAES,0BAA0B,CAClC,WAAoF,EACpF,OAA8B;QAE9B,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,EAAsB,CAAC,CAAA;QAChD,CAAC;QAED,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACvD,IAAI,CAAC;gBACH,MAAM,gBAAgB,GAAG,EAAsB,CAAA;gBAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CACnC,WAAW,EACX,OAAO,EACP,CAAC,EACD,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CAAA;gBACD,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;YAC7B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAY,CAAC,CAAA;YACtB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAES,KAAK,CAAC,yBAAyB,CACvC,OAEa,EACb,OAA8B,EAC9B,gBAAkC,EAClC,gBAAkC;QAElC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,aAAa;YACb,OAAO;gBACL,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,SAAS;aAClB,CAAA;QACH,CAAC;QAED,aAAa;QACb,OAAO,MAAM,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;IACnE,CAAC;IAED,eAAe,CAAC,OAA8B,EAAE,gBAAwB;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,CAAA;QACnE,OAAO,CAAC,IAAA,+BAAmB,EAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAC1D,CAAC;IAES,6BAA6B,CAAC,OAA8B;QACpE,4CAA4C;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAE9D,kDAAkD;QAClD,mBAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;IAC7B,CAAC;IAES,wBAAwB,CAAC,OAA8B;QAC/D,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA,CAAC,sCAAsC;QAEzE;;;WAGG;QACH,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,aAAa;YACb,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;YAClE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,uCAAuC,CAAC,CAAA;QACxF,CAAC;QAED;;WAEG;QACH,MAAM,eAAe,GAAG,IAAI,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAA;QACjE,aAAa;QACb,WAAW,CAAC,IAAI,CAAC,2BAA2B,CAAC;YAC3C,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAEzD,OAAO,WAAW,CAAA;IACpB,CAAC;IAEO,qBAAqB,CAAC,OAA8B;QAC1D,aAAa;QACb,IAAI,IAAI,CAAC,qBAAqB,IAAI,OAAO,EAAE,CAAC;YAC1C,aAAa;YACb,MAAM,GAAG,GAAG,IAAA,oCAAkB,EAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAA;YACnE,IAAI,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,qBAAqB,eAAe,CAAC,CAAA;YAC/D,CAAC;YAED,OAAO,GAAG,CAAA;QACZ,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAEO,2BAA2B,CAAC,OAA8B;QAChE,IACE,IAAI,CAAC,2BAA2B,IAAI,OAAO;YAC3C,OAAO,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,KAAK,QAAQ,EAC7D,CAAC;YACD,aAAa;YACb,OAAO,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QAClD,CAAC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAWD,sCAAsC;IAC5B,qCAAqC,CAC7C,WAAoF,EACpF,gBAAkC,EAClC,OAA8B,EAC9B,KAAa,EACb,gBAAkC,EAClC,OAA0E,EAC1E,MAA4B;QAE5B,OAAO,CAAC,gBAAkC,EAAE,EAAE;YAC5C,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,WAAW,CAAC,MAAM,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC;gBACnC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACN,6DAA6D;gBAC7D,WAAW,CAAC,KAAK,CAAC,CAChB,OAAO,EACP,gBAAgB;gBAChB,aAAa;gBACb,gBAAgB,EAChB,IAAI,CAAC,qCAAqC,CACxC,WAAW,EACX,gBAAgB,EAChB,OAAO,EACP,KAAK,GAAG,CAAC,EACT,gBAAgB,EAChB,OAAO,EACP,MAAM,CACP,CACF,CAAA;YACH,CAAC;QACH,CAAC,CAAA;IACH,CAAC;IAsBD;;;;OAIG;IACO,KAAK,CAAC,6BAA6B,CAC3C,OAA8B,EAC9B,aAA2B;QAE3B,IACE,CAAC,IAAI,CAAC,kBAAkB;YACxB,aAAa,EAAE,IAAI,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,EAC/D,CAAC;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,IAAI,uBAA+B,CAAA;QACnC,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QACrF,IAAI,CAAC;YACH,uBAAuB,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;QAC/F,CAAC;gBAAS,CAAC;YACT,IAAI,IAAA,iCAAa,EAAC,iBAAiB,CAAC,EAAE,CAAC;gBACrC,MAAM,iBAAiB,CAAC,OAAO,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;QAED,OAAO;YACL,uBAAuB;YACvB,oBAAoB,EAAE,iBAAiB,CAAC,IAAI;YAC5C,aAAa;YACb,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC;YACnD,aAAa;YACb,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACvD,aAAa;YACb,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAClE,CAAA;IACH,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,+BAA+B,CAC7C,mCAA4C;QAE5C,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,OAAO;gBACL,KAAK,EAAE,IAAI,KAAK,CACd,4EAA4E,CAC7E;aACF,CAAA;QACH,CAAC;QAED,MAAM,yBAAyB,GAAG,yEAAwC,CAAC,SAAS,CAClF,mCAAmC,CACpC,CAAA;QACD,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,CAAC;YACvC,OAAO;gBACL,KAAK,EAAE,IAAI,KAAK,CAAC,gEAAgE,EAAE;oBACjF,KAAK,EAAE,yBAAyB,CAAC,KAAK;iBACvC,CAAC;aACH,CAAA;QACH,CAAC;QAED,MAAM,kCAAkC,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,eAAe,CAC5F,yBAAyB,CAAC,IAAI,CAAC,uBAAuB,CACvD,CAAA;QACD,IAAI,kCAAkC,KAAK,IAAI,EAAE,CAAC;YAChD,OAAO;gBACL,KAAK,EAAE,IAAI,KAAK,CACd,oBAAoB,yBAAyB,CAAC,IAAI,CAAC,uBAAuB,6BAA6B,CACxG;aACF,CAAA;QACH,CAAC;QAED,MAAM,gCAAgC,GAAG,MAAM,IAAA,yCAA2B,EACxE,kCAAkC,EAClC,yBAAyB,CAAC,IAAI,CAAC,oBAAoB,CACpD,CAAA;QACD,IAAI,CAAC;YACH,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,EAAE,CAAA;QACjE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,8CAA8C,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QAC3F,CAAC;IACH,CAAC;CACF;AA1dD,oDA0dC"}
|
|
@@ -3,11 +3,54 @@ import type { ZodSchema } from 'zod';
|
|
|
3
3
|
import type { PayloadStoreConfig } from '../payload-store/payloadStoreTypes';
|
|
4
4
|
import type { MessageHandlerConfig } from '../queues/HandlerContainer';
|
|
5
5
|
import type { HandlerSpy, HandlerSpyParams } from '../queues/HandlerSpy';
|
|
6
|
-
import type { TransactionObservabilityManager } from './MessageQueueTypes';
|
|
6
|
+
import type { MessageProcessingResult, TransactionObservabilityManager } from './MessageQueueTypes';
|
|
7
7
|
export type QueueDependencies = {
|
|
8
8
|
errorReporter: ErrorReporter;
|
|
9
9
|
logger: CommonLogger;
|
|
10
|
+
messageMetricsManager?: MessageMetricsManager;
|
|
10
11
|
};
|
|
12
|
+
export type ProcessedMessageMetadata<MessagePayloadSchemas extends object = object> = {
|
|
13
|
+
/**
|
|
14
|
+
* Id of the message accessed by `messageIdField`
|
|
15
|
+
*/
|
|
16
|
+
messageId: string;
|
|
17
|
+
/**
|
|
18
|
+
* Message type accessed by `messageTypeField`
|
|
19
|
+
*/
|
|
20
|
+
messageType: string;
|
|
21
|
+
/**
|
|
22
|
+
* Processing result status
|
|
23
|
+
*/
|
|
24
|
+
processingResult: MessageProcessingResult;
|
|
25
|
+
/**
|
|
26
|
+
* Original message object
|
|
27
|
+
*/
|
|
28
|
+
message: MessagePayloadSchemas | null;
|
|
29
|
+
/**
|
|
30
|
+
* Name of the queue processing the message
|
|
31
|
+
*/
|
|
32
|
+
queueName: string;
|
|
33
|
+
/**
|
|
34
|
+
* The timestamp when the message was sent initially, in milliseconds since the epoch
|
|
35
|
+
*/
|
|
36
|
+
messageTimestamp: number | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* The timestamp when the processing of the message began, in milliseconds since the epoch
|
|
39
|
+
* Note: for publishers the value may be smaller than messageTimestamp
|
|
40
|
+
*/
|
|
41
|
+
messageProcessingStartTimestamp: number;
|
|
42
|
+
/**
|
|
43
|
+
* The timestamp when the processing of the message ended, in milliseconds since the epoch
|
|
44
|
+
*/
|
|
45
|
+
messageProcessingEndTimestamp: number;
|
|
46
|
+
};
|
|
47
|
+
export interface MessageMetricsManager<MessagePayloadSchemas extends object = object> {
|
|
48
|
+
/**
|
|
49
|
+
* Executed once message is processed
|
|
50
|
+
* @param metadata - contains basic message processing metadata including processing result and time, as well as the whole message object
|
|
51
|
+
*/
|
|
52
|
+
registerProcessedMessage(metadata: ProcessedMessageMetadata<MessagePayloadSchemas>): void;
|
|
53
|
+
}
|
|
11
54
|
export type QueueConsumerDependencies = {
|
|
12
55
|
consumerErrorResolver: ErrorResolver;
|
|
13
56
|
transactionObservabilityManager: TransactionObservabilityManager;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@message-queue-toolkit/core",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "19.0.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"description": "Useful utilities, interfaces and base classes for message queue handling. Supports AMQP and SQS with a common abstraction on top currently",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"@types/tmp": "^0.2.6",
|
|
41
41
|
"@vitest/coverage-v8": "^2.1.5",
|
|
42
42
|
"awilix": "^12.0.1",
|
|
43
|
-
"awilix-manager": "^
|
|
43
|
+
"awilix-manager": "^6.0.0",
|
|
44
44
|
"del-cli": "^6.0.0",
|
|
45
45
|
"typescript": "^5.7.2",
|
|
46
46
|
"vitest": "^2.1.5"
|