hash_including not working at all? Doesn't find any query

[Fire-Dragon-DoL]

I wrote a test after finding out that my stubbed requests were not called correctly, here is a test code:

require 'spec_helper'

describe WebMock, focus: true do
  let!(:dummy_url) { 'http://dummyurl.com' }

  it "receive a request when mocked with query param on a regex" do
    stub_request(
      :get,
      /#{ dummy_url }/
    ).with(
      query: hash_including({
        param1: 5
      })
    ).to_return(
      body: 'body 1'
    )

    expect(
      HTTParty.get(dummy_url, {
        query: {
          param1: 5,
          param2: 'random1'
        }
      }).body
    ).to eq 'body 1'
  end

  it "receive a request when mocked with query param without a regex" do
    stub_request(
      :get,
      dummy_url
    ).with(
      query: hash_including({
        param1: 5
      })
    ).to_return(
      body: 'body 1'
    )

    expect(
      HTTParty.get(dummy_url, {
        query: {
          param1: 5,
          param2: 'random1'
        }
      }).body
    ).to eq 'body 1'
  end

end

Both of them are not passing, they do not receive the request.
Notice that if I use do end block in with, I do manage to receive the request so it's definitely hash_including the issue, expecially because if I remove it, the query matching works fine (if I add param2: 'random1').

[bblimke]

Try it with keys being strings not symbols.

[Fire-Dragon-DoL]

@bblimke I think I've found the issue and it's quite stupid:

  it "receive a request when mocked with query param", focus: true do

    stub_request(
      :get,
      dummy_url
    ).with(
      query: hash_including({
        param1: '5',
        param2: 'random2'
      })    
    ).to_return(
      body: 'body 1'
    )

    expect(
      HTTParty.get(dummy_url, {
        query: {
          param1: 5,
          param2: 'random1'
        }
      }).body
    ).to eq 'body 1'
  end

The keys are not required to be strings. But the values must be strings.
Is it a bug? I think webmock can autoconvert everything to string easily if it requires that to perform the matching.

[dzajic]

@Fire-Dragon-DoL Thanks for the tip, this issue was killing me today!

[Fire-Dragon-DoL]

@dzajic Happy to help you ;)
I tried writing a patch but I must admit I have difficulties not knowing at all the code base. I would have done it through Hashie gem usually.

[bblimke]

Since query values can only be strings, it indeed makes sense to autoconvert values to strings for comparison.

[davidbegin]

@Fire-Dragon-DoL if you like I can try and help you with a fix. I'm new to codebase too, but 2 eyes might help.

[zdennis]

I hit this today as well. @PresidentJFK or @Fire-Dragon-DoL, have either of you started on a patch?

[davidbegin]

@Fire-Dragon-DoL @zdennis I have opened a Pull Request #517 trying to fix this problem. If you could take a look and see if it fixes your problem. Maybe try the branch against your failing tests.

[Fire-Dragon-DoL]

@PresidentJFK seems good, one point though, maybe you want to stringify hash keys too?

[davidbegin]

@Fire-Dragon-DoL WebMock already converts keys to strings, I added a spec exercising this functionality on #517

[nomasprime]

This was driving me nuts too, thanks @Fire-Dragon-DoL 🙌