Support nested usage of JsonApiClient::Resource.with_headers#418
Open
tom-lord wants to merge 2 commits into
Open
Support nested usage of JsonApiClient::Resource.with_headers#418tom-lord wants to merge 2 commits into
tom-lord wants to merge 2 commits into
Conversation
tom-lord
force-pushed
the
allow_nested_with_headers
branch
2 times, most recently
from
July 20, 2026 15:35
8b056e8 to
7adfaf0
Compare
tom-lord
marked this pull request as ready for review
July 20, 2026 15:35
tom-lord
force-pushed
the
allow_nested_with_headers
branch
from
July 20, 2026 15:39
7adfaf0 to
a5d7565
Compare
Contributor
Author
|
CC: @gaorlov |
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.
The problem:
When the
.with_headersblock closes, it wipes any headers that have been set. This can lead to counterintuitive issues in code; consider:Regardless of whether the headers inside both blocks are the same or different, the JsonApiClient "forgets" them, halfway through the block! This causes
my_record.saveto fail as an unauthorised request.The current workaround might be to instead do:
...But this is confusing, and cumbersome.
My proposal in this PR is to "reset" the headers to their previous state at the end of a
.with_headersblock, rather than wiping them completely. So the first code block above will work as expected.