<#1071 headers with matchers are not working the s...
# pact-js-developmentg
GitHub
03/08/2023, 10:03 PM#1071 headers with matchers are not working the same way as in v9
Issue created by jhayes-dev
Software versions
• OS: macOS 12.4
• Consumer Pact library: v11.0.0
• Node Version: v16.19.1
Issue Checklist
Please confirm the following:
☑︎ I have upgraded to the latest
☑︎ I have the read the FAQs in the Readme
☑︎ I have triple checked, that there are no unhandled promises in my code and have read the section on intermittent test failures
☑︎ I have set my log level to debug and attached a log file showing the complete request/response cycle
☐ For bonus points and virtual high fives, I have created a reproduceable git repository (see below) to illustrate the problem
Expected behaviour
I'm upgrading to pact@11 form pact@9. When defining the consumer tests the mock server return the correct body.
Copy code
{
expected_response: {
data: 'some string',
event_id: '37227fda-94d3-4422-908d-fe2303914e98',
posted_date: '2021-03-17T07:52:34.666Z'
},
} Copy code
{
data: {
data: { value: 'some string', 'pact:matcher:type': 'type' },
event_id: {
value: '37227fda-94d3-4422-908d-fe2303914e98',
'pact:matcher:type': 'type'
},
posted_date: {
value: '2021-03-17T07:52:34.666Z',
regex: '^\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d\\.\\d+([+-][0-2]\\d(:?[0-5]\\d)?|Z)$',
'pact:matcher:type': 'regex'
}
}
} Copy code
import path from 'node:path';
import { Pact, Matchers } from '@pact-foundation/pact';
import axios, { AxiosResponse } from 'axios';
interface RequestPayload {
data: string;
}
interface ResponsePayload extends RequestPayload {
event_id: string;
posted_date: string;
}
function toTemplate<T extends object>(obj: T): { [K in keyof T]: T[K] } {
return obj;
}
async function main() {
const provider: Pact = new Pact({
consumer: 'consumer',
provider: 'provider',
dir: path.resolve('pacts'),
spec: 2,
logLevel: 'debug'
});
await provider.setup();
const request: RequestPayload = {
data: 'some string'
};
const expected_response: ResponsePayload = {
...request,
event_id: '37227fda-94d3-4422-908d-fe2303914e98',
posted_date: '2021-03-17T07:52:34.666Z'
};
await provider.addInteraction({
state: undefined,
uponReceiving: 'a post to the event bus',
willRespondWith: {
body: {
data: Matchers.string(expected_response.data),
event_id: Matchers.string(expected_response.event_id),
posted_date: Matchers.iso8601DateTimeWithMillis(expected_response.posted_date),
},
headers: {
// this worked in pact v9 but in v11 the returned body has all the 'value', 'regex' and 'pact:matcher:type' fields.
// 'Content-Type': Matchers.term({
// generate: 'application/json;charset=utf-8',
// matcher: 'application/json.*'
// }),
// this also returns the body without the matchers replaced like above.
'Content-Type': Matchers.term({
generate: 'application/json',
matcher: 'application/json.*'
}),
// this returns the correct body (with the matchers converted to example values)
// 'Content-Type': 'application/json',
},
status: 201
},
withRequest: {
body: toTemplate(request),
headers: {
// this worked in pact v9 but in v11 return server error (500)
// 'Content-Type': Matchers.term({
// generate: 'application/json;charset=utf-8',
// matcher: 'application/json.*'
// }),
// this works in pact v11 (I think it is just checking against the generate value not the regex)
'Content-Type': Matchers.term({
generate: 'application/json',
matcher: 'application/json.*'
}),
// 'Content-Type': 'application/json',
},
method: 'POST',
path: '/endpoint'
}
});
const client = axios.create({ baseURL: provider.mockService.baseUrl });
const { data } = await <http://client.post|client.post><RequestPayload, AxiosResponse<ResponsePayload>>('/endpoint', request);
console.dir({ request, expected_response, data }, { depth: null });
await provider.verify();
await provider.finalize();
}
main().catch(err => {
console.log('error: ', err)
process.exitCode = 1;
})2 Views