Skip to content

Initial work on supporting binary bodies in both directions (request and response) #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jarl-dk wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Initial work on supporting binary bodies in both directions (request and response) #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"no-throw-literal": 2,
"no-trailing-spaces": 2,
"no-undef-init": 2,
"no-underscore-dangle": [2, { "allow": ["_links", "_behaviors", "_mode", "_proxyResponseTime"] }],
"no-underscore-dangle": [2, { "allow": ["_links", "_behaviors", "_proxyResponseTime"] }],
"no-unneeded-ternary": 2,
"no-unused-expressions": 2,
"no-useless-call": 2,
Expand Down
6 changes: 3 additions & 3 deletions mbTest/api/http/httpImposterTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,11 @@ const assert = require('assert'),
assert.strictEqual(response.statusCode, 200);
assert.deepEqual(response.body.stubs, [
{
responses: [{ is: { body: '1' } }],
responses: [{ is: { bodyEncoding: 'utf8', body: '1' } }],
_links: { self: { href: `${api.url}/imposters/${port}/stubs/0` } }
},
{
responses: [{ is: { body: '2' } }],
responses: [{ is: { bodyEncoding: 'utf8', body: '2' } }],
_links: { self: { href: `${api.url}/imposters/${port}/stubs/1` } }
}
]);
Expand Down Expand Up @@ -214,7 +214,7 @@ const assert = require('assert'),
port: port + 1,
name: imposter.name,
recordRequests: false,
stubs: [{ responses: [{ is: { body: 'Hello, World!' } }] }]
stubs: [{ responses: [{ is: { bodyEncoding: 'utf8', body: 'Hello, World!' } }] }]
});
});
});
Expand Down
63 changes: 48 additions & 15 deletions mbTest/api/http/httpProxyStubTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ describe('http proxy stubs', function () {
});
}

['application/octet-stream', 'audio/mpeg', 'audio/mp4', 'image/gif', 'image/jpeg', 'video/avi', 'video/mpeg'].forEach(mimeType => {
['application/octet-stream', 'audio/mpeg', 'audio/mp4', 'image/gif', 'image/jpeg', 'video/avi', 'video/mpeg', ''].forEach(mimeType => {
it(`should treat ${mimeType} as binary`, async function () {
const buffer = Buffer.from([0, 1, 2, 3]),
origin = {
Expand All @@ -183,7 +183,7 @@ describe('http proxy stubs', function () {
is: {
body: buffer.toString('base64'),
headers: { 'content-type': mimeType },
_mode: 'binary'
bodyEncoding: null
}
}]
}]
Expand Down Expand Up @@ -298,6 +298,8 @@ describe('http proxy stubs', function () {
state.count = state.count || 0;
state.count += 1;
return {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: `${state.count}. ${request.path}`
};
},
Expand Down Expand Up @@ -335,6 +337,8 @@ describe('http proxy stubs', function () {
state.count = state.count || 0;
state.count += 1;
return {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: `${state.count}. ${request.path}`
};
},
Expand Down Expand Up @@ -378,6 +382,8 @@ describe('http proxy stubs', function () {
state.count = state.count || 0;
state.count += 1;
return {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: `${state.count}. ${JSON.stringify(request.query)}`
};
},
Expand Down Expand Up @@ -417,6 +423,8 @@ describe('http proxy stubs', function () {
state.count = state.count || 0;
state.count += 1;
return {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: `${state.count}. ${JSON.stringify(request.query)}`
};
},
Expand Down Expand Up @@ -452,7 +460,12 @@ describe('http proxy stubs', function () {

it('should persist behaviors from origin server', async function () {
const originServerPort = port + 1,
originServerStub = { responses: [{ is: { body: '${SALUTATION} ${NAME}' } }] },
originServerStub = { responses: [{
is: {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: '${SALUTATION} ${NAME}'
} }] },
originServerRequest = {
protocol: 'http',
port: originServerPort,
Expand Down Expand Up @@ -528,6 +541,8 @@ describe('http proxy stubs', function () {
state.count = state.count || 0;
state.count += 1;
return {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: `${state.count}. ${request.path}`
};
},
Expand Down Expand Up @@ -580,10 +595,11 @@ describe('http proxy stubs', function () {
headers: {
Connection: 'close',
Date: 'NOW',
'Content-Type': 'text/plain; charset=utf-8',
'Transfer-Encoding': 'chunked'
},
body: '1. /first',
_mode: 'text'
bodyEncoding: 'utf8'
}
},
{
Expand All @@ -592,10 +608,11 @@ describe('http proxy stubs', function () {
headers: {
Connection: 'close',
Date: 'NOW',
'Content-Type': 'text/plain; charset=utf-8',
'Transfer-Encoding': 'chunked'
},
body: '3. /first',
_mode: 'text'
bodyEncoding: 'utf8'
}
}
]
Expand All @@ -615,10 +632,11 @@ describe('http proxy stubs', function () {
headers: {
Connection: 'close',
Date: 'NOW',
'Content-Type': 'text/plain; charset=utf-8',
'Transfer-Encoding': 'chunked'
},
body: '2. /second',
_mode: 'text'
bodyEncoding: 'utf8'
}
}
]
Expand All @@ -636,7 +654,7 @@ describe('http proxy stubs', function () {
is: {
body: buffer.toString('base64'),
headers: { 'content-encoding': 'gzip' },
_mode: 'binary'
bodyEncoding: null
}
},
originServerStub = { responses: [originServerResponse] },
Expand All @@ -652,14 +670,19 @@ describe('http proxy stubs', function () {
await api.createImposter(originServerRequest);
await api.createImposter(proxyRequest);

const response = await client.responseFor({ method: 'GET', port, path: '/', mode: 'binary' });
const response = await client.responseFor({ method: 'GET', port, path: '/', responseEncoding: null });

assert.deepEqual(response.body.toJSON().data, [0, 1, 2, 3]);
assert.deepEqual(response.body, Buffer.from([0, 1, 2, 3]));
});

it('should persist decorated proxy responses and only run decorator once', async function () {
const originServerPort = port + 1,
originServerStub = { responses: [{ is: { body: 'origin server' } }] },
originServerStub = { responses: [{
is: {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: 'origin server'
} }] },
originServerRequest = {
protocol: 'http',
port: originServerPort,
Expand Down Expand Up @@ -746,6 +769,7 @@ describe('http proxy stubs', function () {
encoding = 'content-length';
}
return {
bodyEncoding: 'utf8',
body: `Encoding: ${encoding}`
};
},
Expand Down Expand Up @@ -784,7 +808,11 @@ describe('http proxy stubs', function () {

it('should add decorate behaviors to newly created response', async function () {
const originServerPort = port + 1,
originServerStub = { responses: [{ is: { body: 'origin server' } }] },
originServerStub = { responses: [{
is: {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: 'origin server' } }] },
originServerRequest = {
protocol: 'http',
port: originServerPort,
Expand Down Expand Up @@ -818,11 +846,11 @@ describe('http proxy stubs', function () {
name: 'origin'
},
firstStaticStub = {
responses: [{ is: { body: 'first stub' } }],
predicates: [{ equals: { body: 'fail match so we fall through to proxy' } }]
responses: [{ is: { bodyEncoding: 'utf8', body: 'first stub' } }],
predicates: [{ equals: { bodyEncoding: 'utf8', body: 'fail match so we fall through to proxy' } }]
},
proxyStub = { responses: [{ proxy: { to: `http://localhost:${originServerPort}`, mode: 'proxyAlways' } }] },
secondStaticStub = { responses: [{ is: { body: 'second stub' } }] },
secondStaticStub = { responses: [{ is: { bodyEncoding: 'utf8', body: 'second stub' } }] },
proxyRequest = {
protocol: 'http',
port,
Expand Down Expand Up @@ -880,7 +908,12 @@ describe('http proxy stubs', function () {

it('should save JSON bodies as JSON instead of text (issue #656)', async function () {
const originServerPort = port + 1,
originServerStub = { responses: [{ is: { body: { json: true } } }] },
originServerStub = { responses: [{
is: {
headers: { 'Content-Type': 'text/plain; charset=utf-8' }, // Tell the client (the proxy recorder) what kind of content.
bodyEncoding: 'utf8', // Tell the stub that the provided body is utf8
body: { json: true }
} }] },
originServerRequest = {
protocol: 'http',
port: originServerPort,
Expand Down
Loading
Loading