akira
/
pdfjs-dist
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

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'.
Tim van der Meij 10 years ago
parent
d59660cfa6
commit
ae8748edfb
2 changed files with 435 additions and 382 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 521
      test/driver.js
  2. 8
      test/test_slave.html

521
test/driver.js
Unescape View File

@ -18,20 +18,121 @@
'use strict'; 'use strict';
/* /**
* A Test Driver for PDF.js * @class
*/ */
(function DriverClosure() { var NullTextLayerBuilder = (function NullTextLayerBuilderClosure() {
/**
* @constructs NullTextLayerBuilder
*/
function NullTextLayerBuilder() {}
NullTextLayerBuilder.prototype = {
beginLayout: function NullTextLayerBuilder_BeginLayout() {},
endLayout: function NullTextLayerBuilder_EndLayout() {},
appendText: function NullTextLayerBuilder_AppendText() {}
};
return NullTextLayerBuilder;
})();
/**
* @class
*/
var SimpleTextLayerBuilder = (function SimpleTextLayerBuilderClosure() {
/**
* @constructs SimpleTextLayerBuilder
*/
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, ii = textItems.length; i < ii; i++) {
this.appendText(textItems[i], textContent.styles);
}
this.ctx.restore();
}
};
PDFJS.enableStats = true; return SimpleTextLayerBuilder;
PDFJS.cMapUrl = '../external/bcmaps/'; })();
PDFJS.cMapPacked = true;
var appPath, masterMode, browser, canvas, dummyCanvas, currentTaskIdx, /**
manifest, stdout; * @typedef {Object} DriverOptions
var inFlightRequests = 0; * @property {HTMLPreElement} output - Container for all output messages.
* @property {HTMLSpanElement} inflight - Field displaying the number of
* inflight requests.
* @property {HTMLDivElement} end - Container for a completion message.
*/
function queryParams() { /**
* @class
*/
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');
}
Driver.prototype = {
_getQueryStringParameters: function Driver_getQueryStringParameters() {
var qs = window.location.search.substring(1); var qs = window.location.search.substring(1);
var kvs = qs.split('&'); var kvs = qs.split('&');
var params = { }; var params = { };
@ -40,109 +141,65 @@ function queryParams() {
params[unescape(kv[0])] = unescape(kv[1]); params[unescape(kv[0])] = unescape(kv[1]);
} }
return params; return params;
} },
window.load = function load() {
var params = queryParams();
browser = params.browser;
var manifestFile = params.manifestFile;
appPath = params.path;
masterMode = params.masterMode === 'True';
var delay = params.delay || 0;
canvas = document.createElement('canvas');
stdout = document.getElementById('output');
info('User Agent: ' + navigator.userAgent); run: function Driver_run() {
log('load...\n'); this._info('User Agent: ' + navigator.userAgent);
this._log('load...\n');
log('Harness thinks this browser is "' + browser + '" with path "' + this._log('Harness thinks this browser is "' + this.browser +
appPath + '"\n'); '" with path "' + this.appPath + '"\n');
log('Fetching manifest "' + manifestFile + '"... '); this._log('Fetching manifest "' + this.manifestFile + '"... ');
var r = new XMLHttpRequest(); var r = new XMLHttpRequest();
r.open('GET', manifestFile, false); var self = this;
r.open('GET', this.manifestFile, false);
r.onreadystatechange = function loadOnreadystatechange(e) { r.onreadystatechange = function loadOnreadystatechange(e) {
if (r.readyState === 4) { if (r.readyState === 4) {
log('done\n'); self._log('done\n');
manifest = JSON.parse(r.responseText); self.manifest = JSON.parse(r.responseText);
currentTaskIdx = 0; self.currentTask = 0;
nextTask(); self._nextTask();
} }
}; };
if (delay) { if (this.delay) {
log('\nDelaying for ' + delay + 'ms...\n'); this._log('\nDelaying for ' + this.delay + 'ms...\n');
} }
// When gathering the stats the numbers seem to be more reliable if the // When gathering the stats the numbers seem to be more reliable
// browser is given more time to startup. // if the browser is given more time to startup.
setTimeout(function() { setTimeout(function() {
r.send(null); r.send(null);
}, delay); }, this.delay);
}; },
function 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 guard = document.getElementById('end');
var body = document.body;
while (body.lastChild !== guard) {
body.removeChild(body.lastChild);
}
// Wipe out the link to the pdfdoc so it can be GC'ed.
for (var i = 0; i < manifest.length; i++) {
if (manifest[i].pdfDoc) {
manifest[i].pdfDoc.destroy();
delete manifest[i].pdfDoc;
}
}
}
function 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] : '');
}
function nextTask() { _nextTask: function Driver_nextTask() {
cleanup(); this._cleanup();
if (currentTaskIdx === manifest.length) { if (this.currentTask === this.manifest.length) {
done(); this._done();
return; return;
} }
var task = manifest[currentTaskIdx]; var task = this.manifest[this.currentTask];
task.round = 0; task.round = 0;
task.stats = {times: []}; task.stats = { times: [] };
log('Loading file "' + task.file + '"\n'); this._log('Loading file "' + task.file + '"\n');
var absoluteUrl = combineUrl(window.location.href, task.file); var absoluteUrl = combineUrl(window.location.href, task.file);
var failure; var failure;
var self = this;
function continuation() { function continuation() {
task.pageNum = task.firstPage || 1; task.pageNum = task.firstPage || 1;
nextPage(task, failure); self._nextPage(task, failure);
} }
PDFJS.disableRange = task.disableRange; PDFJS.disableRange = task.disableRange;
PDFJS.disableAutoFetch = !task.enableAutoFetch; PDFJS.disableAutoFetch = !task.enableAutoFetch;
try { try {
var promise = PDFJS.getDocument({ PDFJS.getDocument({
url: absoluteUrl, url: absoluteUrl,
password: task.password password: task.password
}); }).then(function(doc) {
promise.then(function(doc) {
task.pdfDoc = doc; task.pdfDoc = doc;
continuation(); continuation();
}, function(e) { }, function(e) {
@ -151,12 +208,46 @@ function nextTask() {
}); });
return; return;
} catch (e) { } catch (e) {
failure = 'load PDF doc : ' + exceptionToString(e); failure = 'load PDF doc : ' + this._exceptionToString(e);
} }
continuation(); 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);
}
function getLastPageNum(task) { // 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) { if (!task.pdfDoc) {
return task.firstPage || 1; return task.firstPage || 1;
} }
@ -165,105 +256,58 @@ function getLastPageNum(task) {
lastPageNum = task.pdfDoc.numPages; lastPageNum = task.pdfDoc.numPages;
} }
return lastPageNum; 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(); _nextPage: function Driver_nextPage(task, loadError) {
}
};
function nextPage(task, loadError) {
var failure = loadError || ''; var failure = loadError || '';
var self = this;
if (!task.pdfDoc) { if (!task.pdfDoc) {
var dataUrl = canvas.toDataURL('image/png'); var dataUrl = this.canvas.toDataURL('image/png');
sendTaskResult(dataUrl, task, failure, function () { this._sendResult(dataUrl, task, failure, function () {
log('done' + (failure ? ' (failed !: ' + failure + ')' : '') + '\n'); self._log('done' + (failure ? ' (failed !: ' + failure + ')' : '') +
++currentTaskIdx; '\n');
nextTask(); self.currentTask++;
self._nextTask();
}); });
return; return;
} }
if (task.pageNum > getLastPageNum(task)) { if (task.pageNum > this._getLastPageNum(task)) {
if (++task.round < task.rounds) { if (++task.round < task.rounds) {
log(' Round ' + (1 + task.round) + '\n'); this._log(' Round ' + (1 + task.round) + '\n');
task.pageNum = task.firstPage || 1; task.pageNum = task.firstPage || 1;
} else { } else {
++currentTaskIdx; this.currentTask++;
nextTask(); this._nextTask();
return; return;
} }
} }
if (task.skipPages && task.skipPages.indexOf(task.pageNum) >= 0) { if (task.skipPages && task.skipPages.indexOf(task.pageNum) >= 0) {
log(' skipping page ' + task.pageNum + '/' + task.pdfDoc.numPages + this._log(' skipping page ' + task.pageNum + '/' +
'... '); task.pdfDoc.numPages + '... ');
// empty the canvas
canvas.width = 1; // Empty the canvas
canvas.height = 1; this.canvas.width = 1;
clear(canvas.getContext('2d')); this.canvas.height = 1;
this._clearCanvas(this.canvas.getContext('2d'));
snapshotCurrentPage(task, '');
this._snapshot(task, '');
return; return;
} }
if (!failure) { if (!failure) {
try { try {
log(' loading page ' + task.pageNum + '/' + task.pdfDoc.numPages + this._log(' loading page ' + task.pageNum + '/' +
'... '); task.pdfDoc.numPages + '... ');
var ctx = canvas.getContext('2d'); var ctx = this.canvas.getContext('2d');
task.pdfDoc.getPage(task.pageNum).then(function(page) { task.pdfDoc.getPage(task.pageNum).then(function(page) {
var pdfToCssUnitsCoef = 96.0 / 72.0; var pdfToCssUnitsCoef = 96.0 / 72.0;
var viewport = page.getViewport(pdfToCssUnitsCoef); var viewport = page.getViewport(pdfToCssUnitsCoef);
canvas.width = viewport.width; self.canvas.width = viewport.width;
canvas.height = viewport.height; self.canvas.height = viewport.height;
clear(ctx); self._clearCanvas(ctx);
var drawContext, textLayerBuilder; var drawContext, textLayerBuilder;
var resolveInitPromise; var resolveInitPromise;
@ -271,12 +315,12 @@ function nextPage(task, loadError) {
resolveInitPromise = resolve; resolveInitPromise = resolve;
}); });
if (task.type === 'text') { if (task.type === 'text') {
// using dummy canvas for pdf context drawing operations // Using a dummy canvas for PDF context drawing operations
if (!dummyCanvas) { if (!self.dummyCanvas) {
dummyCanvas = document.createElement('canvas'); self.dummyCanvas = document.createElement('canvas');
} }
drawContext = dummyCanvas.getContext('2d'); drawContext = self.dummyCanvas.getContext('2d');
// ... text builder will draw its content on the test canvas // The text builder will draw its content on the test canvas
textLayerBuilder = new SimpleTextLayerBuilder(ctx, viewport); textLayerBuilder = new SimpleTextLayerBuilder(ctx, viewport);
page.getTextContent().then(function(textContent) { page.getTextContent().then(function(textContent) {
@ -296,7 +340,7 @@ function nextPage(task, loadError) {
page.destroy(); page.destroy();
task.stats = page.stats; task.stats = page.stats;
page.stats = new StatTimer(); page.stats = new StatTimer();
snapshotCurrentPage(task, error); self._snapshot(task, error);
}); });
initPromise.then(function () { initPromise.then(function () {
page.render(renderContext).promise.then(function() { page.render(renderContext).promise.then(function() {
@ -308,65 +352,93 @@ function nextPage(task, loadError) {
}); });
}, },
function(error) { function(error) {
snapshotCurrentPage(task, 'render : ' + error); self._snapshot(task, 'render : ' + error);
}); });
} catch (e) { } catch (e) {
failure = 'page setup : ' + exceptionToString(e); failure = 'page setup : ' + this._exceptionToString(e);
snapshotCurrentPage(task, failure); this._snapshot(task, failure);
} }
} }
} },
_clearCanvas: function Driver_clearCanvas() {
var ctx = this.canvas.getContext('2d');
ctx.beginPath();
ctx.clearRect(0, 0, this.canvas.width, this.canvas.height);
},
function snapshotCurrentPage(task, failure) { _snapshot: function Driver_snapshot(task, failure) {
log('done, snapshotting... '); var self = this;
this._log('done, snapshotting... ');
var dataUrl = canvas.toDataURL('image/png'); var dataUrl = this.canvas.toDataURL('image/png');
sendTaskResult(dataUrl, task, failure, function () { this._sendResult(dataUrl, task, failure, function () {
log('done' + (failure ? ' (failed !: ' + failure + ')' : '') + '\n'); self._log('done' + (failure ? ' (failed !: ' + failure + ')' : '') +
'\n');
task.pageNum++;
self._nextPage(task);
});
},
++task.pageNum; _quit: function Driver_quit() {
nextPage(task); this._log('Done !');
document.body.innerHTML = 'Tests finished. <h1>Close this window.</h1>' +
document.body.innerHTML;
this._sendQuitRequest(function () {
window.close();
}); });
} },
function sendQuitRequest(cb) { _sendQuitRequest: function Driver_sendQuitRequest(callback) {
var r = new XMLHttpRequest(); var r = new XMLHttpRequest();
r.open('POST', '/tellMeToQuit?path=' + escape(appPath), false); r.open('POST', '/tellMeToQuit?path=' + escape(this.appPath), false);
r.onreadystatechange = function sendQuitRequestOnreadystatechange(e) { r.onreadystatechange = function sendQuitRequestOnreadystatechange(e) {
if (r.readyState === 4) { if (r.readyState === 4) {
if (cb) { if (callback) {
cb(); callback();
} }
} }
}; };
r.send(null); r.send(null);
} },
function quitApp() { _info: function Driver_info(message) {
log('Done !'); this._send('/info', JSON.stringify({
document.body.innerHTML = 'Tests are finished. <h1>CLOSE ME!</h1>' + browser: this.browser,
document.body.innerHTML; message: message
sendQuitRequest(function () { }));
window.close(); },
});
} _log: function Driver_log(str) {
if (output.insertAdjacentHTML) {
this.output.insertAdjacentHTML('BeforeEnd', str);
} else {
this.output.innerHTML += str;
}
if (str.lastIndexOf('\n') >= 0) {
// Scroll to the bottom of the page
window.scrollTo(0, document.body.scrollHeight);
}
},
function done() { _done: function Driver_done() {
if (inFlightRequests > 0) { if (this.inFlightRequests > 0) {
document.getElementById('inflight').innerHTML = inFlightRequests; this.inflight.innerHTML = this.inFlightRequests;
setTimeout(done, 100); setTimeout(this._done(), 100);
} else { } else {
setTimeout(quitApp, 100); setTimeout(this._quit(), 100);
} }
} },
function sendTaskResult(snapshot, task, failure, callback) { _sendResult: function Driver_sendResult(snapshot, task, failure,
callback) {
var result = JSON.stringify({ var result = JSON.stringify({
browser: browser, browser: this.browser,
id: task.id, id: task.id,
numPages: task.pdfDoc ? numPages: task.pdfDoc ?
(task.lastPage || task.pdfDoc.numPages) : 0, (task.lastPage || task.pdfDoc.numPages) : 0,
lastPageNum: getLastPageNum(task), lastPageNum: this._getLastPageNum(task),
failure: failure, failure: failure,
file: task.file, file: task.file,
round: task.round, round: task.round,
@ -374,22 +446,22 @@ function sendTaskResult(snapshot, task, failure, callback) {
snapshot: snapshot, snapshot: snapshot,
stats: task.stats.times stats: task.stats.times
}); });
this._send('/submit_task_results', result, callback);
},
send('/submit_task_results', result, callback); _send: function Driver_send(url, message, callback) {
} var self = this;
function send(url, message, callback) {
var r = new XMLHttpRequest(); var r = new XMLHttpRequest();
// (The POST URI is ignored atm.)
r.open('POST', url, true); r.open('POST', url, true);
r.setRequestHeader('Content-Type', 'application/json'); r.setRequestHeader('Content-Type', 'application/json');
r.onreadystatechange = function sendTaskResultOnreadystatechange(e) { r.onreadystatechange = function sendResultOnreadystatechange(e) {
if (r.readyState === 4) { if (r.readyState === 4) {
inFlightRequests--; self.inFlightRequests--;
// Retry until successful // Retry until successful
if (r.status !== 200) { if (r.status !== 200) {
setTimeout(function() { setTimeout(function() {
send(url, message); self._send(url, message);
}); });
} }
if (callback) { if (callback) {
@ -397,33 +469,10 @@ function send(url, message, callback) {
} }
} }
}; };
document.getElementById('inflight').innerHTML = inFlightRequests++; this.inflight.innerHTML = this.inFlightRequests++;
r.send(message); 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) { return Driver;
// Scroll to the bottom of the page })();
window.scrollTo(0, document.body.scrollHeight);
}
}
})(); // DriverClosure

8
test/test_slave.html
Unescape 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>

Write Preview
Loading…
Cancel
Save