Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default value for exc error #1351

Merged
merged 3 commits into from
Dec 21, 2021

Conversation

DariuszMusielak
Copy link
Contributor

Description

I would like to introduce default value for exc in def initialize for Faraday::Error.

In some cases it is difficult to find the reason on a first spot when doing raise Faraday::ConnectionFailed because it raises ArgumentError. In other cases like raise Faraday::TimeoutError it works because Faraday::TimeoutError sets default value or exc.

Link to related issues if any. (As Fixes #XXX) - there was no related issue.
I found out that someone has been asking why this is happening on Stackoverflow, I spent some time today looking for an answer for myself.

From my perspective introducing default value does not break anything and simplify codebase.

Todos

List any remaining work that needs to be done, i.e:

  • Tests
  • Documentation

Additional Notes

Optional section
Stackoverflow: https://stackoverflow.com/questions/59176256/unexpected-behaviour-with-faradayconnectionfailed/70427415#70427415

Dariusz Musielak added 3 commits December 20, 2021 21:21
in specs we only sets nil, missing default value in specific circumentances raised ArgumentError for Faraday::ConnectionFailed. It was difficult to spot why. I would like to have this change to do not worry about cases like this: https://stackoverflow.com/questions/59176256/unexpected-behaviour-with-faradayconnectionfailed/70427415#70427415
Copy link
Member

@iMacTia iMacTia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't find a reason for why the exc parameter was enforced. We may argue it's not a good idea to raise an exception without useful information in it, but going as far as making it manadatory makes testing more complicated than necessary (as this PR shows fixing our own tests).

LGTM 💯

@iMacTia iMacTia merged commit a555580 into lostisland:main Dec 21, 2021
@DariuszMusielak DariuszMusielak deleted the default-value-for-exc-error branch December 21, 2021 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants