Open magreenblatt opened 2 months ago
Decide how to handle features that are currently default-disabled with Alloy bootstrap.
CalculateNativeWinOcclusion should be disabled for browsers with Alloy style windowless rendering or native parent.
We can leave this as the default (enabled) for now, until/unless anyone spots issues related to it. It can also be disabled globally be passing --disable-features=CalculateNativeWinOcclusion
on the command-line.
DocumentPictureInPictureAPI should be disabled for all browsers with Alloy style.
Unfortunately document PiP can't be disabled on a per-browser basis. There are two way to handle this currently with Alloy style (in OnBeforePopup when target_disposition == CEF_WOD_NEW_PICTURE_IN_PICTURE
):
DOMException: Failed to execute 'requestWindow' on 'DocumentPictureInPicture': Internal error: no window
Document PiP can also be disabled globally be passing --disable-features=DocumentPictureInPictureAPI
on the command-line, resulting in ReferenceError: documentPictureInPicture is not defined
.
See issue #3448 for reproduction steps.
Verify that Chrome bootstrap supports all CefSettings.
The following CefSettings parameters are not yet implemented for Chrome bootstrap:
--log-file
is already supported)--log-level
is already supported)Also need to add Chrome bootstrap support for CefResourceBundleHandler (by passing CefResourceBundleDelegate to InitSharedInstanceWithLocale here and here). This would also potentially allow us to support pack_loading_disabled, if we disabled resource-related code in those locations and moved it to ChromeMainDelegateCef.
All prep work is now complete (in current master) for the removal of Alloy bootstrap in ~127.
Also posted to cef-announce: https://groups.google.com/g/cef-announce/c/s1WaovAopFo/m/LV5eiNX1BgAJ
I have found a blocking issue for me in removing the Alloy bootstrap: https://github.com/chromiumembedded/cef/issues/3721
Starting with M125 the CEF Alloy runtime has been split into separate style and bootstrap components. Both Chrome style and Alloy style browsers/windows can now be created while using the Chrome bootstrap. The Alloy bootstrap is considered deprecated and will be removed in approximately M127.
Background
CEF currently supports two bootstraps, the Chrome bootstrap and the Alloy bootstrap. Alloy bootstrap usage has been required up to this point for use cases such as external (native) parent and windowless (off-screen) rendering. Starting with M125 it is now possible to create Alloy style browsers for these use cases while running with the Chrome bootstrap. The final step of this migration process will be the removal of Alloy bootstrap code in approximately M127.
Running with the Alloy bootstrap (
CefSettings.chrome_runtime = false
) will generate a warning message starting with M125. The message looks like this:[WARNING:main_runner.cc(272)] Alloy bootstrap is deprecated and will be removed in ~M127. See https://github.com/chromiumembedded/cef/issues/3685
Testing
The CEF Sample Application (cefclient on Windows/MacOS, cefsimple on Linux) is available for download here and supports the Chrome and Alloy bootstraps as specified below. Additional test applications, including CEF unit tests (ceftests), can be built and run using the Standard Distribution.
--enable-chrome-runtime
command-line flag.--disable-chrome-runtime
command-line flag.Chrome bootstrap + Chrome style is supported in all recent versions (add
--enable-chrome-runtime
if required). Modes supported with Chrome bootstrap + Chrome style:--use-native
(cefclient only & Windows/Linux only)--use-native
(cefsimple only)Chrome bootstrap + Alloy style is supported but default disabled in versions 125.0.8 and newer (add
--use-alloy-style
to enable, and--enable-chrome-runtime
if required). Modes supported with Chrome bootstrap + Alloy style:--use-views
with cefsimple--off-screen-rendering-enabled
(cefclient only)--use-native
with cefclientSee here for additional testing instructions including various runtime modes and unit test commands.
Migration Route
Windowed applications using Alloy style may wish to use Chrome style as it provides substantially more default functionality (details here). To switch a windowed application from Alloy style to Chrome style simply set
CefSettings.chrome_runtime = true
before callingCefInitialize
.Migrating an application from the Alloy bootstrap to the Chrome bootstrap while keeping Alloy style is a bit more involved. Here are the steps:
CefSettings.chrome_runtime = true
before callingCefInitialize
.CefWindowInfo.runtime_style = CEF_RUNTIME_STYLE_ALLOY
before callingCefBrowserHost::CreateBrowser
.CEF_RUNTIME_STYLE_ALLOY
fromCefWindowDelegate::GetWindowRuntimeStyle
andCefBrowserViewDelegate::GetBrowserRuntimeStyle
.What's Different
Chrome bootstrap + Alloy style behavior differs from Alloy bootstrap in the following significant ways:
Known issues specific to Chrome bootstrap + Alloy style:
DevTools popups don't load successfully in combination with windowless rendering. Use windowed rendering or remote debugging as a workaround.(fixed in 99c85e32ac)Reporting Issues
If you run into any additional issues while migrating your application to the Chrome bootstrap please let us know by posting on the CEF Forum or filing a bug in the CEF issue tracker.