Allow pulsar metadata headers to be mapped outbound (#1038)

This allows pulsar metadata headers, which are excluded on the
outbound messages by default, to be included in the outbound
message headers.

Resolves #1037

spring-pulsar-docs/src/main/antora/modules/ROOT/pages/reference/pulsar-header.adoc

@@ -63,9 +63,9 @@ static class PulsarHeadersCustomObjectMapperTestConfig {
 
 === Inbound/Outbound Patterns
 On the inbound side, by default, all Pulsar headers (message metadata plus user properties) are mapped to `MessageHeaders`.
-On the outbound side, by default, all `MessageHeaders` are mapped, except `id`, `timestamp`, and the headers that represent the Pulsar message metadata.
+On the outbound side, by default, all `MessageHeaders` are mapped, except `id`, `timestamp`, and the headers that represent the Pulsar message metadata (i.e. the headers that are prefixed with `pulsar_message_`).
 You can specify which headers are mapped for inbound and outbound messages by configuring the `inboundPatterns` and `outboundPatterns` on a mapper bean you provide.
-
+You can include Pulsar message metadata headers on the outbound messages by adding the exact header name to the `outboundPatterns` as patterns are not supported for metadata headers.
 Patterns are rather simple and can contain a leading wildcard (`\*`), a trailing wildcard, or both (for example, `*.cat.*`).
 You can negate patterns with a leading `!`.
 The first pattern that matches a header name (whether positive or negative) wins.

spring-pulsar/src/main/java/org/springframework/pulsar/support/header/AbstractPulsarHeaderMapper.java

@@ -55,6 +55,13 @@ public abstract class AbstractPulsarHeaderMapper<ToPulsarHeadersContextType, ToS
 
 	private static final PatternMatch EXCLUDE_PATTERN_TIMESTAMP = PatternMatch.fromPatternString("!timestamp");
 
+	private static final List<String> NEVER_MATCH_OUTBOUND_INTERNAL_HEADERS = List.of(PulsarHeaders.KEY,
+			PulsarHeaders.KEY_BYTES, PulsarHeaders.ORDERING_KEY, PulsarHeaders.INDEX, PulsarHeaders.MESSAGE_ID,
+			PulsarHeaders.BROKER_PUBLISH_TIME, PulsarHeaders.EVENT_TIME, PulsarHeaders.MESSAGE_SIZE,
+			PulsarHeaders.PRODUCER_NAME, PulsarHeaders.RAW_DATA, PulsarHeaders.PUBLISH_TIME,
+			PulsarHeaders.REDELIVERY_COUNT, PulsarHeaders.REPLICATED_FROM, PulsarHeaders.SCHEMA_VERSION,
+			PulsarHeaders.SEQUENCE_ID, PulsarHeaders.TOPIC_NAME);
+
 	protected final LogAccessor logger = new LogAccessor(this.getClass());
 
 	private final List<PulsarHeaderMatcher> inboundMatchers = new ArrayList<>();
@@ -64,10 +71,9 @@ public abstract class AbstractPulsarHeaderMapper<ToPulsarHeadersContextType, ToS
 	/**
 	 * Construct a mapper that will match the supplied inbound and outbound patterns.
 	 * <p>
-	 * <strong>NOTE:</strong> Internal framework headers are <em>never</em> mapped
-	 * outbound. By default, the {@code "id"} and {@code "timestamp"} headers are also
-	 * excluded from outbound mapping but can be included by adding them to
-	 * {@code outboundPatterns}.
+	 * <strong>NOTE:</strong> By default, internal framework headers and the {@code "id"}
+	 * and {@code "timestamp"} headers are <em>not</em> mapped outbound but can be
+	 * included by adding them to {@code outboundPatterns}.
 	 * <p>
 	 * <strong>NOTE:</strong> The patterns are applied in order, stopping on the first
 	 * match (positive or negative). When no pattern is specified, the {@code "*"} pattern
@@ -84,23 +90,7 @@ public abstract class AbstractPulsarHeaderMapper<ToPulsarHeadersContextType, ToS
 		Objects.requireNonNull(outboundPatterns, "outboundPatterns must be specified");
 		inboundPatterns.forEach((p) -> this.inboundMatchers.add(PatternMatch.fromPatternString(p)));
 		// @formatter:off
-		this.outboundMatchers.add(new NeverMatch(
-				PulsarHeaders.KEY,
-				PulsarHeaders.KEY_BYTES,
-				PulsarHeaders.ORDERING_KEY,
-				PulsarHeaders.INDEX,
-				PulsarHeaders.MESSAGE_ID,
-				PulsarHeaders.BROKER_PUBLISH_TIME,
-				PulsarHeaders.EVENT_TIME,
-				PulsarHeaders.MESSAGE_SIZE,
-				PulsarHeaders.PRODUCER_NAME,
-				PulsarHeaders.RAW_DATA,
-				PulsarHeaders.PUBLISH_TIME,
-				PulsarHeaders.REDELIVERY_COUNT,
-				PulsarHeaders.REPLICATED_FROM,
-				PulsarHeaders.SCHEMA_VERSION,
-				PulsarHeaders.SEQUENCE_ID,
-				PulsarHeaders.TOPIC_NAME));
+		this.outboundMatchers.add(getNeverMatch(outboundPatterns));
 		// @formatter:on
 		if (outboundPatterns.isEmpty()) {
 			this.outboundMatchers.add(EXCLUDE_PATTERN_ID);
@@ -114,6 +104,12 @@ public abstract class AbstractPulsarHeaderMapper<ToPulsarHeadersContextType, ToS
 		}
 	}
 
+	private NeverMatch getNeverMatch(List<String> outboundPatterns) {
+		List<String> neverMatches = new ArrayList<>(NEVER_MATCH_OUTBOUND_INTERNAL_HEADERS);
+		neverMatches.removeAll(outboundPatterns);
+		return new NeverMatch(neverMatches.toArray(new String[0]));
+	}
+
 	@Override
 	public Map<String, String> toPulsarHeaders(MessageHeaders springHeaders) {
 		Objects.requireNonNull(springHeaders, "springHeaders must not be null");

spring-pulsar/src/test/java/org/springframework/pulsar/support/header/AbstractPulsarHeaderMapperTests.java

@@ -28,6 +28,7 @@ import static org.springframework.pulsar.support.header.PulsarHeaderMapperTestUt
 
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Objects;
 
 import org.apache.pulsar.client.api.Message;
@@ -206,6 +207,19 @@ abstract class AbstractPulsarHeaderMapperTests {
 			verify(spyTestMapper, times(springHeaders.size())).matchesForOutbound(anyString());
 		}
 
+		@Test
+		void neverMatchFiltersCanBeConfigured() {
+			var mapper = mapperWithOutboundPatterns(PulsarHeaders.KEY, PulsarHeaders.MESSAGE_ID,
+					PulsarHeaders.PRODUCER_NAME, "noSuchInternalHeader");
+			var springHeaders = new HashMap<String, Object>();
+			springHeaders.put(PulsarHeaders.KEY, "testKey");
+			springHeaders.put(PulsarHeaders.KEY_BYTES, "testKeyBytes");
+			springHeaders.put(PulsarHeaders.MESSAGE_ID, "testMsg");
+			springHeaders.put(PulsarHeaders.PRODUCER_NAME, "testProducer");
+			assertThat(mapper.toPulsarHeaders(new MessageHeaders(springHeaders))).containsOnlyKeys(PulsarHeaders.KEY,
+					PulsarHeaders.MESSAGE_ID, PulsarHeaders.PRODUCER_NAME);
+		}
+
 	}
 
 	@Nested
@@ -249,7 +263,7 @@ abstract class AbstractPulsarHeaderMapperTests {
 		private String toPulsarHeadersContext;
 
 		TestPulsarHeaderMapper(String toSpringHeadersContext, String toPulsarHeadersContext) {
-			super(Collections.emptyList(), Collections.emptyList());
+			super(List.of(), List.of());
 			this.toSpringHeadersContext = toSpringHeadersContext;
 			this.toPulsarHeadersContext = toPulsarHeadersContext;
 		}

spring-pulsar/src/test/java/org/springframework/pulsar/support/header/ToStringPulsarHeaderMapperTests.java

@@ -19,7 +19,6 @@ package org.springframework.pulsar.support.header;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.pulsar.support.header.PulsarHeaderMapperTestUtil.mockPulsarMessage;
 
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -43,12 +42,12 @@ class ToStringPulsarHeaderMapperTests extends AbstractPulsarHeaderMapperTests {
 
 	@Override
 	AbstractPulsarHeaderMapper<?, ?> mapperWithInboundPatterns(String... patterns) {
-		return new ToStringPulsarHeaderMapper(List.of(patterns), Collections.emptyList());
+		return new ToStringPulsarHeaderMapper(List.of(patterns), List.of());
 	}
 
 	@Override
 	AbstractPulsarHeaderMapper<?, ?> mapperWithOutboundPatterns(String... patterns) {
-		return new ToStringPulsarHeaderMapper(Collections.emptyList(), List.of(patterns));
+		return new ToStringPulsarHeaderMapper(List.of(), List.of(patterns));
 	}
 
 	@Test