Matcher includes is not working in expectJsonSnapshot

[ASaiAnudeep]

Discussed in #98

^{Originally posted by captaincc423 December 1, 2021}
I'm trying to get some matchers to work in expectJsonSnapshot and I'm running into a few problems:

1. I'm trying to use a variable variable with a string in an "includes()", e.g. "id": includes(response.body.id) and it's not working. It always says it doesn't match.

Am I misusing these matchers?

[olcortesb]

Hi, I was reviewing the issue and I have a propose for solution.

• I think it's possible to pass a function to include for get the value of body snapshot. For example include( (resp) => resp.body.id)). So in to src/models/expect.js method _validateJsonSnapshot(response) add new 'if' validating if param of include is a functions, if it is true, load the file json snapshot and evaluate the functions.
  And, finally send the result to jmv.validate( ... ) , similar to actual behavior of include for string parameter

What do you thinks about?

[ASaiAnudeep]

The matchers are initially designed to support contract testing. Need to evaluate on how it effects the matching capabilities at flow server if we start supporting callback functions.

[olcortesb]

Yes, It's true, is necessary evaluate the impact.

Another solution could be passing the functions as string in to include(), and use eval() o new Function()() for evaluate in to _validateJsonSnapshot(response) , for example:

...

"id": includes('return response.body.id')
...
// In _validateJasonSnapshot(response)
// Previews validations of return in string
value = new Function(value)(response)
...
const current_rules = jmv.getMatchingRules(value, '$.body')

[olcortesb]

I add a draft PR for review the second solutions. #213

[olcortesb]

I close Pull Request , comment in the PR! #213

[ASaiAnudeep]

@olcortesb Thank you for taking time to fix this issue.

The easiest resolution would be making the strict comparison configurable while validating json snapshots.

const strict = false;
const errors = jmv.validate(actual, expected, all_rules, '$.body', strict);

User needs to be cautious while disabling strict comparison. May be we can pass the true/false as the second or third argument.

expectJsonSnapshot(matchers, strict?);
expectJsonSnapshot(name, matchers, strict?);

[olcortesb]

@olcortesb Thank you for taking time to fix this issue.

The easiest resolution would be making the strict comparison configurable while validating json snapshots.

const strict = false;
const errors = jmv.validate(actual, expected, all_rules, '$.body', strict);

User needs to be cautious while disabling strict comparison. May be we can pass the true/false as the second or third argument.

expectJsonSnapshot(matchers, strict?);
expectJsonSnapshot(name, matchers, strict?);

OK, Interesting, I take your recommendation with strict comparison configurable and prepare a Pull Request! thanks

[ASaiAnudeep]

This is fixed pactumjs/pactum-matchers#26