Fix stale presenter after expected operation errors#2589
Open
zainnadeem786 wants to merge 1 commit into
Open
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.
Summary
Fix an issue where an expected
OperationErrororDishErrorcould be rendered using a stale presenter from a previously successful operation.This was reproducible with the following chain:
where the expected plain error message was incorrectly returned as an HTML PDF iframe.
Root Cause
Recipe.execute()resetslastRunOpat the beginning of execution and updates it after each successful operation.When an operation throws an expected
OperationErrororDishError, the error message is written to the dish as a"string"and execution returns early, butlastRunOpis left unchanged.Chef.bake()subsequently callsRecipe.present(), which uses the stale presenter from the previous successful operation. As a result, the error string can be wrapped using an unrelated presenter instead of being returned as plain text.Fix
Clear the presentation state on the expected error paths by resetting
lastRunOpbefore returning.This keeps the error dish unpresented and allows the plain error message to be returned as intended.
The fix is generic and is applied to both:
OperationErrorDishErrorwithout introducing any special handling for individual operations.
Regression Tests
Added focused regression coverage for the reported scenario:
Render PDFfollowed byGenerate QR Codereturns a plain QR error message.<iframe>.Validation
Executed the relevant test suites:
Impact