Skip to content

Allow callers to set a translator request timeout #24

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
AbeJellinek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow callers to set a translator request timeout #24

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
17 changes: 17 additions & 0 deletions src/translation/translate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,9 @@ Zotero.Translate.Sandbox = {
var translation = Zotero.Translate.newInstance(type);
translation._parentTranslator = translate;
translation.setTranslatorProvider(translate._translatorProvider);
if (translation instanceof Zotero.Translate.Web || translation instanceof Zotero.Translate.Search) {
translation.setRequestTimeout(translate.requestTimeout);
}

if(translation instanceof Zotero.Translate.Export && !(translation instanceof Zotero.Translate.Export)) {
throw(new Error("Only export translators may call other export translators"));
Expand Down Expand Up @@ -2041,6 +2044,15 @@ Zotero.Translate.Web.prototype.setRequestHeaders = function (headers) {
this.requestHeaders = headers;
};

/**
* Set a timeout on translator HTTP requests.
* @param {Number | null | undefined} requestTimeout Timeout in milliseconds; 0 to disable;
* null/undefined to use implementation default
*/
Zotero.Translate.Web.prototype.setRequestTimeout = function (requestTimeout) {
this.requestTimeout = requestTimeout;
};

/**
* Sets the location to operate upon
*
Expand Down Expand Up @@ -2621,6 +2633,11 @@ Zotero.Translate.Search.prototype.ERROR_NO_RESULTS = "No items returned from any
*/
Zotero.Translate.Search.prototype.setCookieSandbox = Zotero.Translate.Web.prototype.setCookieSandbox;

/**
* @borrows Zotero.Translate.Web#setRequestTimeout
*/
Zotero.Translate.Search.prototype.setRequestTimeout = Zotero.Translate.Web.prototype.setRequestTimeout;

/**
* Sets the item to be used for searching
* @param {Object} item An item, with as many fields as desired, in the format returned by
Expand Down
9 changes: 8 additions & 1 deletion src/utilities_translate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,8 @@ Zotero.Utilities.Translate.prototype.request = async function (url, options = {}
body: options.body,
responseCharset: options.responseCharset,
responseType: options.responseType,
cookieSandbox: this._translate.cookieSandbox
cookieSandbox: this._translate.cookieSandbox,
timeout: this._translate.requestTimeout,
};

// If the request fails or a non-2XX status is returned, Zotero.HTTP.request rejects its promise.
Expand Down Expand Up @@ -426,6 +427,9 @@ Zotero.Utilities.Translate.prototype.doGet = function(urls, processor, done, res
translate.complete(false, e);
}
}, responseCharset, this._translate.cookieSandbox, Object.assign({}, this._translate.requestHeaders, requestHeaders));
if (translate.requestTimeout !== 0) {
xmlhttp.timeout = translate.requestTimeout || xmlhttp.timeout || 30000;
}
}

/**
Expand Down Expand Up @@ -461,6 +465,9 @@ Zotero.Utilities.Translate.prototype.doPost = function(url, body, onDone, header
translate.complete(false, e);
}
}, Object.assign({}, translate.requestHeaders, headers), responseCharset, translate.cookieSandbox ? translate.cookieSandbox : undefined);
if (translate.requestTimeout !== 0) {
xmlhttp.timeout = translate.requestTimeout || xmlhttp.timeout || 30000;
}
}

Zotero.Utilities.Translate.prototype.urlToProxy = function(url) {
Expand Down