btwedutech/hoppscotch
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

fix: ensure Content-Type header priority in the CLI (#4242)

Browse Source 
- Ensure the `Content-Type` header takes priority over the value set in the request body.
- Introduces `HoppRESTRequest` schema `v6` with `text/xml` added under the supported content types.
This commit is contained in:
James George
2024-08-07 09:16:27 -07:00
committed by GitHub
parent 31b691bb37
commit a8bcc75467
11 changed files with 290 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/hoppscotch-cli/src/__tests__/e2e/commands/test.spec.ts
View File

@@ -149,6 +149,16 @@ describe("hopp test [options] <file_path_or_id>", () => {
expect(error).toBeNull();
});
test("The `Content-Type` header takes priority over the value set at the request body", async () => {
const args = `test ${getTestJsonFilePath(
"content-type-header-scenarios.json",
"collection"
)}`;
const { error } = await runCLI(args);
expect(error).toBeNull();
});
});
describe("Test `hopp test <file_path_or_id> --env <file_path_or_id>` command:", () => {

171
packages/hoppscotch-cli/src/__tests__/e2e/fixtures/collections/content-type-header-scenarios.json Normal file
View File

@@ -0,0 +1,171 @@
{
"v": 2,
"name": "content-type-header-scenarios",
"folders": [],
"requests": [
{
"v": "6",
"auth": {
"authType": "inherit",
"authActive": true
},
"body": {
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n <user>\n <id>12345</id>\n <name>John Doe</name>\n <email>john.doe@example.com</email>\n </user>\n <order>\n <id>98765</id>\n <product>Sample Product</product>\n <quantity>2</quantity>\n </order>\n</request>\n",
"contentType": "text/xml"
},
"name": "content-type-header-assignment",
"method": "POST",
"params": [],
"headers": [],
"endpoint": "https://echo.hoppscotch.io",
"testScript": "pw.test(\"The `Content-Type` header is assigned the content type value set at the request body level\", ()=> {\n pw.expect(pw.response.body.headers[\"content-type\"]).toBe(\"text/xml\");\n});",
"preRequestScript": "",
"requestVariables": []
},
{
"v": "6",
"auth": {
"authType": "inherit",
"authActive": true
},
"body": {
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n <user>\n <id>12345</id>\n <name>John Doe</name>\n <email>john.doe@example.com</email>\n </user>\n <order>\n <id>98765</id>\n <product>Sample Product</product>\n <quantity>2</quantity>\n </order>\n</request>\n",
"contentType": "application/json"
},
"name": "content-type-header-override",
"method": "POST",
"params": [],
"headers": [
{
"key": "Content-Type",
"value": "application/xml",
"active": true
}
],
"endpoint": "https://echo.hoppscotch.io",
"testScript": "pw.test(\"The `Content-Type` header overrides the content type value set at the request body level\", ()=> {\n pw.expect(pw.response.body.headers[\"content-type\"]).toBe(\"application/xml\");\n});",
"preRequestScript": "",
"requestVariables": []
},
{
"v": "6",
"auth": {
"authType": "inherit",
"authActive": true
},
"body": {
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n <user>\n <id>12345</id>\n <name>John Doe</name>\n <email>john.doe@example.com</email>\n </user>\n <order>\n <id>98765</id>\n <product>Sample Product</product>\n <quantity>2</quantity>\n </order>\n</request>\n",
"contentType": "application/json"
},
"name": "multiple-content-type-headers",
"method": "POST",
"params": [],
"headers": [
{
"key": "Content-Type",
"value": "text/xml",
"active": true
},
{
"key": "Content-Type",
"value": "application/json",
"active": true
},
{
"key": "Content-Type",
"value": "application/xml",
"active": true
}
],
"endpoint": "https://echo.hoppscotch.io",
"testScript": "pw.test(\"The last occurrence will be considered among multiple `Content-Type` headers\", ()=> {\n pw.expect(pw.response.body.headers[\"content-type\"]).toBe(\"application/xml\");\n});",
"preRequestScript": "",
"requestVariables": []
},
{
"v": "6",
"auth": {
"authType": "inherit",
"authActive": true
},
"body": {
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n <user>\n <id>12345</id>\n <name>John Doe</name>\n <email>john.doe@example.com</email>\n </user>\n <order>\n <id>98765</id>\n <product>Sample Product</product>\n <quantity>2</quantity>\n </order>\n</request>\n",
"contentType": null
},
"name": "multiple-content-type-headers-different-casing",
"method": "POST",
"params": [],
"headers": [
{
"key": "Content-Type",
"value": "text/xml",
"active": true
},
{
"key": "content-Type",
"value": "application/json",
"active": true
},
{
"key": "Content-type",
"value": "text/plain",
"active": true
},
{
"key": "CONTENT-TYPE",
"value": "application/xml",
"active": true
}
],
"endpoint": "https://echo.hoppscotch.io",
"testScript": "pw.test(\"The last occurrence will be considered among multiple `Content-Type` headers following different casing\", ()=> {\n pw.expect(pw.response.body.headers[\"content-type\"]).toBe(\"application/xml\");\n});",
"preRequestScript": "",
"requestVariables": []
},
{
"v": "6",
"auth": {
"authType": "inherit",
"authActive": true
},
"body": {
"body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request>\n <user>\n <id>12345</id>\n <name>John Doe</name>\n <email>john.doe@example.com</email>\n </user>\n <order>\n <id>98765</id>\n <product>Sample Product</product>\n <quantity>2</quantity>\n </order>\n</request>\n",
"contentType": null
},
"name": "multiple-content-type-headers-different-casing-without-value-set-at-body",
"method": "POST",
"params": [],
"headers": [
{
"key": "Content-Type",
"value": "text/xml",
"active": true
},
{
"key": "content-Type",
"value": "application/json",
"active": true
},
{
"key": "Content-type",
"value": "text/plain",
"active": true
},
{
"key": "CONTENT-TYPE",
"value": "application/xml",
"active": true
}
],
"endpoint": "https://echo.hoppscotch.io",
"testScript": "pw.test(\"The content type is inferred from the `Content-Type` header if not set at the request body\", ()=> {\n pw.expect(pw.response.body.headers[\"content-type\"]).toBe(\"application/xml\");\n});",
"preRequestScript": "",
"requestVariables": []
}
],
"auth": {
"authType": "inherit",
"authActive": true
},
"headers": []
}