[CLOSED] [Linux only] Upgrading to CEF 2704

[core-ai-bot]

Issue by nethip
Tuesday Aug 01, 2017 at 06:12 GMT
Originally opened as adobe#619

---

CEF verison upgrade on Linux to 2704.

Note: CEF version on Windows and Mac will still remain to be 2623. At a later time we will upgrade CEF on all platforms to one version.

The main reason why we could not update CEF on linux to 2171/2623 was because of app quit blockage. Upon App quit, the process was completely blocked as the app was waiting for one of the threads to join. After lot of debugging and analysis, I found out that this was because of Linux sandboxing, gtk_init() needs to be called after CefInitialize().

The other major change is the removal of libcrypto dependency, users now don't have to install this package for Brackets to run on Linux.

Here are other noteworthy changes.

1. From now on cefclient_gtk.cc will be the entry point for the app on Linux
2. I have modelled the enitre app to that of CefClient test app.
3. We are going to be using client::ClientHandler instead of appshell/ClientHandler. The difference is that the former will now derive from appshell/ClientHandler.
4. The App quit is now wired to RootWindowGtk close. client::RootWindowGtk is part of CefClient. All issues relating to app quit/ closing individual windows are now fixed.(Yay!!!).
5. Improved multiple windows workflow. g_handler is not going to be used anymore as a new client handler is created for every window creation by RootWindow itself. This improves our multiple windows workflow. Also Debug->New Window, will now have it's own menu bar (finally!). So each of the windows now have their own life time.
6. Menus creation and handling is now mapped to RootWindowGtk. RootWindowGtk will further deliver specific command to the respective browser.
7. appshell_extensions_gtk.cpp had an outdated version on master as it was always updated in the linux-1547 branch alone. So migrated all changes, relating to appshell_extensions_gtk.cpp present in linux-1547 branch to master.
8. All the changes are pertaining only to Linux. Wherever required I have wrapped all the code with #ifdef OS_LINUX macro
9. On Linux we are going to call startNodeProcess() at the start itself. If the thread, that spawns the node process, is called after CefInitialize(), it blocks the app quit.
10. Wired in the new developer tools.
11. Have modified cef_paths.gypi inside the redistributable for Linux 32 bit, zipped and uploaded that to S3.
12. Made changes to control file to remove the libcrypto dependency

Note to the committers: Whoever is merging, feel free to squash all the commits and merge.

Tasks

• Install on Linux 14 and 16 LTS (both 32 and 64) systems and check if Brackets is running fine on these systems
• Verify if libcrypto dependency is gone
• Build this branch on all platforms and see Win and Mac are building fine.
• Run unit tests
• Sometimes, there is a performance bug with respect to startup, because of https://github.com/adobe/brackets/blob/master/src/filesystem/FileSystemEntry.js#L194. I could narrow down it down to recursion on startup. I will unit test more on different systems and take a call.

@ficristo, @ingorichter, @eyelash, @zaggino It would be great if you can review this PR.

---

nethip included the following code: https://github.com/adobe/brackets-shell/pull/619/commits

[core-ai-bot]

Comment by ficristo
Tuesday Aug 01, 2017 at 09:35 GMT

---

Just to verify if I understood correctly: are you going to update macOS and Windows with cef 2704 ?
But in a different PR ?
Also, since you dind't use the current cef version used for macOS / Windows (2623) why you didn't use a newer version instead?
I'm not pressing to update it, I only want to know why.

[core-ai-bot]

Comment by nethip
Tuesday Aug 01, 2017 at 10:41 GMT

---

@ficristo What I meant was that when we upgrade we will upgrade CEF on all the platforms to the latest version but for now only Brackets on Linux would be on 2704. Also I did not upgrade Win and Mac CEF versions to 2704 as I did not want Brackets to be effected on other platforms so kept the changes as minimal as possible and restricted only to Linux platform.

I tried updating to the latest CEF version, but was not successful building Linux atleast. The build mechanism has changed for building CefClient in the most recent versions of CEF(they moved away from gyp). So I guess we need to be update our build mechanism to that of the latest CefClient. We could do this later in a different PR.

[core-ai-bot]

Comment by swmitra
Tuesday Aug 01, 2017 at 13:50 GMT

---

💯 👍 🥇

[core-ai-bot]

Comment by nethip
Wednesday Aug 02, 2017 at 10:51 GMT

---

@ficristo Will you be able to review this PR and let me know if you have any comments?

[core-ai-bot]

Comment by ficristo
Wednesday Aug 02, 2017 at 18:54 GMT

---

Sorry, I cannot really review C++ code.
Next week I should be able to, at least, try this PR. I just need to undust my VM...

@pratts you seemed interested in the past in Linux development of Brackets. Do you want to give a try to this PR ?

[core-ai-bot]

Comment by ficristo
Saturday Aug 05, 2017 at 08:48 GMT

---

In my light testing I can confirm the crash on quit is fixed.
It is also nice to have the developer tools inside Brackets itself.
I didn't try to build the installer.

I don't know how much it is important but when you scroll an element (the editor area, the file tree or the extension manager) I see the following line printed in the terminal:
[0805/104322:ERROR:PlatformKeyboardEvent.cpp(117)] Not implemented reached in static PlatformEvent::Modifiers blink::PlatformKeyboardEvent::getCurrentModifierState()

[core-ai-bot]

Comment by pratts
Sunday Aug 06, 2017 at 08:26 GMT

---

Thank you for this update @nethip. I really appreciate the effort you put in 💯 🥇 !
I cloned the brackets source code and checked out master for brackets and nethip/linux-cef-2704-upgrade for brackets-shell.
Brackets's grunt build and grunt installer worked fine. It no longer asked for libgcrypt11 👍
Trying to install the .deb file gives the following output:

prateek:/home/prateek/brackets$ sudo dpkg -i Brackets\ Release\ 1.11\ 64-bit.deb 
[sudo] password for prateek: 
Selecting previously unselected package brackets.
(Reading database ... 359397 files and directories currently installed.)
Preparing to unpack Brackets Release 1.11 64-bit.deb ...
Unpacking brackets (1.11.0-17496) ...
Setting up brackets (1.11.0-17496) ...
**xdg-icon-resource: size argument must be numeric
Try 'xdg-icon-resource --help' for more information.**
Processing triggers for menu (2.1.47) ...
Processing triggers for hicolor-icon-theme (0.13-1) ...

Running brackets for the first time from terminal gives the following error:
brackets
[0806/133905:FATAL:setuid_sandbox_host.cc(162)] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now. You need to make sure that /opt/brackets/chrome-sandbox is owned by root and has mode 4755.
#0 0x7fb81b590c3e base::debug::StackTrace::StackTrace()
#1 0x7fb81b5a59fb logging::LogMessage::~LogMessage()
#2 0x7fb81e5a3ad6 sandbox::SetuidSandboxHost::PrependWrapper()
#3 0x7fb81e4ee917 content::ZygoteCommunication::Init()
#4 0x7fb81e4ef31e content::CreateZygote()
#5 0x7fb81e218303 content::BrowserMainLoop::EarlyInitialization()
#6 0x7fb81e21ed79 content::BrowserMainRunnerImpl::Initialize()
#7 0x7fb81b502d19 CefMainDelegate::RunProcess()
#8 0x7fb81e6708e2 content::RunNamedProcessTypeMain()
#9 0x7fb81e671257 content::ContentMainRunnerImpl::Run()
#10 0x7fb81b496e6e CefContext::Initialize()
#11 0x7fb81b496c4b CefInitialize()
#12 0x7fb81b43acf6 cef_initialize
#13 0x0000005e1e38 CefInitialize()
#14 0x000000590c87 client::MainContextImpl::Initialize()
#15 0x000000570e7c client::(anonymous namespace)::RunMain()
#16 0x000000571571 main
#17 0x7fb817037b45 __libc_start_main
#18 0x00000055c779

Aborted

I changed the file permission using chmod 4755 /opt/brackets/chrome-sandbox

One more problem, I cannot see the menu bar :File,Edit,View, etc. Is it intentional ?

[core-ai-bot]

Comment by pratts
Sunday Aug 06, 2017 at 09:48 GMT

---

I can close the window using Ctrl+Q. It gives an error and window closes but I see an exception on console and brackets process does not terminate.

brackets
[0806/151520:ERROR:nss_util.cc(842)] After loading Root Certs, loaded==false: NSS error code: -8018
prateek@prateek-debian:~/work/open-source$ /opt/brackets/node-core/ConnectionManager.js:76
            console.error("[Connection] Unable to stringify message: " + e.message);
            ^

RangeError: Maximum call stack size exceeded
    at Connection._send (/opt/brackets/node-core/ConnectionManager.js:76:13)
    at Connection.sendEventMessage (/opt/brackets/node-core/ConnectionManager.js:203:14)
    at /opt/brackets/node-core/ConnectionManager.js:242:11
    at Array.forEach (native)
    at Object.sendEventToAllConnections (/opt/brackets/node-core/ConnectionManager.js:241:18)
    at Object.emitEvent (/opt/brackets/node-core/DomainManager.js:225:27)
    at EventEmitter.<anonymous> (/opt/brackets/node-core/BaseDomain.js:123:28)
    at emitThree (events.js:116:13)
    at EventEmitter.emit (events.js:194:7)
    at logReplacement (/opt/brackets/node-core/Logger.js:80:12)

[core-ai-bot]

Comment by nethip
Monday Aug 07, 2017 at 05:08 GMT

---

Thanks @ficristo @pratts for trying this branch out and testing! Appreciate your efforts 👍

@ficristo I will dig deeper into it and see which module is reporting this error.

@pratts Thanks for your efforts. I will look into the issues you have mentioned above. I have done all the development on Ubuntu and there I have not seen this error. I will try to introduce the chmod through a grunt job. About the other console errors, I think the following is reported by Node side of things. I ran once into this error, but could not repro it again. I will try to repro this again and see.

RangeError: Maximum call stack size exceeded
    at Connection._send (/opt/brackets/node-core/ConnectionManager.js:76:13)
    at Connection.sendEventMessage (/opt/brackets/node-core/ConnectionManager.js:203:14)
    at /opt/brackets/node-core/ConnectionManager.js:242:11
    at Array.forEach (native)
    at Object.sendEventToAllConnections (/opt/brackets/node-core/ConnectionManager.js:241:18)
    at Object.emitEvent (/opt/brackets/node-core/DomainManager.js:225:27)
    at EventEmitter.<anonymous> (/opt/brackets/node-core/BaseDomain.js:123:28)
    at emitThree (events.js:116:13)
    at EventEmitter.emit (events.js:194:7)
    at logReplacement (/opt/brackets/node-core/Logger.js:80:12)

And about the Menus not being shown, are they currently shown if you build brackets-shell from linux-1547? Is this happening with this branch alone?

[core-ai-bot]

Comment by pratts
Monday Aug 07, 2017 at 13:37 GMT

---

Hi @nethip
I can see the menu bar in build made from linux-1547 branch

I had to install libgcrypt11 library and saw the following error in terminal:

[0807/190453:ERROR:connection.cc(799)] sqlite error 11, errno 0: malformed database schema (is_transient) - near "where": syntax error
[0807/190453:ERROR:connection.cc(799)] sqlite error 11, errno 0: malformed database schema (is_transient) - near "where": syntax error
ATTENTION: default value of option force_s3tc_enable overridden by environment.
[0807/190514:ERROR:browser_main_loop.cc(212)] GLib-GObject: invalid cast from 'GtkExpandedContainer' to 'GtkWindow'
[0807/190514:ERROR:browser_main_loop.cc(212)] Gtk: IA__gtk_window_present_with_time: assertion 'GTK_IS_WINDOW (window)' failed

[core-ai-bot]

Comment by ingorichter
Tuesday Aug 08, 2017 at 00:48 GMT

---

@nethip did you ask to test on Ubuntu? Which version of Ubuntu? 16/04, 16/10, 17/04? Older versions or other Linux distros?

[core-ai-bot]

Comment by nethip
Tuesday Aug 08, 2017 at 03:46 GMT

---

@ingorichter I had done a round of testing on both Ubuntu 14 and 16. But testing on other distros would be very helpful.

[core-ai-bot]

Comment by nethip
Tuesday Aug 08, 2017 at 03:47 GMT

---

@pratts That is a bummer. I don't have the debian VM. I will set one up. Meanwhile, will you be able to debug the app. I will point you to the sources where menus are getting created, to see which specific call is failing?

[core-ai-bot]

Comment by pratts
Tuesday Aug 08, 2017 at 04:10 GMT

---

@nethip I use debian 8.
I would love to try this. ❤️

[core-ai-bot]

Comment by nethip
Tuesday Aug 08, 2017 at 05:05 GMT

---

Awesome @pratts . Thanks for the help. Here is a brief of what I generally do.

1. Enable debug symbols creation in appshell.gyp. Add -g to CFLAGS. Add it here
2. All menu handling is now taken care of by appshell/browser/root_window_gtk.cc (root_window_gtk.cc:528 for creation & root_window_gtk.cc:56 for menu activation handling)
3. We get the vbox while dealing with menus over here appshell_extensions_platform.cpp:145
4. Menus are created here. appshell_extensions_gtk.cpp:1042

I am suspecting step 3 is failing. But do let me know, if anything else is breaking.