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.

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

refactor(@embark/utils): use timeouts to improve utils.pingEndpoint #1166

Closed
wants to merge 1 commit into from
Closed

refactor(@embark/utils): use timeouts to improve utils.pingEndpoint #1166

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 src/lib/modules/blockchain_process/proxy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ exports.serve = async (ipc, host, port, ws, origin) => {
'http',
origin ? origin.split(',')[0] : undefined,
(err) => {
if (!err || (Date.now() - start > 10000)) {
if (!err || (Date.now() - start > 600000)) {
resolve();
} else {
utils.timer(250).then(waitOnTarget).then(resolve);
Expand Down
36 changes: 29 additions & 7 deletions src/lib/modules/ipfs/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ const fs = require('../../core/fs.js');
const IpfsApi = require('ipfs-api');
// TODO: not great, breaks module isolation
const StorageProcessesLauncher = require('../storage/storageProcessesLauncher');
const {canonicalHost} = require('../../utils/host');

class IPFS {

Expand Down Expand Up @@ -67,7 +68,7 @@ class IPFS {
});

self.events.request("services:register", 'IPFS', function (cb) {
self._checkService((err, body) => {
self._checkService(true, (err, body) => {
if (err) {
self.logger.trace("IPFS unavailable");
return cb({name: "IPFS ", status: 'off'});
Expand All @@ -82,21 +83,42 @@ class IPFS {
});
}

_getNodeUrl() {
_getNodeConfig() {
if (this.storageConfig.upload.provider === 'ipfs') {
return utils.buildUrlFromConfig(this.storageConfig.upload) + '/api/v0/version';
return this.storageConfig.upload;
}

for (let connection of this.storageConfig.dappConnection) {
if (connection.provider === 'ipfs') {
return utils.buildUrlFromConfig(connection) + '/api/v0/version';
return connection;
}
}
}

_checkService(cb) {
let url = this._getNodeUrl();
utils.getJson(url, cb);
_checkService(getJson, cb) {
let _cb = cb || function () {};
let _getJson = getJson;
if (typeof getJson === 'function') {
_cb = getJson;
_getJson = false;
}
const cfg = this._getNodeConfig();
utils.pingEndpoint(
canonicalHost(cfg.host),
cfg.port,
false,
cfg.protocol === 'https' ? cfg.protocol : 'http',
utils.buildUrlFromConfig(cfg),
(err) => {
if (err) {
_cb(err);
} else if (_getJson) {
utils.getJson(utils.buildUrlFromConfig(cfg) + '/api/v0/version', _cb);
} else {
_cb();
}
}
);
Copy link
Collaborator

@emizzle emizzle Dec 12, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Should we extend this out to all other service checks (swarm, webserver, whisper)? And in that case, maybe this can be abstracted a bit.

Copy link
Contributor Author

@michaelsbradleyjr michaelsbradleyjr Dec 12, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Good idea @emizzle. I'll create a pivotal task for that pending this PR being merged.

}

addStorageProviderToEmbarkJS() {
Expand Down
122 changes: 86 additions & 36 deletions src/lib/utils/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,45 +89,95 @@ function getJson(url, cb) {
httpGetJson(url, cb);
}

function pingEndpoint(host, port, type, protocol, origin, callback) {
const options = {
protocolVersion: 13,
perMessageDeflate: true,
origin: origin,
host: host,
port: port
function pingEndpoint(host, port, type, protocol, origin, callback, count = 0, start = Date.now()) {
// remove trailing api key from infura, e.g. rinkeby.infura.io/nmY8WtT4QfEwz2S7wTbl
const _host = host.indexOf('/') > -1 ? host.split('/')[0] : host;
const maxWait = 600000;
const timeout = 100;

const adjustTimeout = () => {
const t = Math.floor(
(1 + (0.1 * (count && Math.pow(2, count - 1)))) * timeout
);
return t > 3000 ? 3000 : t;
};
if (type === 'ws') {
options.headers = {
'Sec-WebSocket-Version': 13,
Connection: 'Upgrade',
Upgrade: 'websocket',
'Sec-WebSocket-Extensions': 'permessage-deflate; client_max_window_bits',
Origin: origin
};
}
let req;
// remove trailing api key from infura, ie rinkeby.infura.io/nmY8WtT4QfEwz2S7wTbl
if (options.host.indexOf('/') > -1) {
options.host = options.host.split('/')[0];
}
if (protocol === 'https') {
req = require('https').get(options);
} else {
req = require('http').get(options);
}

req.on('error', (err) => {
callback(err);
});
let alreadyClosed = false;
let retrying = false;

req.on('response', (_response) => {
callback();
});
const shouldCallback = (...args) => {
if (args.length) {
callback._shouldCallback = !!args[0];
}
let shouldCallback;
if (callback.hasOwnProperty('_shouldCallback')) {
shouldCallback = !!callback._shouldCallback;
} else {
shouldCallback = true;
}
return shouldCallback;
};

req.on('upgrade', (_res, _socket, _head) => {
callback();
});
const cleanup = (req, closeMethod) => {
if (!alreadyClosed) {
alreadyClosed = true;
setImmediate(() => { req[closeMethod](); });
}
};

const handleEvent = (req, closeMethod, retryCond, ...args) => {
if (shouldCallback()) {
if (!retrying && retryCond) {
retrying = true;
setImmediate(() => {
pingEndpoint(
host, port, type, protocol, origin, callback, ++count, start
);
});
} else if (!alreadyClosed) {
shouldCallback(false);
callback(...args);
}
}
// following cleanup any later events on req will effectively be ignored
cleanup(req, closeMethod);
};

const handleError = (req, closeMethod) => {
req.on('error', (err) => {
handleEvent(
req,
closeMethod,
(/timed out/).test(err.message) && Date.now() - start < maxWait,
err
);
});
};

const handleSuccess = (req, closeMethod, event) => {
req.once(event, () => { handleEvent(req, closeMethod, false); });
};

const handleRequest = (req, closeMethod, event) => {
handleError(req, closeMethod);
handleSuccess(req, closeMethod, event);
};

if (type === 'ws') {
const req = new (require('ws'))(
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we'll be better of having all necessary require() statements at the top of the file instead of requiring within a function.

Especially if we happen to use (in this case) require('ws') in multiple places.

`${protocol === 'https' ? 'wss' : 'ws'}://${_host}:${port}/`,
{handshakeTimeout: adjustTimeout(), origin}
);
handleRequest(req, 'close', 'open');
} else {
const req = (protocol === 'https' ? require('https') : require('http')).get(
{host: _host, origin, port}
);
handleRequest(req, 'abort', 'response');
req.setTimeout(adjustTimeout(), () => {
req.emit('error', new Error('timed out'));
});
}
}

function runCmd(cmd, options, callback) {
Expand Down Expand Up @@ -554,7 +604,7 @@ function isNotFolder(node){
}

function byName(a, b) {
return a.name.localeCompare(b.name);
return a.name.localeCompare(b.name);
}

function fileTreeSort(nodes){
Expand Down