fix(electron): make apps work on electron 7 #2084

walkingriver · 2019-10-23T10:29:52Z

Given that Electron is now at v7, this PR is to support that in Capacitor, and also provides a minor fix in the SplashScreen that is a response to a recently-reported Electron bug.

I've been using the capacitor/electron project with Electron v6.0.12 for a few weeks now, and haven't seen any issues. Recommending we make it official.

jcesarmobile · 2019-10-23T10:59:01Z

There is another PR already.
Also, just saw 7.0.0 was released a few days ago, can you try that version?

walkingriver · 2019-10-23T11:46:54Z

You are correct. I will try 7 tonight, after reviewing the release notes. We can probably just close this PR for now.

hatsantos · 2019-10-25T09:36:49Z

I'm also using Electron 6 and Ionic 4 without problems.
I think Electron 4 will be deprecated now that Electron 7 was released.

I tryed to update to Electron 7 but got some errors...

npx cap open electron

[email protected] electron:start D:\_GIT\ManagerWebApp\electron
> electron ./

 Cannot read property 'SplashScreen' of undefined
npm ERR! code ELIFECYCLE
npm ERR! errno 2147483651
npm ERR! [email protected] electron:start: `electron ./`
npm ERR! Exit status 2147483651
npm ERR! Exit status 2147483651
npm ERR!
npm ERR! Failed at the [email protected] electron:start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\hats\AppData\Roaming\npm-cache\_logs\2019-10-25T09_34_46_041Z-debug.log

    at ChildProcess.exithandler (child_process.js:295:12)
    at ChildProcess.emit (events.js:210:5)
    at maybeClose (internal/child_process.js:1021:16)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:283:5) {
  killed: false,
  code: 2147483651,
  signal: null,
  cmd: 'npm run electron:start'
}

npx cap open

? Please choose a platform to open: electron
[info] Opening Electron project at D:\_GIT\ManagerWebApp\electron
[error] Error: Command failed: npm run electron:start
npm ERR! code ELIFECYCLE
npm ERR! errno 2147483651
npm ERR! [email protected] electron:start: `electron ./`
npm ERR! Exit status 2147483651
npm ERR!
npm ERR! Failed at the [email protected] electron:start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\hats\AppData\Roaming\npm-cache\_logs\2019-10-25T09_48_37_683Z-debug.log

    at ChildProcess.exithandler (child_process.js:295:12)
    at ChildProcess.emit (events.js:210:5)
    at maybeClose (internal/child_process.js:1021:16)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:283:5) {
  killed: false,
  code: 2147483651,
  signal: null,
  cmd: 'npm run electron:start'
}

bcallaghan-fri · 2019-10-26T01:46:43Z

@hatsantos I'm getting the same error you are. Are you using the SplashScreen plugin? If I remove the SplashScreen, and load my index.html file directly, I don't get this error. I recommend moving this conversation to a bug report for the SplashScreen.

walkingriver · 2019-10-27T00:18:22Z

Ok, this isn't quite as awful as it seems. There is an issue with Electron 7, webview setting baseURLForDataURL crashes Electron #20700. This is how the CapacitorSplashScreen plugin works. Removing the baseURLForDataURL parameter causes the splash screen to load (without the image, though), and then the app continues to run properly from there.

walkingriver · 2019-10-27T01:51:46Z

electron/index.js

@@ -67,7 +67,7 @@ class CapacitorSplashScreen {
      let capConfigJson = JSON.parse(fs.readFileSync(`./capacitor.config.json`, 'utf-8'));
      this.splashOptions = Object.assign(
        this.splashOptions,
-        capConfigJson.plugins.SplashScreen
+        capConfigJson.plugins.SplashScreen || {}


This removes the error if the developer has not provided the options in capacitor.config.json. This option should be documented better. Very useful.

walkingriver · 2019-10-27T01:52:54Z

electron/index.js

+      webPreferences: {
+        // Required to load file:// splash screen
+        webSecurity: false  
+      }


I figure this is safe as long as we're only loading a splash screen. It might make more sense to base this value on whether or not the developer provided customHtml, which cannot be verified.

walkingriver · 2019-10-27T01:54:22Z

electron/index.js

@@ -118,7 +124,7 @@ class CapacitorSplashScreen {
      }
    });

-    this.splashWindow.loadURL(`data:text/html;charset=UTF-8,${splashHtml}`, {baseURLForDataURL: `file://${rootPath}/splash_assets/`});


This is the response to Electron bug: electron/electron#20700

walkingriver · 2019-11-09T19:40:26Z

@jcesarmobile, are you an official reviewer? This definitely fixes the issue with Electron 7. It may not be the right long-term fix, but it does solve the immediate problem.

electron/index.js

The imagePath should now work on both macOS and Windows, by using the url object.

jcesarmobile

Turns out pathToFileURL was included in node 10.12.0, but Electron 4 shiped with 10.11.0, so this changes will break existing apps using Electron 4, and since that was the pinned version before this PR could be a lot. Despite it's an easy fix, users just need to bump their Electron version to 5 or greater, I've pushed some changes to keep the old behaviour in case pathToFileURL is not available.
Will merge once the tests finish.
Thanks for the PR!

Bump Electron to latest official version

827b1c7

I've been using the capacitor/electron project with Electron v6.0.12 for a few weeks now, and haven't seen any issues. Recommending we make it official.

walkingriver added 2 commits October 26, 2019 20:38

Merge branch 'master' into patch-4

e12c221

Modified splash screen to support Electron 7

71ecbeb

walkingriver commented Oct 27, 2019

View reviewed changes

walkingriver changed the title ~~Bump Electron to latest official version~~ Bump Electron to official version 7.0.0 Oct 27, 2019

walkingriver commented Nov 9, 2019

View reviewed changes

electron/index.js Outdated Show resolved Hide resolved

Fixed image path to work on macOS and Windows

307503d

The imagePath should now work on both macOS and Windows, by using the url object.

jcesarmobile mentioned this pull request Nov 13, 2019

Update electron to 6.0.0 #1844

Closed

Make it compatible with Electron 4

ea0654c

jcesarmobile approved these changes Dec 10, 2019

View reviewed changes

jcesarmobile changed the title ~~Bump Electron to official version 7.0.0~~ fix(electron): make apps work on electron 7 Dec 10, 2019

jcesarmobile merged commit 046aad2 into ionic-team:master Dec 10, 2019

walkingriver deleted the patch-4 branch December 10, 2019 16:18

bryplano mentioned this pull request Dec 11, 2019

feat: Add support for electron 7.x #2219

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(electron): make apps work on electron 7 #2084

fix(electron): make apps work on electron 7 #2084

walkingriver commented Oct 23, 2019 •

edited

Loading

jcesarmobile commented Oct 23, 2019

walkingriver commented Oct 23, 2019

hatsantos commented Oct 25, 2019 •

edited

Loading

bcallaghan-fri commented Oct 26, 2019

walkingriver commented Oct 27, 2019

walkingriver Oct 27, 2019

walkingriver Oct 27, 2019

walkingriver Oct 27, 2019

walkingriver commented Nov 9, 2019

jcesarmobile left a comment

fix(electron): make apps work on electron 7 #2084

fix(electron): make apps work on electron 7 #2084

Conversation

walkingriver commented Oct 23, 2019 • edited Loading

jcesarmobile commented Oct 23, 2019

walkingriver commented Oct 23, 2019

hatsantos commented Oct 25, 2019 • edited Loading

bcallaghan-fri commented Oct 26, 2019

walkingriver commented Oct 27, 2019

walkingriver Oct 27, 2019

Choose a reason for hiding this comment

walkingriver Oct 27, 2019

Choose a reason for hiding this comment

walkingriver Oct 27, 2019

Choose a reason for hiding this comment

walkingriver commented Nov 9, 2019

jcesarmobile left a comment

Choose a reason for hiding this comment

walkingriver commented Oct 23, 2019 •

edited

Loading

hatsantos commented Oct 25, 2019 •

edited

Loading