Exposing upload and download errors in SyncStatus.

Author: Chriztiaan

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

@@ -297,6 +297,10 @@ protected async Task StreamingSync(CancellationToken? signal, PowerSyncConnectio
                 UpdateSyncStatus(new SyncStatusOptions
                 {
                     Connected = false,
+                    DataFlow = new SyncDataFlowStatus
+                    {
+                        DownloadError = ex
+                    }
                 });
 
                 // On error, wait a little before retrying
@@ -466,7 +470,13 @@ protected async Task<StreamingSyncIterationResult> StreamingSyncIteration(Cancel
                             {
                                 Connected = true,
                                 LastSyncedAt = DateTime.Now,
-                                DataFlow = new SyncDataFlowStatus { Downloading = false }
+                                DataFlow = new SyncDataFlowStatus
+                                {
+                                    Downloading = false
+                                }
+                            }, new UpdateSyncStatusOptions
+                            {
+                                ClearDownloadError = true
                             });
 
                         }
@@ -546,7 +556,9 @@ protected async Task<StreamingSyncIterationResult> StreamingSyncIteration(Cancel
                             //
                             await DelayRetry();
                             return new StreamingSyncIterationResult { Retry = true };
-                        } else if (remainingSeconds < 30) {
+                        }
+                        else if (remainingSeconds < 30)
+                        {
                             logger.LogDebug("Token will expire soon; reconnect");
                             // Pre-emptively refresh the token
                             Options.Remote.InvalidateCredentials();
@@ -563,8 +575,13 @@ protected async Task<StreamingSyncIterationResult> StreamingSyncIteration(Cancel
                             UpdateSyncStatus(new SyncStatusOptions
                             {
                                 Connected = true,
-                                LastSyncedAt = DateTime.Now
-                            });
+                                LastSyncedAt = DateTime.Now,
+                            },
+                            new UpdateSyncStatusOptions
+                            {
+                                ClearDownloadError = true
+                            }
+                            );
                         }
                         else if (validatedCheckpoint == targetCheckpoint)
                         {
@@ -590,8 +607,12 @@ protected async Task<StreamingSyncIterationResult> StreamingSyncIteration(Cancel
                                     LastSyncedAt = DateTime.Now,
                                     DataFlow = new SyncDataFlowStatus
                                     {
-                                        Downloading = false
+                                        Downloading = false,
                                     }
+                                },
+                                new UpdateSyncStatusOptions
+                                {
+                                    ClearDownloadError = true
                                 });
                             }
                         }
@@ -661,6 +682,14 @@ await locks.ObtainLock(new LockOptions<Task>
 
                             checkedCrudItem = nextCrudItem;
                             await Options.UploadCrud();
+                            UpdateSyncStatus(new SyncStatusOptions
+                            {
+                            },
+                            new UpdateSyncStatusOptions
+                            {
+                                ClearUploadError = true
+                            });
+
                         }
                         else
                         {
@@ -672,7 +701,14 @@ await locks.ObtainLock(new LockOptions<Task>
                     catch (Exception ex)
                     {
                         checkedCrudItem = null;
-                        UpdateSyncStatus(new SyncStatusOptions { DataFlow = new SyncDataFlowStatus { Uploading = false } });
+                        UpdateSyncStatus(new SyncStatusOptions
+                        {
+                            DataFlow = new SyncDataFlowStatus
+                            {
+                                Uploading = false,
+                                UploadError = ex
+                            }
+                        });
 
                         await DelayRetry();
 
@@ -706,7 +742,10 @@ public async Task WaitForReady()
         await Task.CompletedTask;
     }
 
-    protected void UpdateSyncStatus(SyncStatusOptions options)
+    protected record UpdateSyncStatusOptions(
+        bool? ClearDownloadError = null, bool? ClearUploadError = null
+    );
+    protected void UpdateSyncStatus(SyncStatusOptions options, UpdateSyncStatusOptions? updateOptions = null)
     {
         var updatedStatus = new SyncStatus(new SyncStatusOptions
         {
@@ -716,7 +755,9 @@ protected void UpdateSyncStatus(SyncStatusOptions options)
             DataFlow = new SyncDataFlowStatus
             {
                 Uploading = options.DataFlow?.Uploading ?? SyncStatus.DataFlowStatus.Uploading,
-                Downloading = options.DataFlow?.Downloading ?? SyncStatus.DataFlowStatus.Downloading
+                Downloading = options.DataFlow?.Downloading ?? SyncStatus.DataFlowStatus.Downloading,
+                DownloadError = updateOptions?.ClearDownloadError == true ? null : options.DataFlow?.DownloadError ?? SyncStatus.DataFlowStatus.DownloadError,
+                UploadError = updateOptions?.ClearUploadError == true ? null : options.DataFlow?.UploadError ?? SyncStatus.DataFlowStatus.UploadError,
             }
         });
 

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

@@ -9,6 +9,20 @@ public class SyncDataFlowStatus
 
     [JsonProperty("uploading")]
     public bool Uploading { get; set; } = false;
+
+    /// <summary>
+    /// Error during downloading (including connecting).
+    /// Cleared on the next successful data download.
+    /// </summary>
+    [JsonProperty("downloadError")]
+    public Exception? DownloadError { get; set; } = null;
+
+    /// <summary>
+    /// Error during uploading.
+    /// Cleared on the next successful upload.
+    /// </summary>
+    [JsonProperty("uploadError")]
+    public Exception? UploadError { get; set; } = null;
 }
 
 public class SyncStatusOptions
@@ -73,7 +87,7 @@ public bool IsEqual(SyncStatus status)
     public string GetMessage()
     {
         var dataFlow = DataFlowStatus;
-        return $"SyncStatus<connected: {Connected} connecting: {Connecting} lastSyncedAt: {LastSyncedAt} hasSynced: {HasSynced}. Downloading: {dataFlow.Downloading}. Uploading: {dataFlow.Uploading}>";
+        return $"SyncStatus<connected: {Connected} connecting: {Connecting} lastSyncedAt: {LastSyncedAt} hasSynced: {HasSynced}. Downloading: {dataFlow.Downloading}. Uploading: {dataFlow.Uploading}. UploadError: ${dataFlow.UploadError}, DownloadError?: ${dataFlow.DownloadError}>";
     }
 
     public string ToJSON()