Add allow_wildcard configuration #2362
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
Borzik
commented
Oct 25, 2019
|
|
||
| def test_render_resource_with_deep_wildcard_include | ||
| assert_raise SystemStackError do | ||
| get :render_resource_with_deep_wildcard_include |
There was a problem hiding this comment.
** wildcard would cause stack overflow in this case. I guess this test can be removed, but left it here as a PoC for now.
Edit: It looks like it fails tests on jruby, so I removed it.
Borzik
force-pushed
the
0-10-allow-wildcard
branch
from
5975ed0 to
b7a990a
Compare
Borzik
force-pushed
the
0-10-allow-wildcard
branch
from
b7a990a to
b98d51a
Compare
bf4
reviewed
Oct 25, 2019
Borzik
force-pushed
the
0-10-allow-wildcard
branch
from
b98d51a to
f107b18
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Purpose
jsonapi-renderer provides an
allow_wildcardconfiguration which can be used to configure how*and**include directives are treated. Since these wildcards are specific to AMS, in some cases it might be better to completely disable them instead of callinggsub(/\*/, '')on every include parameter passed to the API.Changes
This PR adds a way to disable these wildcards by updating how
JSONAPI::IncludeDirectiveis initialized. Default behaviour remains the same. Whenconfig.allow_wildcardisfalse, wildcards will be ignored by jsonapi-renderer.Caveats
default_includesconfiguration, which is currently*, will not be respected and will be handled as if it was an empty string