added test for logical branches

y-crdt · Horusiath · Mar 9, 2024 · Feb 11, 2024 · Feb 15, 2024 · Feb 16, 2024
commit 00f8e48bc05c95ef2ddd53c6f6a4ed66ed69a2ac
diff --git a/tests-ffi/include/libyrs.h b/tests-ffi/include/libyrs.h
@@ -2457,7 +2457,7 @@ struct YBranchId ybranch_id(const Branch *branch);
  * Returned pointer may still point to deleted collection. In such case a subsequent `ybranch_alive`
  * function call is required.
  */
-const Branch *ybranch_get(const struct YBranchId *branch_id, YTransaction *txn);
+Branch *ybranch_get(const struct YBranchId *branch_id, YTransaction *txn);
 
 /**
  * Check if current branch is still alive (returns `Y_TRUE`, otherwise `Y_FALSE`).

diff --git a/tests-ffi/main.cpp b/tests-ffi/main.cpp
@@ -1880,6 +1880,57 @@ TEST_CASE("Weak link references") {
 
     yweak_iter_destroy(iter);
 
+    ytransaction_commit(txn);
+    ydoc_destroy(doc);
+}
+
+TEST_CASE("Logical branch pointers") {
+    YDoc *doc = ydoc_new_with_id(1);
+    Branch *arr = yarray(doc, "array");
+    YTransaction *txn = ydoc_write_transaction(doc, 0, NULL);
+
+    // init doc -> 'array' = [{'key':'value'}]
+    char *key = "key";
+    YInput value = yinput_string("value");
+    YInput in = yinput_ymap(&key, &value, 1);
+    yarray_insert_range(arr, txn, 0, &in, 1);
+    YOutput *out = yarray_get(arr, txn, 0);
+    Branch *map = youtput_read_ymap(out);
+    youtput_destroy(out);
+
+    // get branch identifier
+    YBranchId map_id = ybranch_id(map);
+    YBranchId arr_id = ybranch_id(arr);
+
+    // remote changes
+    YDoc *doc2 = ydoc_new_with_id(2);
+    yarray(doc2, "array"); // roots needs to be pre-initialized
+    YTransaction *txn2 = ydoc_write_transaction(doc2, 0, NULL);
+
+    // synchronize the documents
+    uint32_t sv_len = 0;
+    char *sv = ytransaction_state_vector_v1(txn2, &sv_len);
+
+    uint32_t update_len = 0;
+    char *update = ytransaction_state_diff_v1(txn, sv, sv_len, &update_len);
+
+    ytransaction_apply(txn2, update, update_len);
+
+    ybinary_destroy(sv, sv_len);
+    ybinary_destroy(update, update_len);
+
+    // retrieve branch pointers on remote using logical IDs
+    Branch* arr2 = ybranch_get(&arr_id, txn2);
+    Branch* map2 = ybranch_get(&map_id, txn2);
+
+    REQUIRE_EQ(yarray_len(arr2), 1);
+    out = ymap_get(map2, txn2, key);
+    char* val = youtput_read_string(out);
+    REQUIRE(strcmp(val, "value") == 0);
+    youtput_destroy(out);
+
+    ytransaction_commit(txn2);
+    ydoc_destroy(doc2);
     ytransaction_commit(txn);
     ydoc_destroy(doc);
 }
diff --git a/yffi/src/lib.rs b/yffi/src/lib.rs
@@ -5247,7 +5247,7 @@ pub unsafe extern "C" fn ybranch_id(branch: *const Branch) -> YBranchId {
 pub unsafe extern "C" fn ybranch_get(
     branch_id: *const YBranchId,
     txn: *mut Transaction,
-) -> *const Branch {
+) -> *mut Branch {
     let txn = txn.as_ref().unwrap();
     let branch_id = branch_id.as_ref().unwrap();
     let client_or_len = branch_id.client_or_len;
@@ -5259,7 +5259,7 @@ pub unsafe extern "C" fn ybranch_get(
     };
 
     match ptr {
-        None => null(),
+        None => null_mut(),
         Some(branch_ptr) => branch_ptr.into_raw_branch(),
     }
 }