Merge branch 'main' into maui

Author: Chriztiaan

.github/workflows/dev-packages.yml

@@ -0,0 +1,40 @@
+# The version is pulled from the CHANGELOG.md file of the package.
+# Add a `-dev.xxx` suffix to the version.
+name: Create Dev Release
+
+on: workflow_dispatch
+    
+jobs:
+  dev-release:
+    name: Publish Dev Packages
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0' 
+
+      - name: Download PowerSync extension
+        run: dotnet run --project Tools/Setup    
+
+      - name: Restore dependencies
+        run: dotnet restore
+      
+      - name: Extract Version from CHANGELOG.md
+        id: extract_version
+        shell: bash
+        run: |
+          VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+-dev(\.[0-9]+)?$/ {print $2; exit}' PowerSync/PowerSync.Common/CHANGELOG.md)
+          echo "Detected Version: $VERSION"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV 
+
+      - name: Run Pack
+        run: dotnet pack -c Release -o ${{ github.workspace }}/output
+
+      - name: Run Push
+        run: dotnet nuget push ${{ github.workspace }}\output\*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
+       

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+# The version is pulled from the CHANGELOG.md file of the package.
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  release:
+    name: Release
+    runs-on: windows-latest
+    if: github.ref == 'refs/heads/main'
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0' 
+
+      - name: Download PowerSync extension
+        run: dotnet run --project Tools/Setup    
+
+      - name: Restore dependencies
+        run: dotnet restore
+      
+      - name: Extract Version from CHANGELOG.md
+        id: extract_version
+        shell: bash
+        run: |
+          VERSION=$(awk '/^## [0-9]+\.[0-9]+\.[0-9]+/ {print $2; exit}' PowerSync/PowerSync.Common/CHANGELOG.md)
+          echo "Detected Version: $VERSION"
+          echo "VERSION=$VERSION" >> $GITHUB_ENV 
+
+      - name: Run Pack
+        run: dotnet pack -c Release -o ${{ github.workspace }}/output
+
+      - name: Run Push
+        run: dotnet nuget push ${{ github.workspace }}\output\*.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_API_KEY }}
+       

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test Packages
+
+on:
+  push:
+
+jobs:
+  build:
+    name: Test Packages
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0' 
+
+      - name: Download PowerSync extension
+        run: dotnet run --project Tools/Setup    
+
+      - name: Restore dependencies
+        run: dotnet restore
+      
+      - name: Run tests
+        run: dotnet test -v n --framework net8.0

.gitignore

@@ -60,4 +60,4 @@ TestResults/
 #Core binaries - add rules after ps extension downloading is supported
 *.dylib
 *.dll
-*.so
+*.so

PowerSync/PowerSync.Common/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.0.2-alpha.1
+
+- Introduce package. Support for Desktop .NET use cases.
+
+### Platform Runtime Support Added
+* linux-arm64
+* linux-x64
+* osx-arm64
+* osx-x64
+* wind-x64

PowerSync/PowerSync.Common/Client/PowerSyncDatabase.cs

@@ -28,26 +28,24 @@ public class BasePowerSyncDatabaseOptions()
 
 }
 
-public abstract class DatabaseSource { }
+public interface IDatabaseSource { }
 
-public class DBAdapterSource(IDBAdapter Adapter) : DatabaseSource
+public class DBAdapterSource(IDBAdapter Adapter) : IDatabaseSource
 {
     public IDBAdapter Adapter { get; init; } = Adapter;
 }
 
-public class OpenFactorySource(ISQLOpenFactory Factory) : DatabaseSource
+public class OpenFactorySource(ISQLOpenFactory Factory) : IDatabaseSource
 {
     public ISQLOpenFactory Factory { get; init; } = Factory;
 }
 
-
 public class PowerSyncDatabaseOptions() : BasePowerSyncDatabaseOptions()
 {
     /// <summary> 
     /// Source for a SQLite database connection.
     /// </summary>
-    public DatabaseSource Database { get; set; } = null!;
-
+    public IDatabaseSource Database { get; set; } = null!;
 }
 
 public class PowerSyncDBEvent : StreamingSyncImplementationEvent
@@ -64,6 +62,25 @@ public interface IPowerSyncDatabase : IEventStream<PowerSyncDBEvent>
     public Task<CrudBatch?> GetCrudBatch(int limit);
 
     public Task<CrudTransaction?> GetNextCrudTransaction();
+
+    Task<NonQueryResult> Execute(string query, object[]? parameters = null);
+
+    Task<T[]> GetAll<T>(string sql, params object[]? parameters);
+
+    Task<T?> GetOptional<T>(string sql, params object[]? parameters);
+
+    Task<T> Get<T>(string sql, params object[]? parameters);
+
+    Task<T> ReadLock<T>(Func<ILockContext, Task<T>> fn, DBLockOptions? options = null);
+
+    Task<T> ReadTransaction<T>(Func<ITransaction, Task<T>> fn, DBLockOptions? options = null);
+
+    Task WriteLock(Func<ILockContext, Task> fn, DBLockOptions? options = null);
+    Task<T> WriteLock<T>(Func<ILockContext, Task<T>> fn, DBLockOptions? options = null);
+
+    Task WriteTransaction(Func<ITransaction, Task> fn, DBLockOptions? options = null);
+    Task<T> WriteTransaction<T>(Func<ITransaction, Task<T>> fn, DBLockOptions? options = null);
+
 }
 
 public class PowerSyncDatabase : EventStream<PowerSyncDBEvent>, IPowerSyncDatabase
@@ -103,9 +120,6 @@ public PowerSyncDatabase(PowerSyncDatabaseOptions options)
         }
         else if (options.Database is SQLOpenOptions openOptions)
         {
-            // TODO default to MDSQLite factory for now
-            // Can be broken out, rename this class to Abstract
-            // `this.openDBAdapter(options)`
             Database = new MDSQLiteAdapter(new MDSQLiteAdapterOptions
             {
                 Name = openOptions.DbFilename,
@@ -251,7 +265,7 @@ public async Task UpdateSchema(Schema schema)
 
         try
         {
-            // schema.Validate();
+            schema.Validate();
         }
         catch (Exception ex)
         {
@@ -342,13 +356,19 @@ public async Task Disconnect()
         syncStreamStatusCts?.Cancel();
     }
 
-    public async Task DisconnectAndClear()
+    /// <summary>
+    /// Disconnect and clear the database.
+    /// Use this when logging out.
+    /// The database can still be queried after this is called, but the tables
+    /// would be empty.
+    /// 
+    /// To preserve data in local-only tables, set clearLocal to false.
+    /// </summary>
+    public async Task DisconnectAndClear(bool clearLocal = true)
     {
         await Disconnect();
         await WaitForReady();
 
-        // TODO CL bool clearLocal = options?.ClearLocal ?? false;
-        bool clearLocal = true;
 
         await Database.WriteTransaction(async tx =>
         {
@@ -360,17 +380,23 @@ await Database.WriteTransaction(async tx =>
         Emit(new PowerSyncDBEvent { StatusChanged = CurrentStatus });
     }
 
+    /// <summary>
+    /// Close the database, releasing resources.
+    ///
+    /// Also disconnects any active connection.
+    /// 
+    /// Once close is called, this connection cannot be used again - a new one
+    /// must be constructed.
+    /// </summary>
     public new async Task Close()
     {
-        base.Close();
         await WaitForReady();
 
-        // TODO CL
-        // if (options.Disconnect)
-        // {
-        //     await Disconnect();
-        // }
+        if (Closed) return;
+
 
+        await Disconnect();
+        base.Close();
         syncStreamImplementation?.Close();
         BucketStorageAdapter?.Close();
 
@@ -436,7 +462,7 @@ await Database.WriteTransaction(async tx =>
     /// </summary>
     public async Task<CrudTransaction?> GetNextCrudTransaction()
     {
-        return await Database.ReadTransaction(async tx =>
+        return await ReadTransaction(async tx =>
         {
             var first = await tx.GetOptional<CrudEntryJSON>(
             $"SELECT id, tx_id, data FROM {PSInternalTable.CRUD} ORDER BY id ASC LIMIT 1");
@@ -451,6 +477,7 @@ await Database.WriteTransaction(async tx =>
 
             if (txId == null)
             {
+
                 all = [CrudEntry.FromRow(first)];
             }
             else
@@ -529,15 +556,51 @@ public async Task<T> Get<T>(string query, object[]? parameters = null)
         return await Database.Get<T>(query, parameters);
     }
 
+    public async Task<T> ReadLock<T>(Func<ILockContext, Task<T>> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        return await Database.ReadLock(fn, options);
+    }
+
+    public async Task WriteLock(Func<ILockContext, Task> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        await Database.WriteLock(fn, options);
+    }
+
+    public async Task<T> WriteLock<T>(Func<ILockContext, Task<T>> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        return await Database.WriteLock(fn, options);
+    }
+
+    public async Task<T> ReadTransaction<T>(Func<ITransaction, Task<T>> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        return await Database.ReadTransaction(fn, options);
+    }
+
+    public async Task WriteTransaction(Func<ITransaction, Task> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        await Database.WriteTransaction(fn, options);
+    }
+
+    public async Task<T> WriteTransaction<T>(Func<ITransaction, Task<T>> fn, DBLockOptions? options = null)
+    {
+        await WaitForReady();
+        return await Database.WriteTransaction(fn, options);
+    }
 
     /// <summary>
     /// Executes a read query every time the source tables are modified.
     /// <para />
     /// Use <see cref="SQLWatchOptions.ThrottleMs"/> to specify the minimum interval between queries.
     /// Source tables are automatically detected using <c>EXPLAIN QUERY PLAN</c>.
     /// </summary>
-    public void Watch<T>(string query, object[]? parameters, WatchHandler<T> handler, SQLWatchOptions? options = null)
+    public Task Watch<T>(string query, object[]? parameters, WatchHandler<T> handler, SQLWatchOptions? options = null)
     {
+        var tcs = new TaskCompletionSource<bool>();
         Task.Run(async () =>
         {
             try
@@ -567,12 +630,14 @@ public void Watch<T>(string query, object[]? parameters, WatchHandler<T> handler
                     Signal = options?.Signal,
                     ThrottleMs = options?.ThrottleMs
                 });
+                tcs.SetResult(true);
             }
             catch (Exception ex)
             {
                 handler.OnError?.Invoke(ex);
             }
         });
+        return tcs.Task;
     }
 
     private record ExplainedResult(string opcode, int p2, int p3);
@@ -592,7 +657,6 @@ public async Task<string[]> ResolveTables(string sql, object[]? parameters = nul
                 .Select(row => row.p2)
                 .ToList();
 
-
             var tables = await GetAll<TableSelectResult>(
                 "SELECT DISTINCT tbl_name FROM sqlite_master WHERE rootpage IN (SELECT json_each.value FROM json_each(?))",
                 [JsonConvert.SerializeObject(rootPages)]

PowerSync/PowerSync.Common/Client/SQLOpenFactory.cs

@@ -2,7 +2,7 @@ namespace PowerSync.Common.Client;
 
 using PowerSync.Common.DB;
 
-public class SQLOpenOptions : DatabaseSource
+public class SQLOpenOptions : IDatabaseSource
 {
     /// <summary>
     /// Filename for the database.

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

@@ -50,7 +50,6 @@ public Remote(IPowerSyncBackendConnector connector)
 
         credentials = await connector.FetchCredentials();
 
-        // TODO CL trailing forward slash check
         return credentials;
     }
 
@@ -87,7 +86,6 @@ public async Task<T> Get<T>(string path, Dictionary<string, string>? headers = n
         return JsonConvert.DeserializeObject<T>(responseData)!;
     }
 
-
     public async IAsyncEnumerable<StreamingSyncLine?> PostStream(SyncStreamOptions options)
     {
         using var requestMessage = await BuildRequest(HttpMethod.Post, options.Path, options.Data, options.Headers);
@@ -156,7 +154,6 @@ private async Task<HttpRequestMessage> BuildRequest(HttpMethod method, string pa
 
         if (string.IsNullOrEmpty(credentials.Token))
         {
-            // TODO CL error status code 401
             var error = new HttpRequestException("Not signed in");
             throw error;
         }