fix: Cycle through statuses until TODO is found when marking recurring tasks as DONE #2516
Conversation
There was a problem hiding this comment.
Hi @asokawotulo,
Thank you very much for looking at this.
I've tested it out and suggested improvements that would be needed before merging the code.
If you have any questions, please do ask!
Many thanks.
claremacrae
changed the title
claremacrae
added
the
scope: recurrence
|
Hey @claremacrae, I pushed a fix & test for the infinite loop using the example you provided. Instead of looping until it finds a task with the TODO type, it loops for the length of the registered statuses and if it doesn't find a TODO type it'll just use the DONE statuses next symbol. |
|
Excellent. Thank you. What happens now if there is more than one TODO task? Will it follow the chain from the current status, or will it find the first status with TODO? I think it should try to follow the status chain if it can. |
|
It should still follow the chain from the current task |
I've tested that in the test vault, and have confirmed that this is true. However, from reading the code, I'm struggling to see how it works. Could you please say how the for loop works? Thanks. |
|
Actually I noticed a logical bug while writing the comment to explain the code. I've just pushed a commit to fix that. The code just checks if the next status is of type TODO. If it is not, it moves to the symbol next to it and repeats the same criteria check. This process continues for the length of the registered status. However, if a matching status is not found, it directly uses the next status after DONE. |
There was a problem hiding this comment.
Thank you. I would definitely be OK to merge this now, so please let me know if you don't have time to add the comments suggested below...
Because it's going to need time to update the documentation before I can release the change, I will hold off merging this until I also have time to add more tests and update the docs.
|
Fantastic - thank you very much indeed @asokawotulo. 🚀 |
The comments were kindly written by @asokawotulo in: #2516 (comment) Co-Authored-By: Asoka Wotulo <32058490+asokawotulo@users.noreply.github.com>
Description
I looped through the statuses until a TODO status is found. I realize that there's a possibility of getting stuck in an infinite loop, another approach could be to loop for the length of the registered statuses and fallback if no appropriate status is found.
Motivation and Context
Issues #2304 and #2089.
How has this been tested?
I wrote a test in
Commands/ToggleDone.test.ts(not sure if this is the appropriate file to add the test to)Screenshots (if appropriate)
Types of changes
Changes visible to users:
fix- non-breaking change which fixes an issue)feat- non-breaking change which adds functionality)feat!!orfix!!- fix or feature that would cause existing functionality to not work as expected)docs- improvements to any documentation content for users)vault- improvements to the Tasks-Demo sample vault)contrib- any improvements to documentation content for contributors - see Contributing to Tasks)Internal changes:
refactor- non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)test- additions and improvements to unit tests and the smoke tests)chore- examples include GitHub Actions, issue templates)Checklist
yarn run lint.Terms