Make the detection of Node.js environments on Electron strict. #12085
Conversation
| const isNodeJS = | ||
| typeof process === "object" && | ||
| process + "" === "[object process]" && | ||
| !process.versions.nw && | ||
| !process.versions.electron; | ||
| !(process.versions.electron && process.type && process.type !== "browser"); |
There was a problem hiding this comment.
Quoting from https://www.electronjs.org/docs/api/process#processtype-readonly:
A String representing the current process's type, can be "browser" (i.e. main process), "renderer", or "worker" (i.e. web worker).
Hence my question: Will process.type !== "browser" actually do the right thing when this code is run on the worker-thread in a browser?
There was a problem hiding this comment.
Which is what you are saying with the sentence,
when this code is run on the worker-thread in a browser?":
- Running
build/pdf.wroker.json the worker-thread in a browser. - Running
build/pdf.jswith OffscreenCanvas on the worker-thread in a browser.
In either case, it should work properly. I will check.
There was a problem hiding this comment.
Running
build/pdf.worker.json the worker-thread in a browser.
The changes you're making in this patch only applies to environments that pretend to be Node.js, when in reality they are not.
Hence my question pertains to using the Electron-framework in a browser, with workers enabled, and ensuring that e.g.
Lines 676 to 684 in 7dabc5e
Running
build/pdf.jswith OffscreenCanvas on the worker-thread in a browser.
We don't support OffscreenCanvas so that doesn't really matter right now.
There was a problem hiding this comment.
I have created a repository to check this PR.
git clone [email protected]:tamuratak/electron-pdfjs-sample.git
cd electron-pdfjs-sample
npm i (Install Electron locally)
npx electron app/
Then the PDF.js viewer launches. You can see through the dev tools that WebWoker works well. In both cases that nodeIntegration and nodeIntegrationInWorker are true or false, we can see that it woks well.
All the files at app/src/viewer are copied from pdfjs-2.4.456-dist.zip. I have edited app/src/viewer/pdf.js and app/src/viewer/pdf.worker.js as this PR. I have also edited app/src/viewer/viewer.js and app/src/viewer/viewer.html.
$ diff -u ../tmp/pdfjs-2.4/build/pdf.js app/src/viewer/pdf.js
--- ../tmp/pdfjs-2.4/build/pdf.js 2020-03-19 22:43:52.000000000 +0900
+++ app/src/viewer/pdf.js 2020-07-12 10:58:53.000000000 +0900
@@ -4166,7 +4166,7 @@
value: true
});
exports.isNodeJS = void 0;
-const isNodeJS = typeof process === "object" && process + "" === "[object process]" && !process.versions["nw"] && !process.versions["electron"];
+const isNodeJS = typeof process === "object" && process + "" === "[object process]" && !process.versions["nw"] && !(process.versions.electron && process.type && process.type !== "browser");
exports.isNodeJS = isNodeJS;
/***/ }),$ diff -u ../tmp/pdfjs-2.4/build/pdf.worker.js app/src/viewer/pdf.worker.js
--- ../tmp/pdfjs-2.4/build/pdf.worker.js 2020-03-19 22:44:08.000000000 +0900
+++ app/src/viewer/pdf.worker.js 2020-07-12 10:58:53.000000000 +0900
@@ -45266,7 +45266,7 @@
value: true
});
exports.isNodeJS = void 0;
-const isNodeJS = typeof process === "object" && process + "" === "[object process]" && !process.versions["nw"] && !process.versions["electron"];
+const isNodeJS = typeof process === "object" && process + "" === "[object process]" && !process.versions["nw"] && !(process.versions.electron && process.type && process.type !== "browser");
exports.isNodeJS = isNodeJS;
/***/ }),$ diff -u ../tmp/pdfjs-2.4/web/viewer.js app/src/viewer/viewer.js
--- ../tmp/pdfjs-2.4/web/viewer.js 2020-03-19 22:43:56.000000000 +0900
+++ app/src/viewer/viewer.js 2020-07-12 10:58:53.000000000 +0900
@@ -3629,11 +3629,11 @@
kind: OptionKind.API
},
workerPort: {
- value: null,
+ value: new Worker("pdf.worker.js"),
kind: OptionKind.WORKER
},
workerSrc: {
- value: "../build/pdf.worker.js",
+ value: "pdf.worker.js",
kind: OptionKind.WORKER
}
};$ diff -u ../tmp/pdfjs-2.4/web/viewer.html app/src/viewer/viewer.html
--- ../tmp/pdfjs-2.4/web/viewer.html 2020-03-19 22:43:44.000000000 +0900
+++ app/src/viewer/viewer.html 2020-07-12 10:58:53.000000000 +0900
@@ -34,7 +34,7 @@
<!-- This snippet is used in production (included from viewer.html) -->
<link rel="resource" type="application/l10n" href="locale/locale.properties">
-<script src="../build/pdf.js"></script>
+<script src="pdf.js"></script>
<script src="viewer.js"></script>
The main process and its child processes should be detected as Node.js environments.
|
/botio unittest |
From: Bot.io (Linux m4)ReceivedCommand cmd_unittest from @timvandermeij received. Current queue size: 0 Live output at: http://54.67.70.0:8877/d850858654b4bee/output.txt |
From: Bot.io (Windows)ReceivedCommand cmd_unittest from @timvandermeij received. Current queue size: 0 Live output at: http://54.215.176.217:8877/204aa8cc78558df/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/d850858654b4bee/output.txt Total script time: 3.75 mins
|
From: Bot.io (Windows)SuccessFull output at http://54.215.176.217:8877/204aa8cc78558df/output.txt Total script time: 4.66 mins
|
|
Thank you for your contribution! |
Make the detection of Node.js environments on Electron strict. The main process and its child processes should be detected as Node.js environments.
Without this PR,
pdfjsLib.getDocument(...).promise.thenfails with an error messageSetting up fake worker failed: "No "GlobalWorkerOptions.workerSrc" specified.".on the main process and its child processes of Electron.