Forward client Accept-Language header during web translation

Addresses #16
zotero · Dec 4, 2018 · e763651 · e763651
1 parent 6464497
commit e763651
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 6 deletions.
diff --git a/modules/zotero b/modules/zotero
diff --git a/src/http.js b/src/http.js
@@ -236,22 +236,26 @@ Zotero.HTTP = new function() {
 	 * @param {CookieJar} [cookieSandbox] Cookie sandbox object
 	 * @return {Promise<Array>} - A promise for an array of results from the processor runs
 	 */
-	this.processDocuments = async function (urls, processor, cookieSandbox) {
+	this.processDocuments = async function (urls, processor, options = {}) {
 		// Handle old signature: urls, processor, onDone, onError
 		if (arguments.length > 3) {
 			Zotero.debug("Zotero.HTTP.processDocuments() now takes only 2 arguments -- update your code");
 			var onDone = arguments[3];
 			var onError = arguments[4];
 		}
 
+		var cookieSandbox = options.cookieSandbox;
+		var headers = options.headers;
+
 		if (typeof urls == "string") urls = [urls];
 		var funcs = urls.map(url => () => {
 			return Zotero.HTTP.request(
 				"GET",
 				url,
 				{
 					responseType: 'document',
-					cookieSandbox
+					cookieSandbox,
+					headers
 				}
 			)
 			.then((req) => {

diff --git a/src/testEndpoint.js b/src/testEndpoint.js
@@ -4,11 +4,12 @@ var TestEndpoint = module.exports = {
 	},
 
 	handleSingle: async function (ctx, next) {
+		var title = ctx.headers['accept-language'] == 'fr' ? 'Titre' : 'Title';
 		ctx.response.body = `<html>
 			<head>
-				<title>Page Title</title>
+				<title>${title}</title>
 				<link rel="schema.DC" href="http://purl.org/dc/elements/1.1/" />
-				<meta name="citation_title" content="Title"/>
+				<meta name="citation_title" content="${title}"/>
 			</head>
 			<body>Body</body>
 		</html>`;

diff --git a/src/webSession.js b/src/webSession.js
@@ -33,6 +33,7 @@ const SearchEndpoint = require('./searchEndpoint');
 const { jar: cookieJar } = require('request');
 
 const SERVER_TRANSLATION_TIMEOUT = 30;
+const FORWARDED_HEADERS = ['Accept-Language'];
 
 var WebSession = module.exports = function (ctx, next, data, options) {
 	this.ctx = ctx;
@@ -52,6 +53,15 @@ WebSession.prototype.handleURL = async function () {
 
 	var url = this.data;
 
+	// Forward supported headers
+	var headers = {};
+	for (let header of FORWARDED_HEADERS) {
+		let lc = header.toLowerCase();
+		if (this.ctx.headers[lc]) {
+			headers[header] = this.ctx.headers[lc];
+		}
+	}
+
 	try {
 		var parsedURL = urlLib.parse(url);
 	}
@@ -140,6 +150,7 @@ WebSession.prototype.handleURL = async function () {
 			resolve();
 		});
 		translate.setCookieSandbox(this._cookieSandbox);
+		translate.setRequestHeaders(headers);
 
 		try {
 			await HTTP.processDocuments(
@@ -150,7 +161,10 @@ WebSession.prototype.handleURL = async function () {
 					// if the first fails, but for now just run detect on all
 					return translate.getTranslators(true);
 				},
-				this._cookieSandbox
+				{
+					cookieSandbox: this._cookieSandbox,
+					headers
+				}
 			);
 			return promise;
 		}

diff --git a/test/web_test.js b/test/web_test.js
@@ -80,4 +80,21 @@ describe("/web", function () {
 		assert.equal(response.statusCode, 400);
 		assert.equal(response.text, 'Remote page not found');
 	});
+
+
+	// Note: This doesn't test subsequent requests during translation
+	it("should forward the Accept-Language header in the initial request", async function () {
+		var url = testURL + 'single';
+		var response = await request()
+			.post('/web')
+			.set('Content-Type', 'text/plain')
+			.set('Accept-Language', 'fr')
+			.send(url);
+		assert.equal(response.statusCode, 200);
+		var json = response.body;
+
+		assert.lengthOf(json, 1);
+		assert.equal(json[0].itemType, 'journalArticle');
+		assert.equal(json[0].title, 'Titre');
+	});
 });