add cookie interface for log checkpoint manager

Author: vazois

libs/cluster/Server/Replication/ReplicationLogCheckpointManager.cs

@@ -85,27 +85,6 @@ private unsafe byte[] CreateCookie()
             return cookie;
         }
 
-        private unsafe int GetCookieData(HybridLogRecoveryInfo hlri, out long checkpointCoveredAddress, out string primaryReplId)
-        {
-            checkpointCoveredAddress = -1;
-            primaryReplId = null;
-
-            var bytesRead = sizeof(int);
-            fixed (byte* ptr = hlri.cookie)
-            {
-                if (hlri.cookie.Length < 4) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 4");
-                var cookieSize = *(int*)ptr;
-                bytesRead += cookieSize;
-
-                if (hlri.cookie.Length < 12) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 12");
-                checkpointCoveredAddress = *(long*)(ptr + 4);
-
-                if (hlri.cookie.Length < 52) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 52");
-                primaryReplId = Encoding.ASCII.GetString(ptr + 12, 40);
-            }
-            return bytesRead;
-        }
-
         private HybridLogRecoveryInfo ConverMetadata(byte[] checkpointMetadata)
         {
             var success = true;
@@ -200,7 +179,7 @@ public void CommiLogCheckpointSendFromPrimary(Guid logToken, byte[] checkpointMe
         /// <param name="hlri"></param>
         public override unsafe void CommitLogCheckpoint(Guid logToken, HybridLogRecoveryInfo hlri)
         {
-            CommitCookie = CreateCookie();
+            AddCookie(CreateCookie());
             base.CommitLogCheckpoint(logToken, hlri);
         }
 
@@ -212,7 +191,7 @@ public override unsafe void CommitLogCheckpoint(Guid logToken, HybridLogRecovery
         /// <param name="deltaLog"></param>
         public override unsafe void CommitLogIncrementalCheckpoint(Guid logToken, HybridLogRecoveryInfo hlri, DeltaLog deltaLog)
         {
-            CommitCookie = CreateCookie();
+            AddCookie(CreateCookie());
             base.CommitLogIncrementalCheckpoint(logToken, hlri, deltaLog);
         }
 
@@ -223,6 +202,27 @@ public unsafe (long, string) GetCheckpointCookieMetadata(Guid logToken, DeltaLog
             var bytesRead = GetCookieData(hlri, out var RecoveredSafeAofAddress, out var RecoveredReplicationId);
             Debug.Assert(bytesRead == 52);
             return (RecoveredSafeAofAddress, RecoveredReplicationId);
+
+            unsafe int GetCookieData(HybridLogRecoveryInfo hlri, out long checkpointCoveredAddress, out string primaryReplId)
+            {
+                checkpointCoveredAddress = -1;
+                primaryReplId = null;
+
+                var bytesRead = sizeof(int);
+                fixed (byte* ptr = hlri.cookie)
+                {
+                    if (hlri.cookie.Length < 4) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 4");
+                    var cookieSize = *(int*)ptr;
+                    bytesRead += cookieSize;
+
+                    if (hlri.cookie.Length < 12) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 12");
+                    checkpointCoveredAddress = *(long*)(ptr + 4);
+
+                    if (hlri.cookie.Length < 52) throw new Exception($"invalid metadata length: {hlri.cookie.Length} < 52");
+                    primaryReplId = Encoding.ASCII.GetString(ptr + 12, 40);
+                }
+                return bytesRead;
+            }
         }
 
         public override void GetLogCheckpointMetadataInfo(ref HybridLogRecoveryInfo hlri, Guid logToken, DeltaLog deltaLog, bool scanDelta, long recoverTo)

libs/storage/Tsavorite/cs/src/core/Index/CheckpointManagement/DeviceLogCommitCheckpointManager.cs

@@ -46,7 +46,10 @@ public class DeviceLogCommitCheckpointManager : ILogCommitManager, ICheckpointMa
         readonly int fastCommitThrottleFreq;
         int commitCount;
 
-        public byte[] CommitCookie { get; set; }
+        /// <summary>
+        /// Any additional (user specified) metadata to write out with commit
+        /// </summary>
+        protected byte[] CommitCookie { get; private set; }
 
         /// <summary>
         /// Create new instance of log commit manager
@@ -169,6 +172,9 @@ public byte[] GetCommitMetadata(long commitNum)
 
         #region ICheckpointManager
 
+        /// <inheritdoc />
+        public void AddCookie(byte[] cookie) => CommitCookie = cookie;
+
         /// <inheritdoc />
         public unsafe void CommitIndexCheckpoint(Guid indexToken, byte[] commitMetadata)
         {

libs/storage/Tsavorite/cs/src/core/Index/Checkpointing/TsavoriteStateMachineProperties.cs

@@ -10,13 +10,10 @@ public partial class TsavoriteKV<TKey, TValue, TStoreFunctions, TAllocator> : Ts
         internal long lastVersion;
 
         /// <summary>
-        /// Any additional (user specified) metadata to write out with commit
+        /// Add cookie to the metadata before commit
         /// </summary>
-        public byte[] CommitCookie
-        {
-            get => checkpointManager.CommitCookie;
-            set => checkpointManager.CommitCookie = value;
-        }
+        /// <param name="cookie"></param>
+        public void AddCookie(byte[] cookie) => checkpointManager.AddCookie(cookie);
 
         private byte[] recoveredCommitCookie;
         /// <summary>

libs/storage/Tsavorite/cs/src/core/Index/Recovery/ICheckpointManager.cs

@@ -31,9 +31,10 @@ namespace Tsavorite.core
     public interface ICheckpointManager : IDisposable
     {
         /// <summary>
-        /// Any additional (user specified) metadata to write out with commit
+        /// Add cookie to the metadata before commit
         /// </summary>
-        public byte[] CommitCookie { get; set; }
+        /// <param name="cookie"></param>
+        void AddCookie(byte[] cookie);
 
         /// <summary>
         /// Initialize index checkpoint

libs/storage/Tsavorite/cs/test/SimpleRecoveryTest.cs

@@ -149,7 +149,7 @@ private async ValueTask SimpleRecoveryTest1_Worker(CheckpointType checkpointType
             }
 
             if (testCommitCookie)
-                store1.CommitCookie = commitCookie;
+                store1.AddCookie(commitCookie);
             _ = store1.TryInitiateFullCheckpoint(out Guid token, checkpointType);
             if (completionSyncMode == CompletionSyncMode.Sync)
                 store1.CompleteCheckpointAsync().AsTask().GetAwaiter().GetResult();