openstack/monasca-common
Code Issues Proposed changes

Avoid value decoding in Kafka delivery report

Browse Source 
In Python 2 Kafka message value gets implicitly converted to unicode in
delivery_report function. In case the message value already contains
unicode characters the convertion fails with UnicodeDecodeError.

This case can be reproduced when trying to run:

  u'goose: {}'.format('gęś')

This commit fixes the debug message and avoids implicit type convertion.

Change-Id: Ia9463cd4e9f92cdf18b092abd2cf676aa4966679
Story: 2006503
Task: 36481
This commit is contained in:
Witek Bedyk 2019-09-06 12:44:30 +02:00
parent dd4b19ad46
commit 66754b1a4a
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
monasca_common/confluent_kafka/producer.py
View File

@ -48,10 +48,10 @@ class KafkaProducer(object):
"""
if err is not None:
log.exception(u'Message delivery failed: {}'.format(err))
log.exception('Message delivery failed: {}'.format(err))
raise confluent_kafka.KafkaException(err)
else:
log.debug(u'Message delivered to {} [{}]: {}'.format(
log.debug('Message delivered to {} [{}]: {}'.format(
msg.topic(), msg.partition(), msg.value()))
def publish(self, topic, messages, key=None, timeout=2):

12
monasca_common/tests/test_confluent_kafka.py
View File

@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
@ -94,6 +95,17 @@ class TestConfluentKafkaProducer(base.BaseTestCase):
self.prod.delivery_report(None, confluent_kafka.Message)
mock_logger.debug.assert_called_once()
@mock.patch('monasca_common.confluent_kafka.producer.log')
@mock.patch('confluent_kafka.Message')
def test_delivery_report_with_unicode(self, mock_message, mock_logger):
mock_message.topic.return_value = 'test_topic'
mock_message.partition.return_value = '1'
mock_message.value.return_value = 'gęś'
self.prod.delivery_report(None, mock_message)
mock_logger.debug.assert_called_once_with('Message delivered to '
'test_topic [1]: '
'gęś')
class TestConfluentKafkaConsumer(base.BaseTestCase):