Skip to content

Fix: Enhance JMS Header Handling for Null Values with proper Kafka Header Mapping #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 27, 2025
Merged

Fix: Enhance JMS Header Handling for Null Values with proper Kafka Header Mapping #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f87fa1c
This fix is to handle , When JMS header key comes as empty from MQ pr…
balajisekarraman Feb 12, 2025
6a2066c
fix: review comments from #144 as well as add more tests
Joel-hanson Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/integration/java/com/ibm/eventstreams/connect/mqsource/MQSourceTaskIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1299,4 +1299,53 @@ public void verifyLoggingErrorsWithMessageHavingDefaultRecordBuilder() throws Ex
assertThat(processedRecords.get(0).topic()).isEqualTo("__dlq.mq.source");
assertThat(processedRecords.get(1).topic()).isEqualTo("mytopic");
}

@Test
public void verifyJmsMessageWithNullHeaders() throws Exception {
connectTask = getSourceTaskWithEmptyKafkaOffset();

final Map<String, String> connectorConfigProps = createDefaultConnectorProperties();
connectorConfigProps.put("mq.message.body.jms", "true");
connectorConfigProps.put("mq.record.builder", "com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder");
connectorConfigProps.put("mq.jms.properties.copy.to.kafka.headers", "true");

connectTask.start(connectorConfigProps);

final TextMessage message = getJmsContext().createTextMessage("hello");
message.setStringProperty("teststring", "myvalue");
message.setObjectProperty("testObject", null);

putAllMessagesToQueue(DEFAULT_SOURCE_QUEUE, Arrays.asList(message));

final List<SourceRecord> kafkaMessages = connectTask.poll();
assertEquals(1, kafkaMessages.size());

final SourceRecord kafkaMessage = kafkaMessages.get(0);

assertThat(kafkaMessage.value()).isEqualTo("hello");
assertThat(kafkaMessage.headers().lastWithName("teststring").value()).isEqualTo("myvalue");
assertThat(kafkaMessage.headers().lastWithName("testObject").value()).isNull();
}

@Test
public void verifyJmsMessageNoHeaderCopied_WhenCopyDisabledHavingNullHeader() throws Exception {
connectTask = getSourceTaskWithEmptyKafkaOffset();

final Map<String, String> connectorConfigProps = createDefaultConnectorProperties();
connectorConfigProps.put("mq.message.body.jms", "true");
connectorConfigProps.put("mq.record.builder", "com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder");
connectorConfigProps.put("mq.jms.properties.copy.to.kafka.headers", "false");

connectTask.start(connectorConfigProps);

final TextMessage message = getJmsContext().createTextMessage("hello");
message.setStringProperty("teststring", "myvalue");
message.setObjectProperty("testObject", null);
putAllMessagesToQueue(DEFAULT_SOURCE_QUEUE, Arrays.asList(message));

final SourceRecord kafkaMessage = connectTask.poll().get(0);

assertThat(kafkaMessage.value()).isEqualTo("hello");
assertThat(kafkaMessage.headers()).isEmpty();
}
}
6 changes: 5 additions & 1 deletion src/main/java/com/ibm/eventstreams/connect/mqsource/processor/JmsToKafkaHeaderConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Objects;

/**
* Single responsibility class to copy JMS properties to Kafka headers.
Expand All @@ -48,7 +49,10 @@ public ConnectHeaders convertJmsPropertiesToKafkaHeaders(final Message message)

jmsPropertyKeys.forEach(key -> {
try {
connectHeaders.addString(key.toString(), message.getObjectProperty(key.toString()).toString());
final Object prop = message.getObjectProperty(key.toString());
// this will yield `null` if prop is null, otherwise its toString()
final String headerValue = Objects.toString(prop, null);
connectHeaders.addString(key.toString(), headerValue);
} catch (final JMSException e) {
// Not failing the message processing if JMS properties cannot be read for some
// reason.
Expand Down
7 changes: 3 additions & 4 deletions src/test/java/com/ibm/eventstreams/connect/mqsource/JmsToKafkaHeaderConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,22 @@ public class JmsToKafkaHeaderConverterTest {
@Test
public void convertJmsPropertiesToKafkaHeaders() throws JMSException {

final List<String> keys = Arrays.asList("facilityCountryCode", "facilityNum");
final List<String> keys = Arrays.asList("facilityCountryCode", "facilityNum", "nullProperty");

final Enumeration<String> keyEnumeration = Collections.enumeration(keys);

// Arrange
when(message.getPropertyNames()).thenReturn(keyEnumeration);
when(message.getObjectProperty("facilityCountryCode")).thenReturn("US");
when(message.getObjectProperty("facilityNum")).thenReturn("12345");
when(message.getObjectProperty("nullProperty")).thenReturn(null);

// Act
final ConnectHeaders actualConnectHeaders = jmsToKafkaHeaderConverter
.convertJmsPropertiesToKafkaHeaders(message);


//Verify
assertEquals("Both custom JMS properties were copied to kafka successfully.", 2, actualConnectHeaders.size());


assertEquals("All three custom JMS properties were copied to kafka successfully.", 3, actualConnectHeaders.size());
}
}