Refactor step buttons + improve assertion messages #6417
Closed
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.
I got annoyed with totally useless test failure messages and having to follow the steps to the failures.
A few important changes here:
StepButton
constructors except where required (UntilStepButton
,RepeatStepButton
) to preserve behaviour. They now use properties includingrequired
and{ get; init; }
keywords to indicate expected uses.UntilStepButton
now has a callstack.AddStep
andAddLabelStep
no longer returns the step button. It's not used in o!f and osu!, and I'm not sure where it could ever find a use in practice.AddUntilStep
) calls into theAddStep(StepButton)
method which does the scheduling. This is extremely important for generating correct callstacks - it is currently generated inside the lambda which loses context and is why our traces are terrible.If deemed necessary, I can split this PR up into two. I kinda went down the rabbit hole to see where it ends, so it combines the refactoring.
Demo:
Before:
After: