gerrit.onap Code Review - ccsdk/cds.git/blob

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *  Modifications Copyright © 2018-2021 AT&T, Bell Canada Intellectual Property.
   4  *
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  */
  17
  18 package org.onap.ccsdk.cds.blueprintsprocessor.message.service
  19
  20 import com.fasterxml.jackson.databind.node.ObjectNode
  21 import org.apache.commons.lang.builder.ToStringBuilder
  22 import org.apache.kafka.clients.producer.Callback
  23 import org.apache.kafka.clients.producer.KafkaProducer
  24 import org.apache.kafka.clients.producer.ProducerRecord
  25 import org.apache.kafka.common.header.internals.RecordHeader
  26 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceInput
  27 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.ExecutionServiceOutput
  28 import org.onap.ccsdk.cds.blueprintsprocessor.core.api.data.Status
  29 import org.onap.ccsdk.cds.blueprintsprocessor.message.MessageProducerProperties
  30 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonPrimitive
  31 import org.onap.ccsdk.cds.controllerblueprints.core.asJsonString
  32 import org.slf4j.LoggerFactory
  33 import java.nio.charset.Charset
  34
  35 class KafkaMessageProducerService(
  36     private val messageProducerProperties: MessageProducerProperties
  37 ) :
  38     BlueprintMessageProducerService {
  39
  40     private val log = LoggerFactory.getLogger(KafkaMessageProducerService::class.java)!!
  41
  42     private var kafkaProducer: KafkaProducer<String, ByteArray>? = null
  43
  44     private val messageLoggerService = MessageLoggerService()
  45
  46     companion object {
  47
  48         const val MAX_ERR_MSG_LEN = 128
  49     }
  50
  51     override suspend fun sendMessageNB(key: String, message: Any, headers: MutableMap<String, String>?): Boolean {
  52         checkNotNull(messageProducerProperties.topic) { "default topic is not configured" }
  53         return sendMessageNB(key, messageProducerProperties.topic!!, message, headers)
  54     }
  55
  56     override suspend fun sendMessageNB(
  57         key: String,
  58         topic: String,
  59         message: Any,
  60         headers: MutableMap<String, String>?
  61     ): Boolean {
  62         var clonedMessage = message
  63         if (clonedMessage is ExecutionServiceOutput) {
  64             clonedMessage = truncateResponse(clonedMessage)
  65         }
  66
  67         val byteArrayMessage = when (clonedMessage) {
  68             is String -> clonedMessage.toByteArray(Charset.defaultCharset())
  69             else -> clonedMessage.asJsonString().toByteArray(Charset.defaultCharset())
  70         }
  71
  72         val record = ProducerRecord<String, ByteArray>(topic, key, byteArrayMessage)
  73         val recordHeaders = record.headers()
  74         messageLoggerService.messageProducing(recordHeaders)
  75         headers?.let {
  76             headers.forEach { (key, value) -> recordHeaders.add(RecordHeader(key, value.toByteArray())) }
  77         }
  78         val callback = Callback { metadata, exception ->
  79             if (exception != null)
  80                 log.error("Couldn't publish ${clonedMessage::class.simpleName} ${getMessageLogData(clonedMessage)}.", exception)
  81             else {
  82                 val message = "${clonedMessage::class.simpleName} published : topic(${metadata.topic()}) " +
  83                     "partition(${metadata.partition()}) " +
  84                     "offset(${metadata.offset()}) ${getMessageLogData(clonedMessage)}."
  85                 log.info(message)
  86             }
  87         }
  88         messageTemplate().send(record, callback)
  89         return true
  90     }
  91
  92     fun messageTemplate(additionalConfig: Map<String, ByteArray>? = null): KafkaProducer<String, ByteArray> {
  93         log.trace("Producer client properties : ${ToStringBuilder.reflectionToString(messageProducerProperties)}")
  94         val configProps = messageProducerProperties.getConfig()
  95
  96         /** Add additional Properties */
  97         if (additionalConfig != null)
  98             configProps.putAll(additionalConfig)
  99
 100         if (kafkaProducer == null)
 101             kafkaProducer = KafkaProducer(configProps)
 102
 103         return kafkaProducer!!
 104     }
 105
 106     /**
 107      * Truncation of BP responses
 108      */
 109     private fun truncateResponse(executionServiceOutput: ExecutionServiceOutput): ExecutionServiceOutput {
 110         /** Truncation of error messages */
 111         var truncErrMsg = executionServiceOutput.status.errorMessage
 112         if (truncErrMsg != null && truncErrMsg.length > MAX_ERR_MSG_LEN) {
 113             truncErrMsg = truncErrMsg.substring(0, MAX_ERR_MSG_LEN) +
 114                 " [...]. Check Blueprint Processor logs for more information."
 115         }
 116         /** Truncation for Command Executor responses */
 117         var truncPayload = executionServiceOutput.payload.deepCopy()
 118         val workflowName = executionServiceOutput.actionIdentifiers.actionName
 119         if (truncPayload.path("$workflowName-response").has("execute-command-logs")) {
 120             var cmdExecLogNode = truncPayload.path("$workflowName-response") as ObjectNode
 121             cmdExecLogNode.replace("execute-command-logs", "Check Command Executor logs for more information.".asJsonPrimitive())
 122         }
 123         return ExecutionServiceOutput().apply {
 124             correlationUUID = executionServiceOutput.correlationUUID
 125             commonHeader = executionServiceOutput.commonHeader
 126             actionIdentifiers = executionServiceOutput.actionIdentifiers
 127             status = Status().apply {
 128                 code = executionServiceOutput.status.code
 129                 eventType = executionServiceOutput.status.eventType
 130                 timestamp = executionServiceOutput.status.timestamp
 131                 errorMessage = truncErrMsg
 132                 message = executionServiceOutput.status.message
 133             }
 134             payload = truncPayload
 135             stepData = executionServiceOutput.stepData
 136         }
 137     }
 138
 139     private fun getMessageLogData(message: Any): String {
 140         return when (message) {
 141             is ExecutionServiceInput -> {
 142                 val actionIdentifiers = message.actionIdentifiers
 143                 "CBA(${actionIdentifiers.blueprintName}/${actionIdentifiers.blueprintVersion}/${actionIdentifiers.actionName})"
 144             }
 145             is ExecutionServiceOutput -> {
 146                 val actionIdentifiers = message.actionIdentifiers
 147                 "CBA(${actionIdentifiers.blueprintName}/${actionIdentifiers.blueprintVersion}/${actionIdentifiers.actionName})"
 148             }
 149             else -> "message($message)"
 150         }
 151     }
 152 }