Capturing sync progress received by core extension.

Author: Chriztiaan

PowerSync/PowerSync.Common/Client/Sync/Stream/StreamingSyncImplementation.cs

@@ -469,8 +469,7 @@ async Task HandleInstruction(Instruction instruction)
                             DataFlow = new SyncDataFlowStatus
                             {
                                 Downloading = info.Downloading != null,
-                                // TODO CL
-                                // DownloadProgress = info.Downloading?.Buckets
+                                DownloadProgress = info.Downloading?.Buckets
                             }
                         },
                         new UpdateSyncStatusOptions
@@ -645,6 +644,7 @@ protected void UpdateSyncStatus(SyncStatusOptions options, UpdateSyncStatusOptio
                 UploadError = updateOptions?.ClearUploadError == true
                     ? null
                     : options.DataFlow?.UploadError ?? SyncStatus.DataFlowStatus.UploadError,
+                DownloadProgress = options.DataFlow?.DownloadProgress ?? SyncStatus.DataFlowStatus.DownloadProgress,
             },
             PriorityStatusEntries = options.PriorityStatusEntries ?? SyncStatus.PriorityStatusEntries
         });

PowerSync/PowerSync.Common/DB/Crud/SyncProgress.cs

@@ -1,3 +1,5 @@
+using PowerSync.Common.Client.Sync.Stream;
+
 namespace PowerSync.Common.DB.Crud;
 
 /// <summary>
@@ -18,25 +20,24 @@ namespace PowerSync.Common.DB.Crud;
 public class SyncProgress : ProgressWithOperations
 {
     public static readonly int FULL_SYNC_PRIORITY = 2147483647;
-
-    private InternalProgressInformation internalProgress;
-
-    public SyncProgress(InternalProgressInformation progress)
+    protected Dictionary<string, BucketProgress> InternalProgress { get; }
+    
+    public SyncProgress(Dictionary<string, BucketProgress> progress)
     {
-        this.internalProgress = progress;
+        this.InternalProgress = progress;
         var untilCompletion = UntilPriority(FULL_SYNC_PRIORITY);
 
         TotalOperations = untilCompletion.TotalOperations;
         DownloadedOperations = untilCompletion.DownloadedOperations;
         DownloadedFraction = untilCompletion.DownloadedFraction;
     }
 
-    private ProgressWithOperations UntilPriority(int priority)
+    public ProgressWithOperations UntilPriority(int priority)
     {
         var total = 0;
         var downloaded = 0;
 
-        foreach (var progress in internalProgress.Buckets.Values)
+        foreach (var progress in InternalProgress.Values)
         {
             // Include higher-priority buckets, which are represented by lower numbers.
             if (progress.Priority <= priority)
@@ -55,43 +56,6 @@ private ProgressWithOperations UntilPriority(int priority)
     }
 }
 
-/// <summary>
-/// Represents progress information for sync operations.
-/// </summary>
-public class InternalProgressInformation
-{
-    /// <summary>
-    /// Dictionary mapping bucket names to their progress information.
-    /// </summary>
-    public Dictionary<string, BucketProgressInfo> Buckets { get; set; } = new();
-}
-
-/// <summary>
-/// Represents progress information for a single bucket.
-/// </summary>
-public class BucketProgressInfo
-{
-    /// <summary>
-    /// Priority of the associated buckets
-    /// </summary>
-    public int Priority { get; set; }
-
-    /// <summary>
-    /// Total ops at last completed sync, or 0
-    /// </summary>
-    public int AtLast { get; set; }
-
-    /// <summary>
-    /// Total ops since the last completed sync
-    /// </summary>
-    public int SinceLast { get; set; }
-
-    /// <summary>
-    /// Total opcount for next checkpoint as indicated by service
-    /// </summary>
-    public int TargetCount { get; set; }
-}
-
 /// <summary>
 /// Information about a progressing download made by the PowerSync SDK.
 /// 

PowerSync/PowerSync.Common/DB/Crud/SyncStatus.cs

@@ -1,5 +1,6 @@
 namespace PowerSync.Common.DB.Crud;
 
+using PowerSync.Common.Client.Sync.Stream;
 using Newtonsoft.Json;
 
 public class SyncDataFlowStatus
@@ -21,20 +22,28 @@ public class SyncDataFlowStatus
     /// </summary>
     [JsonProperty("uploadError")]
     public Exception? UploadError { get; set; } = null;
+
+
+    /// <summary>
+    /// Internal information about how far we are downloading operations in buckets.
+    /// </summary>
+    public Dictionary<string, BucketProgress>? DownloadProgress { get; set; } = null;
 }
 
 public class SyncPriorityStatus
 {
     [JsonProperty("uploading")] public int Priority { get; set; }
-    
+
     [JsonProperty("lastSyncedAt")] public DateTime? LastSyncedAt { get; set; }
 
     [JsonProperty("hasSynced")] public bool? HasSynced { get; set; }
 }
 
 public class SyncStatusOptions
 {
-    public SyncStatusOptions() {}
+    public SyncStatusOptions()
+    {
+    }
 
     public SyncStatusOptions(SyncStatusOptions options)
     {
@@ -93,6 +102,21 @@ public class SyncStatus(SyncStatusOptions options)
         .OrderBy(entry => entry.Priority)
         .ToArray();
 
+    /// <summary>
+    /// A realtime progress report on how many operations have been downloaded and
+    /// how many are necessary in total to complete the next sync iteration.
+    /// </summary>
+    public SyncProgress? DownloadProgress()
+    {
+        var internalProgress = Options.DataFlow?.DownloadProgress;
+        if (internalProgress == null)
+        {
+            return null;
+        }
+
+        return new SyncProgress(internalProgress);
+    }
+
     /// <summary>
     /// Reports the sync status (a pair of HasSynced and LastSyncedAt fields)
     /// for a specific bucket priority level.