-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathPowerSyncDatabase.cs
More file actions
1025 lines (849 loc) · 35.1 KB
/
PowerSyncDatabase.cs
File metadata and controls
1025 lines (849 loc) · 35.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
namespace PowerSync.Common.Client;
using System.Runtime.CompilerServices;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Newtonsoft.Json;
using Nito.AsyncEx;
using PowerSync.Common.Client.Connection;
using PowerSync.Common.Client.Sync.Bucket;
using PowerSync.Common.Client.Sync.Stream;
using PowerSync.Common.DB;
using PowerSync.Common.DB.Crud;
using PowerSync.Common.DB.Schema;
using PowerSync.Common.MDSQLite;
using PowerSync.Common.Utils;
public class BasePowerSyncDatabaseOptions()
{
/// <summary>
/// Schema used for the local database.
/// </summary>
public Schema Schema { get; set; } = null!;
public ILogger? Logger { get; set; } = null!;
}
public interface IDatabaseSource { }
public class DBAdapterSource(IDBAdapter Adapter) : IDatabaseSource
{
public IDBAdapter Adapter { get; init; } = Adapter;
}
public class PowerSyncDatabaseOptions() : BasePowerSyncDatabaseOptions()
{
/// <summary>
/// Source for a SQLite database connection.
/// </summary>
public IDatabaseSource Database { get; set; } = null!;
/// <summary>
/// Optional factory for creating the Remote instance.
/// Used for testing to inject mock implementations.
/// If not provided, a default Remote will be created.
/// </summary>
public Func<IPowerSyncBackendConnector, Remote>? RemoteFactory { get; set; }
}
public class PowerSyncDBEvent : StreamingSyncImplementationEvent
{
public bool? Initialized { get; set; }
public Schema? SchemaChanged { get; set; }
public bool? Closing { get; set; }
public bool? Closed { get; set; }
}
public interface IPowerSyncDatabase : IEventStream<PowerSyncDBEvent>
{
public Task Connect(IPowerSyncBackendConnector connector, PowerSyncConnectionOptions? options = null);
public ISyncStream SyncStream(string name, Dictionary<string, object>? parameters = null);
public Task<string> GetClientId();
public Task<CrudBatch?> GetCrudBatch(int limit);
public Task<CrudTransaction?> GetNextCrudTransaction();
Task<NonQueryResult> Execute(string query, object?[]? parameters = null);
Task<NonQueryResult> ExecuteBatch(string query, object?[][]? parameters = null);
Task<T[]> GetAll<T>(string sql, object?[]? parameters = null);
Task<dynamic[]> GetAll(string sql, object?[]? parameters = null);
Task<T?> GetOptional<T>(string sql, object?[]? parameters = null);
Task<dynamic?> GetOptional(string sql, object?[]? parameters = null);
Task<T> Get<T>(string sql, object?[]? parameters = null);
Task<dynamic> Get(string sql, object?[]? parameters = null);
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
{
public IDBAdapter Database { get; protected set; }
private CompiledSchema schema;
private static readonly int DEFAULT_WATCH_THROTTLE_MS = 30;
private static readonly Regex POWERSYNC_TABLE_MATCH = new Regex(@"(^ps_data__|^ps_data_local__)", RegexOptions.Compiled);
public new bool Closed { get; protected set; }
public bool Ready { get; protected set; }
protected Task IsReadyTask;
protected ConnectionManager ConnectionManager;
private readonly InternalSubscriptionManager subscriptions;
private StreamingSyncImplementation? syncStreamImplementation;
public string SdkVersion { get; protected set; }
protected IBucketStorageAdapter BucketStorageAdapter;
public SyncStatus CurrentStatus { get; protected set; }
protected CancellationTokenSource masterCts = new();
protected CancellationTokenSource? syncStreamStatusCts;
public ILogger Logger { get; protected set; }
private readonly AsyncLock runExclusive = new();
private readonly Func<IPowerSyncBackendConnector, Remote> remoteFactory;
public StreamingSyncImplementation? SyncStreamImplementation => ConnectionManager.SyncStreamImplementation;
public IPowerSyncBackendConnector? Connector => ConnectionManager.Connector;
public bool Connected => CurrentStatus.Connected;
public bool Connecting => CurrentStatus.Connecting;
public PowerSyncConnectionOptions? ConnectionOptions => ConnectionManager.ConnectionOptions;
public PowerSyncDatabase(PowerSyncDatabaseOptions options)
{
if (options.Database is DBAdapterSource adapterSource)
{
Database = adapterSource.Adapter;
}
else if (options.Database is ISQLOpenFactory factorySource)
{
Database = factorySource.OpenDatabase();
}
else if (options.Database is SQLOpenOptions openOptions)
{
Database = new MDSQLiteAdapter(new MDSQLiteAdapterOptions
{
Name = openOptions.DbFilename,
SqliteOptions = null
});
}
else
{
throw new ArgumentException("The provided `Database` option is invalid.");
}
Logger = options.Logger ?? NullLogger.Instance;
CurrentStatus = new SyncStatus(new SyncStatusOptions());
BucketStorageAdapter = generateBucketStorageAdapter();
Closed = false;
Ready = false;
schema = options.Schema.Compile();
SdkVersion = "";
remoteFactory = options.RemoteFactory ?? (connector => new Remote(connector));
// Start async init
subscriptions = new InternalSubscriptionManager(
firstStatusMatching: WaitForStatus,
resolveOfflineSyncStatus: ResolveOfflineSyncStatus,
subscriptionsCommand: async (payload) => await this.WriteTransaction(async tx =>
{
await tx.Execute("SELECT powersync_control(?, ?) AS r", ["subscriptions", JsonConvert.SerializeObject(payload)]);
}));
ConnectionManager = new ConnectionManager(createSyncImplementation: async (connector, options) =>
{
await WaitForReady();
using (await runExclusive.LockAsync())
{
syncStreamImplementation = new StreamingSyncImplementation(new StreamingSyncImplementationOptions
{
Adapter = BucketStorageAdapter,
Remote = remoteFactory(connector),
UploadCrud = async () =>
{
await WaitForReady();
await connector.UploadData(this);
},
RetryDelayMs = options.RetryDelayMs,
Subscriptions = options.Subscriptions,
CrudUploadThrottleMs = options.CrudUploadThrottleMs,
Logger = Logger
});
var syncStreamStatusCts = CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token);
var syncStreamStatusListener = syncStreamImplementation.ListenAsync(syncStreamStatusCts.Token);
var _ = Task.Run(async () =>
{
await foreach (var update in syncStreamStatusListener)
{
if (update.StatusChanged != null)
{
CurrentStatus = new SyncStatus(new SyncStatusOptions(update.StatusChanged.Options)
{
HasSynced = CurrentStatus?.HasSynced == true || update.StatusChanged.LastSyncedAt != null,
});
Emit(new PowerSyncDBEvent { StatusChanged = CurrentStatus });
}
}
});
await syncStreamImplementation.WaitForReady();
return new ConnectionManagerSyncImplementationResult(syncStreamImplementation, () => syncStreamStatusCts.Cancel());
}
}, logger: Logger);
IsReadyTask = Initialize(options);
}
protected IBucketStorageAdapter generateBucketStorageAdapter()
{
return new SqliteBucketStorage(Database, Logger);
}
/// <summary>
/// Resolves once initialization is completed.
/// </summary>
public async Task WaitForReady()
{
if (Ready)
{
return;
}
await IsReadyTask;
}
public class PrioritySyncRequest
{
public CancellationToken? Token { get; set; }
public int? Priority { get; set; }
}
/// <summary>
/// Wait for the first sync operation to complete.
/// </summary>
/// <param name="request">
/// An object providing a cancellation token and a priority target.
/// When a priority target is set, the task may complete when all buckets with the given (or higher)
/// priorities have been synchronized. This can be earlier than a complete sync.
/// </param>
/// <returns>A task which will complete once the first full sync has completed.</returns>
public async Task WaitForFirstSync(PrioritySyncRequest? request = null)
{
var priority = request?.Priority;
var cancellationToken = request?.Token;
Func<SyncStatus, bool> statusMatches = priority == null
? status => status.HasSynced == true
: status => status.StatusForPriority(priority.Value).HasSynced == true;
await WaitForStatus(statusMatches, cancellationToken);
}
/// <summary>
/// Waits for the first sync status for which the <paramref name="predicate"/> callback returns true.
/// </summary>
/// <param name="predicate">A function that evaluates the sync status and returns true when the desired condition is met.</param>
/// <param name="cancellationToken">Optional cancellation token to abort the wait.</param>
public async Task WaitForStatus(Func<SyncStatus, bool> predicate, CancellationToken? cancellationToken = null)
{
var cts = cancellationToken == null
? CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token)
: CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token, cancellationToken.Value);
var statusListener = ListenAsync(cts.Token);
if (predicate(CurrentStatus))
{
cts.Cancel();
return;
}
var tcs = new TaskCompletionSource<bool>();
_ = Task.Run(async () =>
{
try
{
await foreach (var update in statusListener)
{
if ((update.StatusChanged != null) && predicate(update.StatusChanged))
{
tcs.TrySetResult(true);
cts.Cancel();
}
}
}
catch (OperationCanceledException) { }
});
await tcs.Task;
}
protected async Task Initialize(PowerSyncDatabaseOptions options)
{
await BucketStorageAdapter.Init();
await LoadVersion();
await UpdateSchema(options.Schema);
await ResolveOfflineSyncStatus();
await Database.Execute("PRAGMA RECURSIVE_TRIGGERS=TRUE");
Ready = true;
Emit(new PowerSyncDBEvent { Initialized = true });
}
private record VersionResult(string version);
private async Task LoadVersion()
{
string sdkVersion = (await Database.Get<VersionResult>("SELECT powersync_rs_version() as version")).version;
SdkVersion = sdkVersion;
int[] versionInts;
try
{
versionInts = [.. sdkVersion
.Split(['.', '/'], StringSplitOptions.RemoveEmptyEntries)
.Take(3)
.Select(n => int.Parse(n))];
}
catch (Exception e)
{
throw new Exception(
$"Unsupported PowerSync extension version. Need >=0.4.5 <1.0.0, got: {sdkVersion}. Details: {e.Message}"
);
}
// Validate version is >= 0.4.5 and < 1.0.0
if (versionInts[0] != 0 || versionInts[1] < 4 || (versionInts[1] == 4 && versionInts[2] < 5))
{
throw new Exception($"Unsupported PowerSync extension version. Need >=0.4.5 <1.0.0, got: {sdkVersion}");
}
}
private record OfflineSyncStatusResult(string r);
protected async Task ResolveOfflineSyncStatus()
{
var result = await Database.Get<OfflineSyncStatusResult>("SELECT powersync_offline_sync_status() as r");
var parsed = JsonConvert.DeserializeObject<CoreSyncStatus>(result.r);
var parsedSyncStatus = CoreInstructionHelpers.CoreStatusToSyncStatus(parsed!);
var updatedStatus = CurrentStatus.CreateUpdatedStatus(parsedSyncStatus);
if (!updatedStatus.IsEqual(CurrentStatus))
{
CurrentStatus = updatedStatus;
Emit(new PowerSyncDBEvent { StatusChanged = CurrentStatus });
}
}
/// <summary>
/// Replace the schema with a new version. This is for advanced use cases - typically the schema should just be specified once in the constructor.
/// Cannot be used while connected - this should only be called before <see cref="Connect"/>.
/// </summary>
public async Task UpdateSchema(Schema schema)
{
CompiledSchema compiledSchema = schema.Compile();
if (syncStreamImplementation != null)
{
throw new Exception("Cannot update schema while connected");
}
try
{
compiledSchema.Validate();
}
catch (Exception ex)
{
Logger.LogWarning("Schema validation failed. Unexpected behavior could occur: {Exception}", ex);
}
this.schema = compiledSchema;
await Database.Execute("SELECT powersync_replace_schema(?)", [compiledSchema.ToJSON()]);
await Database.RefreshSchema();
Emit(new PowerSyncDBEvent { SchemaChanged = schema });
}
/// <summary>
/// Wait for initialization to complete.
/// While initializing is automatic, this helps to catch and report initialization errors.
/// </summary>
public async Task Init()
{
await WaitForReady();
}
private RequiredAdditionalConnectionOptions resolveConnectionOptions(PowerSyncConnectionOptions? options)
{
var defaults = RequiredAdditionalConnectionOptions.DEFAULT_ADDITIONAL_CONNECTION_OPTIONS;
return new RequiredAdditionalConnectionOptions
{
RetryDelayMs = options?.RetryDelayMs ?? defaults.RetryDelayMs,
CrudUploadThrottleMs = options?.CrudUploadThrottleMs ?? defaults.CrudUploadThrottleMs,
};
}
public async Task Connect(IPowerSyncBackendConnector connector, PowerSyncConnectionOptions? options = null)
{
await WaitForReady();
// close connection if one is open
await Disconnect();
if (Closed)
{
throw new Exception("Cannot connect using a closed client");
}
var resolvedOptions = options ?? new PowerSyncConnectionOptions();
await ConnectionManager.Connect(connector, resolvedOptions);
}
public async Task Disconnect()
{
await ConnectionManager.Disconnect();
}
/// <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();
await Database.WriteTransaction(async tx =>
{
await tx.Execute("SELECT powersync_clear(?)", [clearLocal ? 1 : 0]);
});
// The data has been deleted - reset the sync status
CurrentStatus = new SyncStatus(new SyncStatusOptions());
Emit(new PowerSyncDBEvent { StatusChanged = CurrentStatus });
}
/// <summary>
/// Create a sync stream to query its status or to subscribe to it.
///
/// Sync streams are currently in alpha.
/// </summary>
public ISyncStream SyncStream(string name, Dictionary<string, object>? parameters = null)
{
return ConnectionManager.Stream(subscriptions, name, parameters);
}
/// <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()
{
await WaitForReady();
if (Closed) return;
Emit(new PowerSyncDBEvent { Closing = true });
await Disconnect();
base.Close();
masterCts.Cancel();
masterCts.Dispose();
ConnectionManager.Close();
BucketStorageAdapter?.Close();
await Database.Close();
Closed = true;
Emit(new PowerSyncDBEvent { Closed = true });
}
private record UploadQueueStatsSizeCountResult(long size, long count);
private record UploadQueueStatsCountResult(long count);
/// <summary>
/// Get upload queue size estimate and count.
/// </summary>
public async Task<UploadQueueStats> GetUploadQueueStats(bool includeSize = false)
{
return await ReadTransaction(async tx =>
{
if (includeSize)
{
var result = await tx.Get<UploadQueueStatsSizeCountResult>(
$"SELECT SUM(cast(data as blob) + 20) as size, count(*) as count FROM {PSInternalTable.CRUD}"
);
return new UploadQueueStats(result.count, result.size);
}
else
{
var result = await tx.Get<UploadQueueStatsCountResult>(
$"SELECT count(*) as count FROM {PSInternalTable.CRUD}"
);
return new UploadQueueStats(result.count);
}
});
}
/// <summary>
/// Get a batch of crud data to upload.
/// <para />
/// Returns null if there is no data to upload.
/// <para />
/// Use this from the <see cref="IPowerSyncBackendConnector.UploadData"/> callback.
///
/// Once the data have been successfully uploaded, call <see cref="CrudBatch.Complete"/> before
/// requesting the next batch.
/// <para />
/// Use <paramref name="limit"/> to specify the maximum number of updates to return in a single
/// batch.
/// <para />
/// This method does include transaction ids in the result, but does not group
/// data by transaction. One batch may contain data from multiple transactions,
/// and a single transaction may be split over multiple batches.
/// </summary>
public async Task<CrudBatch?> GetCrudBatch(int limit = 100)
{
var crudResult = await GetAll<CrudEntryJSON>($"SELECT id, tx_id as transactionId, data FROM {PSInternalTable.CRUD} ORDER BY id ASC LIMIT ?", [limit + 1]);
var all = crudResult.Select(CrudEntry.FromRow).ToList();
var haveMore = false;
if (all.Count > limit)
{
all.RemoveAt(all.Count - 1);
haveMore = true;
}
if (all.Count == 0)
{
return null;
}
var last = all[all.Count - 1];
return new CrudBatch(
[.. all],
haveMore,
async writeCheckpoint => await HandleCrudCheckpoint(last.ClientId, writeCheckpoint)
);
}
/// <summary>
/// Get the next recorded transaction to upload.
/// <para />
/// Returns null if there is no data to upload.
///
/// Use this from the <see cref="IPowerSyncBackendConnector.UploadData"/> callback.
/// <para />
/// Once the data have been successfully uploaded, call <see cref="CrudTransaction.Complete"/> before
/// requesting the next transaction.
/// <para />
/// Unlike <see cref="GetCrudBatch"/>, this only returns data from a single transaction at a time.
/// All data for the transaction is loaded into memory.
/// </summary>
public async Task<CrudTransaction?> GetNextCrudTransaction()
{
return await ReadTransaction(async tx =>
{
var first = await tx.GetOptional<CrudEntryJSON>(
$"SELECT id, tx_id AS transactionId, data FROM {PSInternalTable.CRUD} ORDER BY id ASC LIMIT 1");
if (first == null)
{
return null;
}
long? txId = first.TransactionId;
List<CrudEntry> all;
if (txId == null)
{
all = [CrudEntry.FromRow(first)];
}
else
{
var result = await tx.GetAll<CrudEntryJSON>(
$"SELECT id, tx_id as transactionId, data FROM {PSInternalTable.CRUD} WHERE tx_id = ? ORDER BY id ASC",
[txId]);
all = result.Select(CrudEntry.FromRow).ToList();
}
var last = all.Last();
return new CrudTransaction(
[.. all],
async writeCheckpoint => await HandleCrudCheckpoint(last.ClientId, writeCheckpoint),
txId
);
});
}
public async Task HandleCrudCheckpoint(long lastClientId, string? writeCheckpoint = null)
{
await Database.WriteTransaction(async (tx) =>
{
await tx.Execute($"DELETE FROM {PSInternalTable.CRUD} WHERE id <= ?", [lastClientId]);
if (!string.IsNullOrEmpty(writeCheckpoint))
{
var check = await tx.GetAll<object>($"SELECT 1 FROM {PSInternalTable.CRUD} LIMIT 1");
if (check.Length == 0)
{
await tx.Execute($"UPDATE {PSInternalTable.BUCKETS} SET target_op = CAST(? as INTEGER) WHERE name='$local'", [
writeCheckpoint
]);
}
}
else
{
await tx.Execute(
$"UPDATE {PSInternalTable.BUCKETS} SET target_op = CAST(? as INTEGER) WHERE name = '$local'",
[BucketStorageAdapter.GetMaxOpId()]);
}
});
}
/// <summary>
/// Get an unique client id for this database.
///
/// The id is not reset when the database is cleared, only when the database is deleted.
/// </summary>
public async Task<string> GetClientId()
{
return await BucketStorageAdapter.GetClientId();
}
public async Task<NonQueryResult> Execute(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.Execute(query, parameters);
}
public async Task<NonQueryResult> ExecuteBatch(string query, object?[][]? parameters = null)
{
await WaitForReady();
return await Database.ExecuteBatch(query, parameters);
}
public async Task<T[]> GetAll<T>(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.GetAll<T>(query, parameters);
}
public async Task<dynamic[]> GetAll(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.GetAll(query, parameters);
}
public async Task<T?> GetOptional<T>(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.GetOptional<T>(query, parameters);
}
public async Task<dynamic?> GetOptional(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.GetOptional(query, parameters);
}
public async Task<T> Get<T>(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.Get<T>(query, parameters);
}
public async Task<dynamic> Get(string query, object?[]? parameters = null)
{
await WaitForReady();
return await Database.Get(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);
}
public IAsyncEnumerable<WatchOnChangeEvent> OnChange(SQLWatchOptions? options = null)
{
options ??= new SQLWatchOptions();
var tables = options?.Tables ?? [];
var powersyncTables = new HashSet<string>(
tables.SelectMany(table => new[] { $"ps_data__{table}", $"ps_data_local__{table}" })
);
var signal = options?.Signal != null
? CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token, options.Signal.Value)
: CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token);
var listener = Database.ListenAsync(signal.Token);
// Return the actual IAsyncEnumerable here, using OnChange as a synchronous wrapper that blocks until the
// connection is established
return OnChangeCore(powersyncTables, listener, signal.Token, options?.TriggerImmediately == true);
}
private async IAsyncEnumerable<WatchOnChangeEvent> OnChangeCore(
HashSet<string> watchedTables,
IAsyncEnumerable<DBAdapterEvent> listener,
[EnumeratorCancellation] CancellationToken signal,
bool triggerImmediately
)
{
if (triggerImmediately == true)
{
yield return new WatchOnChangeEvent { ChangedTables = [] };
}
HashSet<string> changedTables = new();
await foreach (var e in listener)
{
if (signal.IsCancellationRequested) yield break;
if (e.TablesUpdated == null) continue;
changedTables.Clear();
GetTablesFromNotification(e.TablesUpdated, changedTables);
changedTables.IntersectWith(watchedTables);
if (changedTables.Count == 0) continue;
var update = new WatchOnChangeEvent { ChangedTables = [.. changedTables] };
// Convert from 'ps_data__<name>' to '<name>'
for (int i = 0; i < update.ChangedTables.Length; i++)
{
update.ChangedTables[i] = InternalToFriendlyTableName(update.ChangedTables[i]);
}
yield return update;
}
}
private static string InternalToFriendlyTableName(string internalName)
{
const string PS_DATA_PREFIX = "ps_data__";
const string PS_DATA_LOCAL_PREFIX = "ps_data_local__";
if (internalName.StartsWith(PS_DATA_PREFIX))
return internalName.Substring(PS_DATA_PREFIX.Length);
if (internalName.StartsWith(PS_DATA_LOCAL_PREFIX))
return internalName.Substring(PS_DATA_LOCAL_PREFIX.Length);
return internalName;
}
public IAsyncEnumerable<T[]> Watch<T>(
string sql,
object?[]? parameters = null,
SQLWatchOptions? options = null
)
{
options ??= new SQLWatchOptions();
// Stop watching on master CTS cancellation, or on user CTS cancellation
var signal = options.Signal != null
? CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token, options.Signal.Value)
: CancellationTokenSource.CreateLinkedTokenSource(masterCts.Token);
// Establish the initial DB listener synchronously before returning the IAsyncEnumerable,
// so that table changes between Watch() being called and iteration starting are not missed.
// This mirrors the pattern used in OnChange().
var initialRestartCts = CancellationTokenSource.CreateLinkedTokenSource(signal.Token);
var initialListener = Database.ListenAsync(initialRestartCts.Token);
return WatchCore<T>(sql, parameters, options, signal, initialRestartCts, initialListener);
}
private async IAsyncEnumerable<T[]> WatchCore<T>(
string sql,
object?[]? parameters,
SQLWatchOptions options,
CancellationTokenSource signal,
CancellationTokenSource initialRestartCts,
IAsyncEnumerable<DBAdapterEvent> initialListener
)
{
var schemaChanged = new TaskCompletionSource<bool>();
// Listen for schema changes in the background
_ = Task.Run(async () =>
{
await foreach (var update in ListenAsync(signal.Token))
{
if (update.SchemaChanged != null)
{
// Swap schemaChanged with an unresolved TCS
var oldTcs = Interlocked.Exchange(ref schemaChanged, new());
oldTcs.TrySetResult(true);
}
}
}, signal.Token);
// Re-register query on schema updates
bool isRestart = false;
var currentRestartCts = initialRestartCts;
var currentListener = initialListener;
while (!signal.Token.IsCancellationRequested)
{
// Resolve tables
HashSet<string> powersyncTables;
if (options?.Tables != null)
{
powersyncTables = [.. options
.Tables
.SelectMany<string, string>(table => [$"ps_data__{table}", $"ps_data_local__{table}"]
)];
}
else
{
powersyncTables = await GetSourceTables(sql, parameters);
}
var enumerator = OnRawTableChange(
powersyncTables,
currentListener,
currentRestartCts.Token,
isRestart || (options?.TriggerImmediately == true)
).GetAsyncEnumerator(currentRestartCts.Token);
// Continually wait for either OnChange or SchemaChanged to fire
while (true)
{
var currentSchemaTask = schemaChanged.Task;
var onChangeTask = enumerator.MoveNextAsync().AsTask();
var completedTask = await Task.WhenAny(onChangeTask, currentSchemaTask);
if (completedTask == currentSchemaTask)
{
currentRestartCts.Cancel();
isRestart = true;
// Let the current task complete/cancel gracefully
try { await onChangeTask; }
catch (OperationCanceledException) { }
// Establish a new listener BEFORE resolving source tables in the next iteration,
// so that changes during the async GetSourceTables call are not missed.
currentRestartCts = CancellationTokenSource.CreateLinkedTokenSource(signal.Token);
currentListener = Database.ListenAsync(currentRestartCts.Token);
break;
}
var update = enumerator.Current;
if (update.ChangedTables != null)
{
if (signal.IsCancellationRequested) yield break;
yield return await GetAll<T>(sql, parameters);
}
}
}
}
private class ExplainedResult
{
public int addr = 0;
public string opcode = "";
public int p1 = 0;
public int p2 = 0;
public int p3 = 0;
public string p4 = "";
public int p5 = 0;
}
private record TableSelectResult(string tbl_name);
internal async Task<HashSet<string>> GetSourceTables(string sql, object?[]? parameters = null)
{
var explained = await GetAll<ExplainedResult>(
$"EXPLAIN {sql}", parameters
);
var rootPages = explained
.Where(row => row.opcode == "OpenRead" && row.p3 == 0)
.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)]
);
return [.. tables.Select(row => row.tbl_name)];
}
private async IAsyncEnumerable<WatchOnChangeEvent> OnRawTableChange(
HashSet<string> watchedTables,
IAsyncEnumerable<DBAdapterEvent> listener,
[EnumeratorCancellation] CancellationToken token,
bool triggerImmediately = false
)
{
if (triggerImmediately)
{
yield return new WatchOnChangeEvent { ChangedTables = [] };
}
HashSet<string> changedTables = new();
await foreach (var e in listener)
{
if (e.TablesUpdated != null)
{
if (token.IsCancellationRequested) break;
// Extract the changed tables and intersect with the watched tables
changedTables.Clear();
GetTablesFromNotification(e.TablesUpdated, changedTables);
changedTables.IntersectWith(watchedTables);
if (changedTables.Count == 0) continue;
yield return new WatchOnChangeEvent { ChangedTables = [.. changedTables] };
}
}
}
private static void GetTablesFromNotification(INotification updateNotification, HashSet<string> changedTables)
{
string[] tables = [];
if (updateNotification is BatchedUpdateNotification batchedUpdate)
{
tables = batchedUpdate.Tables;
}
else if (updateNotification is UpdateNotification singleUpdate)
{
tables = [singleUpdate.Table];
}
foreach (var table in tables)
{
changedTables.Add(table);
}
}
}