halkyon-days/serverpod-offline-sync
Watch
1
0
Fork
You've already forked serverpod-offline-sync
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: Close generated sync sessions and expose the shared demo (#135)

Browse source
This commit is contained in:
Marcelo Mendonça Soares 2026-09-16 11:40:42 -03:00 • committed by GitHub
commit 0f4b8116f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 266 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

18
example/offline_sync_demo/README.md
View file

@ -9,23 +9,25 @@ them converge.
If you are here to learn the package, read **`lib/src/offline_replica.dart`**
first — it is the entire integration in ~60 lines, deliberately free of demo and
UI code. Every replica follows the same four steps:
UI code. Every replica follows the same three steps:
1. **Open a local database.** `client.createSession(path)` opens a Serverpod
client database (a local SQLite file) and runs the client migrations.
2. **Wrap it for CRDT sync.** `OfflineSyncDatabaseSession.wraps(raw, syncTables: …,
persistentUserId: …)`, then `offlineSyncSession.db.initialize()` to establish this
device's CRDT node so it can take part in sync.
3. **Read and write generated models** against that session, e.g.
1. **Open a sync session.** The generated
`client.createSyncSession(path, isDebugMode: kDebugMode, persistentUserId: …)`
opens the local SQLite database, runs client migrations, wraps the generated
sync tables, and initializes CRDT tracking.
2. **Read and write generated models** against that session, e.g.
`Person.db.insertRow(session, person)` or `session.db.find<Person>()`. (The
demo also routes these through a generic `TableOps` registry so its
metadata-driven UI can touch any table without a per-type switch — that part
is demo-only; the `seed*` methods in `lib/src/demo_controller.dart` show the
plain form.)
4. **Synchronize through a Serverpod client.**
3. **Synchronize through a Serverpod client.**
`client.offlineSync.syncOnce(session, onMergeSuccess: …)` for a one-shot push/pull,
or `client.offlineSync.syncContinuously(session, …)` to stream until cancelled.
When disposing a replica, cancel its sync subscription and call `session.close()`
to release the local database connection.
Connectivity is just *which client you sync through*: the demo swaps
`Client.httpClientOverride` between a real transport and a failing one to
simulate going offline — the local database is untouched either way.