Skip to content

feat: add support for incremental multipart payloads #55

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+74 −37
Open

feat: add support for incremental multipart payloads #55

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
106 changes: 71 additions & 35 deletions src/__test__/PatchResolver.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ function getMultiPartResponse(data, boundary) {
return ['Content-Type: application/json', '', json, `--${boundary}\r\n`].join('\r\n');
}

function assertChunksRecieved(mockCall, chunks) {
const nonIncrementalChunks = chunks.flatMap((chunk) =>
chunk.incremental ? chunk.incremental : chunk
);
expect(mockCall).toEqual(nonIncrementalChunks);
}

describe('PathResolver', function () {
for (const boundary of ['-', 'gc0p4Jq0M2Yt08jU534c0p']) {
describe(`boundary ${boundary}`, () => {
Expand All @@ -32,23 +39,48 @@ describe('PathResolver', function () {
const chunk1 = getMultiPartResponse(chunk1Data, boundary);

const chunk2Data = {
path: ['viewer', 'currencies'],
data: ['USD', 'GBP', 'EUR', 'CAD', 'AUD', 'CHF', '😂'], // test unicode
errors: [{ message: 'Not So Bad Error' }],
incremental: [
{
path: ['viewer', 'currencies'],
data: ['USD', 'GBP', 'EUR', 'CAD', 'AUD', 'CHF', '😂'], // test unicode
errors: [{ message: 'Not So Bad Error' }],
},
],
};
const chunk2 = getMultiPartResponse(chunk2Data, boundary);

const chunk3Data = {
path: ['viewer', 'user', 'profile'],
data: { displayName: 'Steven Seagal' },
incremental: [
{
path: ['viewer', 'user', 'profile'],
data: { displayName: 'Steven Seagal' },
},
],
};
const chunk3 = getMultiPartResponse(chunk3Data, boundary);

const chunk4Data = {
data: false,
path: ['viewer', 'user', 'items', 'edges', 1, 'node', 'isFavorite'],
incremental: [
{
data: false,
path: ['viewer', 'user', 'items', 'edges', 1, 'node', 'isFavorite'],
},
],
};
const chunk4 = getMultiPartResponse(chunk4Data, boundary);
const chunk5Data = {
incremental: [
{
data: true,
path: ['viewer', 'user', 'items', 'edges', 2, 'node', 'isFavorite'],
},
{
data: false,
path: ['viewer', 'user', 'items', 'edges', 3, 'node', 'isFavorite'],
},
],
};
const chunk5 = getMultiPartResponse(chunk5Data, boundary);
it('should work on each chunk', function () {
const onResponse = jest.fn();
const resolver = new PatchResolver({
Expand All @@ -61,19 +93,23 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);

onResponse.mockClear();
resolver.handleChunk(chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);

onResponse.mockClear();
resolver.handleChunk(chunk3);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);

onResponse.mockClear();
resolver.handleChunk(chunk4);
expect(onResponse.mock.calls[0][0]).toEqual([chunk4Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk4Data]);

onResponse.mockClear();
resolver.handleChunk(chunk5);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk5Data]);
});

it('should work when chunks are split', function () {
Expand All @@ -96,7 +132,7 @@ describe('PathResolver', function () {
resolver.handleChunk(chunk1b);
expect(onResponse).not.toHaveBeenCalled();
resolver.handleChunk(chunk1c);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);
onResponse.mockClear();

const chunk2a = chunk2.substr(0, 35);
Expand All @@ -105,7 +141,7 @@ describe('PathResolver', function () {
resolver.handleChunk(chunk2a);
expect(onResponse).not.toHaveBeenCalled();
resolver.handleChunk(chunk2b);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);
onResponse.mockClear();

const chunk3a = chunk3.substr(0, 10);
Expand All @@ -117,7 +153,7 @@ describe('PathResolver', function () {
resolver.handleChunk(chunk3b);
expect(onResponse).not.toHaveBeenCalled();
resolver.handleChunk(chunk3c);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);
});

it('should work when chunks are combined', function () {
Expand All @@ -132,7 +168,7 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1 + chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data, chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data, chunk2Data]);
});

it('should work when chunks are combined and split', function () {
Expand All @@ -159,13 +195,13 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1 + chunk2 + chunk3a);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data, chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data, chunk2Data]);
onResponse.mockClear();

resolver.handleChunk(chunk3b);
expect(onResponse).not.toHaveBeenCalled();
resolver.handleChunk(chunk3c);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);
});

it('should work when chunks are combined across boundaries', function () {
Expand All @@ -183,10 +219,10 @@ describe('PathResolver', function () {
const chunk2b = chunk2.substring(35);

resolver.handleChunk(chunk1 + chunk2a);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);
onResponse.mockClear();
resolver.handleChunk(chunk2b);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);
});
it('should work when final chunk ends with terminating boundary', function () {
const onResponse = jest.fn();
Expand All @@ -200,20 +236,20 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);

onResponse.mockClear();
resolver.handleChunk(chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);

onResponse.mockClear();
resolver.handleChunk(chunk3);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);

onResponse.mockClear();
const chunk4FinalBoundary = getMultiPartResponse(chunk4Data, `${boundary}--`);
resolver.handleChunk(chunk4FinalBoundary);
expect(onResponse.mock.calls[0][0]).toEqual([chunk4Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk4Data]);
});

it('should work with preamble', function () {
Expand All @@ -229,20 +265,20 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);

onResponse.mockClear();
resolver.handleChunk(chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);

onResponse.mockClear();
resolver.handleChunk(chunk3);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);

onResponse.mockClear();
const chunk4FinalBoundary = getMultiPartResponse(chunk4Data, `${boundary}--`);
resolver.handleChunk(chunk4FinalBoundary);
expect(onResponse.mock.calls[0][0]).toEqual([chunk4Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk4Data]);
});
it('should work with epilogue', function () {
const onResponse = jest.fn();
Expand All @@ -256,20 +292,20 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);

onResponse.mockClear();
resolver.handleChunk(chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);

onResponse.mockClear();
resolver.handleChunk(chunk3);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);

onResponse.mockClear();
resolver.handleChunk(chunk4);
resolver.handleChunk(`This is some epilogue data that should be ignored\r\n`);
expect(onResponse.mock.calls[0][0]).toEqual([chunk4Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk4Data]);
});
it('should work with epilogue after chunk with terminating boundary', function () {
const onResponse = jest.fn();
Expand All @@ -283,21 +319,21 @@ describe('PathResolver', function () {
expect(onResponse).not.toHaveBeenCalled();

resolver.handleChunk(chunk1);
expect(onResponse.mock.calls[0][0]).toEqual([chunk1Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk1Data]);

onResponse.mockClear();
resolver.handleChunk(chunk2);
expect(onResponse.mock.calls[0][0]).toEqual([chunk2Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk2Data]);

onResponse.mockClear();
resolver.handleChunk(chunk3);
expect(onResponse.mock.calls[0][0]).toEqual([chunk3Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk3Data]);

onResponse.mockClear();
const chunk4FinalBoundary = getMultiPartResponse(chunk4Data, `${boundary}--`);
resolver.handleChunk(chunk4FinalBoundary);
resolver.handleChunk(`This is some epilogue data that should be ignored\r\n`);
expect(onResponse.mock.calls[0][0]).toEqual([chunk4Data]);
assertChunksRecieved(onResponse.mock.calls[0][0], [chunk4Data]);
});
});
}
Expand Down
5 changes: 3 additions & 2 deletions src/parseMultipartHttp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ export function parseMultipartHttp(buffer, boundary, previousParts = [], isPream
// remove trailing boundary things
body = body.replace(delimiter + '\r\n', '').replace(delimiter + '--\r\n', '');

const payload = JSON.parse(body);
const parts = [...previousParts, payload];
let payload = JSON.parse(body);
payload = payload.incremental ? payload.incremental : [payload];
const parts = [...previousParts, ...payload];

if (next && next.length) {
// we have more parts
Expand Down