Update to IsSuccessful so that it's an optional arg, and true/false h…

…ave correct meaning (#603)
Azure · Feb 10, 2023 · ea9b9ff · ea9b9ff
1 parent 3d60694
commit ea9b9ff
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/sdk/dotnet/src/Microsoft.Datasync.Client/Offline/SyncContext.cs b/sdk/dotnet/src/Microsoft.Datasync.Client/Offline/SyncContext.cs
@@ -343,18 +343,21 @@ public async Task PullItemsAsync(string tableName, string query, PullOptions opt
 
                 if (instance is not JObject item)
                 {
+                    SendPullFinishedEvent(tableName, itemCount, false);
                     throw new DatasyncInvalidOperationException("Received item is not an object");
                 }
 
                 string itemId = ServiceSerializer.GetId(item);
                 if (itemId == null)
                 {
+                    SendPullFinishedEvent(tableName, itemCount, false);
                     throw new DatasyncInvalidOperationException("Received an item without an ID");
                 }
 
                 var pendingOperation = await OperationsQueue.GetOperationByItemIdAsync(tableName, itemId, cancellationToken).ConfigureAwait(false);
                 if (pendingOperation != null)
                 {
+                    SendPullFinishedEvent(tableName, itemCount, false);
                     throw new InvalidOperationException("Received an item for which there is a pending operation.");
                 }
                 DateTimeOffset? updatedAt = ServiceSerializer.GetUpdatedAt(item)?.ToUniversalTime();
@@ -375,7 +378,7 @@ public async Task PullItemsAsync(string tableName, string query, PullOptions opt
                     await DeltaTokenStore.SetDeltaTokenAsync(tableName, queryId, updatedAt.Value, cancellationToken).ConfigureAwait(false);
                 }
             }
-            SendPullFinishedEvent(tableName, itemCount);
+            SendPullFinishedEvent(tableName, itemCount, true);
         }
 
         /// <summary>
@@ -863,11 +866,12 @@ private void SendPullStartedEvent(string tableName)
             ServiceClient.SendSynchronizationEvent(new SynchronizationEventArgs
             {
                 EventType = SynchronizationEventType.PullStarted,
-                TableName = tableName
+                TableName = tableName,
+                IsSuccessful = null
             });
         }
 
-        private void SendPullFinishedEvent(string tableName, long itemsReceived)
+        private void SendPullFinishedEvent(string tableName, long itemsReceived, bool isSuccessful)
         {
             ServiceClient.SendSynchronizationEvent(new SynchronizationEventArgs
             {
@@ -882,7 +886,8 @@ private void SendPushStartedEvent()
             ServiceClient.SendSynchronizationEvent(new SynchronizationEventArgs
             {
                 EventType = SynchronizationEventType.PushStarted,
-                QueueLength = OperationsQueue.PendingOperations
+                QueueLength = OperationsQueue.PendingOperations,
+                IsSuccessful = null
             });
         }
 
@@ -904,7 +909,8 @@ private void SendItemWillBePushedEvent(string tableName, string itemId, long ite
                 ItemsProcessed = itemCount,
                 QueueLength = OperationsQueue.PendingOperations,
                 TableName = tableName,
-                ItemId = itemId
+                ItemId = itemId,
+                IsSuccessful = null
             });
         }
 
@@ -929,7 +935,8 @@ private void SendItemWillBeStoredEvent(string tableName, string itemId, long ite
                 ItemsProcessed = itemCount,
                 QueueLength = expectedItems,
                 TableName = tableName,
-                ItemId = itemId
+                ItemId = itemId,
+                IsSuccessful = null
             });
         }
 
@@ -941,7 +948,8 @@ private void SendItemWasStoredEvent(string tableName, string itemId, long itemCo
                 ItemsProcessed = itemCount,
                 QueueLength = expectedItems,
                 TableName = tableName,
-                ItemId = itemId
+                ItemId = itemId,
+                IsSuccessful = true
             });
         }
         #endregion

diff --git a/sdk/dotnet/src/Microsoft.Datasync.Client/Offline/SynchronizationEventArgs.cs b/sdk/dotnet/src/Microsoft.Datasync.Client/Offline/SynchronizationEventArgs.cs
@@ -51,6 +51,6 @@ public class SynchronizationEventArgs
         /// <summary>
         /// In the case of a result, whether the push was successful or not.
         /// </summary>
-        public bool IsSuccessful { get; internal set; }
+        public bool? IsSuccessful { get; internal set; }
     }
 }
diff --git a/sdk/dotnet/test/Microsoft.Datasync.Client.Test/Offline/SyncContext.Test.cs b/sdk/dotnet/test/Microsoft.Datasync.Client.Test/Offline/SyncContext.Test.cs
@@ -140,6 +140,7 @@ private static void AssertItemWillBePushed(SynchronizationEventArgs args, string
             Assert.Equal(SynchronizationEventType.ItemWillBePushed, args.EventType);
             Assert.Equal(table, args.TableName);
             Assert.Equal(id, args.ItemId);
+            Assert.Null(args.IsSuccessful);
         }
 
         private static void AssertItemWasPushed(SynchronizationEventArgs args, string table, string id, bool success)