alloy: Delete Alloy bootstrap (M128) #3685

magreenblatt · 2024-04-22T19:10:53Z

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 has been removed starting with the M128 release.

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 is the removal of Alloy bootstrap code in current master (M128 release).

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.

Chrome bootstrap is supported but default disabled in cefclient & cefsimple versions 125.0.11 and older. To test the Chrome bootstrap in these versions add the --enable-chrome-runtime command-line flag.
Chrome bootstrap is default enabled in cefclient & cefsimple versions 125.0.14 and newer. To test the Alloy bootstrap in these versions add the --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:

Views framework: Enabled by default (cefclient & cefsimple)
External (native) parent: Add --use-native (cefclient only & Windows/Linux only)
Fully styled Chrome UI window: Add --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:

Views framework: Enabled by default with cefclient, add --use-views with cefsimple
Windowless (off-screen) rendering: Add --off-screen-rendering-enabled (cefclient only)
External (native) parent: Enabled by default with cefsimple, add --use-native with cefclient

See 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 calling CefInitialize.

Migrating an application from the Alloy bootstrap to the Chrome bootstrap while keeping Alloy style is a bit more involved. Here are the steps:

Set CefSettings.chrome_runtime = true before calling CefInitialize.
Make the following changes depending on your Alloy usage:
- With external parent: Set CefWindowInfo.runtime_style = CEF_RUNTIME_STYLE_ALLOY before calling CefBrowserHost::CreateBrowser.
- With windowless rendering: Alloy style is used by default.
- With the Views framework: Return CEF_RUNTIME_STYLE_ALLOY from CefWindowDelegate::GetWindowRuntimeStyle and CefBrowserViewDelegate::GetBrowserRuntimeStyle.

What's Different

Chrome bootstrap + Alloy style behavior differs from Alloy bootstrap in the following significant ways:

Supports Chrome error pages by default.
DevTools popups are Chrome style only (cannot be windowless).
The Alloy extension API is not supported (has been removed in M128). The Chrome extension API is supported with Chrome style browsers/windows only.

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 99c85e3)

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.

The text was updated successfully, but these errors were encountered:

magreenblatt · 2024-04-22T19:17:11Z

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.
BackForwardCache can be enabled by default with Chrome runtime + Alloy style.
DocumentPictureInPictureAPI should be disabled for all browsers with Alloy style.

Set enable_alloy_bootstrap=false to build with Alloy bootstrap code removed. Extension API is documented as deprecated in comments but not compiled out with this arg.

Include cef_config.h from base/cef_build.h and fix detection of args.gn changes so that defines are available everywhere by default. Fix include configuration for chrome_elf_set and sandbox targets.

magreenblatt · 2024-05-02T16:16:17Z

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.

magreenblatt · 2024-05-02T17:38:28Z

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):

Return true. This will cause document PiP to fail with DOMException: Failed to execute 'requestWindow' on 'DocumentPictureInPicture': Internal error: no window
Use default handling (current cefclient implementation). This will cause the document PiP window to open with default Alloy styling.

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.

magreenblatt · 2024-05-02T17:58:22Z

Verify that Chrome bootstrap supports all CefSettings.

The following CefSettings parameters are not yet implemented for Chrome bootstrap:

~~browser_subprocess_path~~ (DONE)
~~framework_dir_path~~ (DONE)
~~main_bundle_path~~ (DONE)
persist_user_preferences (will be removed; always enabled with Chrome bootstrap)
~~log_file~~ (DONE) (--log-file is already supported)
~~log_severity~~ (DONE) (--log-level is already supported)
~~log_items~~ (DONE)
~~resources_dir_path~~ (DONE)
~~locales_dir_path~~ (DONE)
pack_loading_disabled (will be removed; unsupported)

magreenblatt · 2024-05-02T23:02:51Z

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.

Also enables logging by default for Release builds (previously required the `--enable-logging` flag). Logging can still be disabled by passing the `--disable-logging` flag.

Alloy bootstrap is deprecated and will be removed in ~M127.

magreenblatt · 2024-05-03T17:05:12Z

All prep work is now complete (in current master) for the removal of Alloy bootstrap in ~127.

The Alloy extension API is deprecated and these tests have not been supported for some time.

Now that args.gn is an input to the make_config_header target we don't want to invalidate the build unnecessarily by modifying the file if the contents are unchanged.

magreenblatt · 2024-05-03T20:53:22Z

Also posted to cef-announce: https://groups.google.com/g/cef-announce/c/s1WaovAopFo/m/LV5eiNX1BgAJ

CEF plan to drop Alloy bootstrap mode support since CEF127+. chromiumembedded/cef#3685 This decision is affect to Chronos. E.g. An issue for print preview on Alloy bootstrap mode is decided to not fixed. chromiumembedded/cef#3686 So we should use Chrome bootstrap mode since CEF127+. Chrome bootstrap + Alloy runtime style is already supported from CEF125+. So we use Chrome bootstrap + Alloy runtime style in advance　before CEF127 is released. If we don't use Alloy runtime style, at least the following issues have been confirmed: * Download popup like Chrome is displayed on right top corner. * Sometimes Chronos craches by clicking "oepn file" of the popup. * Context menus on right clicking are modified. * This is because menu item IDs are different between Alloy runtime mode and Chrome runtime mode. * We should modify Chronos in order to follow to the IDs of Chrome runtime mode. They are don't occur when we use Alloy runtime style. So we adopt Alloy runtime style.

CEF plan to drop Alloy bootstrap mode support since CEF127+. chromiumembedded/cef#3685 This decision affects to Chronos. E.g. An issue for print preview on Alloy bootstrap mode is decided to not fixed. chromiumembedded/cef#3686 So we should use Chrome bootstrap mode since CEF127+. Chrome bootstrap + Alloy runtime style is already supported from CEF125+. So we use Chrome bootstrap + Alloy runtime style in advance　before CEF127 is released. If we don't use Alloy runtime style, at least the following issues have been confirmed: * Download popup like Chrome is displayed on right top corner. * Sometimes Chronos craches by clicking "oepn file" of the popup. * Context menus on right clicking are modified. * This is because menu item IDs are different between Alloy runtime mode and Chrome runtime mode. * We should modify Chronos in order to follow to the IDs of Chrome runtime mode. They are don't occur when we use Alloy runtime style. So we adopt Alloy runtime style.

EamonHetherton · 2024-06-24T22:13:24Z

I have found a blocking issue for me in removing the Alloy bootstrap: #3721

amaitland · 2024-07-01T19:58:53Z

@magreenblatt Now that the work has been done to remove alloy. Would it be possible to update the issue to explicitly say which version alloy will be removed in?

Thanks!

magreenblatt · 2024-07-02T13:42:12Z

Would it be possible to update the issue to explicitly say which version alloy will be removed in?

Sure. The changes have landed in current master, so the first impacted release branch will be M128.

amaitland · 2024-07-02T20:01:39Z

Thank you!

Remove code abstractions that are no longer required after deletion of the Alloy bootstrap. This is a functional no-op.

After Alloy bootstrap deletion the remaining functions are no longer related to extensions. This change is a functional no-op.

Use more specific file naming. This change is a functional no-op.

Remove code abstractions that are no longer required after deletion of the Alloy bootstrap. This is a functional no-op.

- Add CEF info to existing chrome://version WebUI. - Move chrome://license handling to WebUI. - Remove chrome://webui-hosts; use chrome://chrome-urls instead. - Remove chrome://extension-support; navigate to docs directly instead.

Use BUILDFLAG(ENABLE_CEF) exclusively in patch files.

magreenblatt · 2024-07-05T17:54:15Z

The Architecture Wiki page has been updated for Alloy bootstrap removal.

Enable Chrome bootstrap and update command-line flags. Views and Chrome style are now enabled by default. - Add `--use-alloy-style` to use Alloy style. - Add `--use-native` to use a native parent window. See chromiumembedded/cef#3685 for details on the Alloy bootstrap removal.

JCYang · 2024-08-08T02:53:44Z

locales_dir_path
Hi, in the post 'locales_dir_path' and 'resource_dir_path' are marked as 'DONE', but I've tested the 128.0.6613.18 preview build from https://cef-builds.spotifycdn.com/index.html#linux64 lately, it doesn't work, not yet contained in this build?

more accurately speaking, it is 'resource_dir_path' not working as expected.

magreenblatt added enhancement Enhancement request alloy Related to the Alloy runtime labels Apr 22, 2024

magreenblatt added task Task to be performed and removed enhancement Enhancement request labels Apr 22, 2024

Hethsron mentioned this issue Apr 26, 2024

Off-screen rendering with webview2 MicrosoftEdge/WebView2Feedback#547

Open

magreenblatt added a commit that referenced this issue May 3, 2024

chrome: Support CefSettings path config (see #3685)

2938135

magreenblatt added a commit that referenced this issue May 3, 2024

chrome: Support CefResourceBundleHandler (see #3685)

ca636bb

magreenblatt added a commit that referenced this issue May 3, 2024

Add Alloy bootstrap deprecation warnings (see #3685)

9f45038

Alloy bootstrap is deprecated and will be removed in ~M127.

magreenblatt mentioned this issue May 3, 2024

chrome: Add support for programmatic extension management #3450

Open

magreenblatt added a commit that referenced this issue May 3, 2024

tests: Remove extension tests (see #3685)

17a1fd6

The Alloy extension API is deprecated and these tests have not been supported for some time.

magreenblatt changed the title ~~alloy: Delete Alloy bootstrap~~ alloy: Delete Alloy bootstrap (~M127) May 3, 2024

GrabzIt mentioned this issue Jun 11, 2024

Alloy bootstrap error shown even if debug logs are disabled cefsharp/CefSharp#4833

Closed

1 task

HashidaTKS mentioned this issue Jun 12, 2024

Support chrome bootstrap alloy style ThinBridge/Chronos#196

Merged

9 tasks

amaitland mentioned this issue Jun 13, 2024

Change to using Chrome bootstrap by default cefsharp/CefSharp#4835

Closed

magreenblatt mentioned this issue Jun 25, 2024

Windows: Spell checker not working, add support for WinUseBrowserSpellChecker #3055

Closed

HashidaTKS mentioned this issue Jun 28, 2024

[CEF125+] DevTools doesn't pop up. ThinBridge/Chronos#203

Closed

magreenblatt mentioned this issue Jul 1, 2024

Crash in devtools when clicking the network throttling menu #3724

Closed

magreenblatt closed this as completed in a461a89 Jul 1, 2024

magreenblatt changed the title ~~alloy: Delete Alloy bootstrap (~M127)~~ alloy: Delete Alloy bootstrap (M128) Jul 2, 2024

magreenblatt added a commit that referenced this issue Jul 5, 2024

Remove main runner abstractions (see #3685)

c0a3c89

Remove code abstractions that are no longer required after deletion of the Alloy bootstrap. This is a functional no-op.

magreenblatt added a commit that referenced this issue Jul 5, 2024

Rename browser_extensions_util to browser_guest_util (seee #3685)

bd57a40

After Alloy bootstrap deletion the remaining functions are no longer related to extensions. This change is a functional no-op.

magreenblatt added a commit that referenced this issue Jul 5, 2024

Rename browser_util to browser_event_util (seee #3685)

cd3f617

Use more specific file naming. This change is a functional no-op.

magreenblatt added a commit that referenced this issue Jul 5, 2024

Remove devtools window runner abstraction (see #3685)

1cdf028

Remove code abstractions that are no longer required after deletion of the Alloy bootstrap. This is a functional no-op.

magreenblatt added a commit that referenced this issue Jul 5, 2024

Remove empty runtime_checks.h (see #3685)

b080705

magreenblatt added a commit that referenced this issue Jul 5, 2024

Remove libcef/features/runtime.h (see #3685)

60ce575

Use BUILDFLAG(ENABLE_CEF) exclusively in patch files.

This was referenced Jul 8, 2024

Visited Links file is locked after cef_shutdown. #3406

Closed

CEF force-creates a Downloads directory in user directory #3094

Closed

HashidaTKS mentioned this issue Jul 9, 2024

[CEF125+] Fix DevTools to popup ThinBridge/Chronos#221

Merged

magreenblatt mentioned this issue Aug 7, 2024

GPU process crashes inside of gl::CreateWindowsOnThread #3765

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

alloy: Delete Alloy bootstrap (M128) #3685

alloy: Delete Alloy bootstrap (M128) #3685

magreenblatt commented Apr 22, 2024 •

edited

Loading

magreenblatt commented Apr 22, 2024

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 3, 2024 •

edited

Loading

magreenblatt commented May 3, 2024

EamonHetherton commented Jun 24, 2024 •

edited

Loading

amaitland commented Jul 1, 2024

magreenblatt commented Jul 2, 2024

amaitland commented Jul 2, 2024

magreenblatt commented Jul 5, 2024

JCYang commented Aug 8, 2024 •

edited

Loading

alloy: Delete Alloy bootstrap (M128) #3685

alloy: Delete Alloy bootstrap (M128) #3685

Comments

magreenblatt commented Apr 22, 2024 • edited Loading

magreenblatt commented Apr 22, 2024

magreenblatt commented May 2, 2024 • edited Loading

magreenblatt commented May 2, 2024 • edited Loading

magreenblatt commented May 2, 2024 • edited Loading

magreenblatt commented May 2, 2024 • edited Loading

magreenblatt commented May 3, 2024 • edited Loading

magreenblatt commented May 3, 2024

EamonHetherton commented Jun 24, 2024 • edited Loading

amaitland commented Jul 1, 2024

magreenblatt commented Jul 2, 2024

amaitland commented Jul 2, 2024

magreenblatt commented Jul 5, 2024

JCYang commented Aug 8, 2024 • edited Loading

magreenblatt commented Apr 22, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 2, 2024 •

edited

Loading

magreenblatt commented May 3, 2024 •

edited

Loading

EamonHetherton commented Jun 24, 2024 •

edited

Loading

JCYang commented Aug 8, 2024 •

edited

Loading