fix: Fix pact-matchers for nested objects #60
Conversation
| }, | ||
| "$.body.objectInline.nestedArray": Object { | ||
| "match": "regex", | ||
| "regex": "^[0-9a-fA-F]+$", |
There was a problem hiding this comment.
This is incorrect matching rule.
objectInline.nesgtedArray is not string field, but array, so regex is incorrect
There was a problem hiding this comment.
I think you have created a too complex test case for the test, which is too large and finally, there are difficulties to analyze a lot of snapshot lines.
src/core/type-representation.ts
Outdated
| if (typeMatcher && exampleRepresentation) { | ||
|
|
||
| // recursively set type representation for nested object properties | ||
| if (propertyType.isObject() && !propertyType.isArray()) { |
There was a problem hiding this comment.
It is not solution to this problem.
The problem is in line #90 https://github.com/HLTech/pact-gen-ts/pull/60/files#diff-c6a2f1cd0cfa639da00a7d6c3dfb23df5d133f76e94823ec2619cd05535aa917R90 of this file. We get all descendants of object property (so, if AST contains some JSDocTag node for nested field of some parent field, this is persisted only for parent object field). So, the solution is getting only children nodes of JSDocComments kind of current field.
Working solution:
const jsDocTagsOfProperty = property.getValueDeclaration()?.getChildrenOfKind(ts.SyntaxKind.JSDocComment).reduce((jsDocTags, jsDocCommentElement) => {
return [...jsDocTags, ...(jsDocCommentElement.getChildrenOfKind(ts.SyntaxKind.JSDocTag))];
}, []);use it, and remove your code :)
pawfa
force-pushed
the
fix-nested-object-pact-matchers
branch
from
d8e8a93
to
7e7eef6
Compare
tests/int/pactGenerating.test.ts
Outdated
| @@ -25,6 +24,16 @@ describe('createPacts', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| test('pact-matcher', () => { | |||
There was a problem hiding this comment.
Is it purposeful or some test residues?
There was a problem hiding this comment.
I did it as a first step in separating those tests - having them all in one each makes it a bit more cumbersome to run quickly and get instant feedback. I would even suggest moving all those snapshots into separate files somewhere in the future, we could see in this PR that following and checking everything when it is in one large piece of text is not an easy task.
There was a problem hiding this comment.
Actually after consideration - I reverted this change in this PR - lets do it all at once in other refactor task - but the idea stays the same.
package.json
Outdated
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "pact-gen-ts", | |||
| "version": "0.9.0", | |||
| "version": "0.9.1", | |||
There was a problem hiding this comment.
You have to update version to 0.9.2.
There has been already 0.9.1 version
There was a problem hiding this comment.
Semantic-versioning library is super convenient :) - I guess we could think about implementing it in the near future.
There was a problem hiding this comment.
Yeah.
first we need to release version 1.0 :P
|
Looks nice |
pawfa
force-pushed
the
fix-nested-object-pact-matchers
branch
from
7e7eef6
to
37a9fbe
Compare
Fixes #58