Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Convert PDFWorker, in src/display/api.js, to an ES6 class

Browse Source 
Also changes all occurrences of `var` to `let`/`const` in this code.
This commit is contained in:
Jonas Jenwald 2018-11-08 16:22:26 +01:00
parent 02e77a39ec
commit 061f7bd2f3
1 changed files with 68 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

144
src/display/api.js
View File

@ -321,16 +321,12 @@ function getDocument(src) {
const workerParams = { const workerParams = {
postMessageTransfers: params.postMessageTransfers, postMessageTransfers: params.postMessageTransfers,
verbosity: params.verbosity, verbosity: params.verbosity,
port: GlobalWorkerOptions.workerPort,
}; };
// Worker was not provided -- creating and owning our own. If message port // Worker was not provided -- creating and owning our own. If message port
// is specified in global worker options, using it. // is specified in global worker options, using it.
let workerPort = GlobalWorkerOptions.workerPort; worker = workerParams.port ? PDFWorker.fromPort(workerParams) :
if (workerPort) { new PDFWorker(workerParams);
workerParams.port = workerPort;
worker = PDFWorker.fromPort(workerParams);
} else {
worker = new PDFWorker(workerParams);
}
task._worker = worker; task._worker = worker;
} }
var docId = task.docId; var docId = task.docId;
@ -1342,8 +1338,10 @@ class LoopbackPort {
* a "fake" worker will be used instead. * a "fake" worker will be used instead.
* @class * @class
*/ */
var PDFWorker = (function PDFWorkerClosure() { const PDFWorker = (function PDFWorkerClosure() {
const pdfWorkerPorts = new WeakMap();
let nextFakeWorkerId = 0; let nextFakeWorkerId = 0;
let fakeWorkerFilesLoadedCapability;
function getWorkerSrc() { function getWorkerSrc() {
if (GlobalWorkerOptions.workerSrc) { if (GlobalWorkerOptions.workerSrc) {
@ -1364,8 +1362,6 @@ var PDFWorker = (function PDFWorkerClosure() {
return null; return null;
} }
let fakeWorkerFilesLoadedCapability;
// Loads worker code into main thread. // Loads worker code into main thread.
function setupFakeWorkerGlobal() { function setupFakeWorkerGlobal() {
if (fakeWorkerFilesLoadedCapability) { if (fakeWorkerFilesLoadedCapability) {
@ -1373,7 +1369,7 @@ var PDFWorker = (function PDFWorkerClosure() {
} }
fakeWorkerFilesLoadedCapability = createPromiseCapability(); fakeWorkerFilesLoadedCapability = createPromiseCapability();
let mainWorkerMessageHandler = getMainThreadWorkerMessageHandler(); const mainWorkerMessageHandler = getMainThreadWorkerMessageHandler();
if (mainWorkerMessageHandler) { if (mainWorkerMessageHandler) {
// The worker was already loaded using a `<script>` tag. // The worker was already loaded using a `<script>` tag.
fakeWorkerFilesLoadedCapability.resolve(mainWorkerMessageHandler); fakeWorkerFilesLoadedCapability.resolve(mainWorkerMessageHandler);
@ -1389,7 +1385,7 @@ var PDFWorker = (function PDFWorkerClosure() {
}).catch(fakeWorkerFilesLoadedCapability.reject); }).catch(fakeWorkerFilesLoadedCapability.reject);
} else if (typeof require === 'function') { } else if (typeof require === 'function') {
try { try {
let worker = require('../core/worker.js'); const worker = require('../core/worker.js');
fakeWorkerFilesLoadedCapability.resolve(worker.WorkerMessageHandler); fakeWorkerFilesLoadedCapability.resolve(worker.WorkerMessageHandler);
} catch (ex) { } catch (ex) {
fakeWorkerFilesLoadedCapability.reject(ex); fakeWorkerFilesLoadedCapability.reject(ex);
@ -1414,65 +1410,61 @@ var PDFWorker = (function PDFWorkerClosure() {
// We will rely on blob URL's property to specify origin. // We will rely on blob URL's property to specify origin.
// We want this function to fail in case if createObjectURL or Blob do not // We want this function to fail in case if createObjectURL or Blob do not
// exist or fail for some reason -- our Worker creation will fail anyway. // exist or fail for some reason -- our Worker creation will fail anyway.
var wrapper = 'importScripts(\'' + url + '\');'; const wrapper = 'importScripts(\'' + url + '\');';
return URL.createObjectURL(new Blob([wrapper])); return URL.createObjectURL(new Blob([wrapper]));
} }
let pdfWorkerPorts = new WeakMap();
/** /**
* @param {PDFWorkerParameters} params - The worker initialization parameters. * @param {PDFWorkerParameters} params - The worker initialization parameters.
*/ */
function PDFWorker({ name = null, port = null, class PDFWorker {
postMessageTransfers = true, constructor({ name = null, port = null, postMessageTransfers = true,
verbosity = getVerbosityLevel(), } = {}) { verbosity = getVerbosityLevel(), } = {}) {
if (port && pdfWorkerPorts.has(port)) { if (port && pdfWorkerPorts.has(port)) {
throw new Error('Cannot use more than one PDFWorker per port'); throw new Error('Cannot use more than one PDFWorker per port');
}
this.name = name;
this.destroyed = false;
this.postMessageTransfers = postMessageTransfers !== false;
this.verbosity = verbosity;
this._readyCapability = createPromiseCapability();
this._port = null;
this._webWorker = null;
this._messageHandler = null;
if (port) {
pdfWorkerPorts.set(port, this);
this._initializeFromPort(port);
return;
}
this._initialize();
} }
this.name = name;
this.destroyed = false;
this.postMessageTransfers = postMessageTransfers !== false;
this.verbosity = verbosity;
this._readyCapability = createPromiseCapability();
this._port = null;
this._webWorker = null;
this._messageHandler = null;
if (port) {
pdfWorkerPorts.set(port, this);
this._initializeFromPort(port);
return;
}
this._initialize();
}
PDFWorker.prototype = /** @lends PDFWorker.prototype */ {
get promise() { get promise() {
return this._readyCapability.promise; return this._readyCapability.promise;
}, }
get port() { get port() {
return this._port; return this._port;
}, }
get messageHandler() { get messageHandler() {
return this._messageHandler; return this._messageHandler;
}, }
_initializeFromPort: function PDFWorker_initializeFromPort(port) { _initializeFromPort(port) {
this._port = port; this._port = port;
this._messageHandler = new MessageHandler('main', 'worker', port); this._messageHandler = new MessageHandler('main', 'worker', port);
this._messageHandler.on('ready', function () { this._messageHandler.on('ready', function() {
// Ignoring 'ready' event -- MessageHandler shall be already initialized // Ignoring 'ready' event -- MessageHandler shall be already initialized
// and ready to accept the messages. // and ready to accept the messages.
}); });
this._readyCapability.resolve(); this._readyCapability.resolve();
}, }
_initialize: function PDFWorker_initialize() { _initialize() {
// If worker support isn't disabled explicit and the browser has worker // If worker support isn't disabled explicit and the browser has worker
// support, create a new web worker and test if it/the browser fulfills // support, create a new web worker and test if it/the browser fulfills
// all requirements to run parts of pdf.js in a web worker. // all requirements to run parts of pdf.js in a web worker.
@ -1493,9 +1485,9 @@ var PDFWorker = (function PDFWorkerClosure() {
// Some versions of FF can't create a worker on localhost, see: // Some versions of FF can't create a worker on localhost, see:
// https://bugzilla.mozilla.org/show_bug.cgi?id=683280 // https://bugzilla.mozilla.org/show_bug.cgi?id=683280
var worker = new Worker(workerSrc); const worker = new Worker(workerSrc);
var messageHandler = new MessageHandler('main', 'worker', worker); const messageHandler = new MessageHandler('main', 'worker', worker);
var terminateEarly = () => { const terminateEarly = () => {
worker.removeEventListener('error', onWorkerError); worker.removeEventListener('error', onWorkerError);
messageHandler.destroy(); messageHandler.destroy();
worker.terminate(); worker.terminate();
@ -1508,7 +1500,7 @@ var PDFWorker = (function PDFWorkerClosure() {
} }
}; };
var onWorkerError = () => { const onWorkerError = () => {
if (!this._webWorker) { if (!this._webWorker) {
// Worker failed to initialize due to an error. Clean up and fall // Worker failed to initialize due to an error. Clean up and fall
// back to the fake worker. // back to the fake worker.
@ -1582,9 +1574,9 @@ var PDFWorker = (function PDFWorkerClosure() {
// Either workers are disabled, not supported or have thrown an exception. // Either workers are disabled, not supported or have thrown an exception.
// Thus, we fallback to a faked worker. // Thus, we fallback to a faked worker.
this._setupFakeWorker(); this._setupFakeWorker();
}, }
_setupFakeWorker: function PDFWorker_setupFakeWorker() { _setupFakeWorker() {
if (!isWorkerDisabled) { if (!isWorkerDisabled) {
warn('Setting up fake worker.'); warn('Setting up fake worker.');
isWorkerDisabled = true; isWorkerDisabled = true;
@ -1595,30 +1587,30 @@ var PDFWorker = (function PDFWorkerClosure() {
this._readyCapability.reject(new Error('Worker was destroyed')); this._readyCapability.reject(new Error('Worker was destroyed'));
return; return;
} }
let port = new LoopbackPort(); const port = new LoopbackPort();
this._port = port; this._port = port;
// All fake workers use the same port, making id unique. // All fake workers use the same port, making id unique.
var id = 'fake' + (nextFakeWorkerId++); const id = 'fake' + (nextFakeWorkerId++);
// If the main thread is our worker, setup the handling for the // If the main thread is our worker, setup the handling for the
// messages -- the main thread sends to it self. // messages -- the main thread sends to it self.
var workerHandler = new MessageHandler(id + '_worker', id, port); const workerHandler = new MessageHandler(id + '_worker', id, port);
WorkerMessageHandler.setup(workerHandler, port); WorkerMessageHandler.setup(workerHandler, port);
var messageHandler = new MessageHandler(id, id + '_worker', port); const messageHandler = new MessageHandler(id, id + '_worker', port);
this._messageHandler = messageHandler; this._messageHandler = messageHandler;
this._readyCapability.resolve(); this._readyCapability.resolve();
}).catch((reason) => { }).catch((reason) => {
this._readyCapability.reject( this._readyCapability.reject(
new Error(`Setting up fake worker failed: "${reason.message}".`)); new Error(`Setting up fake worker failed: "${reason.message}".`));
}); });
}, }
/** /**
* Destroys the worker instance. * Destroys the worker instance.
*/ */
destroy: function PDFWorker_destroy() { destroy() {
this.destroyed = true; this.destroyed = true;
if (this._webWorker) { if (this._webWorker) {
// We need to terminate only web worker created resource. // We need to terminate only web worker created resource.
@ -1631,26 +1623,26 @@ var PDFWorker = (function PDFWorkerClosure() {
this._messageHandler.destroy(); this._messageHandler.destroy();
this._messageHandler = null; this._messageHandler = null;
} }
},
};
/**
* @param {PDFWorkerParameters} params - The worker initialization parameters.
*/
PDFWorker.fromPort = function(params) {
if (!params || !params.port) {
throw new Error('PDFWorker.fromPort - invalid method signature.');
} }
if (pdfWorkerPorts.has(params.port)) {
return pdfWorkerPorts.get(params.port); /**
* @param {PDFWorkerParameters} params - The worker initialization
* parameters.
*/
static fromPort(params) {
if (!params || !params.port) {
throw new Error('PDFWorker.fromPort - invalid method signature.');
}
if (pdfWorkerPorts.has(params.port)) {
return pdfWorkerPorts.get(params.port);
}
return new PDFWorker(params);
} }
return new PDFWorker(params);
};
PDFWorker.getWorkerSrc = function() {
return getWorkerSrc();
};
static getWorkerSrc() {
return getWorkerSrc();
}
}
return PDFWorker; return PDFWorker;
})(); })();