@message-queue-toolkit/core 3.3.0 → 3.5.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export type { QueueConsumer, AsyncPublisher, SyncPublisher, TransactionObservabi
 export { AbstractQueueService } from './lib/queues/AbstractQueueService';
 export type { NewQueueOptions, ExistingQueueOptions, NewQueueOptionsMultiSchema, ExistingQueueOptionsMultiSchema, MonoSchemaQueueOptions, MultiSchemaConsumerOptions, QueueDependencies, QueueConsumerDependencies, Deserializer, CommonQueueLocator, DeletionConfig, MultiSchemaPublisherOptions, } from './lib/queues/AbstractQueueService';
 export { isMessageError, MessageValidationError, MessageInvalidFormatError, } from './lib/errors/Errors';
-export { HandlerContainer, MessageHandlerConfig, MessageHandlerConfigBuilder, } from './lib/queues/HandlerContainer';
+export { HandlerContainer, MessageHandlerConfig, MessageHandlerConfigBuilder, BarrierCallbackWithoutMessageType, } from './lib/queues/HandlerContainer';
 export type { HandlerContainerOptions, Handler } from './lib/queues/HandlerContainer';
 export { MessageSchemaContainer } from './lib/queues/MessageSchemaContainer';
 export type { MessageSchemaContainerOptions } from './lib/queues/MessageSchemaContainer';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AASA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAgB7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,kEAIsC;AAHpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAI7B,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAG/B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AACrB,qDAAqD;AAA5C,0GAAA,YAAY,OAAA;AAErB,iDAAiE;AAAxD,wGAAA,YAAY,OAAA;AAAE,wGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AASA,0EAAwE;AAA/D,4HAAA,oBAAoB,OAAA;AAgB7B,8CAI4B;AAH1B,wGAAA,cAAc,OAAA;AACd,gHAAA,sBAAsB,OAAA;AACtB,mHAAA,yBAAyB,OAAA;AAG3B,kEAKsC;AAJpC,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,+HAAA,2BAA2B,OAAA;AAK7B,8EAA4E;AAAnE,gIAAA,sBAAsB,OAAA;AAG/B,qDAAuD;AAA9C,4GAAA,cAAc,OAAA;AACvB,mDAAoD;AAA3C,yGAAA,YAAY,OAAA;AACrB,qDAAqD;AAA5C,0GAAA,YAAY,OAAA;AAErB,iDAAiE;AAAxD,wGAAA,YAAY,OAAA;AAAE,wGAAA,YAAY,OAAA"}

package/dist/lib/queues/AbstractQueueService.d.ts

@@ -18,18 +18,21 @@ export type DeletionConfig = {
     deleteIfExists?: boolean;
     forceDeleteInProduction?: boolean;
 };
+export type CommonQueueOptions = {
+    logMessages?: boolean;
+};
 export type NewQueueOptions<CreationConfigType extends object> = {
     messageTypeField: string;
     locatorConfig?: never;
     deletionConfig?: DeletionConfig;
     creationConfig: CreationConfigType;
-};
+} & CommonQueueOptions;
 export type ExistingQueueOptions<QueueLocatorType extends object> = {
     messageTypeField: string;
     locatorConfig: QueueLocatorType;
     deletionConfig?: DeletionConfig;
     creationConfig?: never;
-};
+} & CommonQueueOptions;
 export type MultiSchemaPublisherOptions<MessagePayloadSchemas extends object> = {
     messageSchemas: readonly ZodSchema<MessagePayloadSchemas>[];
 };
@@ -46,12 +49,21 @@ export declare abstract class AbstractQueueService<MessagePayloadSchemas extends
     protected readonly errorReporter: ErrorReporter;
     readonly logger: Logger;
     protected readonly messageTypeField: string;
+    protected readonly logMessages: boolean;
     protected readonly creationConfig?: QueueConfiguration;
     protected readonly locatorConfig?: QueueLocatorType;
     protected readonly deletionConfig?: DeletionConfig;
     constructor({ errorReporter, logger }: DependenciesType, options: OptionsType);
     protected abstract resolveSchema(message: MessagePayloadSchemas): Either<Error, ZodSchema<MessagePayloadSchemas>>;
     protected abstract resolveMessage(message: MessageEnvelopeType): Either<MessageInvalidFormatError | MessageValidationError, unknown>;
+    /**
+     * Format message for logging
+     */
+    protected resolveMessageLog(message: MessagePayloadSchemas, _messageType: string): unknown;
+    /**
+     * Log preformatted and potentially presanitized message payload
+     */
+    protected logMessage(messageLogEntry: unknown): void;
     protected handleError(err: unknown): void;
     abstract close(): Promise<unknown>;
 }

package/dist/lib/queues/AbstractQueueService.js

@@ -7,6 +7,7 @@ class AbstractQueueService {
     errorReporter;
     logger;
     messageTypeField;
+    logMessages;
     creationConfig;
     locatorConfig;
     deletionConfig;
@@ -17,6 +18,19 @@ class AbstractQueueService {
         this.creationConfig = options.creationConfig;
         this.locatorConfig = options.locatorConfig;
         this.deletionConfig = options.deletionConfig;
+        this.logMessages = options.logMessages ?? false;
+    }
+    /**
+     * Format message for logging
+     */
+    resolveMessageLog(message, _messageType) {
+        return message;
+    }
+    /**
+     * Log preformatted and potentially presanitized message payload
+     */
+    logMessage(messageLogEntry) {
+        this.logger.debug(messageLogEntry);
     }
     handleError(err) {
         const logObject = (0, node_core_1.resolveGlobalErrorLogObject)(err);

package/dist/lib/queues/AbstractQueueService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AAyEjE,MAAsB,oBAAoB;IAYrB,aAAa,CAAe;IAC/B,MAAM,CAAQ;IACX,gBAAgB,CAAQ;IACxB,cAAc,CAAqB;IACnC,aAAa,CAAmB;IAChC,cAAc,CAAiB;IAElD,YAAY,EAAE,aAAa,EAAE,MAAM,EAAoB,EAAE,OAAoB;QAC3E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,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;IAC9C,CAAC;IASS,WAAW,CAAC,GAAY;QAChC,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC5B,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;SAC1C;IACH,CAAC;CAGF;AA7CD,oDA6CC"}
+{"version":3,"file":"AbstractQueueService.js","sourceRoot":"","sources":["../../../lib/queues/AbstractQueueService.ts"],"names":[],"mappings":";;;AAAA,yCAAiC;AAGjC,mDAAiE;AA6EjE,MAAsB,oBAAoB;IAYrB,aAAa,CAAe;IAC/B,MAAM,CAAQ;IACX,gBAAgB,CAAQ;IACxB,WAAW,CAAS;IACpB,cAAc,CAAqB;IACnC,aAAa,CAAmB;IAChC,cAAc,CAAiB;IAElD,YAAY,EAAE,aAAa,EAAE,MAAM,EAAoB,EAAE,OAAoB;QAC3E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,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;QAE5C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,KAAK,CAAA;IACjD,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;QAChC,MAAM,SAAS,GAAG,IAAA,uCAA2B,EAAC,GAAG,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC5B,IAAI,iBAAK,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;SAC1C;IACH,CAAC;CAGF;AA/DD,oDA+DC"}

package/dist/lib/queues/HandlerContainer.d.ts

@@ -1,14 +1,23 @@
 import type { Either } from '@lokalise/node-core';
 import type { ZodSchema } from 'zod';
-export declare class MessageHandlerConfig<const MessagePayloadSchemas, const ExecutionContext> {
-    readonly schema: ZodSchema<MessagePayloadSchemas>;
-    readonly handler: Handler<MessagePayloadSchemas, ExecutionContext>;
-    constructor(schema: ZodSchema<MessagePayloadSchemas>, handler: Handler<MessagePayloadSchemas, ExecutionContext>);
+export type LogFormatter<MessagePayloadSchema> = (message: MessagePayloadSchema) => unknown;
+export type BarrierCallbackWithoutMessageType<MessagePayloadSchema extends object> = (message: MessagePayloadSchema) => Promise<boolean>;
+export declare const defaultLogFormatter: <MessagePayloadSchema>(message: MessagePayloadSchema) => MessagePayloadSchema;
+export type HandlerConfigOptions<MessagePayloadSchema extends object> = {
+    messageLogFormatter?: LogFormatter<MessagePayloadSchema>;
+    preHandlerBarrier?: BarrierCallbackWithoutMessageType<MessagePayloadSchema>;
+};
+export declare class MessageHandlerConfig<const MessagePayloadSchema extends object, const ExecutionContext> {
+    readonly schema: ZodSchema<MessagePayloadSchema>;
+    readonly handler: Handler<MessagePayloadSchema, ExecutionContext>;
+    readonly messageLogFormatter: LogFormatter<MessagePayloadSchema>;
+    readonly preHandlerBarrier?: BarrierCallbackWithoutMessageType<MessagePayloadSchema>;
+    constructor(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext>, options?: HandlerConfigOptions<MessagePayloadSchema>);
 }
-export declare class MessageHandlerConfigBuilder<MessagePayloadSchemas, ExecutionContext> {
+export declare class MessageHandlerConfigBuilder<MessagePayloadSchemas extends object, ExecutionContext> {
     private readonly configs;
     constructor();
-    addConfig<MessagePayloadSchema extends MessagePayloadSchemas>(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext>): this;
+    addConfig<MessagePayloadSchema extends MessagePayloadSchemas>(schema: ZodSchema<MessagePayloadSchema>, handler: Handler<MessagePayloadSchema, ExecutionContext>, options?: HandlerConfigOptions<MessagePayloadSchema>): this;
     build(): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext>[];
 }
 export type Handler<MessagePayloadSchemas, ExecutionContext> = (message: MessagePayloadSchemas, context: ExecutionContext) => Promise<Either<'retryLater', 'success'>>;
@@ -20,6 +29,6 @@ export declare class HandlerContainer<MessagePayloadSchemas extends object, Exec
     private readonly messageHandlers;
     private readonly messageTypeField;
     constructor(options: HandlerContainerOptions<MessagePayloadSchemas, ExecutionContext>);
-    resolveHandler(messageType: string): Handler<MessagePayloadSchemas, ExecutionContext>;
+    resolveHandler(messageType: string): MessageHandlerConfig<MessagePayloadSchemas, ExecutionContext>;
     private resolveHandlerMap;
 }

package/dist/lib/queues/HandlerContainer.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HandlerContainer = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = void 0;
+exports.HandlerContainer = exports.MessageHandlerConfigBuilder = exports.MessageHandlerConfig = exports.defaultLogFormatter = void 0;
+const defaultLogFormatter = (message) => message;
+exports.defaultLogFormatter = defaultLogFormatter;
 class MessageHandlerConfig {
     schema;
     handler;
-    constructor(schema, handler) {
+    messageLogFormatter;
+    preHandlerBarrier;
+    constructor(schema, handler, options) {
         this.schema = schema;
         this.handler = handler;
+        this.messageLogFormatter = options?.messageLogFormatter ?? exports.defaultLogFormatter;
+        this.preHandlerBarrier = options?.preHandlerBarrier;
     }
 }
 exports.MessageHandlerConfig = MessageHandlerConfig;
@@ -15,9 +21,9 @@ class MessageHandlerConfigBuilder {
     constructor() {
         this.configs = [];
     }
-    addConfig(schema, handler) {
+    addConfig(schema, handler, options) {
         // @ts-ignore
-        this.configs.push(new MessageHandlerConfig(schema, handler));
+        this.configs.push(new MessageHandlerConfig(schema, handler, options));
         return this;
     }
     build() {
@@ -44,7 +50,7 @@ class HandlerContainer {
         return supportedHandlers.reduce((acc, entry) => {
             // @ts-ignore
             const messageType = entry.schema.shape[this.messageTypeField].value;
-            acc[messageType] = entry.handler;
+            acc[messageType] = entry;
             return acc;
         }, {});
     }

package/dist/lib/queues/HandlerContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"HandlerContainer.js","sourceRoot":"","sources":["../../../lib/queues/HandlerContainer.ts"],"names":[],"mappings":";;;AAGA,MAAa,oBAAoB;IACf,MAAM,CAAkC;IACxC,OAAO,CAAkD;IAEzE,YACE,MAAwC,EACxC,OAAyD;QAEzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAXD,oDAWC;AAED,MAAa,2BAA2B;IACrB,OAAO,CAAiE;IAEzF;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;IACnB,CAAC;IAED,SAAS,CACP,MAAuC,EACvC,OAAwD;QAExD,aAAa;QACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AAnBD,kEAmBC;AAYD,MAAa,gBAAgB;IACV,eAAe,CAAkE;IACjF,gBAAgB,CAAQ;IAEzC,YAAY,OAAyE;QACnF,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACxE,CAAC;IAED,8DAA8D;IACvD,cAAc,CAAC,WAAmB;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACjD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAA;SAC5D;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,iBAAiB,CACvB,iBAAkF;QAElF,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,aAAa;YACb,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAA;YACnE,GAAG,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,OAAO,CAAA;YAChC,OAAO,GAAG,CAAA;QACZ,CAAC,EACD,EAAsE,CACvE,CAAA;IACH,CAAC;CACF;AA/BD,4CA+BC"}
+{"version":3,"file":"HandlerContainer.js","sourceRoot":"","sources":["../../../lib/queues/HandlerContainer.ts"],"names":[],"mappings":";;;AASO,MAAM,mBAAmB,GAAG,CAAuB,OAA6B,EAAE,EAAE,CAAC,OAAO,CAAA;AAAtF,QAAA,mBAAmB,uBAAmE;AAOnG,MAAa,oBAAoB;IAIf,MAAM,CAAiC;IACvC,OAAO,CAAiD;IACxD,mBAAmB,CAAoC;IACvD,iBAAiB,CAA0D;IAE3F,YACE,MAAuC,EACvC,OAAwD,EACxD,OAAoD;QAEpD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,mBAAmB,GAAG,OAAO,EAAE,mBAAmB,IAAI,2BAAmB,CAAA;QAC9E,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAA;IACrD,CAAC;CACF;AAnBD,oDAmBC;AAED,MAAa,2BAA2B;IACrB,OAAO,CAAiE;IAEzF;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;IACnB,CAAC;IAED,SAAS,CACP,MAAuC,EACvC,OAAwD,EACxD,OAAoD;QAEpD,aAAa;QACb,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;QACrE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AApBD,kEAoBC;AAYD,MAAa,gBAAgB;IACV,eAAe,CAG/B;IACgB,gBAAgB,CAAQ;IAEzC,YAAY,OAAyE;QACnF,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;IACxE,CAAC;IAED,8DAA8D;IACvD,cAAc,CACnB,WAAmB;QAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACjD,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,EAAE,CAAC,CAAA;SAC5D;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAEO,iBAAiB,CACvB,iBAAkF;QAElF,OAAO,iBAAiB,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,aAAa;YACb,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,KAAK,CAAA;YACnE,GAAG,CAAC,WAAW,CAAC,GAAG,KAAK,CAAA;YACxB,OAAO,GAAG,CAAA;QACZ,CAAC,EACD,EAAmF,CACpF,CAAA;IACH,CAAC;CACF;AApCD,4CAoCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "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",