Merge branch 'feat/progress-priorities' into feat/app-metadata

Chriztiaan · Chriztiaan · commit 11a417394e23 · 2025-12-11T09:31:28.000+02:00
diff --git a/.github/workflows/dev-packages.yml b/.github/workflows/dev-packages.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Setup .NET SDK
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '8.0.x'
 
       - name: Install MAUI Workloads
         run: dotnet workload restore
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Setup .NET SDK
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '8.0.x'
 
       - name: Install MAUI Workloads
         run: dotnet workload restore
diff --git a/PowerSync/PowerSync.Common/CHANGELOG.md b/PowerSync/PowerSync.Common/CHANGELOG.md
@@ -1,8 +1,14 @@
 # PowerSync.Common Changelog
 
 ## 0.0.6-alpha.1
-- Added ability to specify `AppMetadata` for sync/stream requests.
-
+- Dropping support for the legacy C# sync implementation.
+- Add `trackPreviousValues` option on `TableOptions` which sets `CrudEntry.PreviousValues` to previous values on updates.
+- Add `trackMetadata` option on `TableOptions` which adds a `_metadata` column that can be used for updates. The configured metadata is available through `CrudEntry.Metadata`.
+- Add `ignoreEmptyUpdates` option on `TableOptions` which skips creating CRUD entries for updates that don't change any values.
+- Reporting progress information about downloaded rows. Sync progress is available through `SyncStatus.DownloadProgress()`.
+- Support bucket priorities.
+- Report `PriorityStatusEntries` on `SyncStatus`.
+- Added ability to specify `AppMetadata` for sync/stream requests
 Note: This requires a PowerSync service version `>=1.17.0` in order for logs to display metadata.
 
 ```csharp
diff --git a/PowerSync/PowerSync.Common/Client/PowerSyncDatabase.cs b/PowerSync/PowerSync.Common/Client/PowerSyncDatabase.cs
@@ -80,8 +80,6 @@ public interface IPowerSyncDatabase : IEventStream<PowerSyncDBEvent>
 
 public class PowerSyncDatabase : EventStream<PowerSyncDBEvent>, IPowerSyncDatabase
 {
-    private static readonly int FULL_SYNC_PRIORITY = 2147483647;
-
     public IDBAdapter Database;
     private Schema schema;
 
diff --git a/PowerSync/PowerSync.Common/Client/Sync/Stream/CoreInstructions.cs b/PowerSync/PowerSync.Common/Client/Sync/Stream/CoreInstructions.cs
@@ -138,7 +138,7 @@ public static DB.Crud.SyncPriorityStatus PriorityToStatus(SyncPriorityStatus sta
         {
             Priority = status.Priority,
             HasSynced = status.HasSynced ?? null,
-            LastSyncedAt = status?.LastSyncedAt != null ? new DateTime(status!.LastSyncedAt) : null
+            LastSyncedAt = status?.LastSyncedAt != null ? DateTimeOffset.FromUnixTimeSeconds(status!.LastSyncedAt).DateTime : null
         };
     }
 
diff --git a/PowerSync/PowerSync.Common/DB/Crud/CrudEntry.cs b/PowerSync/PowerSync.Common/DB/Crud/CrudEntry.cs
@@ -48,28 +48,6 @@ public class CrudEntryDataJSON
     public string? Metadata { get; set; }
 }
 
-public class CrudEntryOutputJSON
-{
-    [JsonProperty("op_id")]
-    public int OpId { get; set; }
-
-    [JsonProperty("op")]
-    public UpdateType Op { get; set; }
-
-    [JsonProperty("type")]
-    public string Type { get; set; } = null!;
-
-    [JsonProperty("id")]
-    public string Id { get; set; } = null!;
-
-    [JsonProperty("tx_id")]
-    public long? TransactionId { get; set; }
-
-    [JsonProperty("data")]
-    public Dictionary<string, object>? Data { get; set; }
-}
-
-
 public class CrudEntry(
     int clientId,
     UpdateType op,
@@ -84,6 +62,7 @@ public class CrudEntry(
     public int ClientId { get; private set; } = clientId;
     public string Id { get; private set; } = id;
     public UpdateType Op { get; private set; } = op;
+
     public Dictionary<string, object>? OpData { get; private set; } = opData;
     public string Table { get; private set; } = table;
     public long? TransactionId { get; private set; } = transactionId;
diff --git a/PowerSync/PowerSync.Common/DB/Crud/SyncProgress.cs b/PowerSync/PowerSync.Common/DB/Crud/SyncProgress.cs
@@ -68,7 +68,7 @@ public class ProgressWithOperations
     public int TotalOperations { get; set; }
 
     /// <summary>
-    /// The numnber of operations that have already been downloaded.
+    /// The number of operations that have already been downloaded.
     /// </summary>
     public int DownloadedOperations { get; set; }
 
diff --git a/PowerSync/PowerSync.Common/DB/Schema/Table.cs b/PowerSync/PowerSync.Common/DB/Schema/Table.cs
@@ -9,7 +9,7 @@ public class TableOptions(
     bool? insertOnly = null,
     string? viewName = null,
     bool? trackMetadata = null,
-    TrackPreviousOptions? trackPreviousOptions = null,
+    TrackPreviousOptions? trackPreviousValues = null,
     bool? ignoreEmptyUpdates = null
 )
 {
@@ -25,18 +25,18 @@ public class TableOptions(
     /// Whether to add a hidden `_metadata` column that will be enabled for updates to attach custom
     /// information about writes that will be reported through [CrudEntry.metadata].
     /// </summary>
-    public bool TrackMetadata { get; } = trackMetadata ?? false;
+    public bool TrackMetadata { get; set; } = trackMetadata ?? false;
 
     /// <summary>
     /// When set to a non-null value, track old values of columns
     /// </summary>
-    public TrackPreviousOptions? TrackPreviousOptions { get; } = trackPreviousOptions ?? null;
+    public TrackPreviousOptions? TrackPreviousValues { get; set; } = trackPreviousValues ?? null;
 
     /// <summary>
     /// Whether an `UPDATE` statement that doesn't change any values should be ignored when creating
     /// CRUD entries.
     /// </summary>
-    public bool IgnoreEmptyUpdates { get; } = ignoreEmptyUpdates ?? false;
+    public bool IgnoreEmptyUpdates { get; set; } = ignoreEmptyUpdates ?? false;
 }
 
 /// <summary>
@@ -53,8 +53,7 @@ public class TrackPreviousOptions
     public List<string>? Columns { get; set; }
 
     /// <summary>
-    /// Whether to only include old values when they were changed by an update, instead of always
-    /// including all old values,
+    /// When enabled, only include values that have actually been changed by an update.
     /// </summary>
     [JsonProperty("onlyWhenChanged")]
     public bool? OnlyWhenChanged { get; set; }
@@ -117,7 +116,7 @@ public void Validate()
             throw new Exception("Can't include metadata for local-only tables.");
         }
 
-        if (Options.TrackPreviousOptions != null && Options.LocalOnly)
+        if (Options.TrackPreviousValues != null && Options.LocalOnly)
         {
             throw new Exception("Can't include old values for local-only tables.");
         }
@@ -161,7 +160,7 @@ public void Validate()
 
     public string ToJSON(string Name = "")
     {
-        var trackPrevious = Options.TrackPreviousOptions;
+        var trackPrevious = Options.TrackPreviousValues;
 
         var jsonObject = new
         {
diff --git a/PowerSync/PowerSync.Maui/CHANGELOG.md b/PowerSync/PowerSync.Maui/CHANGELOG.md
@@ -1,8 +1,7 @@
 # PowerSync.Maui Changelog
 
 ## 0.0.4-alpha.1
-- Upstream PowerSync.Common version bump
-- Added ability to specify `AppMetadata` sync/stream requests (see Common changelog).
+- Upstream PowerSync.Common version bump (See Powersync.Common changelog for more information)
 
 ## 0.0.3-alpha.1
 - Upstream PowerSync.Common version bump
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
   <a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
 </p>
 
-_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB or MySQL on the server-side._
+_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB, MySQL or SQL Server on the server-side._
 
 # PowerSync .NET SDKs
 
diff --git a/Tests/PowerSync/PowerSync.Common.IntegrationTests/NodeClient.cs b/Tests/PowerSync/PowerSync.Common.IntegrationTests/NodeClient.cs
@@ -32,6 +32,7 @@ public Task<string> CreateList(string id, string name)
     {
         return CreateItem("lists", id, name);
     }
+
     async Task<string> CreateItem(string table, string id, string name)
     {
         var data = new Dictionary<string, object>
@@ -74,6 +75,55 @@ public Task<string> DeleteList(string id)
         return DeleteItem("lists", id);
     }
 
+    public Task<string> CreateTodo(string id, string listId, string description)
+    {
+        return CreateTodoItem("todos", id, listId, description);
+    }
+
+    async Task<string> CreateTodoItem(string table, string id, string listId, string description)
+    {
+        var data = new Dictionary<string, object>
+        {
+            { "created_at", DateTime.UtcNow.ToString("yyyy-MM-dd HH:mm:ss") },
+            { "description", description },
+            { "list_id", listId },
+            { "created_by", _userId },
+            { "completed", 0 },
+        };
+
+        var batch = new[]
+        {
+            new
+            {
+                op = UpdateType.PUT.ToString(),
+                table = table,
+                id = id,
+                data = data
+            }
+        };
+
+        var payload = JsonSerializer.Serialize(new { batch });
+        var content = new StringContent(payload, Encoding.UTF8, "application/json");
+
+        HttpResponseMessage response = await _httpClient.PostAsync($"{_backendUrl}/api/data", content);
+
+        if (!response.IsSuccessStatusCode)
+        {
+            Console.WriteLine(await response.Content.ReadAsStringAsync());
+            throw new Exception(
+                $"Failed to create todo. Status: {response.StatusCode}, " +
+                $"Response: {await response.Content.ReadAsStringAsync()}"
+            );
+        }
+
+        return await response.Content.ReadAsStringAsync();
+    }
+
+    public Task<string> DeleteTodo(string id)
+    {
+        return DeleteItem("todos", id);
+    }
+
     async Task<string> DeleteItem(string table, string id)
     {
         var batch = new[]
diff --git a/Tests/PowerSync/PowerSync.Common.IntegrationTests/SyncIntegrationTests.cs b/Tests/PowerSync/PowerSync.Common.IntegrationTests/SyncIntegrationTests.cs
@@ -1,8 +1,4 @@
-using Newtonsoft.Json;
 using PowerSync.Common.Client;
-using System.Data.Common;
-using System.Diagnostics;
-using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using PowerSync.Common.Client.Sync.Stream;
 
@@ -14,6 +10,8 @@ public class SyncIntegrationTests : IAsyncLifetime
 {
     private record ListResult(string id, string name, string owner_id, string created_at);
 
+    private record TodoResult(string id, string list_id, string content, string owner_id, string created_at);
+
     private string userId = Uuid();
 
     private NodeClient nodeClient = default!;
@@ -223,8 +221,67 @@ await db.Execute("insert into lists (id, name, owner_id, created_at) values (uui
         await backendInsertWatch.Task;
     }
 
+
+    /// <summary>
+    /// Helper that requires manual setup of the data to verify that download progress updates are working.
+    /// Ensure backend has 5000+ entries, then run this test to see progress updates in the console. 
+    /// </summary>
+    // [IntegrationFact(Timeout = 10000)]
+    // public async Task InitialSyncDownloadProgressTest()
+    // {
+    //     ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
+    //     {
+    //         builder.AddConsole();
+    //         builder.SetMinimumLevel(LogLevel.Information);
+    //     });
+
+    //     var logger = loggerFactory.CreateLogger("PowerSyncLogger");
+
+    //     nodeClient = new NodeClient(userId);
+    //     db = new PowerSyncDatabase(new PowerSyncDatabaseOptions
+    //     {
+    //         Database = new SQLOpenOptions { DbFilename = "powersync-sync-progress-tests.db" },
+    //         Schema = TestSchema.PowerSyncSchema,
+    //         Logger = logger
+
+    //     });
+    //     await db.Init();
+    //     await db.DisconnectAndClear();
+
+
+    //     var clearListener = db.RunListener((update) =>
+    //     {
+    //         if (update.StatusChanged != null)
+    //         {
+    //             try
+    //             {
+    //                 Console.WriteLine("Total: " + update.StatusChanged.DownloadProgress()?.TotalOperations + " Downloaded: " + update.StatusChanged.DownloadProgress()?.DownloadedOperations);
+    //                 Console.WriteLine("Synced: " + Math.Round((decimal)((update.StatusChanged.DownloadProgress()?.DownloadedFraction ?? 0) * 100)) + "%");
+
+    //             }
+    //             catch (Exception ex)
+    //             {
+    //                 Console.WriteLine("Exception reading DownloadProgress: " + ex);
+    //             }
+    //         }
+    //     });
+
+    //     var connector = new NodeConnector(userId);
+    //     await db.Connect(connector);
+    //     await db.WaitForFirstSync();
+
+
+    //     clearListener.Dispose();
+    //     await db.DisconnectAndClear();
+    //     await db.Close();
+    // }
+
     private async Task ClearAllData()
     {
+        if (db.Closed)
+        {
+            return;
+        }
         // Inefficient but simple way to clear all data, avoiding payload limitations
         var results = await db.GetAll<ListResult>("select * from lists");
         foreach (var item in results)
diff --git a/Tests/PowerSync/PowerSync.Common.Tests/Client/Sync/CRUDTests.cs b/Tests/PowerSync/PowerSync.Common.Tests/Client/Sync/CRUDTests.cs
diff --git a/Tests/PowerSync/PowerSync.Common.Tests/TestSchema.cs b/Tests/PowerSync/PowerSync.Common.Tests/TestSchema.cs
diff --git a/global.json b/global.json

Original file line number	Diff line number	Diff line change
`@@ -80,8 +80,6 @@ public interface IPowerSyncDatabase : IEventStream<PowerSyncDBEvent>`
`80`	`80`
`81`	`81`	`public class PowerSyncDatabase : EventStream<PowerSyncDBEvent>, IPowerSyncDatabase`
`82`	`82`	`{`
`83`		`- private static readonly int FULL_SYNC_PRIORITY = 2147483647;`
`84`		`-`
`85`	`83`	`public IDBAdapter Database;`
`86`	`84`	`private Schema schema;`
`87`	`85`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ public static DB.Crud.SyncPriorityStatus PriorityToStatus(SyncPriorityStatus sta`
`138`	`138`	`{`
`139`	`139`	`Priority = status.Priority,`
`140`	`140`	`HasSynced = status.HasSynced ?? null,`
`141`		`- LastSyncedAt = status?.LastSyncedAt != null ? new DateTime(status!.LastSyncedAt) : null`
	`141`	`+ LastSyncedAt = status?.LastSyncedAt != null ? DateTimeOffset.FromUnixTimeSeconds(status!.LastSyncedAt).DateTime : null`
`142`	`142`	`};`
`143`	`143`	`}`
`144`	`144`