[api-minor] Remove support for synchronous event dispatching in LoopbackPort
#12999
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…backPort` *Please note:* The `defer` parameter has been enabled by default ever since PR 9777 (in 2018), which first shipped in PDF.js release `2.0.943`. With workers *disabled*, e.g. in Node.js environments, this has been used ever since without any problems reported[1]. The impetus for this change was that I happened to notice that *if* the `LoopbackPort` was used with synchronous event dispatching, we'd simply send that data as-is to the listeners. This created an inconsistency in the data returned from the `pdf.worker.js` file, since `postMessage` used with *actual* workers (or the `LoopbackPort` with `defer = true`) will ignore/throw when encountering unclonable data. Originally my intention was simply to just call `cloneValue` regardless of the event dispatching used in `LoopbackPort`, however looking at the use-cases (or lack thereof) of the `LoopbackPort` it seemed reasonable to simply remove the `defer` parameter instead. This patch is tagged "[api-minor]" since the `LoopbackPort` is still exposed in the API, although I really hope that no third-party is using this (since disabling workers leads to bad performance). Finally, this patch changes a `forEach` loop to `for...of` and makes uses of optional changing in existing code. --- [1] As evident by the `npm test` command run by Github Actions, and previously by Travis.
|
/botio unittest |
From: Bot.io (Linux m4)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.67.70.0:8877/770e36c7dfed554/output.txt |
From: Bot.io (Windows)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://3.101.106.178:8877/5020bb87c38e235/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/770e36c7dfed554/output.txt Total script time: 3.63 mins
|
From: Bot.io (Windows)SuccessFull output at http://3.101.106.178:8877/5020bb87c38e235/output.txt Total script time: 5.27 mins
|
timvandermeij
approved these changes
Feb 17, 2021
|
I also don't see a particular good use case for this. Let's remove it; thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please note: The
deferparameter has been enabled by default ever since PR #9777 (in 2018), which first shipped in PDF.js release2.0.943.With workers disabled, e.g. in Node.js environments, this has been used ever since without any problems reported[1].
The impetus for this change was that I happened to notice that if the
LoopbackPortwas used with synchronous event dispatching, we'd simply send that data as-is to the listeners. This created an inconsistency in the data returned from thepdf.worker.jsfile, sincepostMessageused with actual workers (or theLoopbackPortwithdefer = true) will ignore/throw when encountering unclonable data.Originally my intention was simply to just call
cloneValueregardless of the event dispatching used inLoopbackPort, however looking at the use-cases (or lack thereof) of theLoopbackPortit seemed reasonable to simply remove thedeferparameter instead.This patch is tagged "[api-minor]" since the
LoopbackPortis still exposed in the API, although I really hope that no third-party is using this (since disabling workers leads to bad performance).Finally, this patch changes a
forEachloop tofor...ofand makes uses of optional changing in existing code.[1] As evident by the
npm testcommand run by Github Actions, and previously by Travis.