forked from mongodb/docs-realm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into docsp-31555-sync-…
…data
- Loading branch information
Showing
51 changed files
with
1,057 additions
and
362 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
211 changes: 211 additions & 0 deletions
211
...es/kotlin/shared/src/commonTest/kotlin/com/mongodb/realm/realmkmmapp/ManageSyncSession.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| package com.mongodb.realm.realmkmmapp | ||
|
|
||
| import io.realm.kotlin.Realm | ||
| import io.realm.kotlin.ext.query | ||
| import io.realm.kotlin.internal.platform.runBlocking | ||
| import io.realm.kotlin.mongodb.App | ||
| import io.realm.kotlin.mongodb.Credentials | ||
| import io.realm.kotlin.mongodb.sync.* | ||
| import io.realm.kotlin.mongodb.syncSession | ||
| import io.realm.kotlin.types.RealmInstant | ||
| import io.realm.kotlin.types.RealmObject | ||
| import io.realm.kotlin.types.annotations.PrimaryKey | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.flow.first | ||
| import kotlinx.coroutines.launch | ||
| import org.mongodb.kbson.BsonObjectId | ||
| import org.mongodb.kbson.ObjectId | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
| import kotlin.test.assertTrue | ||
| import kotlin.time.Duration.Companion.minutes | ||
|
|
||
|
|
||
| // :replace-start: { | ||
| // "terms": { | ||
| // "SyncTask": "Task" | ||
| // } | ||
| // } | ||
| class ManageSyncSession : RealmTest() { | ||
|
|
||
| class SyncTask : RealmObject { | ||
| @PrimaryKey | ||
| var _id: ObjectId = BsonObjectId() | ||
| var taskName: String = "" | ||
| var assignee: String? = null | ||
| var completed: Boolean = false | ||
| var progressMinutes: Int = 0 | ||
| var dueDate: RealmInstant? = null | ||
| } | ||
|
|
||
| val app = App.create(yourFlexAppId) | ||
| val credentials = Credentials.anonymous(reuseExisting = false) | ||
| @Test | ||
| fun waitForChangesUploadAndDownload() { | ||
| runBlocking { | ||
| val user = app.login(credentials) | ||
| val config = SyncConfiguration.Builder(user, setOf(SyncTask::class)) | ||
| .initialSubscriptions { it.query<SyncTask>().subscribe() } | ||
| .build() | ||
| val realm = Realm.open(config) | ||
| Log.v("Successfully opened realm: ${realm.configuration}") | ||
| // :snippet-start: wait-upload-download | ||
| // Wait to download all pending changes from Atlas | ||
| realm.syncSession.downloadAllServerChanges(1.minutes) | ||
|
|
||
| // Add data locally | ||
| realm.write { | ||
| this.copyToRealm(SyncTask().apply { | ||
| taskName = "Review proposal" | ||
| assignee = "Emma" | ||
| progressMinutes = 0 | ||
| }) | ||
| } | ||
|
|
||
| val upload = // :remove: | ||
| // Wait for local changes to be uploaded to Atlas | ||
| realm.syncSession.uploadAllLocalChanges(1.minutes) | ||
| // :snippet-end: | ||
| assertTrue(upload) | ||
| realm.write { | ||
| val tasks = query<SyncTask>().find() | ||
| delete(tasks) | ||
| assertEquals(0, tasks.size) | ||
| } | ||
| realm.syncSession.uploadAllLocalChanges() | ||
| user.remove() | ||
| realm.close() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun pauseResumeSyncSession() { | ||
| runBlocking { | ||
| val user = app.login(credentials) | ||
| val config = SyncConfiguration.Builder(user, setOf(SyncTask::class)) | ||
| .initialSubscriptions { it.query<SyncTask>().subscribe() } | ||
| .build() | ||
| val realm = Realm.open(config) | ||
| Log.v("Successfully opened realm: ${realm.configuration}") | ||
| // :snippet-start: pause-resume-sync | ||
| // Pause the sync session | ||
| // Data that you write while session is paused does not sync to Atlas | ||
| realm.syncSession.pause() | ||
| assertEquals(SyncSession.State.PAUSED, realm.syncSession.state) // :remove: | ||
|
|
||
| // Add data locally | ||
| realm.write { | ||
| this.copyToRealm(SyncTask().apply { | ||
| taskName = "Submit expense report" | ||
| assignee = "Kevin" | ||
| progressMinutes = 0 | ||
| }) | ||
| } | ||
|
|
||
| // Resume sync session | ||
| // Local changes now sync to Atlas | ||
| realm.syncSession.resume() | ||
| // :snippet-end: | ||
| assertEquals(SyncSession.State.ACTIVE, realm.syncSession.state) | ||
| realm.write { | ||
| val tasks = query<SyncTask>().find() | ||
| delete(tasks) | ||
| assertEquals(0, tasks.size) | ||
| } | ||
| realm.syncSession.uploadAllLocalChanges() | ||
| user.remove() | ||
| realm.close() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun monitorSyncProgress() { | ||
| /* | ||
| NOTE: Kotlin does not currently support progress listeners for Flexible Sync | ||
| Requires PBS | ||
| */ | ||
| runBlocking { | ||
| val app1 = App.create(yourAppId) | ||
| val user = app1.login(credentials) | ||
| val config = SyncConfiguration.Builder(user, PARTITION, setOf(SyncTask::class)) | ||
| .name(PARTITION) | ||
| .build() | ||
| val realm = Realm.open(config) | ||
| Log.v("Successfully opened realm: ${realm.configuration}") | ||
|
|
||
| realm.write { | ||
| this.copyToRealm(SyncTask().apply { | ||
| taskName = "Schedule appointment" | ||
| assignee = "Jane" | ||
| progressMinutes = 0 | ||
| }) | ||
| } | ||
| // :snippet-start: monitor-progress | ||
| val stream = realm.syncSession.progressAsFlow( | ||
| Direction.UPLOAD, ProgressMode.CURRENT_CHANGES | ||
| ) | ||
| stream.collect { progress -> | ||
| if (progress.transferableBytes == progress.transferredBytes) { | ||
| Log.i("Upload complete") | ||
| } | ||
| } | ||
| // :snippet-end: | ||
| assertTrue(stream.first().isTransferComplete) | ||
| realm.write { | ||
| val tasks = query<SyncTask>().find() | ||
| delete(tasks) | ||
| assertEquals(0, tasks.size) | ||
| } | ||
| realm.syncSession.uploadAllLocalChanges() | ||
| user.remove() | ||
| realm.close() | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun monitorNetworkConnection() { | ||
| runBlocking { | ||
| val user = app.login(credentials) | ||
| val config = SyncConfiguration.Builder(user, setOf(SyncTask::class)) | ||
| .initialSubscriptions { it.query<SyncTask>().subscribe() } | ||
| .build() | ||
| val realm = Realm.open(config) | ||
| Log.v("Successfully opened realm: ${realm.configuration}") | ||
| // :snippet-start: get-network-connection | ||
| if (realm.syncSession.connectionState == ConnectionState.CONNECTED) { | ||
| Log.i("Connected to network") | ||
| // ... do something | ||
| } | ||
| // :snippet-end: | ||
| val flow = CoroutineScope(Dispatchers.Default).launch { | ||
| // :snippet-start: monitor-network-connection | ||
| val connectionFlow = realm.syncSession.connectionStateAsFlow() | ||
| connectionFlow.collect { ConnectionStateChange -> | ||
| if (ConnectionStateChange.newState == ConnectionState.CONNECTED) { | ||
| Log.i("Connected to Atlas Device Sync server") | ||
| } | ||
| } | ||
| // :snippet-end: | ||
| assertEquals(ConnectionState.CONNECTED, realm.syncSession.connectionState) | ||
| } | ||
| realm.write { | ||
| this.copyToRealm(SyncTask().apply { | ||
| taskName = "Do a thing" | ||
| assignee = "Me" | ||
| progressMinutes = 0 | ||
| }) | ||
| } | ||
| realm.write { | ||
| val tasks = query<SyncTask>().find() | ||
| delete(tasks) | ||
| assertEquals(0, tasks.size) | ||
| } | ||
| realm.syncSession.uploadAllLocalChanges() | ||
| flow.cancel() | ||
| user.remove() | ||
| realm.close() | ||
| } | ||
| } | ||
| } | ||
| // :replace-end: |
2 changes: 0 additions & 2 deletions
2
...nerated/dotnet-flexible-sync/FlexibleSyncExamples.snippet.open-a-flexible-synced-realm.cs
This file was deleted.
Oops, something went wrong.
22 changes: 22 additions & 0 deletions
22
...ples/generated/dotnet-flexible-sync/FlexibleSyncExamples.snippet.open-fs-realm-offline.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| var app = App.Create("myRealmAppId"); | ||
| Realms.Sync.User user; | ||
| FlexibleSyncConfiguration config; | ||
| Realm realm; | ||
|
|
||
| if (app.CurrentUser == null) | ||
| { | ||
| // App must be online for user to authenticate | ||
| user = await app.LogInAsync(Credentials.Anonymous()); | ||
| config = new FlexibleSyncConfiguration(user); | ||
| realm = Realm.GetInstance(config); | ||
| // Go on to add or update subscriptions and use the realm | ||
| } | ||
| else | ||
| { | ||
| // This works whether online or offline | ||
| // It requires a user to have been previously authenticated | ||
| user = app.CurrentUser; | ||
| config = new FlexibleSyncConfiguration(user); | ||
| realm = Realm.GetInstance(config); | ||
| // Go on to add or update subscriptions and use the realm | ||
| } |
Oops, something went wrong.