hello! not sure if this has been asked here before already, but i’ve been having issues running consumer tests with PactV3. i’ve set up my test file as such:

const provider = new PactV3({ consumer, provider, dir, port: 1234 })
describe('test 1', () => {
  test('should pass', () => {
    provider
      .given('valid user session')
      .uponReceiving('request')
      .withRequest({ 
        method: 'POST', 
        path: '/my-url', 
        headers: { custom_header }, 
        body: reqBody
      })
      .willRespondWith({
        status: 200,
        headers: reponseHeaders,
        body: like(exampleBody)
      })
    
    await provider.executeTest(async mockService => {
      myApi.configureUrl(mockService.url)
      const apiResp = await <http://myApi.post|myApi.post>({ 
        headers: { custom_header },
        data: reqBody,
      })
    })
  })
})

however, the above test fails with

The following request was expected but not received

and then it displays the request that I have defined under

withRequest

i’m not sure what setup i got wrong

The error message means that your request isn't being sent by your code

my mistake, i type the above by hand. i do have async in the test

can you please share the actual code?

the above is as close to the actual code as i am permitted to share (NDA)

Ok. I can't help you other than tell you that the error message means that your request is not being received by the mock server. Either you're not sending it, or it's not going to the right place, or you are sending it, but it is not what you set up in the test, or your test isn't waiting for the request to be sent before asking pact if it was sent.

how do i confirm that the mock server is actually live and receiving requests? am i able to ping it mid-test or some other method?

You don't need to do that.

this is what the returned response from the api looks like

{
      status: [Function: status],
      ok: true,
      get: [Function: mockConstructor] {
        _isMockFunction: true,
        getMockImplementation: [Function],
        mock: [Getter/Setter],
        mockClear: [Function],
        mockReset: [Function],
        mockRestore: [Function],
        mockReturnValueOnce: [Function],
        mockResolvedValueOnce: [Function],
        mockRejectedValueOnce: [Function],
        mockReturnValue: [Function],
        mockResolvedValue: [Function],
        mockRejectedValue: [Function],
        mockImplementationOnce: [Function],
        mockImplementation: [Function],
        mockReturnThis: [Function],
        mockName: [Function],
        getMockName: [Function]
      },
      toError: [Function: mockConstructor] {
        _isMockFunction: true,
        getMockImplementation: [Function],
        mock: [Getter/Setter],
        mockClear: [Function],
        mockReset: [Function],
        mockRestore: [Function],
        mockReturnValueOnce: [Function],
        mockResolvedValueOnce: [Function],
        mockRejectedValueOnce: [Function],
        mockReturnValue: [Function],
        mockResolvedValue: [Function],
        mockRejectedValue: [Function],
        mockImplementationOnce: [Function],
        mockImplementation: [Function],
        mockReturnThis: [Function],
        mockName: [Function],
        getMockName: [Function]
      }
    }

Well. This is why we ask for the actual test code. That is a mock provided by something other than pact. Looks like Jest, probably.

in the test i am calling the apiclient that we have defined. under the hood, the api client is calling

superagent

Something is mocking your API layer, and you're not really sending a post request.

ok, i’ll look into that. this test is being run as a standalone test. not sure if jest automagically mocks http requests

it doesn't.

then i am stumped 😅 . we’re not mocking http calls in this test

You're definitely mocking something - that's a mock object that you posted

will see what i can find

Sorry I can't be more helpful.

all good, this is good enough direction for now. thanks! will explore and let you know if i get anywhere

My guess is somewhere you have something like

jest.mock('superagent')

thanks for that direction. that was the issue.

superagent

was being mocked by

jest

automatically because we have a

___mocks___

directory where a custom implementation of

superagent

was defined. just added

jest.unmock('superagent')

to the pact test file and looks like the request is being made as expected

Awesome! In general, I think it's risky to mock your http framework, because you can't check that you're invoking it correctly. If you need to mock the API for unit tests, I would mock

myApi

instead - then you can use pact to ensure that the mock objects that you're using in your unit tests can actually be received by your API.

On the “how can we make this easier for users” front, I wonder if we could detect the use of common tools (like supertest, or jest mocks) and suggest a fix?

I'm not sure how we could do that. I've wondered about

expect(responseObject).toMatchPactExpectations()

which just does a

stripMatchers

, but I think that might cause more confusion

ooh that

stripMatchers

method sounds like a useful one that i am definitely going to use. didn’t know that existed and i just manually stripped them lol. thanks!

Apologies, it's called extractPayload

gotchya, no worries! i was just about to ask that too. found the github commit for that particular conversation regarding renaming it

Yes