Avoid terminating when a precondition is not met in HTTPServerPipelineHandler #2550
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
Lukasa
added
🆕 semver/minor
|
@swift-server-bot add to allowlist |
Lukasa
reviewed
Oct 13, 2023
Lukasa
reviewed
Oct 13, 2023
| var file: String | ||
| var line: Int | ||
|
|
||
| init(base: Base, file: String, line: Int) { |
There was a problem hiding this comment.
This, and the various vars, may as well be private.
FranzBusch
reviewed
Oct 16, 2023
| var description: String { | ||
| switch self { | ||
| case .preconditionViolated(let message): | ||
| return message |
There was a problem hiding this comment.
We should add a "precondition violated" to this description as well
hamzahrmalik
force-pushed
the
http_handler_dont_crash
branch
from
44385ac to
d6d5575
Compare
hamzahrmalik
force-pushed
the
http_handler_dont_crash
branch
from
d6d5575 to
828f362
Compare
Lukasa
reviewed
Oct 17, 2023
| } | ||
|
|
||
| /// Calls assert if and only if `self.failOnPreconditions` is true. This allows us to avoid terminating the program in tests | ||
| private func checkPrecondition( |
There was a problem hiding this comment.
I think a minor nit here, but let's replace the word precondition in these two functions with assertion. They only fail in debug mode so they behave like assertions, not preconditions, and it'll be a little less confusing at the call site I think.
We can keep the word precondition in the error, that works well.
Lukasa
approved these changes
Oct 18, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Motivation:
HTTPServerPipelineHandlerhas a few preconditionFailures in its state machine. This isn’t really ideal, as while these are important invariants, it is fairly easy for users to accidentally break them.Modifications:
We continue to crash (by calling assertionFailure) when in debug mode, to make it obvious to users that they have violated an invariant
However, an internal flag allows us to disable this behaviour for testing
Result:
Making an illegal state change in
HTTPServerPipelineHandlerwill no longer crash