fix(API): Changed the createConsumer and createProducer methjods

createConsumer and createProducer methods would generate a promise when none is needed. Also cleaned
up documentation due to connect() not returning itself.

create clients methods are no longer promises

Author: Daniel Olivares

README.md

@@ -122,6 +122,8 @@ import iris from '@parkhub/iris';
     }
   });
 
+  await consumer.connect();
+
   const handler = data => console.log(data);
   consumer.subscribe(['MY_TOPIC'], handler);
 
@@ -153,7 +155,9 @@ import iris from '@parkhub/iris';
   const producer = await iris.createProducer({
     'client.id': 'kafka',
     'dr_cb': true 
-  }).connect();
+  });
+
+  await producer.connect();
 
   producer.produce('TestTopic', null, 'message');
 

__tests__/both.integration.test.js

@@ -36,7 +36,7 @@ describe('Running combined producer consume test', () => {
 
     kafka = await iris({ registryUrl, brokerList, schemaCfgs }).initialize();
 
-    const consumer = await kafka.createConsumer({
+    const consumer = kafka.createConsumer({
       groupId: 'BothIntegrationTest',
       event_cb: true
     });
@@ -54,7 +54,7 @@ describe('Running combined producer consume test', () => {
     consumer.subscribe([testTopic], handler);
 
     setTimeout(async () => {
-      const producer = await kafka.createProducer();
+      const producer = kafka.createProducer();
       await producer.connect();
 
       producer.produce(testTopic, null, message);

__tests__/fixtures/scripts/waitForServicesToBeAvailable.js

@@ -15,7 +15,7 @@ export default async function waitForServicesToBeAvailable(tries = 0) {
   try {
     log(`Making request ${tries}`);
 
-    await delay(30000);
+    await delay(15000);
     await request(postOpts);
   } catch (e) {
     log('Failed...');

codefresh.yml

@@ -26,7 +26,7 @@ steps:
     type: composition
     title: Running Integration Tests
     description: Running integration tests with kafka
-    composition: docker-compose.ci-integration.yml
+    composition: ./docker-compose.ci-integration.yml
     composition_candidates:
       integration_tests:
         image: ${{BuildDockerImage}}

docker-compose.ci-integration.yml

@@ -8,7 +8,7 @@ services:
       - zookeeper
       - schema-registry
   kafka:
-    image: parkhubprime/pk-confluent-kafka:3.3.0
+    image: quay.io/parkhubprime/pk-confluent-kafka:3.3.0
     hostname: kafka
     depends_on:
       - zookeeper
@@ -19,7 +19,7 @@ services:
       KAFKA_JMX_PORT: 9999
       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
   zookeeper:
-    image: parkhubprime/pk-confluent-zookeeper:3.3.0
+    image: quay.io/parkhubprime/pk-confluent-zookeeper:3.3.0
     hostname: zookeeper
     environment:
       ZOOKEEPER_REPLICAS: 1

docker-compose.yml

@@ -12,7 +12,7 @@ services:
       - ./:/home/app
       - /home/app/node_modules
   kafka:
-    image: parkhubprime/pk-confluent-kafka:3.3.0
+    image: quay.io/parkhubprime/pk-confluent-kafka:3.3.0
     hostname: kafka
     depends_on:
       - zookeeper
@@ -26,7 +26,7 @@ services:
       KAFKA_JMX_PORT: 9999
       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
   zookeeper:
-    image: parkhubprime/pk-confluent-zookeeper:3.3.0
+    image: quay.io/parkhubprime/pk-confluent-zookeeper:3.3.0
     hostname: zookeeper
     ports:
       - 2181:2181

src/index.js

@@ -48,7 +48,7 @@ const irisProto = {
   /**
    * Creates a new producer.
    */
-  async createProducer(cfgs: { brokerList: string }): Promise<any> {
+  createProducer(cfgs: { brokerList: string }): Promise<any> {
     const { brokerList, registry } = this;
     const producerCfgs = {
       brokerList,
@@ -57,7 +57,7 @@ const irisProto = {
 
     log('Creating new producer with configurations %O', producerCfgs);
 
-    const initiatedProducer = await producer({
+    const initiatedProducer = producer({
       producerCfgs,
       registry
     });
@@ -71,7 +71,7 @@ const irisProto = {
   /**
    * Creates a new consumer.
    */
-  async createConsumer(cfgs: { brokerList: string }): Promise<any> {
+  createConsumer(cfgs: { brokerList: string }): Promise<any> {
     const { brokerList, registry } = this;
     const consumerCfgs = {
       brokerList,
@@ -80,7 +80,7 @@ const irisProto = {
 
     log('Creating new consumer with configurations %O', consumerCfgs);
 
-    const initiatedConsumer = await consumer({
+    const initiatedConsumer = consumer({
       consumerCfgs,
       registry
     });