Exclude goog_ prefixed attributes from outbound Pub/Sub messages (b…

…ackport) (#919)
GoogleCloudPlatform · Jan 28, 2022 · 3b52203 · 3b52203
1 parent 40f720c
commit 3b52203
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/...p-pubsub/src/main/java/com/google/cloud/spring/pubsub/integration/PubSubHeaderMapper.java b/...p-pubsub/src/main/java/com/google/cloud/spring/pubsub/integration/PubSubHeaderMapper.java
@@ -46,6 +46,7 @@ public class PubSubHeaderMapper implements HeaderMapper<Map<String, String>> {
     "!" + MessageHeaders.ID,
     "!" + MessageHeaders.TIMESTAMP,
     "!" + GcpPubSubHeaders.ORIGINAL_MESSAGE,
+    "!" + GcpPubSubHeaders.CLIENT,
     "!" + NativeMessageHeaderAccessor.NATIVE_HEADERS,
     "!" + MessageHistory.HEADER_NAME,
     "*"

diff --git a/...oud-gcp-pubsub/src/main/java/com/google/cloud/spring/pubsub/support/GcpPubSubHeaders.java b/...oud-gcp-pubsub/src/main/java/com/google/cloud/spring/pubsub/support/GcpPubSubHeaders.java
@@ -28,6 +28,9 @@ private GcpPubSubHeaders() {}
 
   private static final String PREFIX = "gcp_pubsub_";
 
+  /** The client header text. */
+  public static final String CLIENT = "googclient_*";
+
   /** The topic header text. */
   public static final String TOPIC = PREFIX + "topic";
 

diff --git a/...sub/src/test/java/com/google/cloud/spring/pubsub/integration/PubSubHeaderMapperTests.java b/...sub/src/test/java/com/google/cloud/spring/pubsub/integration/PubSubHeaderMapperTests.java
@@ -35,6 +35,24 @@ public class PubSubHeaderMapperTests {
   /** used to check for exception messages and types. */
   @Rule public ExpectedException expectedException = ExpectedException.none();
 
+  @Test
+  public void testFilterGoogleClientHeaders() {
+    PubSubHeaderMapper mapper = new PubSubHeaderMapper();
+    Map<String, Object> originalHeaders = new HashMap<>();
+    originalHeaders.put("my header", "pantagruel's nativity");
+    MessageHeaders internalHeaders = new MessageHeaders(originalHeaders);
+
+    originalHeaders.put("googclient_deliveryattempt", "header attached when DLQ is enabled");
+    originalHeaders.put("googclient_anyHeader", "any other possible headers");
+
+    Map<String, String> filteredHeaders = new HashMap<>();
+    mapper.fromHeaders(internalHeaders, filteredHeaders);
+    assertThat(filteredHeaders)
+        .hasSize(1)
+        .containsEntry("my header", "pantagruel's nativity");
+  }
+
+
   @Test
   public void testFilterHeaders() {
     PubSubHeaderMapper mapper = new PubSubHeaderMapper();