Add an option to fold over keep-while expirations

rabbitmq · Sep 30, 2024 · 012c024 · 012c024
1 parent 681d738
commit 012c024
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 4 deletions.
diff --git a/src/khepri.erl b/src/khepri.erl
@@ -362,6 +362,8 @@
 %% created/updated tree node.</li>
 %% </ul>
 
+-type delete_options() :: #{accumulate_keep_while_expirations => boolean()}.
+
 -type fold_fun() :: fun((khepri_path:native_path(),
                          khepri:node_props(),
                          khepri:fold_acc()) -> khepri:fold_acc()).
@@ -472,6 +474,7 @@
               query_options/0,
               tree_options/0,
               put_options/0,
+              delete_options/0,
 
               fold_fun/0,
               fold_acc/0,

diff --git a/src/khepri_machine.erl b/src/khepri_machine.erl
@@ -732,10 +732,12 @@ split_query_options(Options) ->
       end, {#{}, #{}}, Options1).
 
 -spec split_command_options(Options) ->
-    {CommandOptions, TreeAndPutOptions} when
-      Options :: CommandOptions | TreeAndPutOptions,
+    {CommandOptions, TreeOptions} when
+      Options :: CommandOptions | TreeOptions,
       CommandOptions :: khepri:command_options(),
-      TreeAndPutOptions :: khepri:tree_options() | khepri:put_options().
+      TreeOptions :: khepri:tree_options() |
+                     khepri:put_options() |
+                     khepri:delete_options().
 %% @private
 
 split_command_options(Options) ->
@@ -753,7 +755,8 @@ split_command_options(Options) ->
           (Option, Value, {C, TP}) when
                 Option =:= expect_specific_node orelse
                 Option =:= props_to_return orelse
-                Option =:= include_root_props ->
+                Option =:= include_root_props orelse
+                Option =:= accumulate_keep_while_expirations ->
               TP1 = TP#{Option => Value},
               {C, TP1};
           (keep_while, KeepWhile, {C, TP}) ->

diff --git a/src/khepri_tree.erl b/src/khepri_tree.erl
@@ -1381,6 +1381,26 @@ is_parent_being_removed1([], _) ->
 
 remove_expired_nodes([], Walk) ->
     {ok, Walk};
+remove_expired_nodes(
+  [PathToDelete | Rest],
+  #walk{tree = Tree,
+        applied_changes = AppliedChanges,
+        'fun' = Fun,
+        fun_acc = Acc,
+        tree_options =
+        #{accumulate_keep_while_expirations := true} = TreeOptions} = Walk) ->
+    Result = walk_down_the_tree(
+               Tree, PathToDelete, TreeOptions, AppliedChanges, Fun, Acc),
+    case Result of
+        {ok, Tree1, AppliedChanges1, Acc1} ->
+            AppliedChanges2 = merge_applied_changes(
+                                AppliedChanges, AppliedChanges1),
+            Walk1 = Walk#walk{tree = Tree1,
+                              node = Tree1#tree.root,
+                              applied_changes = AppliedChanges2,
+                              fun_acc = Acc1},
+            remove_expired_nodes(Rest, Walk1)
+    end;
 remove_expired_nodes(
   [PathToDelete | Rest],
   #walk{tree = Tree, applied_changes = AppliedChanges} = Walk) ->

diff --git a/test/advanced_delete.erl b/test/advanced_delete.erl
@@ -27,6 +27,26 @@ delete_non_existing_node_test_() ->
                                                  node_is_target => true})},
          khepri_adv:get(?FUNCTION_NAME, [foo]))]}.
 
+%% TODO: find a place for this test
+accumulate_keep_while_expirations_test_() ->
+    {setup,
+     fun() -> test_ra_server_helpers:setup(?FUNCTION_NAME) end,
+     fun(Priv) -> test_ra_server_helpers:cleanup(Priv) end,
+     [?_assertEqual(
+         ok,
+         khepri:create(?FUNCTION_NAME, [a, b, c], val1)),
+      ?_assertEqual(
+         ok,
+         khepri:create(
+           ?FUNCTION_NAME, [d, e], val2,
+           #{keep_while => #{[a, b, c] => #if_node_exists{exists = true}}})),
+      ?_assertMatch(
+         {ok, #{[a, b, c] := #{data := val1},
+                [d, e] := #{data := val2}}},
+         khepri_adv:delete_many(
+           ?FUNCTION_NAME, [a, b, c],
+           #{accumulate_keep_while_expirations => true}))]}.
+
 delete_existing_node_test_() ->
     {setup,
      fun() -> test_ra_server_helpers:setup(?FUNCTION_NAME) end,