@mojaloop/central-services-shared 18.0.0 → 18.1.0-snapshot.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.0.0",
+  "version": "18.1.0-snapshot.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",

package/src/util/kafka/index.js

@@ -182,12 +182,13 @@ const createParticipantTopicConf = (template, participantName, functionality, ac
  * @param {string} key - optional key that allows partitioning it occur
  * @param {number} partition - optional partition to produce to
  * @param {*} opaqueKey - optional opaque token, which gets passed along to your delivery reports
+ * @param {string} topicNameOverride - optional topic name override that skips topic name rendering
  *
  * @returns {object} - Returns newly created general topicConfig
  */
-const createGeneralTopicConf = (template, functionality, action, key = null, partition = null, opaqueKey = null) => {
+const createGeneralTopicConf = (template, functionality, action, key = null, partition = null, opaqueKey = null, topicNameOverride = null) => {
   return {
-    topicName: transformGeneralTopicName(template, functionality, action),
+    topicName: topicNameOverride || transformGeneralTopicName(template, functionality, action),
     key,
     partition,
     opaqueKey
@@ -223,13 +224,14 @@ const getFunctionalityAction = (functionality, action) => {
  * @param {object} state - state of the message being produced
  * @param {string} key - optional key that allows partitioning it occur
  * @param {object} span - the span for event logging
+ * @param {string} topicNameOverride - optional topic name override that skips topic name rendering
  *
  * @returns {object} - Returns a boolean: true if successful, or throws and error if failed
  */
-const produceGeneralMessage = async (defaultKafkaConfig, kafkaProducer, functionality, action, message, state, key = null, span = null) => {
+const produceGeneralMessage = async (defaultKafkaConfig, kafkaProducer, functionality, action, message, state, key = null, span = null, topicNameOverride = null) => {
   const { functionalityMapped, actionMapped } = getFunctionalityAction(functionality, action)
   let messageProtocol = StreamingProtocol.updateMessageProtocolMetadata(message, functionality, action, state)
-  const topicConfig = createGeneralTopicConf(defaultKafkaConfig.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, functionalityMapped, actionMapped, key)
+  const topicConfig = createGeneralTopicConf(defaultKafkaConfig.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, functionalityMapped, actionMapped, key, null, null, topicNameOverride)
   const kafkaConfig = getKafkaConfig(defaultKafkaConfig, Enum.Kafka.Config.PRODUCER, functionalityMapped.toUpperCase(), actionMapped.toUpperCase())
   if (span) {
     messageProtocol = await span.injectContextToMessage(messageProtocol)
@@ -285,7 +287,7 @@ const commitMessageSync = async (kafkaConsumer, kafkaTopic, message) => {
 
 const proceed = async (defaultKafkaConfig, params, opts) => {
   const { message, kafkaTopic, consumer, decodedPayload, span, producer } = params
-  const { consumerCommit, fspiopError, eventDetail, fromSwitch, toDestination, messageKey } = opts
+  const { consumerCommit, fspiopError, eventDetail, fromSwitch, toDestination, messageKey, topicNameOverride } = opts
   let metadataState
 
   if (consumerCommit) {
@@ -310,7 +312,7 @@ const proceed = async (defaultKafkaConfig, params, opts) => {
     if (message.value.content.headers) message.value.content.headers[Enum.Http.Headers.FSPIOP.DESTINATION] = toDestination
   }
   if (eventDetail && producer) {
-    await produceGeneralMessage(defaultKafkaConfig, producer, eventDetail.functionality, eventDetail.action, message.value, metadataState, messageKey, span)
+    await produceGeneralMessage(defaultKafkaConfig, producer, eventDetail.functionality, eventDetail.action, message.value, metadataState, messageKey, span, topicNameOverride)
   }
   return true
 }

package/test/unit/util/kafka/index.test.js

@@ -234,6 +234,27 @@ Test('Utility Test', utilityTest => {
       }
     })
 
+    createGeneralTopicConfTest.test('return topic name override when specfied', test => {
+      const ModuleProxy = Proxyquire('../../../../src/util/kafka', {
+        '../../enums': {
+          topicMap: {
+            transfer: {
+              fulfil: {
+                functionality: 'transfer',
+                action: 'fulfil'
+              }
+            }
+          }
+        }
+      })
+      const response = ModuleProxy.createGeneralTopicConf(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, TRANSFER, FULFIL, 0, null, null, 'topic-name-override')
+      test.equal(response.topicName, 'topic-name-override')
+      test.equal(response.key, 0)
+      test.equal(response.partition, null)
+      test.equal(response.opaqueKey, null)
+      test.end()
+    })
+
     createGeneralTopicConfTest.end()
   })
 
@@ -294,6 +315,25 @@ Test('Utility Test', utilityTest => {
       test.end()
     })
 
+    produceGeneralMessageTest.test('produce a message with topic name override when specified', async (test) => {
+      const ModuleProxy = Proxyquire('../../../../src/util/kafka', {
+        '../../enums': {
+          topicMap: {
+            transfer: {
+              prepare: {
+                functionality: 'transfer',
+                action: 'prepare'
+              }
+            }
+          }
+        }
+      })
+      const result = await ModuleProxy.produceGeneralMessage(Config.KAFKA_CONFIG, KafkaProducer, TRANSFER, PREPARE, messageProtocol, Enum.Events.EventStatus.SUCCESS, null, null, 'topic-name-override')
+      test.equal(KafkaProducer.produceMessage.getCall(0).args[1].topicName, 'topic-name-override')
+      test.equal(result, true)
+      test.end()
+    })
+
     produceGeneralMessageTest.test('produce a notification message using topicMap', async (test) => {
       const ModuleProxy = Proxyquire('../../../../src/util/kafka', {
         '../../enums': {
@@ -529,6 +569,20 @@ Test('Utility Test', utilityTest => {
       test.end()
     })
 
+    proceedTest.test('produce message when topicNameOverride specified', async test => {
+      const opts = { consumerCommit: true, eventDetail, messageKey: '101', topicNameOverride: 'topic-name-override' }
+      try {
+        const result = await UtilityProxy.proceed(Config.KAFKA_CONFIG, params, opts)
+        test.ok(commitMessageSyncStub.calledOnce, 'commitMessageSyncStub not called')
+        test.ok(produceGeneralMessageStub.withArgs(Config.KAFKA_CONFIG, producer, eventDetail.functionality, eventDetail.action, message.value, successState, '101', undefined, 'topic-name-override').calledOnce, 'produceGeneralMessageStub not called')
+        test.equal(result, true, 'result returned')
+      } catch (err) {
+        test.fail(err.message)
+      }
+
+      test.end()
+    })
+
     proceedTest.test('produce fromSwitch and do not stop timer', async test => {
       const opts = { fromSwitch: true, eventDetail }
       try {