[multi] Introduce preload script #3397
Merged
Conversation
This file contains 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
matheusd
force-pushed
the
improve-ipc
branch
4 times, most recently
from
5799411
to
e31e5c1
Compare
This makes the code cleaner in the ipc renderer side. ipcRenderer.invoke implicitly returns a promise and doesn't block the ipcRenderer process vs sendSync.
This is a pre-requisite to moving fs accesses to a preload script.
This introduces a preload script to the app. This script is generated via a new webpack config, which watches over changes to regenerate it as needed when running via `yarn dev`. Currently the only API reintroduced via this preload script into the main world is the wallet/fs module. In future commits, other APIs will be compatibilized to the preload script and will be offered through it.
This serves as a check throughout development that the preload script is behaving as expected.
This ensures tests pass.
alexlyp
approved these changes
May 25, 2021
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.
Rebased on top of #3366This simplifies some code that runs in the main process and introduces a preload script that runs before the main wallet interface. This starts the work towards moving all node-related calls to the preload script, so that node integration can be turned off for the main UI code.
Notable changes:
Switch fromaxiosto standardfetchcallsaxiosstill uses the old XMLHTTPRequest which is not needed in modern browsers.fetchallows more config options and removes the need for an additional dependency.send/onIPC calls withinvoke/handlefor commsinvoke/handleautomatically promisify calls and are asynchronous, thus removing the need for an error-prone architecture usingsend/onfor async comms with the main processfsrelated code to separate filefsmodule, the operations are shimmed through a local js module and call sites are updated accordlingyPreload scripts are specified by the main electron process code when creating a
BrowserWindowobject and run before the document specified byloadURLis loaded. The main usefulness for preload scripts is (re-)introducing select node and electron APIs to the UI code when theBrowserWindowis created withnodeIntegration: falseandcontextIsolation: true(which is the default in electron v12 and is likely to become mandatory in the future).Unfortunately, due to the large number of places in the UI code where native node modules and electron API calls are happening today, it's going to be too difficult to write, test and review a single PR moving all code to the preload stage. Therefore, this is going to be broken up into a series of PRs that slowly improve the interface for IPC calls between the main and renderer processes and moves code to the preload script, such that a final PR can simply set the appropriate flags in the
webContentsduring startup.