@woovi/kafka 0.1.4 → 0.1.7

package/dist/index.cjs

@@ -24,37 +24,42 @@ var __webpack_require__ = {};
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
-    getMetricsContentType: ()=>getMetricsContentType,
     logLevel: ()=>external_kafkajs_namespaceObject.logLevel,
-    WooviProducer: ()=>WooviProducer,
-    parseMessage: ()=>parseMessage,
-    enableDefaultMetrics: ()=>enableDefaultMetrics,
     consumerLag: ()=>consumerLag,
-    messagesProducedTotal: ()=>messagesProducedTotal,
     createKafkaFromEnv: ()=>createKafkaFromEnv,
-    createProducer: ()=>createProducer,
     healthCheck: ()=>healthCheck,
     createKafka: ()=>createKafka,
-    WooviConsumer: ()=>WooviConsumer,
     batchProcessingDuration: ()=>batchProcessingDuration,
     lastMessageTimestamp: ()=>lastMessageTimestamp,
-    getMetrics: ()=>getMetrics,
-    messageProcessingDuration: ()=>messageProcessingDuration,
     messagesProcessedTotal: ()=>messagesProcessedTotal,
     onShutdown: ()=>onShutdown,
-    batchSize: ()=>batchSize,
-    Kafka: ()=>external_kafkajs_namespaceObject.Kafka,
-    kafkaRegistry: ()=>kafkaRegistry,
     produceLatency: ()=>produceLatency,
     createConsumer: ()=>createConsumer,
     getKafka: ()=>getKafka,
-    messagesFailedTotal: ()=>messagesFailedTotal,
     resetMetrics: ()=>resetMetrics,
-    getMessageHeaders: ()=>getMessageHeaders
+    getMessageHeaders: ()=>getMessageHeaders,
+    getMetricsContentType: ()=>getMetricsContentType,
+    WooviProducer: ()=>WooviProducer,
+    parseMessage: ()=>parseMessage,
+    enableDefaultMetrics: ()=>enableDefaultMetrics,
+    messagesProducedTotal: ()=>messagesProducedTotal,
+    messageProcessingDuration: ()=>messageProcessingDuration,
+    createProducer: ()=>createProducer,
+    WooviConsumer: ()=>WooviConsumer,
+    getMetrics: ()=>getMetrics,
+    batchSize: ()=>batchSize,
+    Kafka: ()=>external_kafkajs_namespaceObject.Kafka,
+    isTestMode: ()=>isTestMode,
+    disableTestMode: ()=>disableTestMode,
+    kafkaRegistry: ()=>kafkaRegistry,
+    setMockKafkaForTestMode: ()=>setMockKafkaForTestMode,
+    messagesFailedTotal: ()=>messagesFailedTotal,
+    enableTestMode: ()=>enableTestMode
 });
 const external_kafkajs_namespaceObject = require("kafkajs");
 const logger_namespaceObject = require("@woovi/logger");
 let kafkaInstance = null;
+let testMode = false;
 const shutdownCallbacks = [];
 let shutdownRegistered = false;
 const kafkaLogger = logger_namespaceObject.logger.child({
@@ -104,7 +109,25 @@ function registerGracefulShutdown() {
 function onShutdown(callback) {
     shutdownCallbacks.push(callback);
 }
+const WOOVI_KAFKA_MOCK_KEY = '__woovi_kafka_mock__';
+function getGlobalState() {
+    const g = globalThis;
+    if (!g[WOOVI_KAFKA_MOCK_KEY]) g[WOOVI_KAFKA_MOCK_KEY] = {
+        mock: null,
+        testMode: false
+    };
+    return g[WOOVI_KAFKA_MOCK_KEY];
+}
+function setMockKafkaForTestMode(mock) {
+    const state = getGlobalState();
+    state.mock = mock;
+    state.testMode = true;
+    testMode = true;
+}
 function getKafka() {
+    const state = getGlobalState();
+    if (state.testMode && state.mock) return state.mock;
+    if (testMode && kafkaInstance) return kafkaInstance;
     if (!kafkaInstance) throw new Error('Kafka not initialized. Call createKafka() first.');
     return kafkaInstance;
 }
@@ -164,6 +187,17 @@ async function healthCheck() {
         };
     }
 }
+function enableTestMode(mockKafka) {
+    testMode = true;
+    if (mockKafka) kafkaInstance = mockKafka;
+}
+function disableTestMode() {
+    testMode = false;
+    kafkaInstance = null;
+}
+function isTestMode() {
+    return testMode;
+}
 const external_prom_client_namespaceObject = require("prom-client");
 const kafkaRegistry = new external_prom_client_namespaceObject.Registry();
 const messageProcessingDuration = new external_prom_client_namespaceObject.Histogram({
@@ -707,12 +741,15 @@ exports.createConsumer = __webpack_exports__.createConsumer;
 exports.createKafka = __webpack_exports__.createKafka;
 exports.createKafkaFromEnv = __webpack_exports__.createKafkaFromEnv;
 exports.createProducer = __webpack_exports__.createProducer;
+exports.disableTestMode = __webpack_exports__.disableTestMode;
 exports.enableDefaultMetrics = __webpack_exports__.enableDefaultMetrics;
+exports.enableTestMode = __webpack_exports__.enableTestMode;
 exports.getKafka = __webpack_exports__.getKafka;
 exports.getMessageHeaders = __webpack_exports__.getMessageHeaders;
 exports.getMetrics = __webpack_exports__.getMetrics;
 exports.getMetricsContentType = __webpack_exports__.getMetricsContentType;
 exports.healthCheck = __webpack_exports__.healthCheck;
+exports.isTestMode = __webpack_exports__.isTestMode;
 exports.kafkaRegistry = __webpack_exports__.kafkaRegistry;
 exports.lastMessageTimestamp = __webpack_exports__.lastMessageTimestamp;
 exports.logLevel = __webpack_exports__.logLevel;
@@ -724,6 +761,7 @@ exports.onShutdown = __webpack_exports__.onShutdown;
 exports.parseMessage = __webpack_exports__.parseMessage;
 exports.produceLatency = __webpack_exports__.produceLatency;
 exports.resetMetrics = __webpack_exports__.resetMetrics;
+exports.setMockKafkaForTestMode = __webpack_exports__.setMockKafkaForTestMode;
 for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "Kafka",
     "WooviConsumer",
@@ -735,12 +773,15 @@ for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "createKafka",
     "createKafkaFromEnv",
     "createProducer",
+    "disableTestMode",
     "enableDefaultMetrics",
+    "enableTestMode",
     "getKafka",
     "getMessageHeaders",
     "getMetrics",
     "getMetricsContentType",
     "healthCheck",
+    "isTestMode",
     "kafkaRegistry",
     "lastMessageTimestamp",
     "logLevel",
@@ -751,7 +792,8 @@ for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "onShutdown",
     "parseMessage",
     "produceLatency",
-    "resetMetrics"
+    "resetMetrics",
+    "setMockKafkaForTestMode"
 ].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
 Object.defineProperty(exports, '__esModule', {
     value: true

package/dist/index.d.ts

@@ -34,12 +34,23 @@ export declare function createKafkaFromEnv(clientId: string): Kafka;
 
 export declare function createProducer(config?: WooviProducerConfig): WooviProducer;
 
+/**
+ * Disable test mode and reset the Kafka instance.
+ */
+export declare function disableTestMode(): void;
+
 export { EachBatchPayload }
 
 export { EachMessagePayload }
 
 export declare function enableDefaultMetrics(): void;
 
+/**
+ * Enable test mode with a mock Kafka instance.
+ * This allows tests to bypass the real Kafka connection.
+ */
+export declare function enableTestMode(mockKafka?: Kafka): void;
+
 export declare interface ErrorHandler {
     (error: Error, payload: EachMessagePayload): Promise<void>;
 }
@@ -57,6 +68,11 @@ export declare function healthCheck(): Promise<{
     error?: string;
 }>;
 
+/**
+ * Check if test mode is enabled.
+ */
+export declare function isTestMode(): boolean;
+
 export { Kafka }
 
 export declare interface KafkaConfig {
@@ -132,6 +148,8 @@ export { RecordMetadata }
 
 export declare function resetMetrics(): void;
 
+export declare function setMockKafkaForTestMode(mock: Kafka): void;
+
 export declare class WooviConsumer {
     private consumer;
     private topics;

package/dist/index.js

@@ -2,6 +2,7 @@ import { Kafka, logLevel } from "kafkajs";
 import { logger } from "@woovi/logger";
 import { Counter, Gauge, Histogram, Registry, collectDefaultMetrics } from "prom-client";
 let kafkaInstance = null;
+let testMode = false;
 const shutdownCallbacks = [];
 let shutdownRegistered = false;
 const kafkaLogger = logger.child({
@@ -51,7 +52,25 @@ function registerGracefulShutdown() {
 function onShutdown(callback) {
     shutdownCallbacks.push(callback);
 }
+const WOOVI_KAFKA_MOCK_KEY = '__woovi_kafka_mock__';
+function getGlobalState() {
+    const g = globalThis;
+    if (!g[WOOVI_KAFKA_MOCK_KEY]) g[WOOVI_KAFKA_MOCK_KEY] = {
+        mock: null,
+        testMode: false
+    };
+    return g[WOOVI_KAFKA_MOCK_KEY];
+}
+function setMockKafkaForTestMode(mock) {
+    const state = getGlobalState();
+    state.mock = mock;
+    state.testMode = true;
+    testMode = true;
+}
 function getKafka() {
+    const state = getGlobalState();
+    if (state.testMode && state.mock) return state.mock;
+    if (testMode && kafkaInstance) return kafkaInstance;
     if (!kafkaInstance) throw new Error('Kafka not initialized. Call createKafka() first.');
     return kafkaInstance;
 }
@@ -111,6 +130,17 @@ async function healthCheck() {
         };
     }
 }
+function enableTestMode(mockKafka) {
+    testMode = true;
+    if (mockKafka) kafkaInstance = mockKafka;
+}
+function disableTestMode() {
+    testMode = false;
+    kafkaInstance = null;
+}
+function isTestMode() {
+    return testMode;
+}
 const kafkaRegistry = new Registry();
 const messageProcessingDuration = new Histogram({
     name: 'kafka_consumer_message_processing_duration_seconds',
@@ -643,4 +673,4 @@ function getMessageHeaders(payload) {
     }
     return headers;
 }
-export { Kafka, WooviConsumer, WooviProducer, batchProcessingDuration, batchSize, consumerLag, createConsumer, createKafka, createKafkaFromEnv, createProducer, enableDefaultMetrics, getKafka, getMessageHeaders, getMetrics, getMetricsContentType, healthCheck, kafkaRegistry, lastMessageTimestamp, logLevel, messageProcessingDuration, messagesFailedTotal, messagesProcessedTotal, messagesProducedTotal, onShutdown, parseMessage, produceLatency, resetMetrics };
+export { Kafka, WooviConsumer, WooviProducer, batchProcessingDuration, batchSize, consumerLag, createConsumer, createKafka, createKafkaFromEnv, createProducer, disableTestMode, enableDefaultMetrics, enableTestMode, getKafka, getMessageHeaders, getMetrics, getMetricsContentType, healthCheck, isTestMode, kafkaRegistry, lastMessageTimestamp, logLevel, messageProcessingDuration, messagesFailedTotal, messagesProcessedTotal, messagesProducedTotal, onShutdown, parseMessage, produceLatency, resetMetrics, setMockKafkaForTestMode };

package/dist/test-utils.cjs

@@ -29,13 +29,15 @@ __webpack_require__.d(__webpack_exports__, {
     mockAdmin: ()=>mockAdmin,
     KafkaJSProtocolError: ()=>KafkaJSProtocolError,
     clearAllMocks: ()=>clearAllMocks,
+    createMockKafka: ()=>createMockKafka,
     mockConsumer: ()=>mockConsumer,
-    mockProducerSend: ()=>mockProducerSend,
     kafkaAssert: ()=>kafkaAssert,
     Kafka: ()=>Kafka,
     kafkaAssertLength: ()=>kafkaAssertLength,
+    mockProducerSend: ()=>mockProducerSend,
     mockTransaction: ()=>mockTransaction,
     mockTransactionSend: ()=>mockTransactionSend,
+    setupKafkaTest: ()=>setupKafkaTest,
     KafkaJSNonRetriableError: ()=>KafkaJSNonRetriableError,
     CompressionTypes: ()=>CompressionTypes,
     mockProducer: ()=>mockProducer
@@ -77,34 +79,34 @@ const kafkaMock_fn = getMockFn();
 const mockProducerSend = kafkaMock_fn();
 const mockTransactionSend = kafkaMock_fn();
 const mockTransaction = kafkaMock_fn().mockReturnValue({
-    send: mockTransactionSend,
-    commit: kafkaMock_fn(),
-    abort: kafkaMock_fn()
+    send: mockTransactionSend.mockResolvedValue(void 0),
+    commit: kafkaMock_fn().mockResolvedValue(void 0),
+    abort: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const mockProducer = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    send: mockProducerSend,
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    send: mockProducerSend.mockResolvedValue(void 0),
     transaction: mockTransaction,
     on: kafkaMock_fn()
 });
 const mockConsumer = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    subscribe: kafkaMock_fn(),
-    run: kafkaMock_fn(),
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    subscribe: kafkaMock_fn().mockResolvedValue(void 0),
+    run: kafkaMock_fn().mockResolvedValue(void 0),
     on: kafkaMock_fn(),
-    pause: kafkaMock_fn(),
-    resume: kafkaMock_fn(),
-    seek: kafkaMock_fn()
+    pause: kafkaMock_fn().mockResolvedValue(void 0),
+    resume: kafkaMock_fn().mockResolvedValue(void 0),
+    seek: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const mockAdmin = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    createTopics: kafkaMock_fn(),
-    deleteTopics: kafkaMock_fn(),
-    listTopics: kafkaMock_fn().mockReturnValue([]),
-    fetchTopicMetadata: kafkaMock_fn()
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    createTopics: kafkaMock_fn().mockResolvedValue(void 0),
+    deleteTopics: kafkaMock_fn().mockResolvedValue(void 0),
+    listTopics: kafkaMock_fn().mockResolvedValue([]),
+    fetchTopicMetadata: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const Kafka = kafkaMock_fn().mockReturnValue({
     producer: mockProducer,
@@ -202,11 +204,28 @@ const kafkaAssertLength = (args)=>{
         throw error;
     }
 };
+function createMockKafka() {
+    return Kafka();
+}
+const WOOVI_KAFKA_MOCK_KEY = '__woovi_kafka_mock__';
+function setupKafkaTest() {
+    const mockKafkaInstance = {
+        producer: mockProducer,
+        consumer: mockConsumer,
+        admin: mockAdmin
+    };
+    const g = globalThis;
+    g[WOOVI_KAFKA_MOCK_KEY] = {
+        mock: mockKafkaInstance,
+        testMode: true
+    };
+}
 exports.CompressionTypes = __webpack_exports__.CompressionTypes;
 exports.Kafka = __webpack_exports__.Kafka;
 exports.KafkaJSNonRetriableError = __webpack_exports__.KafkaJSNonRetriableError;
 exports.KafkaJSProtocolError = __webpack_exports__.KafkaJSProtocolError;
 exports.clearAllMocks = __webpack_exports__.clearAllMocks;
+exports.createMockKafka = __webpack_exports__.createMockKafka;
 exports.getKafkaMessages = __webpack_exports__.getKafkaMessages;
 exports.kafkaAssert = __webpack_exports__.kafkaAssert;
 exports.kafkaAssertLength = __webpack_exports__.kafkaAssertLength;
@@ -217,12 +236,14 @@ exports.mockProducer = __webpack_exports__.mockProducer;
 exports.mockProducerSend = __webpack_exports__.mockProducerSend;
 exports.mockTransaction = __webpack_exports__.mockTransaction;
 exports.mockTransactionSend = __webpack_exports__.mockTransactionSend;
+exports.setupKafkaTest = __webpack_exports__.setupKafkaTest;
 for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "CompressionTypes",
     "Kafka",
     "KafkaJSNonRetriableError",
     "KafkaJSProtocolError",
     "clearAllMocks",
+    "createMockKafka",
     "getKafkaMessages",
     "kafkaAssert",
     "kafkaAssertLength",
@@ -232,7 +253,8 @@ for(var __webpack_i__ in __webpack_exports__)if (-1 === [
     "mockProducer",
     "mockProducerSend",
     "mockTransaction",
-    "mockTransactionSend"
+    "mockTransactionSend",
+    "setupKafkaTest"
 ].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
 Object.defineProperty(exports, '__esModule', {
     value: true

package/dist/test-utils.d.ts

@@ -8,6 +8,20 @@ export declare const CompressionTypes: {
     ZSTD: number;
 };
 
+/**
+ * Create a mock Kafka instance for testing.
+ * Use this with setMockKafkaForTestMode from @woovi/kafka.
+ *
+ * @example
+ * import { setMockKafkaForTestMode } from '@woovi/kafka';
+ * import { createMockKafka } from '@woovi/kafka/test-utils';
+ *
+ * beforeAll(() => {
+ *   setMockKafkaForTestMode(createMockKafka());
+ * });
+ */
+export declare function createMockKafka(): any;
+
 export declare const getKafkaMessages: () => KafkaMessage[];
 
 export declare const Kafka: MockFn;
@@ -76,4 +90,21 @@ export declare const mockTransaction: MockFn;
 
 export declare const mockTransactionSend: MockFn;
 
+/**
+ * Set up Kafka for testing with a mock instance.
+ * This creates a mock Kafka that records messages for kafkaAssert.
+ *
+ * @example
+ * import { setupKafkaTest, clearAllMocks } from '@woovi/kafka/test-utils';
+ *
+ * beforeAll(() => {
+ *   setupKafkaTest();
+ * });
+ *
+ * beforeEach(() => {
+ *   clearAllMocks();
+ * });
+ */
+export declare function setupKafkaTest(): void;
+
 export { }

package/dist/test-utils.js

@@ -35,34 +35,34 @@ const kafkaMock_fn = getMockFn();
 const mockProducerSend = kafkaMock_fn();
 const mockTransactionSend = kafkaMock_fn();
 const mockTransaction = kafkaMock_fn().mockReturnValue({
-    send: mockTransactionSend,
-    commit: kafkaMock_fn(),
-    abort: kafkaMock_fn()
+    send: mockTransactionSend.mockResolvedValue(void 0),
+    commit: kafkaMock_fn().mockResolvedValue(void 0),
+    abort: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const mockProducer = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    send: mockProducerSend,
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    send: mockProducerSend.mockResolvedValue(void 0),
     transaction: mockTransaction,
     on: kafkaMock_fn()
 });
 const mockConsumer = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    subscribe: kafkaMock_fn(),
-    run: kafkaMock_fn(),
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    subscribe: kafkaMock_fn().mockResolvedValue(void 0),
+    run: kafkaMock_fn().mockResolvedValue(void 0),
     on: kafkaMock_fn(),
-    pause: kafkaMock_fn(),
-    resume: kafkaMock_fn(),
-    seek: kafkaMock_fn()
+    pause: kafkaMock_fn().mockResolvedValue(void 0),
+    resume: kafkaMock_fn().mockResolvedValue(void 0),
+    seek: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const mockAdmin = kafkaMock_fn().mockReturnValue({
-    connect: kafkaMock_fn(),
-    disconnect: kafkaMock_fn(),
-    createTopics: kafkaMock_fn(),
-    deleteTopics: kafkaMock_fn(),
-    listTopics: kafkaMock_fn().mockReturnValue([]),
-    fetchTopicMetadata: kafkaMock_fn()
+    connect: kafkaMock_fn().mockResolvedValue(void 0),
+    disconnect: kafkaMock_fn().mockResolvedValue(void 0),
+    createTopics: kafkaMock_fn().mockResolvedValue(void 0),
+    deleteTopics: kafkaMock_fn().mockResolvedValue(void 0),
+    listTopics: kafkaMock_fn().mockResolvedValue([]),
+    fetchTopicMetadata: kafkaMock_fn().mockResolvedValue(void 0)
 });
 const Kafka = kafkaMock_fn().mockReturnValue({
     producer: mockProducer,
@@ -160,4 +160,20 @@ const kafkaAssertLength = (args)=>{
         throw error;
     }
 };
-export { CompressionTypes, Kafka, KafkaJSNonRetriableError, KafkaJSProtocolError, clearAllMocks, getKafkaMessages, kafkaAssert, kafkaAssertLength, logLevel, mockAdmin, mockConsumer, mockProducer, mockProducerSend, mockTransaction, mockTransactionSend };
+function createMockKafka() {
+    return Kafka();
+}
+const WOOVI_KAFKA_MOCK_KEY = '__woovi_kafka_mock__';
+function setupKafkaTest() {
+    const mockKafkaInstance = {
+        producer: mockProducer,
+        consumer: mockConsumer,
+        admin: mockAdmin
+    };
+    const g = globalThis;
+    g[WOOVI_KAFKA_MOCK_KEY] = {
+        mock: mockKafkaInstance,
+        testMode: true
+    };
+}
+export { CompressionTypes, Kafka, KafkaJSNonRetriableError, KafkaJSProtocolError, clearAllMocks, createMockKafka, getKafkaMessages, kafkaAssert, kafkaAssertLength, logLevel, mockAdmin, mockConsumer, mockProducer, mockProducerSend, mockTransaction, mockTransactionSend, setupKafkaTest };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@woovi/kafka",
   "description": "Kafka setup and utilities for Woovi microservices",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "author": "",
   "type": "module",
   "dependencies": {