fix: Improve performance when multiple files are edited quickly #3394
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
Basically, many Tasks searches can take more than 0.1 second to render. But Obsidian and Tasks can parse many files during that 0.1 second span. 1. This speeds up start-up time in cases where there were Tasks queries open at start-up Obsidian, preventing double-redraws. 2. It eliminates lots of wasted redraws in open queries, when Obsidian is re-reading files that were edited externally (such as via Sync) and where bulk edits are made to files in the vault. Relates to issue #3283
claremacrae
added
scope: performance issues
|
claremacrae
changed the title
|
I've been through all the relevant steps in the Smoke tests, since my notes from before said that my first attempt with this code broke refreshing of results in Live Preview. I've done all the tests except these ones:
I expect that the problem was fixed by one or both of these - likely the second one: |
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.
Types of changes
Done by pairing with @ilandikov.
Changes visible to users:
fix- non-breaking change which fixes an issue)Description
The change
This adds a small delay between successive redraws of Tasks search results.
This speeds up situations where more than one file containing tests is modified within that 0.1 second window, which can happen with things like:
Previously, Tasks would redraw all open queries on every individual file edit, for files that contain lines it considers to be tasks.
This also eliminates some double redraws that I have not previously been able to track down.
Example improvement
Time taken to delete 76 files with tasks in, in the test vault, on a very fast Mac.
What is not (yet) changed
Because the 0.1 secs delay is small compared to the Obsidian 2-second auto-save interval, this probably will not have much benefit to typing speed, whilst the Tasks plugin is rendering many searches.
That will be improved in a future PR.
Motivation and Context
This is the first of a series of improvements to Tasks performance.
How has this been tested?
Thorough exploratory testing in the Tasks test vault.
Screenshots (if appropriate)
Screenshot showing the size of debug-log files from Tasks, when deleting 64 files containing tasks, with 5 queries open.
The size of the output reflects the number of redraws done.
Checklist
yarn run lint.Terms