feat: Add support for replicateSubscriptionState in Pulsar pubsub component (#3853)

Signed-off-by: Prashanth Nagaraj <[email protected]>
Co-authored-by: Cassie Coyle <[email protected]>
Co-authored-by: Yaron Schneider <[email protected]>
Co-authored-by: Dapr Bot <[email protected]>

Author: 4 people

pubsub/pulsar/metadata.go

@@ -39,6 +39,7 @@ type pulsarMetadata struct {
 	ReceiverQueueSize                int                       `mapstructure:"receiverQueueSize"`
 	SubscriptionType                 string                    `mapstructure:"subscribeType"`
 	SubscriptionInitialPosition      string                    `mapstructure:"subscribeInitialPosition"`
+	ReplicateSubscriptionState       bool                      `mapstructure:"replicateSubscriptionState"`
 	SubscriptionMode                 string                    `mapstructure:"subscribeMode"`
 	Token                            string                    `mapstructure:"token"`
 	oauth2.ClientCredentialsMetadata `mapstructure:",squash"`

pubsub/pulsar/metadata.yaml

@@ -202,6 +202,17 @@ metadata:
     url: 
       title: "Pulsar SubscriptionInitialPosition"
       url: "https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#SubscriptionInitialPosition"
+  - name: replicateSubscriptionState
+    type: bool
+    description: |
+      Enable replication of subscription state across geo-replicated Pulsar clusters.
+      When enabled, subscription state (such as cursor positions and acknowledgments) will be replicated to other clusters in a geo-replicated setup.
+      This is useful for maintaining subscription consistency during cluster failovers.
+    default: 'false'
+    example: '"true", "false"'
+    url:
+      title: "Pulsar Geo-Replication"
+      url: "https://pulsar.apache.org/docs/administration-geo/"
   - name: subscribeMode
     type: string
     description: |
@@ -210,4 +221,4 @@ metadata:
     example: '"durable"'
     url: 
       title: "Pulsar SubscriptionMode"
-      url: "https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#SubscriptionMode"
+      url: "https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#SubscriptionMode"

pubsub/pulsar/pulsar.go

@@ -509,6 +509,7 @@ func (p *Pulsar) Subscribe(ctx context.Context, req pubsub.SubscribeRequest, han
 		MessageChannel:              channel,
 		NackRedeliveryDelay:         p.metadata.RedeliveryDelay,
 		ReceiverQueueSize:           p.metadata.ReceiverQueueSize,
+		ReplicateSubscriptionState:  p.metadata.ReplicateSubscriptionState,
 	}
 
 	// Handle KeySharedPolicy for key_shared subscription type

pubsub/pulsar/pulsar_test.go

@@ -605,6 +605,48 @@ func TestEncryptionKeys(t *testing.T) {
 	})
 }
 
+func TestParsePulsarMetadataReplicateSubscriptionState(t *testing.T) {
+	tt := []struct {
+		name                       string
+		replicateSubscriptionState string
+		expected                   bool
+	}{
+		{
+			name:                       "test replicateSubscriptionState true",
+			replicateSubscriptionState: "true",
+			expected:                   true,
+		},
+		{
+			name:                       "test replicateSubscriptionState false",
+			replicateSubscriptionState: "false",
+			expected:                   false,
+		},
+		{
+			name:                       "test replicateSubscriptionState empty (defaults to false)",
+			replicateSubscriptionState: "",
+			expected:                   false,
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.name, func(t *testing.T) {
+			m := pubsub.Metadata{}
+			m.Properties = map[string]string{
+				"host": "a",
+			}
+
+			if tc.replicateSubscriptionState != "" {
+				m.Properties["replicateSubscriptionState"] = tc.replicateSubscriptionState
+			}
+
+			meta, err := parsePulsarMetadata(m)
+
+			require.NoError(t, err)
+			assert.Equal(t, tc.expected, meta.ReplicateSubscriptionState)
+		})
+	}
+}
+
 func TestSanitiseURL(t *testing.T) {
 	tests := []struct {
 		name     string