Protect from typos in route definitions #52
Merged
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
dominikkaluza
approved these changes
Feb 4, 2022
dominikvoda
requested changes
Feb 4, 2022
There was a problem hiding this comment.
This was there on purpose, platform-backend is using extra fields to do some magic https://github.com/BrandEmbassy/platform-backend/blob/master/application/Configs/api/engager.neon#L41
Maybe we can just introduce alias middleware = middlewares
PetrHeinz
changed the title
|
@dominikvoda OK, I get that use case, so I've allowed extra fields back (971b87e), made a supersimple check for that specific typo (bdec72d) and then generalized it to disallowing any config keys that are different, but very similar (1 or 2 changed characters) to the ones we've defined (53e2d9e). This should provide at least some protection from typos and not interfere with extra fields in other projects. |
dominikvoda
approved these changes
Feb 4, 2022
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.
It's quite easy to make a typo in the configuration (eg
middleware/middlewares), and some middlewares have effects that are not immediately obvious.Loading route configs should fail with additional info when such misconfiguration happens, imo. It was surprising that there was a test for allowing extra fields - is there a use case for this?