New helper apps on macOS in Electron v6

[MarshallOfSound]

• Version: 🤷‍♂

• Target: macOS

This is just a heads up that electron@6 will include two new "Helper.app" applications as a result of a Chromium change and builder needs to be updated to support those two new helpers.

Refs: electron/electron#19500 (comment)

electron-packager commit to handle the new files --> electron/packager@8d407e7

[stevenroussey-privicy]

Related: electron/electron#19510

[mattpilott]

Any timeline on this?

[Kilian]

For reference, this is where the new helpers need to be added:

electron-builder/packages/app-builder-lib/src/electron/electronMac.ts

Lines 44 to 50 in b83f580

	const appPlistFilename = path.join(contentsPath, "Info.plist")
	const helperPlistFilename = path.join(frameworksPath, "Electron Helper.app", "Contents", "Info.plist")
	const helperEHPlistFilename = path.join(frameworksPath, "Electron Helper EH.app", "Contents", "Info.plist")
	const helperNPPlistFilename = path.join(frameworksPath, "Electron Helper NP.app", "Contents", "Info.plist")
	const helperLoginPlistFilename = path.join(loginItemPath, "Electron Login Helper.app", "Contents", "Info.plist")
	const plistContent: Array<any> = await executeAppBuilderAsJson(["decode-plist", "-f", appPlistFilename, "-f", helperPlistFilename, "-f", helperEHPlistFilename, "-f", helperNPPlistFilename, "-f", helperLoginPlistFilename])

[btzsoft]

guys, any timeline? thx!

[btzsoft]

@Kilian I did this changes, also added to moveHelpers but the same, app is crashing.

[caesar]

@Kilian @btzsoft there are many more places in that file where the new helpers need adding. (Ideally it should be refactored to make the code DRYer for so many helpers.)

[btzsoft]

@caesar I did it working right now, my mistake was that I haven't included (GPU) helper also.
I changed electronMac.js directly from node_modules until a new release will be here.
Thx!

[steverandy]

@btzsoft can you share the code snippet?

[Kilian]

@btzsoft @steverandy Or submit a PR? ;)

[Evoks]

PR #4111

[develar]

Thanks! 21.2.0 released.

[gaodeng]

@develar @Evoks
I upgraded from Electron5 to 6 (electron-builder to the latest version), when submitted via the Application Loader, it gives these error:

ERROR ITMS-90277: "Invalid Bundle Identifier. The application bundle contains a tool or framework Electron Helper (GPU) [fm.moon.apps.desktop.player.pkg/Payload/Moon FM.app/Contents/Frameworks/Moon FM Helper (GPU).app] using the bundle identifier 'fm.moon.apps.desktop.player.helper.(GPU)', which is not a valid bundle identifier." 

ERROR ITMS-90277: "Invalid Bundle Identifier. The application bundle contains a tool or framework Electron Helper (Plugin) [fm.moon.apps.desktop.player.pkg/Payload/Moon FM.app/Contents/Frameworks/Moon FM Helper (Plugin).app] using the bundle identifier 'fm.moon.apps.desktop.player.helper.(Plugin)', which is not a valid bundle identifier."

ERROR ITMS-90277: "Invalid Bundle Identifier. The application bundle contains a tool or framework Electron Helper (Renderer) [fm.moon.apps.desktop.player.pkg/Payload/Moon FM.app/Contents/Frameworks/Moon FM Helper (Renderer).app] using the bundle identifier 'fm.moon.apps.desktop.player.helper.(Renderer)', which is not a valid bundle identifier."

[caesar]

@gaodeng I suspect you should open a new issue for this. But for what it's worth, the issue you're seeing is caused by these lines:

electron-builder/packages/app-builder-lib/src/electron/electronMac.ts

Lines 102 to 117 in ebbd9f7

	function configureHelper(helper: any, postfix: string) {
	helper.CFBundleExecutable = `${appFilename} Helper ${postfix}`
	helper.CFBundleDisplayName = `${appInfo.productName} Helper ${postfix}`
	helper.CFBundleIdentifier = `${helperBundleIdentifier}.${postfix}`
	helper.CFBundleVersion = appPlist.CFBundleVersion
	}
	if (helperRendererPlist != null) {
	configureHelper(helperRendererPlist, "(Renderer)")
	}
	if (helperPluginPlist != null) {
	configureHelper(helperPluginPlist, "(Plugin)")
	}
	if (helperGPUPlist != null) {
	configureHelper(helperGPUPlist, "(GPU)")
	}

As you can see, the configureHelper function takes a postfix parameter which is used both in the filename of the helper app, and as the final part of the bundle identifier.
The postfix values being passed contain ( and ) characters which are invalid in the bundle identifier.

This function will need refactoring to avoid this.

Actually the whole of this file is pretty ugly… I started work a while back on refactoring the whole thing but I didn't have time to finish, and won't have time for at least several months more.

[johannesjo]

Still an issue for me with 21.2.0.

[jcc]

Still an issue for me with 21.2.0.

[dimitrisnl]

Happens to me too.

(I know posting a comment doesn't help, but since the thread is locked I wanted to bring some extra attention.)

[turbidwater]

Updating electron-builder to 21.2.0 and adding electron-packager did resolve this for me.
"electron-builder": "^21.2.0", "electron-packager": "^14.2.1",
FWIW, I was using electron 8.3.0 with this.