refactor!: rebuild the "refresh" system into expanded "sync" system - #1501
Open
CyanVoxel wants to merge 3 commits into
Open
refactor!: rebuild the "refresh" system into expanded "sync" system#1501CyanVoxel wants to merge 3 commits into
CyanVoxel wants to merge 3 commits into
Conversation
This file contains hidden or 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
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.
Important
Blocked by #1499 in order to finalize migration and resolve failing migration tests.
Note
This PR is targeting the
devbranch for release with Alpha v9.7.Summary
This is a complete rebuild of the "refresh" system into an expanded "sync" system that removes longstanding design constraints like modal progress bars that block the app, addresses important edge cases such as Unicode normalization and filesystem case-insensitivity, and finally adds some basic amount of automatic relinking with the help of cached file stats.
Much of the performance and code consolidation was inspired by #1242 along with the NFD research stemming directly from that PR, with additional notes taken from #1495. Completes this system's task for #1460.
Half of this PR centers around the new sync system and how it stores up-to-date file metadata to aid in searches and the relinking process, and the other half is a whoooole lot of UI code for a new notification and banner that displays progress of sync operations without blocking the app. I poured a lot of polish into since I'm aiming for a v10 level of completion with this system, and two years of temporary progress bar modals was just too much.
Directory scanning, file metadata updates, and automatic relinking operations all now run in the background, letting you use TagStudio while these operations complete. Because syncing no longer has the blocking impact it did previously, I've also added a dismissable banner message that displays on app startup encouraging users to turn on the "sync library on startup" setting. Since it's still valid to not want your filesystem hit or library modified when opening a library, I've kept the setting around.
What I haven't done in this PR is rework the old "Fix Unlined Entries" modal/system, only integrated it slightly with the new sync system. That whole thing needs its own rework that's out of the scope of this PR (yes, this PR actually has a scope...)
Full Breakdown
Unicode Normalization Form D (NFD) + Windows Case-Insensitivity Enforcement
Non-Blocking UI Banner
Reworked Refresh (Now Called Sync) System
Automatic Relinking
Sort by File Size, Date Created, Date Modified
Supersedes #1242 and #1495
Fixes #1252
Fixes #1279
Fixes #1450
Closes #610
Closes #1212
Closes #1218
Tasks Completed