Merge pull request #6 from cinemataztic/remove-unnecessary-console-logs

Remove unnecessary console logs

Author: daniyaltalatteo

README.md

@@ -2,7 +2,7 @@
 
 Wrapper package around [node-rdkafka](https://www.npmjs.com/package/node-rdkafka) where only the configuration is required, and the package can be used instantly with just the essentials. Don't be scared from the name, Kafka is cool and the name is a nod to the [Undertaker's](https://en.wikipedia.org/wiki/The_Undertaker) biker persona in the early 2000s.
 
-The purpose of this package is to provide a battery-included package where one does not have to worry about configuring the [node-rdkafka](https://www.npmjs.com/package/node-rdkafka) package for using Kafka client's functions like sending a message to a topic and consuming a message from a topic. The package handles producer/consumer connection internally and only allows disconnecting both producer and consumer connection.
+The purpose is to provide a batteries-included package where one does not have to worry about configuring [node-rdkafka](https://www.npmjs.com/package/node-rdkafka) for sending a message to a topic and consuming a message from a topic. The package handles producer/consumer connection internally and only allows disconnecting producer/consumer externally.
 
 ## Getting started
 
@@ -14,6 +14,8 @@ npm i @cinemataztic/big-evil-kafka
 
 ## Prerequisites
 
+Node.js version should be >=16
+
 This package uses [confluent-schema-registry](https://www.npmjs.com/package/@kafkajs/confluent-schema-registry) and assumes that the schema registry is in place along with the Kafka server running in the background.
 
 ## Usage
@@ -34,7 +36,7 @@ Configurations must be passed to the KafkaClient to initialize node-rdkafka prod
 
   The unique identifier of both producer and consumer instance. It is meant as a label and is not to be confused with the group ID.
 
-  Default value is `default-client`.
+  Default value is `default-client-id`.
 
 - `groupId?: string`
 
@@ -44,7 +46,7 @@ Configurations must be passed to the KafkaClient to initialize node-rdkafka prod
 
 - `brokers?: Array`
 
-  The list of brokers that specifies the Kafka broker(s), the producer and consumer should connect to. Brokers need to be passed as an array, i.e, `['localhost:9092', 'kafka:29092']` because the package internally converts them to string as per the requirement for node-rdkafka that requires `metadata.broker.list` as a string.  
+  The list of brokers that specifies the Kafka broker(s), the producer and consumer should connect to. Brokers need to be passed as an array, i.e, `['localhost:9092', 'kafka:29092']` because the package internally converts them to string as a requirement for `metadata.broker.list`.  
 
   Default value is `['localhost:9092']`.
 
@@ -85,7 +87,7 @@ client.consumeMessage(topic, onMessage);
 
 ## Disconnection
 
-To disconnect either the producer or consumer, call the following methods for both producer and consumer respectively.
+To disconnect either the producer or consumer, call the following methods for producer and consumer respectively.
 ```js
 client.disconnectProducer();
 
@@ -95,6 +97,6 @@ client.disconnectConsumer();
 
 ## Motivation
 
-Many of our services are relying upon the Kafka message queue system. The problem with using node-rdkafka in each of the different services is that in case of any change to kafka configuration, it had to be replicated across different services for consistency and also the manual setup and configuration of node-rdkafka is not simple and requires a lot of effort to set it up in a way that ensures maintainability. 
+Many of our services are relying upon the Kafka message queue system. The problem with using node-rdkafka in multiple services was that in case of any change to kafka configuration, it had to be replicated across multiple services for consistency. The manual setup and configuration of node-rdkafka is not simple and requires a lot of effort to set it up in a way that ensures maintainability. 
 
-Having a wrapper package around node-rdkafka allows us to not only utilize [exponential backoff](https://www.npmjs.com/package/exponential-backoff) for consumer/producer retry mechanism but also to provide a batteries-included package that would simply allow users to send and consume messages, and with additional ability to disconnect them in case of an error in the services.
+Having a wrapper package around node-rdkafka allows to not only utilize [exponential backoff](https://www.npmjs.com/package/exponential-backoff) for consumer/producer retry mechanism but also provide a batteries-included package that would simply allow users to send and consume messages.

__test__/index.test.js

@@ -16,7 +16,7 @@ beforeAll(async () => {
   logSpy = jest.spyOn(console, 'log').mockImplementation();
 });
 
-describe('Kafka producer integration tests', () => {
+describe('Kafka client integration tests', () => {
   beforeEach(async () => {
     jest.clearAllMocks();
   });
@@ -27,18 +27,6 @@ describe('Kafka producer integration tests', () => {
       'Kafka producer successfully connected',
     );
   });
-  test('should log message when producer sends a message', async () => {
-    await kafkaClient.sendMessage(topic, { message: 'Hello Cinemataztic' });
-    expect(logSpy).toHaveBeenCalledWith(
-      `Successfully published data to topic: ${topic}`,
-    );
-  });
-});
-
-describe('Kafka consumer integration tests', () => {
-  beforeEach(async () => {
-    jest.clearAllMocks();
-  });
 
   test('should log message when consumer is connected', async () => {
     await kafkaClient.consumeMessage(topic, () => {});
@@ -49,7 +37,6 @@ describe('Kafka consumer integration tests', () => {
 
   test('should log message when consumer receives a message', async () => {
     await kafkaClient.consumeMessage(topic, (data) => {
-      console.log(`Message received by consumer on topic: ${topic}`);
       expect(data).toHaveProperty('value');
       expect(data.value).toHaveProperty('message', 'Hello Cinemataztic');
     });
@@ -62,10 +49,6 @@ describe('Kafka consumer integration tests', () => {
 
     // Wait for the polling (via setInterval) to pick up the message.
     await new Promise((resolve) => setTimeout(resolve, 5000));
-
-    expect(logSpy).toHaveBeenCalledWith(
-      `Message received by consumer on topic: ${topic}`,
-    );
   });
 
   afterEach(() => {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cinemataztic/big-evil-kafka",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "A wrapper around node-rdkafka",
   "main": "src/index.js",
   "scripts": {

package.json

@@ -75,13 +75,13 @@ class KafkaClient {
    * @constructor
    * @public
    * @param {Object} config The configuration object for kafka client initialization
-   * @param {String} config.clientId The client identifier (default: 'default-client')
+   * @param {String} config.clientId The client identifier (default: 'default-client-id')
    * @param {String} config.groupId The client group id string. All clients sharing the same groupId belong to the same group (default: 'default-group-id')
    * @param {Array} config.brokers The initial list of brokers as a CSV list of broker host or host:port (default: ['localhost:9092'])
    * @param {String} config.avroSchemaRegistry The schema registry host for encoding and decoding the messages as per the avro schemas wrt a subject (default: 'http://localhost:8081')
    */
   constructor(config = {}) {
-    this.#clientId = config.clientId || 'default-client';
+    this.#clientId = config.clientId || 'default-client-id';
     this.#groupId = config.groupId || 'default-group-id';
     this.#brokers = config.brokers || ['localhost:9092'];
     this.#avroSchemaRegistry =
@@ -251,8 +251,6 @@ class KafkaClient {
         const subject = `${topic}-value`;
         const id = await this.#registry.getRegistryId(subject, 'latest');
 
-        console.log(`Using schema ${topic}-value@latest (id: ${id})`);
-
         const encodedMessage = await this.#registry.encode(id, message);
 
         this.#producer.produce(
@@ -261,8 +259,6 @@ class KafkaClient {
           Buffer.from(encodedMessage),
           `${topic}-schema`, // Key
         );
-
-        console.log(`Successfully published data to topic: ${topic}`);
       }
     } catch (error) {
       console.error(
@@ -287,7 +283,6 @@ class KafkaClient {
 
       if (this.#isConsumerConnected) {
         this.#consumer.subscribe([topic]);
-        console.log(`Subscribed to topic ${topic}`);
 
         if (!this.#intervalId) {
           this.#intervalId = setInterval(() => {
@@ -299,8 +294,6 @@ class KafkaClient {
           try {
             const decodedValue = await this.#registry.decode(data.value);
 
-            console.log(`Message received by consumer on topic: ${topic}`);
-
             onMessage({ value: decodedValue });
           } catch (error) {
             console.error(