@xnestjs/kafka 1.8.0 → 1.9.0

package/README.md

@@ -60,7 +60,7 @@ export class MyModule {}
 The library supports configuration through environment variables. Environment variables below is accepted.
 All environment variables starts with prefix (KAFKA\_). This can be configured while registering the module.
 
-<--- BEGIN env --->
+<!--- BEGIN env --->
 
 | Environment Variable            | Type      | Default               | Description                                                                                                                                                                                            |
 | ------------------------------- | --------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
@@ -102,4 +102,4 @@ The environment variables are available when KAFKA_SASL is `aws`
 | AWS_SECRET_ACCESS_KEY | String! |         |             |
 | AWS_SESSION_TOKEN     | String  |         |             |
 
-<--- END env --->
+<!--- END env --->

package/cjs/index.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientKafka = void 0;
+exports.Kafka = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./constants.js"), exports);
 tslib_1.__exportStar(require("./get-kafka-config.js"), exports);
 tslib_1.__exportStar(require("./kafka.module.js"), exports);
 tslib_1.__exportStar(require("./types.js"), exports);
-var microservices_1 = require("@nestjs/microservices");
-Object.defineProperty(exports, "ClientKafka", { enumerable: true, get: function () { return microservices_1.ClientKafka; } });
+var kafkajs_1 = require("kafkajs");
+Object.defineProperty(exports, "Kafka", { enumerable: true, get: function () { return kafkajs_1.Kafka; } });

package/cjs/kafka-core.module.js

@@ -6,8 +6,8 @@ const tslib_1 = require("tslib");
 const node_assert_1 = tslib_1.__importDefault(require("node:assert"));
 const crypto = tslib_1.__importStar(require("node:crypto"));
 const common_1 = require("@nestjs/common");
-const microservices_1 = require("@nestjs/microservices");
 const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
+const kafkajs_1 = require("kafkajs");
 const constants_js_1 = require("./constants.js");
 const create_log_creator_js_1 = require("./create-log-creator.js");
 const get_kafka_config_js_1 = require("./get-kafka-config.js");
@@ -48,8 +48,7 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
         });
     }
     static _createDynamicModule(opts, metadata) {
-        const token = opts.token ?? microservices_1.ClientKafka;
-        const name = typeof token === 'string' ? token : 'Kafka';
+        const token = opts.token ?? kafkajs_1.Kafka;
         const logger = typeof opts.logger === 'string' ? new common_1.Logger(opts.logger) : opts.logger;
         const exports = [constants_js_1.KAFKA_CONNECTION_OPTIONS, ...(metadata.exports ?? [])];
         const providers = [
@@ -66,41 +65,20 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
                 provide: constants_js_1.KAFKA_MODULE_ID,
                 useValue: crypto.randomUUID(),
             },
-        ];
-        if (name !== token) {
-            exports.push(token);
-            providers.push({
+            {
                 provide: token,
-                useExisting: name,
-            });
-        }
+                inject: [constants_js_1.KAFKA_CONNECTION_OPTIONS],
+                useFactory: (connectionOptions) => {
+                    return new kafkajs_1.Kafka({
+                        ...connectionOptions,
+                        logCreator: () => (0, create_log_creator_js_1.createLogCreator)(logger),
+                    });
+                },
+            },
+        ];
         return {
             module: KafkaCoreModule_1,
             providers,
-            imports: [
-                /** Import ClientsModule */
-                microservices_1.ClientsModule.registerAsync({
-                    clients: [
-                        {
-                            name,
-                            extraProviders: metadata.providers,
-                            inject: [constants_js_1.KAFKA_CONNECTION_OPTIONS],
-                            useFactory: (connectionOptions) => {
-                                return {
-                                    transport: microservices_1.Transport.KAFKA,
-                                    options: {
-                                        client: {
-                                            ...connectionOptions,
-                                            logCreator: () => (0, create_log_creator_js_1.createLogCreator)(logger),
-                                        },
-                                        consumer: connectionOptions.consumer,
-                                    },
-                                };
-                            },
-                        },
-                    ],
-                }),
-            ],
             exports,
         };
     }
@@ -112,28 +90,59 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
         this.client = client;
         this.connectionOptions = connectionOptions;
         this.logger = logger;
+        this._admins = new Set();
+        this._consumers = new Set();
+        this._producers = new Set();
     }
     async onApplicationBootstrap() {
         const options = this.connectionOptions;
-        if (options.lazyConnect)
+        const _this = this;
+        const oldConsumerFn = this.client.consumer;
+        this.client.consumer = function (...args) {
+            const instance = oldConsumerFn.apply(this, args);
+            _this._consumers.add(instance);
+            instance.on('consumer.disconnect', () => _this._consumers.delete(instance));
+            return instance;
+        };
+        const oldProducerFn = this.client.producer;
+        this.client.producer = function (...args) {
+            const instance = oldProducerFn.apply(this, args);
+            _this._producers.add(instance);
+            instance.on('producer.disconnect', () => _this._producers.delete(instance));
+            return instance;
+        };
+        if (options.lazyConnect || !options.brokers)
             return;
-        this.logger?.log('Connecting to Kafka brokers' +
+        this.logger?.log('Testing to Kafka brokers' +
             (Array.isArray(options.brokers)
                 ? ansi_colors_1.default.blue(options.brokers.join(','))
                 : ''));
         common_1.Logger.flush();
-        await this.client.connect().catch(e => {
-            this.logger?.error('Kafka connection failed: ' + e.message);
-            throw e;
-        });
+        const admin = this.client.admin();
+        try {
+            await admin.connect();
+            await admin.fetchTopicMetadata(); // this will fail if Kafka is not reachable
+            this.logger?.log('Kafka connection is healthy');
+        }
+        catch (error) {
+            this.logger?.error('Kafka connection failed: ' + error.message);
+            throw error;
+        }
+        finally {
+            await admin.disconnect();
+        }
     }
     onApplicationShutdown() {
-        return this.client.close();
+        return Promise.allSettled([
+            ...Array.from(this._admins).map(x => x.disconnect()),
+            ...Array.from(this._consumers).map(x => x.disconnect()),
+            ...Array.from(this._producers).map(x => x.disconnect()),
+        ]);
     }
 };
 exports.KafkaCoreModule = KafkaCoreModule;
 exports.KafkaCoreModule = KafkaCoreModule = KafkaCoreModule_1 = tslib_1.__decorate([
     tslib_1.__param(0, (0, common_1.Inject)(CLIENT_TOKEN)),
     tslib_1.__param(1, (0, common_1.Inject)(constants_js_1.KAFKA_CONNECTION_OPTIONS)),
-    tslib_1.__metadata("design:paramtypes", [microservices_1.ClientKafka, Object, common_1.Logger])
+    tslib_1.__metadata("design:paramtypes", [kafkajs_1.Kafka, Object, common_1.Logger])
 ], KafkaCoreModule);

package/esm/index.js

@@ -2,4 +2,4 @@ export * from './constants.js';
 export * from './get-kafka-config.js';
 export * from './kafka.module.js';
 export * from './types.js';
-export { ClientKafka } from '@nestjs/microservices';
+export { Kafka } from 'kafkajs';

package/esm/kafka-core.module.js

@@ -3,8 +3,8 @@ import { __decorate, __metadata, __param } from "tslib";
 import assert from 'node:assert';
 import * as crypto from 'node:crypto';
 import { Inject, Logger, } from '@nestjs/common';
-import { ClientKafka, ClientsModule, Transport, } from '@nestjs/microservices';
 import colors from 'ansi-colors';
+import { Kafka } from 'kafkajs';
 import { KAFKA_CONNECTION_OPTIONS, KAFKA_MODULE_ID } from './constants.js';
 import { createLogCreator } from './create-log-creator.js';
 import { getKafkaConfig } from './get-kafka-config.js';
@@ -45,8 +45,7 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
         });
     }
     static _createDynamicModule(opts, metadata) {
-        const token = opts.token ?? ClientKafka;
-        const name = typeof token === 'string' ? token : 'Kafka';
+        const token = opts.token ?? Kafka;
         const logger = typeof opts.logger === 'string' ? new Logger(opts.logger) : opts.logger;
         const exports = [KAFKA_CONNECTION_OPTIONS, ...(metadata.exports ?? [])];
         const providers = [
@@ -63,41 +62,20 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
                 provide: KAFKA_MODULE_ID,
                 useValue: crypto.randomUUID(),
             },
-        ];
-        if (name !== token) {
-            exports.push(token);
-            providers.push({
+            {
                 provide: token,
-                useExisting: name,
-            });
-        }
+                inject: [KAFKA_CONNECTION_OPTIONS],
+                useFactory: (connectionOptions) => {
+                    return new Kafka({
+                        ...connectionOptions,
+                        logCreator: () => createLogCreator(logger),
+                    });
+                },
+            },
+        ];
         return {
             module: KafkaCoreModule_1,
             providers,
-            imports: [
-                /** Import ClientsModule */
-                ClientsModule.registerAsync({
-                    clients: [
-                        {
-                            name,
-                            extraProviders: metadata.providers,
-                            inject: [KAFKA_CONNECTION_OPTIONS],
-                            useFactory: (connectionOptions) => {
-                                return {
-                                    transport: Transport.KAFKA,
-                                    options: {
-                                        client: {
-                                            ...connectionOptions,
-                                            logCreator: () => createLogCreator(logger),
-                                        },
-                                        consumer: connectionOptions.consumer,
-                                    },
-                                };
-                            },
-                        },
-                    ],
-                }),
-            ],
             exports,
         };
     }
@@ -109,28 +87,59 @@ let KafkaCoreModule = KafkaCoreModule_1 = class KafkaCoreModule {
         this.client = client;
         this.connectionOptions = connectionOptions;
         this.logger = logger;
+        this._admins = new Set();
+        this._consumers = new Set();
+        this._producers = new Set();
     }
     async onApplicationBootstrap() {
         const options = this.connectionOptions;
-        if (options.lazyConnect)
+        const _this = this;
+        const oldConsumerFn = this.client.consumer;
+        this.client.consumer = function (...args) {
+            const instance = oldConsumerFn.apply(this, args);
+            _this._consumers.add(instance);
+            instance.on('consumer.disconnect', () => _this._consumers.delete(instance));
+            return instance;
+        };
+        const oldProducerFn = this.client.producer;
+        this.client.producer = function (...args) {
+            const instance = oldProducerFn.apply(this, args);
+            _this._producers.add(instance);
+            instance.on('producer.disconnect', () => _this._producers.delete(instance));
+            return instance;
+        };
+        if (options.lazyConnect || !options.brokers)
             return;
-        this.logger?.log('Connecting to Kafka brokers' +
+        this.logger?.log('Testing to Kafka brokers' +
             (Array.isArray(options.brokers)
                 ? colors.blue(options.brokers.join(','))
                 : ''));
         Logger.flush();
-        await this.client.connect().catch(e => {
-            this.logger?.error('Kafka connection failed: ' + e.message);
-            throw e;
-        });
+        const admin = this.client.admin();
+        try {
+            await admin.connect();
+            await admin.fetchTopicMetadata(); // this will fail if Kafka is not reachable
+            this.logger?.log('Kafka connection is healthy');
+        }
+        catch (error) {
+            this.logger?.error('Kafka connection failed: ' + error.message);
+            throw error;
+        }
+        finally {
+            await admin.disconnect();
+        }
     }
     onApplicationShutdown() {
-        return this.client.close();
+        return Promise.allSettled([
+            ...Array.from(this._admins).map(x => x.disconnect()),
+            ...Array.from(this._consumers).map(x => x.disconnect()),
+            ...Array.from(this._producers).map(x => x.disconnect()),
+        ]);
     }
 };
 KafkaCoreModule = KafkaCoreModule_1 = __decorate([
     __param(0, Inject(CLIENT_TOKEN)),
     __param(1, Inject(KAFKA_CONNECTION_OPTIONS)),
-    __metadata("design:paramtypes", [ClientKafka, Object, Logger])
+    __metadata("design:paramtypes", [Kafka, Object, Logger])
 ], KafkaCoreModule);
 export { KafkaCoreModule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnestjs/kafka",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "NestJS extension library for Kafka",
   "author": "Panates",
   "license": "MIT",
@@ -13,7 +13,6 @@
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
     "@nestjs/core": "^10.0.0 || ^11.0.0",
-    "@nestjs/microservices": "^10.0.0 || ^11.0.0",
     "kafkajs": "^2.2.4"
   },
   "type": "module",

package/types/index.d.cts

@@ -2,4 +2,4 @@ export * from './constants.js';
 export * from './get-kafka-config.js';
 export * from './kafka.module.js';
 export * from './types.js';
-export { ClientKafka } from '@nestjs/microservices';
+export { Kafka } from 'kafkajs';

package/types/index.d.ts

@@ -2,4 +2,4 @@ export * from './constants.js';
 export * from './get-kafka-config.js';
 export * from './kafka.module.js';
 export * from './types.js';
-export { ClientKafka } from '@nestjs/microservices';
+export { Kafka } from 'kafkajs';

package/types/kafka-core.module.d.ts

@@ -1,8 +1,8 @@
 import { DynamicModule, Logger, OnApplicationBootstrap, OnApplicationShutdown } from '@nestjs/common';
-import { ClientKafka } from '@nestjs/microservices';
+import { Kafka } from 'kafkajs';
 import type { KafkaConnectionOptions, KafkaModuleAsyncOptions, KafkaModuleOptions } from './types';
 export declare class KafkaCoreModule implements OnApplicationShutdown, OnApplicationBootstrap {
-    protected client: ClientKafka;
+    protected client: Kafka;
     private connectionOptions;
     private logger?;
     /**
@@ -14,11 +14,14 @@ export declare class KafkaCoreModule implements OnApplicationShutdown, OnApplica
      */
     static forRootAsync(asyncOptions: KafkaModuleAsyncOptions): DynamicModule;
     private static _createDynamicModule;
+    private _admins;
+    private _consumers;
+    private _producers;
     /**
      *
      * @constructor
      */
-    constructor(client: ClientKafka, connectionOptions: KafkaConnectionOptions, logger?: Logger | undefined);
+    constructor(client: Kafka, connectionOptions: KafkaConnectionOptions, logger?: Logger | undefined);
     onApplicationBootstrap(): Promise<void>;
-    onApplicationShutdown(): Promise<void>;
+    onApplicationShutdown(): Promise<PromiseSettledResult<void>[]>;
 }