feat(chrome): add configurable timeout status code

Closes: 418/1

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 .elasticbeanstalk/
 .ebextensions/
 .idea/
+.vscode/

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 5.9.0 - 2021-04-28
+### Added
+- added `timeoutStatusCode` to `tab.prerender` and to `this.options`. We are returning with this status code if a page won't load in `pageLoadTimeout`.
+
 ## 5.8.0 - 2020-07-27
 ### Added
 - added `timeSpentConnectingToBrowser`, `timeSpentOpeningTab`, `timeSpentLoadingUrl`, `timeSpentParsingPage`, `timeUntilError` to `req.prerender` to allow for debugging of certain issues with the server spending too much time in different lifecycle sections

lib/browsers/chrome.js

@@ -359,7 +359,7 @@ chrome.setUpEvents = function(tab) {
 
 					tab.prerender.pageLoadInfo.logEntries.push({
 						...message,
-						// to keep consistent with Log.LogEntry 
+						// to keep consistent with Log.LogEntry
 						lineNumber: message.line,
 						timestamp: new Date().getTime()
 					});
@@ -440,6 +440,12 @@ chrome.loadUrlThenWaitForPageLoadEvent = function(tab, url) {
 				if (!finished) {
 					finished = true;
 					util.log('page timed out', tab.prerender.url);
+
+					const timeoutStatusCode = tab.prerender.timeoutStatusCode || this.options.timeoutStatusCode;
+					if (timeoutStatusCode) {
+						tab.prerender.statusCode = timeoutStatusCode;
+					}
+
 					resolve();
 				}
 			}, pageLoadTimeout);

lib/server.js

@@ -1,5 +1,4 @@
 const util = require('./util.js');
-const zlib = require('zlib');
 const validUrl = require('valid-url');
 
 const WAIT_AFTER_LAST_REQUEST = process.env.WAIT_AFTER_LAST_REQUEST || 500;
@@ -21,6 +20,8 @@ const BROWSER_TRY_RESTART_PERIOD = process.env.BROWSER_TRY_RESTART_PERIOD || 600
 
 const BROWSER_DEBUGGING_PORT = process.env.BROWSER_DEBUGGING_PORT || 9222;
 
+const TIMEOUT_STATUS_CODE = process.env.TIMEOUT_STATUS_CODE
+
 const server = exports = module.exports = {};
 
 
@@ -40,6 +41,7 @@ server.init = function(options) {
 		printBackground: true
 	};
 	this.options.browserDebuggingPort = this.options.browserDebuggingPort || BROWSER_DEBUGGING_PORT;
+	this.options.timeoutStatusCode = this.options.timeoutStatusCode || TIMEOUT_STATUS_CODE;
 
 	this.browser = require('./browsers/chrome');
 

package.json

@@ -2,7 +2,7 @@
   "author": "Prerender.io",
   "name": "prerender",
   "description": "Service to prerender Javascript rendered pages for SEO",
-  "version": "5.8.4",
+  "version": "5.9.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
   },
   "scripts": {
     "start": "node server.js",
-    "test": "./node_modules/.bin/mocha"
+    "test": "./node_modules/.bin/mocha ./test/**/*-spec.js"
   },
   "engines": {
     "node": ">=10"

test/browsers/chrome-spec.js

@@ -0,0 +1,52 @@
+const chrome = require("../../lib/browsers/chrome"),
+  sinon = require("sinon"),
+  assert = require("assert");
+
+describe("chrome", function() {
+  describe("loadUrlThenWaitForPageLoadEvent", function() {
+    let tab;
+    let sandbox;
+
+    beforeEach(function() {
+      sandbox = sinon.createSandbox();
+
+      tab = sandbox.stub();
+      tab.prerender = sandbox.stub();
+      tab.prerender.pageDoneCheckInterval = 1000;
+      tab.prerender.pageLoadTimeout = 1;
+
+      tab.Page = sandbox.stub();
+      tab.Page.enable = sandbox.stub();
+      tab.Page.enable.resolves(1);
+      tab.Page.addScriptToEvaluateOnNewDocument = sandbox.stub();
+      tab.Page.navigate = sandbox.stub();
+      tab.Page.navigate.resolves(1);
+
+      tab.Emulation = sandbox.stub();
+      tab.Emulation.setDeviceMetricsOverride = sandbox.stub();
+    });
+
+    afterEach(function() {
+      sandbox.restore();
+    });
+
+    it("Should NOT change tabs status code", async function() {
+      const expectedStatusCode = 123;
+      tab.prerender.statusCode = expectedStatusCode;
+
+      await chrome.loadUrlThenWaitForPageLoadEvent(tab, "the-url");
+
+      assert.strictEqual(tab.prerender.statusCode, expectedStatusCode);
+    });
+
+    it("Should change tabs status code to the predefined value", async function() {
+      const expectedStatusCode = 222;
+      tab.prerender.statusCode = 111;
+      tab.prerender.timeoutStatusCode = expectedStatusCode;
+
+      await chrome.loadUrlThenWaitForPageLoadEvent(tab, "the-url");
+
+      assert.strictEqual(tab.prerender.statusCode, expectedStatusCode);
+    });
+  });
+});