feat: generating path examples #671
Conversation
There was a problem hiding this comment.
We're on the good track. Good job with the tests coverage.
-
I've left some comments on the fp-ts usage and there are different ways we can improve the code. Let me know if you need any help on this
-
Apparently the harness tests are halting (they go to timeout); do not worry about this too much right now but we'll have to figure it out :)
-
I've tried the CLI with the new changes and here's the output:
I believe we have some changes to do:
http://127.0.0.1:4010/pet/findByStatus?status=available,sold,sold
This is technically correct but I believe that we should limit ourselves to a single example and more importantly do not repeat an example twice.
http://127.0.0.1:4010/pet/-41647052
This is also correct, although we might want to limit the example to positive numbers and less than…1000?
http://127.0.0.1:4010/user/quis%20velit%20nostrud
In order to make the things easier to read I would say we shall only produce examples with no spaces or special characters.
//cc @philsturgeon let me know if you're ok with these suggestions.
packages/cli/src/util/__tests__/__snapshots__/paths.spec.ts.snap
Outdated
Show resolved
Hide resolved
| logInstance.note(`${resource.method.toUpperCase().padEnd(10)} ${address}${resource.path}`); | ||
| const path = pipe( | ||
| createExamplePath(resource), | ||
| Either.getOrElse(() => resource.path), |
There was a problem hiding this comment.
Nice fallback. If we fail, we display the regular path.
packages/http/src/mocker/generator/__tests__/HttpParamGenerator.spec.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
I had another round of checks; very good job, the code is going towards the right direction.
I've added other comments and suggestions and I'll take a final review tomorrow, and hopefully get this merged.
P.S: You have a lot of unused imports, try to check out all the files and remove them if you can.
packages/cli/src/util/paths.ts
Outdated
| case HttpParamStyles.SpaceDelimited: | ||
| if (Array.isArray(value)) { | ||
| return Either.right( | ||
| serializeWithSpaceDelimitedStyle(spec.name, value as Array<string | number | boolean>, spec.explode), |
There was a problem hiding this comment.
ditto
| serializeWithSpaceDelimitedStyle(spec.name, value as Array<string | number | boolean>, spec.explode), | |
| serializeWithSpaceDelimitedStyle(spec.name, value, spec.explode), |
packages/http/src/mocker/generator/__tests__/HttpParamGenerator.spec.ts
Outdated
Show resolved
Hide resolved
packages/http/src/mocker/generator/__tests__/HttpParamGenerator.spec.ts
Outdated
Show resolved
Hide resolved
| } | ||
| } | ||
|
|
||
| if (newSchema.type === 'string') { |
There was a problem hiding this comment.
| if (newSchema.type === 'string') { | |
| else if (newSchema.type === 'string') { |
| } | ||
| } | ||
|
|
||
| if (newSchema.type === 'object') { |
There was a problem hiding this comment.
| if (newSchema.type === 'object') { | |
| else if (newSchema.type === 'object') { |
| } | ||
| } | ||
|
|
||
| if (newSchema.type === 'array') { |
There was a problem hiding this comment.
| if (newSchema.type === 'array') { | |
| else if (newSchema.type === 'array') { |
Closes #505
Checklist
What kind of change does this PR introduce?
Feature
What is the current behavior? What is the new behavior?
Prism CLI lists available operation paths to the console. This feature adds example parameter values to those paths. This both path and query parameters.
Does this PR introduce a breaking change?
No