Ensure the request body is not emptied in Faraday v1.0.0

[Domon]

Context

JWT Signed Request's Faraday middleware does not work as expected when the request has a body (e.g. a POST request) and Faraway version is v1.0.0.

It empties the request body no matter the request body has been set or not.

Change

Replace the problematic #fetch method with #[] and #[]= to ensure JWT Signed Request works as expected in Faraday v0.17.3 or v1.0.0.

Considerations

The Faraday::Env#fetch method (inherited from Faraday#Options) works in a way different from the Hash#fetch method. It not only returns the value when the key exists but also sets the value of the key (❗️) if a second argument is provided.

https://github.com/lostisland/faraday/blob/099dd45f63ff99bbb343eebf7504a3cf0b10bc63/lib/faraday/options.rb#L76-L88

JWT Signed Request uses this method to obtain the request body or set it to an empty string if it was nil.

In Faraday v1.0.0, the :body option has been replaced with the new :request_body and :response_body options. Smarter getter (#[]) and setter (#[]=) methods are provided. When the argument is :body, they access :request_body or :response_body depending on if :status has been set.

lostisland/faraday#847

However, the #fetch method remains the same.

A request with a body will have the :request_body option set but not the :body option. That results in JWT Signed Request think the request body was not provided and sets :request_body to an empty string.

Instead of the #fetch method, I propose we use the #[] and #[]= method instead.

[orien]

Nice investigation @Domon!

LGTM

[delfinag]

I just noticed #40 addresses this too. I'll close that one off favour of this PR which includes tests.

[zubin]

Would it be less surprising (more readable) to set this beforehand? eg:

env[:body] ||= ::JWTSignedRequest::EMPTY_BODY
@jwt_token = ::JWTSignedRequest.sign(

So this would become simply:

Suggested change

	body: env[:body] || (env[:body] = ::JWTSignedRequest::EMPTY_BODY),
	body: env[:body],

Great catch btw!

[zubin]

Thanks, LGTM! 👍

[Domon]

Thanks everyone for reviewing 🙏