Add the revision field for alidocstore (#68)

sandeepvinayak · web-flow · commit 9f7a4ac44c3e · 2025-10-03T14:35:15.000-04:00
diff --git a/docstore/docstore-ali/src/main/java/com/salesforce/multicloudj/docstore/ali/AliDocStore.java b/docstore/docstore-ali/src/main/java/com/salesforce/multicloudj/docstore/ali/AliDocStore.java
@@ -27,6 +27,7 @@
 import com.alicloud.openservices.tablestore.model.RowPutChange;
 import com.alicloud.openservices.tablestore.model.StartLocalTransactionRequest;
 import com.alicloud.openservices.tablestore.model.StartLocalTransactionResponse;
+import com.alicloud.openservices.tablestore.model.condition.SingleColumnValueCondition;
 import com.alicloud.openservices.tablestore.model.sql.SQLQueryRequest;
 import com.google.auto.service.AutoService;
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
@@ -305,16 +306,47 @@ protected WriteOperation newPut(Action action, Consumer<Predicate<Object>> befor
         );
     }
 
+    private Condition buildRevisionPrecondition(Document doc, String revField) {
+        Object object = doc.getField(revField);
+        if (object == null) {
+            return null;
+        }
+        if (!(object instanceof String)) {
+            throw new IllegalArgumentException(String.format("Invalid revision field %s type as %s, expect String type.", revField, object == null ? null : object.getClass().getName()));
+        }
+        String v = (String) doc.getField(revField);
+        if (v == null || v.isEmpty()) {
+            return null;
+        }
+
+        Condition condition = new Condition();
+        SingleColumnValueCondition singleColumnValueCondition = new SingleColumnValueCondition(revField,
+                SingleColumnValueCondition.CompareOperator.EQUAL, ColumnValue.fromString(v));
+        condition.setColumnCondition(singleColumnValueCondition);
+        return condition;
+    }
+
     private void buildPreCondition(Action a, RowPutChange rowPutChange) {
         switch (a.getKind()) {
             case ACTION_KIND_CREATE:
                 rowPutChange.setCondition(new Condition(RowExistenceExpectation.EXPECT_NOT_EXIST));
                 return;
             case ACTION_KIND_UPDATE:
             case ACTION_KIND_REPLACE:
-                rowPutChange.setCondition(new Condition(RowExistenceExpectation.EXPECT_EXIST));
+                Condition condition = buildRevisionPrecondition(a.getDocument(), getRevisionField());
+                rowPutChange.setCondition(Objects.requireNonNullElseGet(condition, () -> new Condition(RowExistenceExpectation.EXPECT_NOT_EXIST)));
+                return;
+            case ACTION_KIND_DELETE:
+            case ACTION_KIND_PUT:
+                // Precondition: the revision matches, if any.
+                rowPutChange.setCondition(buildRevisionPrecondition(a.getDocument(), getRevisionField()));
+                return;
+            case ACTION_KIND_GET:
+                // No preconditions on a Get.
+                return;
+            default:
+                throw new IllegalArgumentException("Invalid action kind: " + a.getKind());
         }
-
     }
 
     protected void runPut(RowPutChange put, Action action, Consumer<Predicate<Object>> beforeDo) {
diff --git a/docstore/docstore-ali/src/test/java/com/salesforce/multicloudj/docstore/ali/AliDocStoreTest.java b/docstore/docstore-ali/src/test/java/com/salesforce/multicloudj/docstore/ali/AliDocStoreTest.java
@@ -12,9 +12,7 @@
 import com.alicloud.openservices.tablestore.model.DescribeTableResponse;
 import com.alicloud.openservices.tablestore.model.IndexMeta;
 import com.alicloud.openservices.tablestore.model.IndexType;
-import com.alicloud.openservices.tablestore.model.PrimaryKey;
 import com.alicloud.openservices.tablestore.model.PrimaryKeyBuilder;
-import com.alicloud.openservices.tablestore.model.PrimaryKeyColumn;
 import com.alicloud.openservices.tablestore.model.PrimaryKeyValue;
 import com.alicloud.openservices.tablestore.model.PutRowRequest;
 import com.alicloud.openservices.tablestore.model.PutRowResponse;
@@ -24,13 +22,10 @@
 import com.alicloud.openservices.tablestore.model.RowPutChange;
 import com.alicloud.openservices.tablestore.model.StartLocalTransactionResponse;
 import com.alicloud.openservices.tablestore.model.TableMeta;
-import com.alicloud.openservices.tablestore.model.search.ParallelScanRequest;
-import com.alicloud.openservices.tablestore.model.search.ParallelScanResponse;
 import com.alicloud.openservices.tablestore.model.sql.SQLQueryRequest;
 import com.alicloud.openservices.tablestore.model.sql.SQLQueryResponse;
 import com.google.protobuf.Timestamp;
 import com.salesforce.multicloudj.common.exceptions.InvalidArgumentException;
-import com.salesforce.multicloudj.common.exceptions.SubstrateSdkException;
 import com.salesforce.multicloudj.common.exceptions.UnAuthorizedException;
 import com.salesforce.multicloudj.docstore.client.Query;
 import com.salesforce.multicloudj.docstore.driver.Action;
@@ -68,7 +63,7 @@
 import static org.mockito.Mockito.when;
 
 class AliDocStoreTest {
-    BookWithoutNest book = new BookWithoutNest("YellowBook", "Neil", "WA", Timestamp.newBuilder().setNanos(1000).build(), 3.99f);
+    BookWithoutNest book = new BookWithoutNest("YellowBook", "Neil", "WA", Timestamp.newBuilder().setNanos(1000).build(), 3.99f, null);
     TestDocStore docStore;
     SyncClient syncClient;
     IndexMeta localIndex1;
@@ -148,8 +143,9 @@ void setup() {
                 .withInstanceId("something")
                 .withCollectionOptions(
                         new CollectionOptions.CollectionOptionsBuilder()
-                                .withPartitionKey("title").withSortKey("publisher").
-                                withTableName("my-table").build()
+                                .withPartitionKey("title").withSortKey("publisher")
+                                .withTableName("my-table")
+                                .withRevisionField("docRevision").build()
                 ).withCredentialsOverrider(credsOverrider).withTableStoreClient(syncClient).build();
 
         localIndex1 = new IndexMeta("local_index_1");
@@ -330,7 +326,7 @@ void testRunGetsWithException() {
         List<String> fp3 = new ArrayList<>(List.of("title"));
         List<String> fp4 = new ArrayList<>(List.of("publisher"));
 
-        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0);
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, null);
         List<Action> gets = new ArrayList<>();
 
         TestAction get1 = new TestAction(ActionKind.ACTION_KIND_GET, new Document(bookObj), fp1, null);
@@ -375,7 +371,7 @@ void testRunGets() {
         List<String> fp1 = new ArrayList<>(List.of("title", "publisher"));
         List<String> fp2 = new ArrayList<>(List.of("publisher", "title"));  // Different order of fp1, treated as a different fp.
 
-        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0);
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, null);
         List<Action> gets = new ArrayList<>();
 
         TestAction get1 = new TestAction(ActionKind.ACTION_KIND_GET, new Document(bookObj), fp1, null);
@@ -427,7 +423,7 @@ void testRunGets() {
 
     @Test
     void testBatchGetWithMissingKeys() {
-        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0);
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, null);
         List<Action> gets = new ArrayList<>();
         List<String> fp1 = new ArrayList<>(List.of("d"));
         TestAction get1 = new TestAction(ActionKind.ACTION_KIND_GET, new Document(bookObj), fp1, null);
@@ -458,7 +454,7 @@ void testBatchGetWithMissingKeys() {
 
     @Test
     void testBatchGet() {
-        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0);
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, null);
         List<Action> gets = new ArrayList<>();
         List<String> fp1 = new ArrayList<>(List.of("title", "publisher", "author"));
         TestAction get1 = new TestAction(ActionKind.ACTION_KIND_GET, new Document(bookObj), fp1, null);
@@ -510,7 +506,27 @@ void testBatchGet() {
     @Test
     void testCreate() {
         Document document = new Document(book);
-        ali.getActions().create(document).run();
+        Assertions.assertDoesNotThrow(() -> ali.getActions().create(document).run());
+    }
+
+    @Test
+    void testPut() {
+        Document document = new Document(book);
+        Assertions.assertDoesNotThrow(() -> ali.getActions().put(document).run());
+    }
+
+    @Test
+    void testPutWithRevision() {
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, "something");
+        Document document = new Document(bookObj);
+        Assertions.assertDoesNotThrow(() -> ali.getActions().put(document).run());
+    }
+
+    @Test
+    void testDeleteWithRevision() {
+        BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, "something");
+        Document document = new Document(bookObj);
+        Assertions.assertDoesNotThrow(() -> ali.getActions().delete(document).run());
     }
 
     @Test
@@ -577,7 +593,7 @@ void testRunDelete() {
                     .withAllowScans(false)
                     .withMaxOutstandingActionRPCs(10)
                     .build();
-            BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0);
+            BookWithoutNest bookObj = new BookWithoutNest("YellowBook", null, "WA", Timestamp.newBuilder().setNanos(1000).build(), 0, null);
             List<Action> deletes = new ArrayList<>();
 
             TestAction delete1 = new TestAction(ActionKind.ACTION_KIND_DELETE, new Document(bookObj), null, null);
diff --git a/docstore/docstore-client/src/test/java/com/salesforce/multicloudj/docstore/driver/testtypes/BookWithoutNest.java b/docstore/docstore-client/src/test/java/com/salesforce/multicloudj/docstore/driver/testtypes/BookWithoutNest.java
@@ -18,4 +18,5 @@ public class BookWithoutNest {
     @JsonDeserialize(using = TimestampPbDeserializer.class)
     public Timestamp publishedDate;
     public float price;
+    String docRevision;
 }

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,5 @@ public class BookWithoutNest {`
`18`	`18`	`@JsonDeserialize(using = TimestampPbDeserializer.class)`
`19`	`19`	`public Timestamp publishedDate;`
`20`	`20`	`public float price;`
	`21`	`+ String docRevision;`
`21`	`22`	`}`