Skip to content
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.

End asyncStream later in the process (before piping) #185

Merged
merged 2 commits into from
Sep 22, 2017
Merged

End asyncStream later in the process (before piping) #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1fb334
End asyncStream later in the process (before piping)
Sep 21, 2017
7d91770
Address comments + add test (would fail without without the new changes)
Sep 21, 2017
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
7 changes: 4 additions & 3 deletions lib/request-handler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ module.exports = function processRequest(options, request, response) {
} = options;

const asyncStream = new AsyncStream();
asyncStream.once('plugged', () => {
asyncStream.end();
});

const contextPromise = fetchContext(request).catch(err => {
this.emit('context:error', request, err);
return {};
Expand Down Expand Up @@ -195,9 +199,6 @@ module.exports = function processRequest(options, request, response) {
});

resultStream.once('finish', () => {
// Flush the async stream only after stringifer stream is finished
// This guarentees the async fragments are flushed to the client at last
asyncStream.end();
const statusCode = response.statusCode || 200;
if (shouldWriteHead) {
shouldWriteHead = false;
Expand Down
5 changes: 5 additions & 0 deletions lib/streams/stringifier-stream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
const stream = require('stream');
const AsyncStream = require('./async-stream');

module.exports = class StringifierStream extends stream.Transform {
constructor(fn) {
Expand All @@ -22,6 +23,10 @@ module.exports = class StringifierStream extends stream.Transform {
}
let st = this.queue.shift();
if (st instanceof stream) {
if (st instanceof AsyncStream) {
st.emit('plugged');
}

st.setMaxListeners(st.getMaxListeners() + 1);
this.isBusy = true;

Expand Down
39 changes: 39 additions & 0 deletions tests/tailor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const sinon = require('sinon');
const zlib = require('zlib');
const { TEMPLATE_NOT_FOUND } = require('../lib/fetch-template');
const Tailor = require('../index');
const processTemplate = require('../lib/process-template');

describe('Tailor', () => {
let server;
Expand Down Expand Up @@ -56,6 +57,24 @@ describe('Tailor', () => {
return Promise.reject(error);
}
},
handledTags: ['delayed-fragment'],
handleTag: (request, tag, options, context) => {
if (tag.name === 'delayed-fragment') {
const st = processTemplate(request, options, context);
setTimeout(() => {
st.end({
name: 'fragment',
attributes: {
async: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before, since the fragment's async + also located in handleTag, there would be an error, cause one can't write to async channel after it's ended (which happens on 'finish' events which is all fine, cause we stop writing to the original resultStream right after pushing all parsed chunks).

src: 'https://fragment/1'
}
});
}, 10);
return st;
}

return '';
},
pipeInstanceName: 'p',
pipeAttributes: attributes => ({ id: attributes.id }),
filterResponseHeaders: (attributes, headers) => headers
Expand Down Expand Up @@ -645,6 +664,26 @@ describe('Tailor', () => {
});
});

describe('Custom async fragments', () => {
it('should add async fragments from handleTag', done => {
nock('https://fragment')
.get('/1')
.reply(200, 'hello');

mockTemplate.returns('<delayed-fragment></delayed-fragment>');
mockChildTemplate.returns('');

getResponse('http://localhost:8080/test')
.then(response => {
assert.equal(
response.body,
'<html><head></head><body><script data-pipe>p.placeholder(0)</script><script data-pipe>p.start(0)</script>hello<script data-pipe>p.end(0)</script></body></html>'
);
})
.then(done, done);
});
});

describe('Slots::Tailor ', () => {
it('should support base templates using slots', done => {
mockTemplate.returns(
Expand Down