Generate Snippets for Multiple Content-Types #72

bpross · 2021-08-13T16:21:08Z

Adds support for generating snippets for endpoint methods that support multiple content-types. Endpoints might support uploading files using multipart/form-data, but otherwise support application/json for other modifications. As it stands this library has the following behavior:

Generate a snippet for the first content-type defined in path.method.requestBody.content
Set the content-type header to be the last content-type defined in path.method.requestbody.content

This PR address those concerns by:

Generating a code snippet for each of the content-types defined in path.method.requestBody.content
Add support for multipart/form-data with accompanying tests
Adding mimeType to the snippet object to provide uniqueness of snippets
Removing the parsing of content-type headers in `getHeaders.
Setting content-type headers for HARs that have postData
Simplify getPayloads to loop over supported content-types instead of hard coding blocks. This will ease support for more content-type support in the future

…verify behavior

…d if there are multiple content-type request bodies. Refactor generation methods to adjust for return type changes. Refactor header parsing to move content-type header to come from the postData parsing

….comment is undefined, not set to undefined. Fix some formatting

…dy generation. Format code

bpross · 2021-08-24T15:05:28Z

@ErikWittern do you mind taking a look when you have a change? Thanks!

ErikWittern · 2021-08-27T07:28:25Z

@bpross I just merged #71, which introduced a conflict with this PR. Would you be willing to resolve the conflict?

bpross · 2021-08-27T15:33:30Z

@ErikWittern conflict resolved.

ErikWittern · 2021-08-27T17:28:36Z

test/test.js

+    ['node_request']
+  );
+  const snippet = result.snippets[0].content;
+  t.true(/boundary=---011000010111000001101001/.test(snippet));


@bpross Hah, I was not aware that this is a commonly used header for multipart/form-data...

ErikWittern

@bpross Excellent work, thank you so much for the contribution!

* Add x-www-form-urlencoded media type examples support (ErikWittern#67) * Add x-www-form-urlencoded media type * ditch querystring dependency * escape keys and values * add test * fix: replace all '%20' occurrences * fix: use replace function with wildcard instead of replaceAll * improve syntax Co-authored-by: Diogo Silva <diogo.silva@alviere.com> * Bump version; fix typo * Parse Query Params From Path in Addition to Method (ErikWittern#71) * Update query string parsing to look for parameters defined on the path in addition to the method. * Add return to method comment block * Fix comment formatting * Add tests to verify that method params override path params. Update query strings so method params override path params * Format all code * Generate Snippets for Multiple Content-Types (ErikWittern#72) * Add support for multipart/form-data snippet generation. Add tests to verify behavior * Add functionality to generate multiple snippets for an endpoint method if there are multiple content-type request bodies. Refactor generation methods to adjust for return type changes. Refactor header parsing to move content-type header to come from the postData parsing * Set mimeType to contentType instead of using magic string * Don't copy sample * Fix formatting * DRY payloads method up a bit * Move snippet creation into its own function. Only set mimeType if har.comment is undefined, not set to undefined. Fix some formatting * run prettier on code * Bump version * Fix bug when generating multipart/form-data requests (ErikWittern#73) Form data must be of type string, so stringify objects and arrays * Bump version * bump httpsnippet to latest v2 version (ErikWittern#75) * Bump version * Add csharp_httpclient to readme and link (ErikWittern#79) * Revise parameter handling for snippets (ErikWittern#86) * Revise example swagger to match test There are three test cases dealing with array value query parameters in test/parameter_example_swagger.json. The assertion for each of these is wrong as it assumes the array should not be exploded. However, two of these parameters are explicitly form style. The third is implicitly form style because that is the default for query parameters. None of them specify a value for explode, so this defaults to true. Therefore the assertions are wrong. See https://spec.openapis.org/oas/v3.0.3#fixed-fields-9 This commit does not fix the logic in the code, rather (for now) it just updates the spec that is being used for the test to set explode equal to false. * create function createHarParameterObjects This function takes an OpenAPI parameter and a sample value and creates a HAR "parameter" object which is just a {name: "", value: ""} object. The function handles all of the variatons outlined in the spec and this commit adds all the test cases that are presented here: https://swagger.io/docs/specification/serialization This function will be used in future commits to handle every type of parrameter while generating snippets. * refactor getParameterValues in terms of createHarParameterObjects This doesn't change the functionality yet. This is just in preparation for providing full support for all variations of parameters. This commit breaks no tests but prepares us for more test cases. * Add support for exploded values in query parameters * Add support for simple style exploded values in path * Add tests to demonstrate working label style path params * Add tests to demonstrate working matrix style path params * Add support for pipe and space delimited path params * Add tests to demonstrate working object and array values in headers * Re-order checks for candidate example param values Per the swagger guide: https://swagger.io/docs/specification/describing-parameters/ "Using default to specify a sample value. This is not intended use of default and can lead to unexpected behavior in some Swagger tools. Use the example or examples keyword for this purpose instead." Per this I think `default` should be the sample value of last resort instead favoring `example` and `examples` first. * Add support for samples in examples key This works for header, path, and query parameter which will now be discovered if the sample is in the examles key. The snippet will choose the first example in examples. * refactor getQueryStrings in terms of reusable method getQueryStrings was doing something special that getFullPath and getHeadersArray are not doing: considering both path and operation level defined parameters. By parameterizing this method on `in` we can later use it for `path`, `header` and `cookie` parameters as well. * Refactor getFullPath and getHeadersArray These functions are now written in terms of getParameterCollectionIn which does the following correctly * Considers path and operation parameters and overrides appropriately * Resolves parameter references * Resolves schema references * Looks at example, examples, schema.example and default keys looking for sample value So now getFullPath and getHeadersArray benefit from all of this logic. Each had one or more short comings. * Add support for cookie parameters * Resolve examples objects as needed * Bump shell-quote from 1.7.2 to 1.7.3 (ErikWittern#88) Bumps [shell-quote](https://github.com/substack/node-shell-quote) from 1.7.2 to 1.7.3. - [Release notes](https://github.com/substack/node-shell-quote/releases) - [Changelog](https://github.com/substack/node-shell-quote/blob/master/CHANGELOG.md) - [Commits](https://github.com/substack/node-shell-quote/compare/v1.7.2...1.7.3) --- updated-dependencies: - dependency-name: shell-quote dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump cached-path-relative from 1.0.2 to 1.1.0 (ErikWittern#76) Bumps [cached-path-relative](https://github.com/ashaffer/cached-path-relative) from 1.0.2 to 1.1.0. - [Release notes](https://github.com/ashaffer/cached-path-relative/releases) - [Commits](https://github.com/ashaffer/cached-path-relative/commits) --- updated-dependencies: - dependency-name: cached-path-relative dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump ajv from 6.12.0 to 6.12.6 (ErikWittern#77) Bumps [ajv](https://github.com/ajv-validator/ajv) from 6.12.0 to 6.12.6. - [Release notes](https://github.com/ajv-validator/ajv/releases) - [Commits](ajv-validator/ajv@v6.12.0...v6.12.6) --- updated-dependencies: - dependency-name: ajv dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Increase version; update dependencies --------- Co-authored-by: Diogo Silva <d-silva@users.noreply.github.com> Co-authored-by: Diogo Silva <diogo.silva@alviere.com> Co-authored-by: ErikWittern <erikwittern@googlemail.com> Co-authored-by: Benjamin Ross <benr22@gmail.com> Co-authored-by: Benjamin Ross <ben.ross@procore.com> Co-authored-by: restyler <russiancss@gmail.com> Co-authored-by: Davis Martin <davis.martin@procore.com> Co-authored-by: Michael Welch <michaelgwelch@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Ben Ross added 11 commits August 5, 2021 11:42

Add support for multipart/form-data snippet generation. Add tests to …

d8aecf7

…verify behavior

Add functionality to generate multiple snippets for an endpoint metho…

77dee03

…d if there are multiple content-type request bodies. Refactor generation methods to adjust for return type changes. Refactor header parsing to move content-type header to come from the postData parsing

Set mimeType to contentType instead of using magic string

789d6a7

Don't copy sample

ab788eb

Merge base branch

b9ba83a

Fix formatting

85c5d74

DRY payloads method up a bit

66b0dba

Merge base branch

445e612

Move snippet creation into its own function. Only set mimeType if har…

f07ec46

….comment is undefined, not set to undefined. Fix some formatting

run prettier on code

538ef52

Merge in main. Update urlencoded form code to fit in with multiple bo…

11803c0

…dy generation. Format code

Fix merge conflicts with main

7b6377c

ErikWittern reviewed Aug 27, 2021

View reviewed changes

ErikWittern approved these changes Aug 27, 2021

View reviewed changes

ErikWittern merged commit cb9fbb5 into ErikWittern:main Aug 27, 2021

bpross deleted the gen-multiple-snippets-for-multiple-content-types branch August 27, 2021 18:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Generate Snippets for Multiple Content-Types #72

Generate Snippets for Multiple Content-Types #72

Uh oh!

bpross commented Aug 13, 2021

Uh oh!

bpross commented Aug 24, 2021

Uh oh!

ErikWittern commented Aug 27, 2021

Uh oh!

bpross commented Aug 27, 2021

Uh oh!

ErikWittern Aug 27, 2021

Uh oh!

ErikWittern left a comment

Uh oh!

Uh oh!

Generate Snippets for Multiple Content-Types #72

Generate Snippets for Multiple Content-Types #72

Uh oh!

Conversation

bpross commented Aug 13, 2021

Uh oh!

bpross commented Aug 24, 2021

Uh oh!

ErikWittern commented Aug 27, 2021

Uh oh!

bpross commented Aug 27, 2021

Uh oh!

ErikWittern Aug 27, 2021

Choose a reason for hiding this comment

Uh oh!

ErikWittern left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!