pubsub: add getAttributes for gcp pubsub (salesforce#120)

LihaoLiuXs · web-flow · commit 228ab6fda6f7 · 2025-10-31T10:01:21.000-07:00
diff --git a/blob/blob-gcp/src/test/java/com/salesforce/multicloudj/blob/gcp/GcpBlobStoreTest.java b/blob/blob-gcp/src/test/java/com/salesforce/multicloudj/blob/gcp/GcpBlobStoreTest.java
@@ -2077,7 +2077,6 @@ void testDoDownloadDirectory_SkipsFolderMarkers() throws Exception {
     }
 
     @Test
-    @Disabled
     void testDoDownloadDirectory_PathTraversalProtection() throws Exception {
         // Given
         String prefix = "test-prefix/";
diff --git a/pubsub/pubsub-aws/src/java/com/salesforce/multicloudj/pubsub/aws/AwsSubscription.java b/pubsub/pubsub-aws/src/java/com/salesforce/multicloudj/pubsub/aws/AwsSubscription.java
@@ -2,12 +2,12 @@
 
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 
 import com.salesforce.multicloudj.common.aws.AwsConstants;
 import com.salesforce.multicloudj.common.exceptions.SubstrateSdkException;
 import com.salesforce.multicloudj.pubsub.batcher.Batcher;
+import com.salesforce.multicloudj.pubsub.client.GetAttributeResult;
 import com.salesforce.multicloudj.pubsub.driver.AbstractSubscription;
 import com.salesforce.multicloudj.pubsub.driver.AckID;
 import com.salesforce.multicloudj.pubsub.driver.Message;
@@ -56,8 +56,11 @@ public boolean canNack() {
     }
 
     @Override
-    public Map<String, String> getAttributes() {
-        return null;
+    public GetAttributeResult getAttributes() {
+        return new GetAttributeResult.Builder()
+                .name("aws-subscription")
+                .topic("aws-topic")
+                .build();
     }
 
     @Override
diff --git a/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/client/GetAttributeResult.java b/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/client/GetAttributeResult.java
@@ -0,0 +1,45 @@
+package com.salesforce.multicloudj.pubsub.client;
+
+
+/**
+ * Result object containing subscription attributes that are common across all Pub/Sub providers.
+ * This class provides a standardized way to access subscription configuration properties
+ * regardless of the underlying cloud provider (AWS, GCP, Aliyun, etc.).
+ */
+public class GetAttributeResult {
+
+    // Core Identification
+    private String name;
+    private String topic;
+
+    // Default constructor
+    public GetAttributeResult() {}
+
+    // Builder pattern for easy construction
+    public static class Builder {
+        private final GetAttributeResult result = new GetAttributeResult();
+
+        public Builder name(String name) {
+            result.name = name;
+            return this;
+        }
+
+        public Builder topic(String topic) {
+            result.topic = topic;
+            return this;
+        }
+
+        public GetAttributeResult build() {
+            return result;
+        }
+    }
+
+    // Getters
+    public String getName() { return name; }
+    public String getTopic() { return topic; }
+
+    // Setters
+    public void setName(String name) { this.name = name; }
+    public void setTopic(String topic) { this.topic = topic; }
+
+}
diff --git a/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/client/SubscriptionClient.java b/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/client/SubscriptionClient.java
@@ -2,7 +2,6 @@
 
 import java.net.URI;
 import java.util.List;
-import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 
 import com.salesforce.multicloudj.common.exceptions.ExceptionHandler;
@@ -145,10 +144,10 @@ public boolean canNack() {
      * This may include provider-specific configuration like delivery delay,
      * message retention period, etc.
      *
-     * @return A map of subscription attributes
+     * @return A GetAttributeResult containing subscription attributes
      * @throws SubstrateSdkException If the operation fails
      */
-    public Map<String, String> getAttributes() {
+    public GetAttributeResult getAttributes() {
         try {
             return subscription.getAttributes();
         } catch (Throwable t) {
diff --git a/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/driver/AbstractSubscription.java b/pubsub/pubsub-client/src/main/java/com/salesforce/multicloudj/pubsub/driver/AbstractSubscription.java
@@ -7,7 +7,6 @@
 import java.util.Collections;
 import java.util.Queue;
 import java.util.List;
-import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ExecutorService;
@@ -21,6 +20,7 @@
 import com.salesforce.multicloudj.common.exceptions.FailedPreconditionException;
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
 import com.salesforce.multicloudj.common.exceptions.SubstrateSdkException;
+import com.salesforce.multicloudj.pubsub.client.GetAttributeResult;
 import com.salesforce.multicloudj.pubsub.batcher.Batcher;
 import com.salesforce.multicloudj.sts.model.CredentialsOverrider;
 
@@ -410,7 +410,7 @@ public CompletableFuture<Void> sendNacks(List<AckID> ackIDs) {
     
     public abstract boolean canNack();
     public abstract boolean isRetryable(Throwable error);
-    public abstract Map<String, String> getAttributes();
+    public abstract GetAttributeResult getAttributes();
     
     protected abstract void doSendAcks(List<AckID> ackIDs);
     protected abstract void doSendNacks(List<AckID> ackIDs);
diff --git a/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/client/AbstractPubsubIT.java b/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/client/AbstractPubsubIT.java
@@ -4,6 +4,7 @@
 import com.salesforce.multicloudj.pubsub.driver.AbstractTopic;
 import com.salesforce.multicloudj.pubsub.driver.Message;
 import com.salesforce.multicloudj.pubsub.driver.AckID;
+import com.salesforce.multicloudj.pubsub.client.GetAttributeResult;
 import com.salesforce.multicloudj.common.util.common.TestsUtil;
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
 
@@ -325,4 +326,25 @@ public void testDoubleAck() throws Exception {
             subscription.sendAck(receivedMessages.get(0).getAckID());
         }
     }
+
+    @Test
+    public void testGetAttributes() throws Exception {
+        try (AbstractSubscription subscription = harness.createSubscriptionDriver()) {
+            GetAttributeResult attributes = subscription.getAttributes();
+
+            // Verify that attributes are returned
+            Assertions.assertNotNull(attributes, "Attributes should not be null");
+
+            // Verify essential attributes that should be present across all providers
+            Assertions.assertNotNull(attributes.getName(), "Name should not be null");
+            Assertions.assertFalse(attributes.getName().isEmpty(), "Name should not be empty");
+
+            Assertions.assertNotNull(attributes.getTopic(), "Topic should not be null");
+            Assertions.assertFalse(attributes.getTopic().isEmpty(), "Topic should not be empty");
+
+            // Verify that we have the essential attributes
+            Assertions.assertNotNull(attributes.getName(), "Should have name attribute");
+            Assertions.assertNotNull(attributes.getTopic(), "Should have topic attribute");
+        }
+    }
 }
diff --git a/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/client/SubscriptionClientTest.java b/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/client/SubscriptionClientTest.java
@@ -137,11 +137,14 @@ public void testCanNack() {
     @Test
     public void testGetAttributes() {
         // Arrange
-        Map<String, String> expectedAttributes = Map.of("key", "value");
+        GetAttributeResult expectedAttributes = new GetAttributeResult.Builder()
+        .name("test-subscription")
+        .topic("test-topic")
+        .build();
         when(mockSubscription.getAttributes()).thenReturn(expectedAttributes);
 
         // Act
-        Map<String, String> result = subscriptionClient.getAttributes();
+        GetAttributeResult result = subscriptionClient.getAttributes();
 
         // Assert
         assertEquals(expectedAttributes, result);
diff --git a/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/driver/AbstractSubscriptionTest.java b/pubsub/pubsub-client/src/test/java/com/salesforce/multicloudj/pubsub/driver/AbstractSubscriptionTest.java
@@ -3,6 +3,7 @@
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
 import com.salesforce.multicloudj.common.exceptions.SubstrateSdkException;
 import com.salesforce.multicloudj.pubsub.batcher.Batcher;
+import com.salesforce.multicloudj.pubsub.client.GetAttributeResult;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Timeout;
 
@@ -133,7 +134,12 @@ protected Batcher.Options createAckBatcherOptions() {
         public boolean canNack() { return false; }
 
         @Override
-        public Map<String, String> getAttributes() { return Collections.emptyMap(); }
+        public GetAttributeResult getAttributes() { 
+            return new GetAttributeResult.Builder()
+                    .name("test-subscription")
+                    .topic("test-topic")
+                    .build();
+        }
 
         @Override
         public boolean isRetryable(Throwable error) {
diff --git a/pubsub/pubsub-gcp/src/main/java/com/salesforce/multicloudj/pubsub/gcp/GcpSubscription.java b/pubsub/pubsub-gcp/src/main/java/com/salesforce/multicloudj/pubsub/gcp/GcpSubscription.java
@@ -14,8 +14,10 @@
 import com.google.pubsub.v1.PullResponse;
 import com.google.pubsub.v1.ReceivedMessage;
 import com.salesforce.multicloudj.common.exceptions.SubstrateSdkException;
+import com.google.pubsub.v1.Subscription;
 import com.salesforce.multicloudj.common.gcp.GcpConstants;
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
+import com.salesforce.multicloudj.pubsub.client.GetAttributeResult;
 
 import com.salesforce.multicloudj.common.gcp.GcpCredentialsProvider;
 import com.salesforce.multicloudj.pubsub.batcher.Batcher;
@@ -36,6 +38,9 @@
 import java.net.Proxy;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.BlockingQueue;
@@ -184,9 +189,17 @@ public boolean isRetryable(Throwable error) {
     }
 
     @Override
-    public Map<String, String> getAttributes() {
-        // TODO: Implement subscription attributes retrieval
-        return Collections.emptyMap();
+    public GetAttributeResult getAttributes() {
+        try {
+            Subscription sub = getOrCreateSubscriptionAdminClient().getSubscription(subscriptionName);
+
+            return new GetAttributeResult.Builder()
+                    .name(sub.getName())
+                    .topic(sub.getTopic())
+                    .build();
+        } catch (ApiException e) {
+            throw new SubstrateSdkException("Failed to retrieve subscription attributes", e);
+        }
     }
 
     @Override
diff --git a/pubsub/pubsub-gcp/src/test/java/com/salesforce/multicloudj/pubsub/gcp/GcpSubscriptionTest.java b/pubsub/pubsub-gcp/src/test/java/com/salesforce/multicloudj/pubsub/gcp/GcpSubscriptionTest.java
diff --git a/pubsub/pubsub-gcp/src/test/resources/mappings/get-rlkjudkzxb.json b/pubsub/pubsub-gcp/src/test/resources/mappings/get-rlkjudkzxb.json

Original file line number	Diff line number	Diff line change
`@@ -2077,7 +2077,6 @@ void testDoDownloadDirectory_SkipsFolderMarkers() throws Exception {`
`2077`	`2077`	`}`
`2078`	`2078`
`2079`	`2079`	`@Test`
`2080`		`- @Disabled`
`2081`	`2080`	`void testDoDownloadDirectory_PathTraversalProtection() throws Exception {`
`2082`	`2081`	`// Given`
`2083`	`2082`	`String prefix = "test-prefix/";`