[RKOTLIN-1079] Add support for transfer progress estimate #1575
Conversation
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
# Conflicts: # packages/cinterop/src/nativeDarwin/kotlin/io/realm/kotlin/internal/interop/RealmInterop.kt # packages/external/core # packages/jni-swig-stub/src/main/jni/realm_api_helpers.cpp # packages/jni-swig-stub/src/main/jni/realm_api_helpers.h
clementetb
changed the title
rorbech
suggested changes
May 16, 2024
CHANGELOG.md
Outdated
| @@ -4,11 +4,12 @@ | |||
| This release will bump the Realm file format from version 23 to 24. Opening a file with an older format will automatically upgrade it from file format v10. If you want to upgrade from an earlier file format version you will have to use Realm Kotlin v1.13.1 or earlier. Downgrading to a previous file format is not possible. | |||
|
|
|||
| ### Breaking changes | |||
| * None. | |||
| * Sync progress updates no longer report `transferredBytes` and `totalBytes`. (Issue [#1744](https://github.com/realm/realm-kotlin/issues/1744) [RKOTLIN-1079](https://jira.mongodb.org/browse/RKOTLIN-1079)). | |||
There was a problem hiding this comment.
I guess the new values are the enhancement, but I think I would have combined both into one breaking change entry and put emphasis on the new better precision ... And support for flx-sync, right?
...test-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/ProgressListenerTests.kt
Outdated
Show resolved
Hide resolved
rorbech
reviewed
May 17, 2024
...t-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/PBSProgressListenerTests.kt
Outdated
Show resolved
Hide resolved
nhachicha
reviewed
May 20, 2024
...t-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/FLXProgressListenerTests.kt
Outdated
Show resolved
Hide resolved
...t-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/FLXProgressListenerTests.kt
Show resolved
Hide resolved
| // Await the flow actually being active, this requires actual data transfer as | ||
| // we arent guaranteed any initial events. | ||
| writerRealm.writeSampleData(TEST_SIZE, timeout = TIMEOUT) | ||
| mutex.lock() |
There was a problem hiding this comment.
Note this will not timeout (if the test fails) only if the Job is cancelled. https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.sync/-mutex/lock.html
maybe wrap with withTimeout(TIMEOUT)
...t-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/PBSProgressListenerTests.kt
Outdated
Show resolved
Hide resolved
…mongodb/common/FLXProgressListenerTests.kt Co-authored-by: Nabil Hachicha <nabil.hachicha@mongodb.com>
# Conflicts: # CHANGELOG.md
rorbech
approved these changes
May 24, 2024
...t-sync/src/commonTest/kotlin/io/realm/kotlin/test/mongodb/common/PBSProgressListenerTests.kt
Outdated
Show resolved
Hide resolved
| // `flow.collect()` can be called. | ||
| channel.receiveOrFail() | ||
| realm.close() | ||
| job.await() |
There was a problem hiding this comment.
This could hang forever if the test fails in some unexpected way.
There was a problem hiding this comment.
I have created a ticket to address this after the PR. We should revisit these tests.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Core now reports progress estimates during a Download/Upload. This PR adds support for it.
The progress estimate is a double ranged between 0 - 1.
Depends on realm/realm-core#7124
Closes #1744