feat: Komga page-based sync #1032
Open
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
feat: chapter tracker overhaul: add switch, replace existing tracker logic if enabled fix: sync page progress regardless of chapter index chore: change log level feat: Komga page-based sync
RandomNamer
force-pushed
the
features/komga_book_specific_tracker
branch
from
ad834c9
to
acfb276
Compare
|
Good stuff. I'll give it a review soon. Meanwhile please rebase. |
AntsyLich
reviewed
Aug 21, 2024
Comment on lines
+32
to
+54
| companion object { | ||
| //Equal compare | ||
| private const val SYNC_STRATEGY_DEFAULT = 1 | ||
| private fun syncStrategyDefault(local: PageTracker.ChapterReadProgress, remote: PageTracker.ChapterReadProgress): RemoteProgressResolution { | ||
| return when { | ||
| local > remote -> RemoteProgressResolution.REJECT | ||
| local < remote -> RemoteProgressResolution.ACCEPT | ||
| else -> RemoteProgressResolution.SAME | ||
| } | ||
| } | ||
|
|
||
| //Flush local with remote | ||
| private const val SYNC_STRATEGY_ACCEPT_ALL = 2 | ||
| private fun syncStrategyAcceptAll(local: PageTracker.ChapterReadProgress, remote: PageTracker.ChapterReadProgress): RemoteProgressResolution { | ||
| return if (local.completed && remote.completed || local.page == remote.page) RemoteProgressResolution.SAME else RemoteProgressResolution.ACCEPT | ||
| } | ||
|
|
||
| //Update remote only when both local and remote are not completed and local page index gt remote | ||
| private const val SYNC_STRATEGY_ALLOW_REREAD = 3 | ||
|
|
||
| private fun syncStrategyAllowReread(local: PageTracker.ChapterReadProgress, remote: PageTracker.ChapterReadProgress): RemoteProgressResolution { | ||
| return if (local.completed && !remote.completed && remote.page > 1) RemoteProgressResolution.ACCEPT else syncStrategyDefault(local, remote) | ||
| } |
There was a problem hiding this comment.
What's the point of all this?
There was a problem hiding this comment.
When I'm developing the feature I come up with several sync strategies that tailored to my needs, e.g. for some books I want to flush all states from komga to Mihon and for some other just update every chapter to latest page from both sources (like CRDT).
There was a problem hiding this comment.
They're not being used anywhere except test so why do they exist in this file? Are they even being used anywhere aside from test? I haven't reviewed the whole thing so pardon me if i'm missing something.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As mentioned in issue #236
Use book APIs to achieve chapter-level read progress sync for Komga with the Komga tracker. Every page turn would be reported to Komga just like the Komga web app; to sync page progress from Komga, just trigger refresh tracker manually and all read progress, with page-level granularity would be merged with local. Other trackers should also be able to reuse this feature by implementing
PageTrackerinterface. Additionally, there are 3 sync strategies implemented but currently no UI to configure them.In case the CI is not running
[app-dev-arm64-v8a-preview.apk.zip](https://github.com/user-attachments/files/16327306/app-dev-arm64-v8a-preview.apk.zip)