Kong / Kong/httpsnippet

Generated multipart curl doesn't escape characters of form data fields

Open
#260 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1.2k
Forks
242
PR merge metrics
No merged PRs in 30d

Description

Related with https://github.com/Kong/insomnia/issues/3868

As of now we are not escaping double-quote characters that are in data fields of curl requests. This causes the curl request to fail.

Example generated curl:
```
curl --request GET \
--url http://mockbin.org/request/anything \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--form timestamp=2022-05-10T10:04:18.748Z \
--form field=test \
--form 'data=
TEST'
```

This doesn't seem to be the case for example for Python, where we escape characters we need to, and the request works fine:
```
import requests

url = "http://mockbin.org/request/anything"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timestamp\"\r\n\r\n2022-05-10T10:07:25.650Z\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"field\"\r\n\r\ntest\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data\"\r\n\r\n\nTEST\r\n-----011000010111000001101001--\r\n"
headers = {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'}

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)
```

Example postman generated curl:
```
curl --location --request POST 'https://test.com' \
--form 'timestamp="2021-07-14T01:02:34.567Z"' \
--form 'field="test"' \
--form 'data="
TEST"'
```

Contributor guide

Open the contributing guide

Research direction

Start by locating the TypeScript code that generates multipart curl snippets and reproduce the shown XML field case. Update the generated form-data argument so embedded quote characters are escaped, then verify that the resulting curl request succeeds and add or update coverage if the repository has a relevant test.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.