Skip to content
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.

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

Move upload progress plumbing to its own module #531

Merged
merged 1 commit into from
Jul 22, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
69 changes: 69 additions & 0 deletions source/progress.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
'use strict';
module.exports = {
upload(req, emitter, uploadBodySize) {
const uploadEventFrequency = 150;
let uploaded = 0;
let progressInterval;

emitter.emit('uploadProgress', {
percent: 0,
transferred: 0,
total: uploadBodySize
});

req.once('error', () => {
clearInterval(progressInterval);
});

req.once('response', () => {
clearInterval(progressInterval);

emitter.emit('uploadProgress', {
percent: 1,
transferred: uploaded,
total: uploadBodySize
});
});

req.once('socket', socket => {
const onSocketConnect = () => {
progressInterval = setInterval(() => {
if (socket.destroyed) {
clearInterval(progressInterval);
return;
}

const lastUploaded = uploaded;
const headersSize = req._header ? Buffer.byteLength(req._header) : 0;
uploaded = socket.bytesWritten - headersSize;

// Prevent the known issue of `bytesWritten` being larger than body size
if (uploadBodySize && uploaded > uploadBodySize) {
uploaded = uploadBodySize;
}

// Don't emit events with unchanged progress and
// prevent last event from being emitted, because
// it's emitted when `response` is emitted
if (uploaded === lastUploaded || uploaded === uploadBodySize) {
return;
}

emitter.emit('uploadProgress', {
percent: uploadBodySize ? uploaded / uploadBodySize : 0,
transferred: uploaded,
total: uploadBodySize
});
}, uploadEventFrequency);
};

if (socket.connecting) {
socket.once('connect', onSocketConnect);
} else {
// The socket is being reused from pool,
// so the connect event will not be emitted
onSocketConnect();
}
});
}
};
71 changes: 2 additions & 69 deletions source/request-as-event-emitter.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ const is = require('@sindresorhus/is');
const timedOut = require('./timed-out');
const getBodySize = require('./get-body-size');
const getResponse = require('./get-response');
const progress = require('./progress');
const {CacheError, UnsupportedProtocolError, MaxRedirectsError, RequestError} = require('./errors');

const getMethodRedirectCodes = new Set([300, 301, 302, 303, 304, 305, 307, 308]);
Expand All @@ -23,7 +24,6 @@ module.exports = (options = {}) => {
let retryTries = 0;
let redirectUrl;
let uploadBodySize;
let uploaded = 0;

const get = options => {
if (options.protocol !== 'http:' && options.protocol !== 'https:') {
Expand All @@ -43,20 +43,9 @@ module.exports = (options = {}) => {
fn = electron.net || electron.remote.net;
}

let progressInterval;

const cacheableRequest = new CacheableRequest(fn.request, options.cache);
const cacheReq = cacheableRequest(options, response => {
clearInterval(progressInterval);

emitter.emit('uploadProgress', {
percent: 1,
transferred: uploaded,
total: uploadBodySize
});

const {statusCode} = response;

response.retryCount = retryCount;
response.url = redirectUrl || requestUrl;
response.requestUrl = requestUrl;
Expand Down Expand Up @@ -99,7 +88,6 @@ module.exports = (options = {}) => {
emitter.emit('redirect', response, redirectOpts);

get(redirectOpts);

return;
}

Expand Down Expand Up @@ -127,8 +115,6 @@ module.exports = (options = {}) => {
});

req.once('error', error => {
clearInterval(progressInterval);

if (aborted) {
return;
}
Expand All @@ -141,62 +127,9 @@ module.exports = (options = {}) => {
});
});

emitter.once('request', req => {
emitter.emit('uploadProgress', {
percent: 0,
transferred: 0,
total: uploadBodySize
});

const socket = req.connection;
if (socket) {
const onSocketConnect = () => {
const uploadEventFrequency = 150;

progressInterval = setInterval(() => {
if (socket.destroyed) {
clearInterval(progressInterval);
return;
}

const lastUploaded = uploaded;
const headersSize = req._header ? Buffer.byteLength(req._header) : 0;
uploaded = socket.bytesWritten - headersSize;

// Prevent the known issue of `bytesWritten` being larger than body size
if (uploadBodySize && uploaded > uploadBodySize) {
uploaded = uploadBodySize;
}

// Don't emit events with unchanged progress and
// prevent last event from being emitted, because
// it's emitted when `response` is emitted
if (uploaded === lastUploaded || uploaded === uploadBodySize) {
return;
}

emitter.emit('uploadProgress', {
percent: uploadBodySize ? uploaded / uploadBodySize : 0,
transferred: uploaded,
total: uploadBodySize
});
}, uploadEventFrequency);
};

// Only subscribe to `connect` event if we're actually connecting a new
// socket, otherwise if we're already connected (because this is a
// keep-alive connection) do not bother. This is important since we won't
// get a `connect` event for an already connected socket.
if (socket.connecting) {
socket.once('connect', onSocketConnect);
} else {
onSocketConnect();
}
}
});
progress.upload(req, emitter, uploadBodySize);

if (options.gotTimeout) {
clearInterval(progressInterval);
timedOut(req, options.gotTimeout);
}

Expand Down