@mojaloop/central-services-stream/test/unit/util/consumer.test.js

Streaming library code for central services.

/*****
 License
 --------------
 Copyright © 2020-2025 Mojaloop Foundation
 The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

 Contributors
 --------------
 This is the official list of the Mojaloop project contributors for this file.
 Names of the original copyright holders (individuals or organizations)
 should be listed with a '*' in the first column. People who have
 contributed from an organization can be listed under the organization
 that actually holds the copyright for their contributions (see the
 Mojaloop Foundation for an example). Those individuals should have
 their names indented and be marked with a '-'. Email address can be added
 optionally within square brackets <email>.

 * Mojaloop Foundation
 - Name Surname <name.surname@mojaloop.io>

 * Georgi Georgiev <georgi.georgiev@modusbox.com>

 --------------
 ******/
'use strict'

const src = '../../../src'
const rewire = require('rewire')
const Sinon = require('sinon')
const Test = require('tapes')(require('tape'))
const Consumer = require(`${src}`).Util.Consumer
const KafkaConsumer = require(`${src}`).Kafka.Consumer
const Logger = require('@mojaloop/central-services-logger')
const { stateList } = require('../../../src/constants')

Test('Consumer', ConsumerTest => {
  let sandbox

  ConsumerTest.beforeEach(test => {
    sandbox = Sinon.createSandbox()
    sandbox.stub(KafkaConsumer.prototype, 'constructor').resolves()
    sandbox.stub(KafkaConsumer.prototype, 'connect').resolves()
    sandbox.stub(KafkaConsumer.prototype, 'consume').resolves()
    sandbox.stub(KafkaConsumer.prototype, 'commitMessageSync').resolves()
    sandbox.stub(Logger, 'isErrorEnabled').value(true)
    sandbox.stub(Logger, 'isWarnEnabled').value(true)
    sandbox.stub(Logger, 'isDebugEnabled').value(true)
    sandbox.stub(Logger, 'isSillyEnabled').value(true)
    test.end()
  })

  ConsumerTest.afterEach(test => {
    sandbox.restore()
    test.end()
  })

  ConsumerTest.test('createHandler should', createHandlerTest => {
    createHandlerTest.test('topic is still added if fails to connect', async (test) => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const topicName = 'admin'
      const config = { rdkafkaConf: {} }
      KafkaConsumer.prototype.connect.throws(new Error())

      // Act
      await ConsumerProxy.createHandler(topicName, config)
      const topics = ConsumerProxy.getListOfTopics()

      // Assert
      test.deepEqual(topics, [topicName], 'Topic should still be in list even if consumer failed to connect.')
      test.end()
    })

    createHandlerTest.test('array topic', async (test) => {
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const topicName = ['admin2', 'admin1']
      const config = { rdkafkaConf: {} }
      try {
        await ConsumerProxy.createHandler(topicName, config)
        test.pass('passed')
      } catch (err) {
        test.fail('Error Thrown')
      }
      test.end()
    })

    createHandlerTest.test('should have a timestamp of 0 if couldn\'t connect', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const topicName = ['admin2', 'admin1']
      const config = { rdkafkaConf: {} }
      KafkaConsumer.prototype.connect.throws(new Error())

      // Act
      await ConsumerProxy.createHandler(topicName, config)
      const result = ConsumerProxy.__get__('listOfConsumers')
      const timestamps = Object.keys(result).map(k => result[k].connectedTimeStamp)

      // Assert
      test.deepEqual(timestamps, [0, 0], 'Timestamps should be 0')
      test.end()
    })

    createHandlerTest.test('should contain a timestamp of when it connected', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const topicName = ['admin2', 'admin1']
      const config = { rdkafkaConf: {} }
      // KafkaConsumer.prototype.connect.throws(new Error())

      // Act
      await ConsumerProxy.createHandler(topicName, config)
      const result = ConsumerProxy.__get__('listOfConsumers')
      const timestamps = Object.keys(result).map(k => result[k].connectedTimeStamp)

      // Assert
      timestamps.forEach(ts => test.ok(ts > 0, 'Timestamp should be greater than 0'))
      test.end()
    })

    createHandlerTest.test('should contain a timestamp of when it connected', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const topicName = ['admin2', 'admin1']
      const config = { rdkafkaConf: undefined }
      // KafkaConsumer.prototype.connect.throws(new Error())

      // Act
      await ConsumerProxy.createHandler(topicName, config)
      const result = ConsumerProxy.__get__('listOfConsumers')
      const timestamps = Object.keys(result).map(k => result[k].connectedTimeStamp)

      // Assert
      timestamps.forEach(ts => test.ok(ts > 0, 'Timestamp should be greater than 0'))
      test.end()
    })

    createHandlerTest.end()
  })

  ConsumerTest.test('getListOfTopics should', getListOfTopicsTest => {
    getListOfTopicsTest.test('return an empty array when there are no topics', test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', { })
      const expected = []

      // Act
      const result = ConsumerProxy.getListOfTopics()

      // Assert
      test.deepEqual(result, expected, 'Should return an empty array')
      test.end()
    })

    getListOfTopicsTest.test('return a list of topics', test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', { admin1: {}, admin2: {} })
      const expected = ['admin1', 'admin2']

      // Act
      const result = ConsumerProxy.getListOfTopics()

      // Assert
      test.deepEqual(result, expected, 'Should return an empty array')
      test.end()
    })

    getListOfTopicsTest.end()
  })

  ConsumerTest.test('getConsumer should', getConsumerTest => {
    const topicName = 'admin'
    const expected = 'consumer'

    getConsumerTest.test('return list of consumers', async (test) => {
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {
        admin: {
          consumer: expected
        }
      })
      try {
        const result = await ConsumerProxy.getConsumer(topicName)
        test.equal(result, expected)
      } catch (err) {
        test.fail()
      }
      test.end()
    })

    getConsumerTest.test('throw error', async (test) => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)

      // Act
      try {
        await ConsumerProxy.getConsumer(topicName)
        test.fail('Error not thrown!')
      } catch (err) {
        // Assert
        test.pass()
      }
      test.end()
    })

    getConsumerTest.end()
  })

  ConsumerTest.test('isConsumerAutoCommitEnabled should', isConsumerAutoCommitEnabledTest => {
    const topicName = 'admin'

    isConsumerAutoCommitEnabledTest.test('return consumer auto commit status', async (test) => {
      const topicName = 'admin'
      const autoCommitEnabled = false
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', { admin: { autoCommitEnabled } })
      try {
        const result = await ConsumerProxy.isConsumerAutoCommitEnabled(topicName)
        test.equal(result, false, 'auto commit is disabled')
      } catch (err) {
        test.fail()
      }
      test.end()
    })

    isConsumerAutoCommitEnabledTest.test('throw error', async (test) => {
      try {
        await Consumer.isConsumerAutoCommitEnabled(topicName)
        test.fail('Error not thrown!')
      } catch (err) {
        test.pass()
      }
      test.end()
    })

    isConsumerAutoCommitEnabledTest.end()
  })

  ConsumerTest.test('isConnected should', isConnectedTest => {
    isConnectedTest.test('Should return true if consumer.isConnected passes', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {
        admin: {
          consumer: {
            isConnected: () => true
          }
        }
      })
      // Act
      try {
        const response = await ConsumerProxy.isConnected('admin')
        test.equal(response, true, 'Response should be boolean true')
      } catch (err) {
        // Assert
        test.fail('Error not thrown!')
      }
      test.end()
    })

    isConnectedTest.test('reject with an error if consumer.isConnected passes, but topicName not supplied', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {
        admin: {
          consumer: {
            isConnected: () => true
          }
        }
      })
      // Act
      try {
        await ConsumerProxy.isConnected()
        test.fail('Error not thrown!')
      } catch (err) {
        // Assert
        test.equal(err.message, 'topicName is undefined.', 'Error message does not match')
      }
      test.end()
    })

    isConnectedTest.test('reject with an error if consumer.isConnected fails', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {
        admin: {
          consumer: {
            // Callback with error
            isConnected: () => {
              throw new Error('test err message.')
            }
          }
        }
      })

      // Act
      try {
        await ConsumerProxy.isConnected('admin')
        test.fail('Error not thrown!')
      } catch (err) {
        // Assert
        test.equal(err.message, 'test err message.', 'Error message does not match')
        test.pass()
      }
      test.end()
    })

    isConnectedTest.test('reject with an error if consumer does not exist', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {
        someOtherTopic: {
          consumer: {
            isConnected: () => true
          }
        }
      })

      // Act
      try {
        await ConsumerProxy.isConnected('admin')
        test.fail('Error not thrown!')
      } catch (err) {
        // Assert
        test.equal(err.message, 'No consumer found for topic admin', 'Error message does not match')
        test.pass()
      }
      test.end()
    })

    isConnectedTest.end()
  })

  ConsumerTest.test('getMetadataPromise should', getMetadataPromiseTest => {
    getMetadataPromiseTest.test('resolve with metadata when no error', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const fakeConsumer = {
        getMetadata: (opts, cb) => cb(null, { topics: [{ name: 'admin' }] })
      }
      // Act
      try {
        const metadata = await ConsumerProxy.getMetadataPromise(fakeConsumer, 'admin')
        test.deepEqual(metadata, { topics: [{ name: 'admin' }] }, 'Should resolve with metadata')
      } catch (err) {
        test.fail('Should not throw')
      }
      test.end()
    })

    getMetadataPromiseTest.test('reject with error when getMetadata returns error', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const fakeConsumer = {
        getMetadata: (opts, cb) => cb(new Error('fail'), null)
      }
      // Act
      try {
        await ConsumerProxy.getMetadataPromise(fakeConsumer, 'admin')
        test.fail('Should throw')
      } catch (err) {
        test.ok(err.message.includes('Error connecting to consumer: fail'), 'Should reject with error')
      }
      test.end()
    })

    getMetadataPromiseTest.end()
  })

  ConsumerTest.test('allConnected should', allConnectedTest => {
    allConnectedTest.test('return OK if topic found in metadata', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const fakeConsumer = {
        getMetadata: (opts, cb) => cb(null, { topics: [{ name: 'admin' }] })
      }
      ConsumerProxy.__set__('listOfConsumers', {
        admin: { consumer: fakeConsumer }
      })
      // Act
      try {
        const result = await ConsumerProxy.allConnected('admin')
        test.equal(result, stateList.OK, 'Should return OK')
      } catch (err) {
        test.fail('Should not throw')
      }
      test.end()
    })

    allConnectedTest.test('throw error if topic not found in metadata', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      const fakeConsumer = {
        getMetadata: (opts, cb) => cb(null, { topics: [{ name: 'otherTopic' }] })
      }
      ConsumerProxy.__set__('listOfConsumers', {
        admin: { consumer: fakeConsumer }
      })
      // Act
      try {
        await ConsumerProxy.allConnected('admin')
        test.fail('Should throw')
      } catch (err) {
        test.ok(err.message.includes('Connected to consumer, but admin not found.'), 'Should throw correct error')
      }
      test.end()
    })

    allConnectedTest.test('throw error if getConsumer throws', async test => {
      // Arrange
      const ConsumerProxy = rewire(`${src}/util/consumer`)
      ConsumerProxy.__set__('listOfConsumers', {})
      // Act
      try {
        await ConsumerProxy.allConnected('admin')
        test.fail('Should throw')
      } catch (err) {
        test.ok(err.message.includes('No consumer found for topic admin'), 'Should throw correct error')
      }
      test.end()
    })

    allConnectedTest.end()
  })

  ConsumerTest.end()
})