Skip to content

Conversation

@erunion
Copy link
Contributor

@erunion erunion commented Apr 29, 2022

This is a reworking of my original PR in #219 for this, just against the new TS rewrite.

This slightly modifies the cURL snippet target to clean up how it handles JSON payloads into rendering them on multiple lines.

This is what they currently look like:

curl --request POST \
  --url http://mockbin.com/har \
  --header 'content-type: application/json' \
  --data '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'

With this change:

curl --request POST \
  --url http://mockbin.com/har \
  --header 'content-type: application/json' \
  --data '
{
  "number": 1,
  "string": "f\"oo",
  "arr": [
    1,
    2,
    3
  ],
  "nested": {
    "a": "b"
  },
  "arr_mix": [
    1,
    "a",
    {
      "arr_mix_nested": {}
    }
  ],
  "boolean": false
}
'

🐳 Things to note

  • I don't love how arrays and objects get blown out if they're small enough to be able to fit on a single line (like arr is above), but the stringify-object library that's used throughout this library for doing prettification of objects removes quotes from object keys, which in this case would result in invalid JSON from being sent.
  • If the JSON payload has a ' quote within it, we can't wrap that in a --data string without busting STDIN so instead we wrap the JSON within a HEREDOC:
curl --request POST \
  --url http://mockbin.com/har \
  --header 'content-type: application/json' \
  --data @- <<EOF
{
  "number": 1,
  "string": "f'oo"
}
EOF
  • To prevent miniscule JSON payloads from getting blown out snippets, if the stringified JSON is less than or equal to 20 characters we'll render it on one line:
curl --request POST \
  --url http://mockbin.com/har \
  --header 'content-type: application/json' \
  --data '{"foo":null}'

@CLAassistant
Copy link

CLAassistant commented May 24, 2022

CLA assistant check
All committers have signed the CLA.

@dimitropoulos dimitropoulos added the improvement improvement label Jul 13, 2022
@dimitropoulos dimitropoulos force-pushed the feat/cleaner-json-in-curl branch from bd1ad42 to e63b1b9 Compare July 18, 2022 14:15
@dimitropoulos dimitropoulos merged commit 735e69a into Kong:master Jul 18, 2022
@erunion erunion deleted the feat/cleaner-json-in-curl branch July 18, 2022 16:20
erunion referenced this pull request in readmeio/httpsnippet Jun 16, 2023
* Total Overhaul (but with all the same fixtures!) (#248)

see Kong#248 and the commits therein for more context.  Essentially:
- the original client fixtures were unchanged, which hopefully means the 
- all source code is now in strict mode TypeScript
- tests are now all in jest
- the file structure was reorganized so that everything for a particular client is in one place
- the CLI is updated and now using yargs
- all dependencies were updated and some (i.e. `format.utils`) were able to be removed entirely
- more work left to do (including CI with GitHub Actions, for example), but this is a start

* fix: case where if `postData.params` is missing some targets crash (#258)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: compatibility issues on node 14 with `Object.hasOwn()` (#252)

* fix: typo in the httpie `style` option not being correctly applied (#254)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: axios targets not sending `x-www-form-urlencoded` properly (#255)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* feat: addition of a PHP target for Guzzle (#253)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* Add Github Build Workflow (#250) (#251)

* Add Github Build Workflow (#250)

* Edit job name

* Replace install with ci on GH workflow

* Add matrix with major node versions (14, 16, 18)

* Disable fail-fast

* Remove node v14 from build GH action

* feat: native upload support in python `requests` snippets (#259)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: `multipart/form-data` header issues with node/js fetch targets (#257)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: headers not being properly applied to R httr snippets (#263)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* Fix build workflow dispatch rules (#265)

* Chore: Remove travis links (#266)

* Remove travis links

* Update README.md

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: issue where query strings in R wouldn't be properly concatenated (#269)

* fix: issue where query strings in R wouldn't be properly concatenated

* adds (and respects) indent options to httr, plus double looping fix

now, indent is respected, and also avoiding running Object.keys twice per run since we can just run it once with .entries

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* add header namesspace to prevent header errors (#247)

* add header namesspace to prevent header errors

* update fixtures

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: stop implicitly coercing warning in Swift snippet generator (#195)

* swift/nsurlsession adds `as Any` to print for error

* adds OVERWRITE_EVERYTHING to ease fixture snapshot resetting

* updates fixtures

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: clj-http handling of literal null JSON bodies (#283)

Co-authored-by: Sergey Zakharchenko <[email protected]>

* fix: prevent crash in Swift/Objc with checking length of input body post params (#192)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* fix: cUrl target should encode x-www-form-urlencoded post data params (#198)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* feat: Add support for insecureSkipVerify (#285)

* go/native: adds insecureSkipVerify

* node/native: adds insecureSkipVerify

* python/python3: adds insecureSkipVerify

* ruby/native: adds insecureSkipVerify

* shell/curl: adds insecureSkipVerify

Co-authored-by: Tim Perry <[email protected]>

* feat: implementing cleaner handling of JSON in cURL snippets (#256)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* chore: minor cleanup (#286)

* feat: use curl's --compressed option for requests that accept it (#287)

* feat: make Python snippets simpler, clearer & more consistent (#288)

Co-authored-by: Tim Perry <[email protected]>

* feat: change the default response code for Python Requests (#181)

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* feat: PHP JSON body encoding (#291)

* php/curl: use json_encode for CURLOPT_POSTFIELDS

* php/http1: use json_encode when body is JSON

* php/http2: use json_encode when body is JSON

Co-authored-by: Andrii Kostenko <[email protected]>

* Async/Await (top level) support in JavaScript snippets (#292)

* Exclude package.json from build to fix output paths (#294)

* Exclude package.json from build to fix output paths

* keeps bin pointing at cli output

* makes rootDir explicit

* removes unused cli build scripts

Co-authored-by: Dimitri Mitropoulos <[email protected]>

* Fix crash when building nsurlsession snippets for empty params (#295)

* removes `require 'openssl'` from ruby target (no longer needed) (#296)

* Escape quotes in headers correctly in all languages (#289)

* updates README (#299)

Co-authored-by: Filipe Freire <[email protected]>

* ioutil -> io (deprecated) (#305)

* chore: undoing unwanted changes

* chore: revert more unwanted changes

* chore: reverting more unwanted changes

* fix: fixing broken test snapshots and libcurl not escaping

* fix: a bunch of broken tests

* fix: removing dead code

* fix: remove support for `insecureSkipVerify` as we dont need or want it

* fix: removing top-level await changes for axios

* fix: revert top-level await changes for js:fetch

* fix: remove some problematic changes to `node:request`

* fix: retaining line trimming in powershell snippets

* fix: bug in php snippets where booleans were casted to null

* fix: revert problematic changes to python:requests

* fix: revert more unwanted changes

* chore: temporarily skipping the integration suite

* fix: broken snapshot

* fix: disabling the integration suite from being run without inside docker

* fix: integration suite

* fix: integration suite

---------

Co-authored-by: Dimitri Mitropoulos <[email protected]>
Co-authored-by: Filipe Freire <[email protected]>
Co-authored-by: Davis Martin <[email protected]>
Co-authored-by: iraj taghlidi <[email protected]>
Co-authored-by: Sergey Zakharchenko <[email protected]>
Co-authored-by: Julien Giovaresco <[email protected]>
Co-authored-by: Tim Perry <[email protected]>
Co-authored-by: Andrii Kostenko <[email protected]>
Co-authored-by: Tim Perry <[email protected]>
Co-authored-by: Alexander Weber <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants