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

Nicer error when specifying non-nil non-string opt value #861

Merged
merged 1 commit into from
Oct 4, 2019

Commits on Oct 4, 2019

  1. Nicer error when specifying non-nil non-string opt value

    Previously, if you specified a non-nil non-string opt value, like a
    symbol for `idempotency_key`, you'd get a pretty user-unfriendly error
    from `Net::HTTP`:
    
    ```
    /Users/brandur/.rbenv/versions/2.4.5/lib/ruby/2.4.0/net/http/header.rb:21:in `block in initialize_http_header': undefined method `strip' for :foo:Symbol (NoMethodError)
    ```
    
    Here, we introduce a new argument error that makes it a little easier
    for someone to read. The impetus for the change is that we had an
    internal product quality report where someone ran into this and was
    confused.
    
    I'm pretty sure this change is backward compatible because `Net::HTTP`
    would call `strip` on anything that was passed in as a value, and
    generally just strings would support that. There may be some other less
    common data type that was accidentally compatible that someone was
    using, but that case should be quite unusual.
    brandur committed Oct 4, 2019
    Configuration menu
    Copy the full SHA
    a8daac6 View commit details
    Browse the repository at this point in the history