Fix inefficient assert pattern in Rack::Lint [2-2-stable] #2101
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
4 tasks
tenderlove
approved these changes
Jul 30, 2023
|
@skipkayhil I've talked with everyone and we agree that if you want to implement this for all of LMK. |
|
Awesome! I'll go ahead and do them all |
jeremyevans
approved these changes
Jul 31, 2023
skipkayhil
force-pushed
the
hm-backport-1724
branch
from
afc1ce9
to
54228a2
Compare
Partial backport of 1970771 Differences from original commit: - `#assert` is not deprecated - `include Assertion` is not removed - The assertion in `check_status` is the 2-2-stable version since the SPEC [change][1] to require statuses to be integers was merged before this - `#dump` was added to the `REQUEST_METHOD` assertion [after][2] the original commit, so it was added here as well This fixes an issue encountered when adding `Rack::Lint` to the Rails test suite. Rails puts a lazily evaluated class inside the request env that has the potential to raise when converted to a string. Since this assertion in `Rack::Lint` calls `#inspect` on `env` whether or not `env` is a `Hash`, the lazily evaluated class would raise at that point and prevent the rest of `Rack::Lint` from validating the conformity of the request. By backporting this change, `#inspect` is now only called when the `LintError` would be raised which avoids the problem. [1]: ba25ade [2]: b426cc2 Co-authored-by: Benoit Daloze <eregontp@gmail.com>
skipkayhil
force-pushed
the
hm-backport-1724
branch
from
54228a2
to
8397d42
Compare
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.
Partial backport of 1970771
Differences from original commit:
#assertis not deprecatedinclude Assertionis not removedcheck_statusis the 2-2-stable version since the SPEC change to require statuses to be integers was merged before this#dumpwas added to theREQUEST_METHODassertion after the original commit, so it was added here as wellThis fixes an issue encountered when adding
Rack::Lintto the Rails test suite. Rails puts a lazily evaluated class inside the request env that has the potential to raise when converted to a string. Since this assertion inRack::Lintcalls#inspectonenvwhether or notenvis aHash, the lazily evaluated class would raise at that point and prevent the rest ofRack::Lintfrom validating the conformity of the request.By backporting this change,
#inspectis now only called when theLintErrorwould be raised which avoids the problem.I started with the smallest change needed to fix the problem in the Rails test suite, but I'm happy to add more based on feedback