Refactor test driver to be more class-like

- Extract NullTextLayerBuilder and SimpleTextLayerBuilder from the driver code and create classes for them.
- Move options to the constructor and pass in HTML elements instead of getting them in the driver.
- Remove unused masterMode variable.
- Minor method name updates.

The rest is only moving/indenting existing code and adding 'this'.
This commit is contained in:
Tim van der Meij 2015-05-15 15:29:43 +02:00
parent d59660cfa6
commit ae8748edfb
2 changed files with 433 additions and 380 deletions

View File

@ -18,412 +18,461 @@
'use strict'; 'use strict';
/* /**
* A Test Driver for PDF.js * @class
*/ */
(function DriverClosure() { var NullTextLayerBuilder = (function NullTextLayerBuilderClosure() {
/**
* @constructs NullTextLayerBuilder
*/
function NullTextLayerBuilder() {}
PDFJS.enableStats = true; NullTextLayerBuilder.prototype = {
PDFJS.cMapUrl = '../external/bcmaps/'; beginLayout: function NullTextLayerBuilder_BeginLayout() {},
PDFJS.cMapPacked = true; endLayout: function NullTextLayerBuilder_EndLayout() {},
appendText: function NullTextLayerBuilder_AppendText() {}
};
var appPath, masterMode, browser, canvas, dummyCanvas, currentTaskIdx, return NullTextLayerBuilder;
manifest, stdout; })();
var inFlightRequests = 0;
function queryParams() { /**
var qs = window.location.search.substring(1); * @class
var kvs = qs.split('&'); */
var params = { }; var SimpleTextLayerBuilder = (function SimpleTextLayerBuilderClosure() {
for (var i = 0; i < kvs.length; ++i) { /**
var kv = kvs[i].split('='); * @constructs SimpleTextLayerBuilder
params[unescape(kv[0])] = unescape(kv[1]); */
function SimpleTextLayerBuilder(ctx, viewport) {
this.ctx = ctx;
this.viewport = viewport;
this.textCounter = 0;
} }
return params;
}
window.load = function load() { SimpleTextLayerBuilder.prototype = {
var params = queryParams(); appendText: function SimpleTextLayerBuilder_AppendText(geom, styles) {
browser = params.browser; var style = styles[geom.fontName];
var manifestFile = params.manifestFile; var ctx = this.ctx, viewport = this.viewport;
appPath = params.path; var tx = PDFJS.Util.transform(this.viewport.transform, geom.transform);
masterMode = params.masterMode === 'True'; var angle = Math.atan2(tx[1], tx[0]);
var delay = params.delay || 0; var fontHeight = Math.sqrt((tx[2] * tx[2]) + (tx[3] * tx[3]));
var fontAscent = (style.ascent ? style.ascent * fontHeight :
(style.descent ? (1 + style.descent) * fontHeight : fontHeight));
canvas = document.createElement('canvas'); ctx.save();
stdout = document.getElementById('output'); ctx.beginPath();
ctx.strokeStyle = 'red';
ctx.fillStyle = 'yellow';
ctx.translate(tx[4] + (fontAscent * Math.sin(angle)),
tx[5] - (fontAscent * Math.cos(angle)));
ctx.rotate(angle);
ctx.rect(0, 0, geom.width * viewport.scale, geom.height * viewport.scale);
ctx.stroke();
ctx.fill();
ctx.restore();
ctx.font = fontHeight + 'px ' + style.fontFamily;
ctx.fillStyle = 'black';
ctx.fillText(geom.str, tx[4], tx[5]);
info('User Agent: ' + navigator.userAgent); this.textCounter++;
log('load...\n'); },
log('Harness thinks this browser is "' + browser + '" with path "' + setTextContent:
appPath + '"\n'); function SimpleTextLayerBuilder_SetTextContent(textContent) {
log('Fetching manifest "' + manifestFile + '"... '); this.ctx.save();
var textItems = textContent.items;
var r = new XMLHttpRequest(); for (var i = 0, ii = textItems.length; i < ii; i++) {
r.open('GET', manifestFile, false); this.appendText(textItems[i], textContent.styles);
r.onreadystatechange = function loadOnreadystatechange(e) { }
if (r.readyState === 4) { this.ctx.restore();
log('done\n');
manifest = JSON.parse(r.responseText);
currentTaskIdx = 0;
nextTask();
} }
}; };
if (delay) {
log('\nDelaying for ' + delay + 'ms...\n');
}
// When gathering the stats the numbers seem to be more reliable if the
// browser is given more time to startup.
setTimeout(function() {
r.send(null);
}, delay);
};
function cleanup() { return SimpleTextLayerBuilder;
// Clear out all the stylesheets since a new one is created for each font. })();
while (document.styleSheets.length > 0) {
var styleSheet = document.styleSheets[0]; /**
while (styleSheet.cssRules.length > 0) { * @typedef {Object} DriverOptions
styleSheet.deleteRule(0); * @property {HTMLPreElement} output - Container for all output messages.
} * @property {HTMLSpanElement} inflight - Field displaying the number of
var ownerNode = styleSheet.ownerNode; * inflight requests.
ownerNode.parentNode.removeChild(ownerNode); * @property {HTMLDivElement} end - Container for a completion message.
} */
var guard = document.getElementById('end');
var body = document.body; /**
while (body.lastChild !== guard) { * @class
body.removeChild(body.lastChild); */
var Driver = (function DriverClosure() {
/**
* @constructs Driver
* @param {DriverOptions} options
*/
function Driver(options) {
// Configure the global PDFJS object
PDFJS.workerSrc = '../src/worker_loader.js';
PDFJS.cMapPacked = true;
PDFJS.cMapUrl = '../external/bcmaps/';
PDFJS.enableStats = true;
// Set the passed options
this.output = options.output;
this.inflight = options.inflight;
this.end = options.end;
// Set parameters from the query string
var parameters = this._getQueryStringParameters();
this.browser = parameters.browser;
this.manifestFile = parameters.manifestFile;
this.appPath = parameters.path;
this.delay = (parameters.delay | 0) || 0;
this.inFlightRequests = 0;
// Create a working canvas
this.canvas = document.createElement('canvas');
} }
// Wipe out the link to the pdfdoc so it can be GC'ed. Driver.prototype = {
for (var i = 0; i < manifest.length; i++) { _getQueryStringParameters: function Driver_getQueryStringParameters() {
if (manifest[i].pdfDoc) { var qs = window.location.search.substring(1);
manifest[i].pdfDoc.destroy(); var kvs = qs.split('&');
delete manifest[i].pdfDoc; var params = { };
} for (var i = 0; i < kvs.length; ++i) {
} var kv = kvs[i].split('=');
} params[unescape(kv[0])] = unescape(kv[1]);
}
return params;
},
function exceptionToString(e) { run: function Driver_run() {
if (typeof e !== 'object') { this._info('User Agent: ' + navigator.userAgent);
return String(e); this._log('load...\n');
}
if (!('message' in e)) {
return JSON.stringify(e);
}
return e.message + ('stack' in e ? ' at ' + e.stack.split('\n')[0] : '');
}
function nextTask() { this._log('Harness thinks this browser is "' + this.browser +
cleanup(); '" with path "' + this.appPath + '"\n');
this._log('Fetching manifest "' + this.manifestFile + '"... ');
if (currentTaskIdx === manifest.length) { var r = new XMLHttpRequest();
done(); var self = this;
return; r.open('GET', this.manifestFile, false);
} r.onreadystatechange = function loadOnreadystatechange(e) {
var task = manifest[currentTaskIdx]; if (r.readyState === 4) {
task.round = 0; self._log('done\n');
task.stats = {times: []}; self.manifest = JSON.parse(r.responseText);
self.currentTask = 0;
log('Loading file "' + task.file + '"\n'); self._nextTask();
var absoluteUrl = combineUrl(window.location.href, task.file);
var failure;
function continuation() {
task.pageNum = task.firstPage || 1;
nextPage(task, failure);
}
PDFJS.disableRange = task.disableRange;
PDFJS.disableAutoFetch = !task.enableAutoFetch;
try {
var promise = PDFJS.getDocument({
url: absoluteUrl,
password: task.password
});
promise.then(function(doc) {
task.pdfDoc = doc;
continuation();
}, function(e) {
failure = 'load PDF doc : ' + e;
continuation();
});
return;
} catch (e) {
failure = 'load PDF doc : ' + exceptionToString(e);
}
continuation();
}
function getLastPageNum(task) {
if (!task.pdfDoc) {
return task.firstPage || 1;
}
var lastPageNum = task.lastPage || 0;
if (!lastPageNum || lastPageNum > task.pdfDoc.numPages) {
lastPageNum = task.pdfDoc.numPages;
}
return lastPageNum;
}
function NullTextLayerBuilder() {
}
NullTextLayerBuilder.prototype = {
beginLayout: function NullTextLayerBuilder_BeginLayout() {},
endLayout: function NullTextLayerBuilder_EndLayout() {},
appendText: function NullTextLayerBuilder_AppendText() {}
};
function SimpleTextLayerBuilder(ctx, viewport) {
this.ctx = ctx;
this.viewport = viewport;
this.textCounter = 0;
}
SimpleTextLayerBuilder.prototype = {
appendText: function SimpleTextLayerBuilder_AppendText(geom, styles) {
var style = styles[geom.fontName];
var ctx = this.ctx, viewport = this.viewport;
var tx = PDFJS.Util.transform(this.viewport.transform, geom.transform);
var angle = Math.atan2(tx[1], tx[0]);
var fontHeight = Math.sqrt((tx[2] * tx[2]) + (tx[3] * tx[3]));
var fontAscent = (style.ascent ? style.ascent * fontHeight :
(style.descent ? (1 + style.descent) * fontHeight : fontHeight));
ctx.save();
ctx.beginPath();
ctx.strokeStyle = 'red';
ctx.fillStyle = 'yellow';
ctx.translate(tx[4] + (fontAscent * Math.sin(angle)),
tx[5] - (fontAscent * Math.cos(angle)));
ctx.rotate(angle);
ctx.rect(0, 0, geom.width * viewport.scale, geom.height * viewport.scale);
ctx.stroke();
ctx.fill();
ctx.restore();
ctx.font = fontHeight + 'px ' + style.fontFamily;
ctx.fillStyle = 'black';
ctx.fillText(geom.str, tx[4], tx[5]);
this.textCounter++;
},
setTextContent: function SimpleTextLayerBuilder_SetTextContent(textContent) {
this.ctx.save();
var textItems = textContent.items;
for (var i = 0; i < textItems.length; i++) {
this.appendText(textItems[i], textContent.styles);
}
this.ctx.restore();
}
};
function nextPage(task, loadError) {
var failure = loadError || '';
if (!task.pdfDoc) {
var dataUrl = canvas.toDataURL('image/png');
sendTaskResult(dataUrl, task, failure, function () {
log('done' + (failure ? ' (failed !: ' + failure + ')' : '') + '\n');
++currentTaskIdx;
nextTask();
});
return;
}
if (task.pageNum > getLastPageNum(task)) {
if (++task.round < task.rounds) {
log(' Round ' + (1 + task.round) + '\n');
task.pageNum = task.firstPage || 1;
} else {
++currentTaskIdx;
nextTask();
return;
}
}
if (task.skipPages && task.skipPages.indexOf(task.pageNum) >= 0) {
log(' skipping page ' + task.pageNum + '/' + task.pdfDoc.numPages +
'... ');
// empty the canvas
canvas.width = 1;
canvas.height = 1;
clear(canvas.getContext('2d'));
snapshotCurrentPage(task, '');
return;
}
if (!failure) {
try {
log(' loading page ' + task.pageNum + '/' + task.pdfDoc.numPages +
'... ');
var ctx = canvas.getContext('2d');
task.pdfDoc.getPage(task.pageNum).then(function(page) {
var pdfToCssUnitsCoef = 96.0 / 72.0;
var viewport = page.getViewport(pdfToCssUnitsCoef);
canvas.width = viewport.width;
canvas.height = viewport.height;
clear(ctx);
var drawContext, textLayerBuilder;
var resolveInitPromise;
var initPromise = new Promise(function (resolve) {
resolveInitPromise = resolve;
});
if (task.type === 'text') {
// using dummy canvas for pdf context drawing operations
if (!dummyCanvas) {
dummyCanvas = document.createElement('canvas');
}
drawContext = dummyCanvas.getContext('2d');
// ... text builder will draw its content on the test canvas
textLayerBuilder = new SimpleTextLayerBuilder(ctx, viewport);
page.getTextContent().then(function(textContent) {
textLayerBuilder.setTextContent(textContent);
resolveInitPromise();
});
} else {
drawContext = ctx;
textLayerBuilder = new NullTextLayerBuilder();
resolveInitPromise();
} }
var renderContext = { };
canvasContext: drawContext, if (this.delay) {
viewport: viewport this._log('\nDelaying for ' + this.delay + 'ms...\n');
}; }
var completeRender = (function(error) { // When gathering the stats the numbers seem to be more reliable
page.destroy(); // if the browser is given more time to startup.
task.stats = page.stats; setTimeout(function() {
page.stats = new StatTimer(); r.send(null);
snapshotCurrentPage(task, error); }, this.delay);
},
_nextTask: function Driver_nextTask() {
this._cleanup();
if (this.currentTask === this.manifest.length) {
this._done();
return;
}
var task = this.manifest[this.currentTask];
task.round = 0;
task.stats = { times: [] };
this._log('Loading file "' + task.file + '"\n');
var absoluteUrl = combineUrl(window.location.href, task.file);
var failure;
var self = this;
function continuation() {
task.pageNum = task.firstPage || 1;
self._nextPage(task, failure);
}
PDFJS.disableRange = task.disableRange;
PDFJS.disableAutoFetch = !task.enableAutoFetch;
try {
PDFJS.getDocument({
url: absoluteUrl,
password: task.password
}).then(function(doc) {
task.pdfDoc = doc;
continuation();
}, function(e) {
failure = 'load PDF doc : ' + e;
continuation();
}); });
initPromise.then(function () { return;
page.render(renderContext).promise.then(function() { } catch (e) {
completeRender(false); failure = 'load PDF doc : ' + this._exceptionToString(e);
}
continuation();
},
_cleanup: function Driver_cleanup() {
// Clear out all the stylesheets since a new one is created for each font.
while (document.styleSheets.length > 0) {
var styleSheet = document.styleSheets[0];
while (styleSheet.cssRules.length > 0) {
styleSheet.deleteRule(0);
}
var ownerNode = styleSheet.ownerNode;
ownerNode.parentNode.removeChild(ownerNode);
}
var body = document.body;
while (body.lastChild !== this.end) {
body.removeChild(body.lastChild);
}
// Wipe out the link to the pdfdoc so it can be GC'ed.
for (var i = 0; i < this.manifest.length; i++) {
if (this.manifest[i].pdfDoc) {
this.manifest[i].pdfDoc.destroy();
delete this.manifest[i].pdfDoc;
}
}
},
_exceptionToString: function Driver_exceptionToString(e) {
if (typeof e !== 'object') {
return String(e);
}
if (!('message' in e)) {
return JSON.stringify(e);
}
return e.message + ('stack' in e ? ' at ' + e.stack.split('\n')[0] : '');
},
_getLastPageNum: function Driver_getLastPageNum(task) {
if (!task.pdfDoc) {
return task.firstPage || 1;
}
var lastPageNum = task.lastPage || 0;
if (!lastPageNum || lastPageNum > task.pdfDoc.numPages) {
lastPageNum = task.pdfDoc.numPages;
}
return lastPageNum;
},
_nextPage: function Driver_nextPage(task, loadError) {
var failure = loadError || '';
var self = this;
if (!task.pdfDoc) {
var dataUrl = this.canvas.toDataURL('image/png');
this._sendResult(dataUrl, task, failure, function () {
self._log('done' + (failure ? ' (failed !: ' + failure + ')' : '') +
'\n');
self.currentTask++;
self._nextTask();
});
return;
}
if (task.pageNum > this._getLastPageNum(task)) {
if (++task.round < task.rounds) {
this._log(' Round ' + (1 + task.round) + '\n');
task.pageNum = task.firstPage || 1;
} else {
this.currentTask++;
this._nextTask();
return;
}
}
if (task.skipPages && task.skipPages.indexOf(task.pageNum) >= 0) {
this._log(' skipping page ' + task.pageNum + '/' +
task.pdfDoc.numPages + '... ');
// Empty the canvas
this.canvas.width = 1;
this.canvas.height = 1;
this._clearCanvas(this.canvas.getContext('2d'));
this._snapshot(task, '');
return;
}
if (!failure) {
try {
this._log(' loading page ' + task.pageNum + '/' +
task.pdfDoc.numPages + '... ');
var ctx = this.canvas.getContext('2d');
task.pdfDoc.getPage(task.pageNum).then(function(page) {
var pdfToCssUnitsCoef = 96.0 / 72.0;
var viewport = page.getViewport(pdfToCssUnitsCoef);
self.canvas.width = viewport.width;
self.canvas.height = viewport.height;
self._clearCanvas(ctx);
var drawContext, textLayerBuilder;
var resolveInitPromise;
var initPromise = new Promise(function (resolve) {
resolveInitPromise = resolve;
});
if (task.type === 'text') {
// Using a dummy canvas for PDF context drawing operations
if (!self.dummyCanvas) {
self.dummyCanvas = document.createElement('canvas');
}
drawContext = self.dummyCanvas.getContext('2d');
// The text builder will draw its content on the test canvas
textLayerBuilder = new SimpleTextLayerBuilder(ctx, viewport);
page.getTextContent().then(function(textContent) {
textLayerBuilder.setTextContent(textContent);
resolveInitPromise();
});
} else {
drawContext = ctx;
textLayerBuilder = new NullTextLayerBuilder();
resolveInitPromise();
}
var renderContext = {
canvasContext: drawContext,
viewport: viewport
};
var completeRender = (function(error) {
page.destroy();
task.stats = page.stats;
page.stats = new StatTimer();
self._snapshot(task, error);
});
initPromise.then(function () {
page.render(renderContext).promise.then(function() {
completeRender(false);
},
function(error) {
completeRender('render : ' + error);
});
});
}, },
function(error) { function(error) {
completeRender('render : ' + error); self._snapshot(task, 'render : ' + error);
}); });
}); } catch (e) {
}, failure = 'page setup : ' + this._exceptionToString(e);
function(error) { this._snapshot(task, failure);
snapshotCurrentPage(task, 'render : ' + error); }
}
},
_clearCanvas: function Driver_clearCanvas() {
var ctx = this.canvas.getContext('2d');
ctx.beginPath();
ctx.clearRect(0, 0, this.canvas.width, this.canvas.height);
},
_snapshot: function Driver_snapshot(task, failure) {
var self = this;
this._log('done, snapshotting... ');
var dataUrl = this.canvas.toDataURL('image/png');
this._sendResult(dataUrl, task, failure, function () {
self._log('done' + (failure ? ' (failed !: ' + failure + ')' : '') +
'\n');
task.pageNum++;
self._nextPage(task);
}); });
} catch (e) { },
failure = 'page setup : ' + exceptionToString(e);
snapshotCurrentPage(task, failure);
}
}
}
function snapshotCurrentPage(task, failure) { _quit: function Driver_quit() {
log('done, snapshotting... '); this._log('Done !');
document.body.innerHTML = 'Tests finished. <h1>Close this window.</h1>' +
document.body.innerHTML;
this._sendQuitRequest(function () {
window.close();
});
},
var dataUrl = canvas.toDataURL('image/png'); _sendQuitRequest: function Driver_sendQuitRequest(callback) {
sendTaskResult(dataUrl, task, failure, function () { var r = new XMLHttpRequest();
log('done' + (failure ? ' (failed !: ' + failure + ')' : '') + '\n'); r.open('POST', '/tellMeToQuit?path=' + escape(this.appPath), false);
r.onreadystatechange = function sendQuitRequestOnreadystatechange(e) {
if (r.readyState === 4) {
if (callback) {
callback();
}
}
};
r.send(null);
},
++task.pageNum; _info: function Driver_info(message) {
nextPage(task); this._send('/info', JSON.stringify({
}); browser: this.browser,
} message: message
}));
},
function sendQuitRequest(cb) { _log: function Driver_log(str) {
var r = new XMLHttpRequest(); if (output.insertAdjacentHTML) {
r.open('POST', '/tellMeToQuit?path=' + escape(appPath), false); this.output.insertAdjacentHTML('BeforeEnd', str);
r.onreadystatechange = function sendQuitRequestOnreadystatechange(e) { } else {
if (r.readyState === 4) { this.output.innerHTML += str;
if (cb) {
cb();
} }
if (str.lastIndexOf('\n') >= 0) {
// Scroll to the bottom of the page
window.scrollTo(0, document.body.scrollHeight);
}
},
_done: function Driver_done() {
if (this.inFlightRequests > 0) {
this.inflight.innerHTML = this.inFlightRequests;
setTimeout(this._done(), 100);
} else {
setTimeout(this._quit(), 100);
}
},
_sendResult: function Driver_sendResult(snapshot, task, failure,
callback) {
var result = JSON.stringify({
browser: this.browser,
id: task.id,
numPages: task.pdfDoc ?
(task.lastPage || task.pdfDoc.numPages) : 0,
lastPageNum: this._getLastPageNum(task),
failure: failure,
file: task.file,
round: task.round,
page: task.pageNum,
snapshot: snapshot,
stats: task.stats.times
});
this._send('/submit_task_results', result, callback);
},
_send: function Driver_send(url, message, callback) {
var self = this;
var r = new XMLHttpRequest();
r.open('POST', url, true);
r.setRequestHeader('Content-Type', 'application/json');
r.onreadystatechange = function sendResultOnreadystatechange(e) {
if (r.readyState === 4) {
self.inFlightRequests--;
// Retry until successful
if (r.status !== 200) {
setTimeout(function() {
self._send(url, message);
});
}
if (callback) {
callback();
}
}
};
this.inflight.innerHTML = this.inFlightRequests++;
r.send(message);
} }
}; };
r.send(null);
}
function quitApp() { return Driver;
log('Done !'); })();
document.body.innerHTML = 'Tests are finished. <h1>CLOSE ME!</h1>' +
document.body.innerHTML;
sendQuitRequest(function () {
window.close();
});
}
function done() {
if (inFlightRequests > 0) {
document.getElementById('inflight').innerHTML = inFlightRequests;
setTimeout(done, 100);
} else {
setTimeout(quitApp, 100);
}
}
function sendTaskResult(snapshot, task, failure, callback) {
var result = JSON.stringify({
browser: browser,
id: task.id,
numPages: task.pdfDoc ?
(task.lastPage || task.pdfDoc.numPages) : 0,
lastPageNum: getLastPageNum(task),
failure: failure,
file: task.file,
round: task.round,
page: task.pageNum,
snapshot: snapshot,
stats: task.stats.times
});
send('/submit_task_results', result, callback);
}
function send(url, message, callback) {
var r = new XMLHttpRequest();
// (The POST URI is ignored atm.)
r.open('POST', url, true);
r.setRequestHeader('Content-Type', 'application/json');
r.onreadystatechange = function sendTaskResultOnreadystatechange(e) {
if (r.readyState === 4) {
inFlightRequests--;
// Retry until successful
if (r.status !== 200) {
setTimeout(function() {
send(url, message);
});
}
if (callback) {
callback();
}
}
};
document.getElementById('inflight').innerHTML = inFlightRequests++;
r.send(message);
}
function info(message) {
send('/info', JSON.stringify({
browser: browser,
message: message
}));
}
function clear(ctx) {
ctx.beginPath();
ctx.clearRect(0, 0, canvas.width, canvas.height);
}
function log(str) {
if (stdout.insertAdjacentHTML) {
stdout.insertAdjacentHTML('BeforeEnd', str);
} else {
stdout.innerHTML += str;
}
if (str.lastIndexOf('\n') >= 0) {
// Scroll to the bottom of the page
window.scrollTo(0, document.body.scrollHeight);
}
}
})(); // DriverClosure

View File

@ -34,7 +34,11 @@ limitations under the License.
<div id="end"></div> <div id="end"></div>
</body> </body>
<script> <script>
PDFJS.workerSrc = '../src/worker_loader.js'; var driver = new Driver({
load(); output: document.getElementById('output'),
inflight: document.getElementById('inflight'),
end: document.getElementById('end')
});
driver.run();
</script> </script>
</html> </html>