[Web] Plugins not loaded on frontend

[mcserep]

How to reproduce: run the latest version of CodeCompass (Ericsson/master) on Ubuntu 20.04.
(The bug is not present on Ubuntu 18.04.)

Malfunctions:

• search toolbar is not shown on top;
• user guide tab is not shown on main area;
• right click functions basically do not work at all (menus are not shown).

There are no error messages on the JavaScript error log (in the browser), no failed HTTP request and no error on the server log (even with debug level logging).

The bug can be tested here:
http://codecompass.net:8020/

Screenshots:

[mcserep]

The bug is not present with this version of CodeCompass:
Docker runtime image (#409) 0f3ab69

[whisperity]

Findings so far: it seems none of the plugin-specific JSes are compiled into the bundle.js target. When trying the bundle.js.uncompressed.js from a live server you linked, grepping any real CodeCompass specific thing, such as reparse or Blame or Get AST HTML or Text search (some string literals from the program), there are 0 findings in the output.

By the looks of it, the builder packages the CodeCompass UI core (explains why InfoTree, File manager, the code viewer and such still work, as they're part of the core...), but don't copy in the plugins, and as such, they cannot get loaded by the browser.

[whisperity]

I have created a brand new build on Ubuntu 18.04 and I got the bug... It is present in both Release and Debug builds.

[whisperity]

When I do make install and the build script gets to the part where /home/w/Work/CodeCompass/Install-C10/share/codecompass/webgui/scripts/codecompass.profile.js is processed, the file's contents are as follows:

        'codecompass/bundle': {
            include: [
                'codecompass/codecompass',
                'codecompass/view/codeBites', 'codecompass/view/diagram', 'codecompass/view/fileManager', 'codecompass/view/header', 'codecompass/view/infoPage', 'codecompass/view/infoTree', 'codecompass/view/infobox', 'codecompass/view/text' // CMake will insert the list of files
            ]
        },

I think the issue is that the file that is being processed by the script resides in the install (and not the build) directory, and perhaps the Dojo builder happens earlier than the copying of the plugin-specific JSes to the install directory.

CMake's file(GLOB is notoriously "broken" as it only executes the expression when the configuration changes (i.e. when cmake itself is invoked).
Instead of the current approach, I think the more working one is that instead of using GLOB expressions, plugin CMakeLists should explicitly register the list of JS files they are delivering. (Similarly to how add_library requires listing the .cpp files.)

(Doing that would also solve part of the issue I've detailed in #273 about GLOB expressions.)

@bruntib Can you take a gander at this, perhaps the fix is easy, or should we roll back #402 until @mcserep can get around reworking it?

Currently, I have found one workaround, which involves forcing CMake to regenerate the embedded list:

make install
rm <install_directory>/share/codecompass/webgui/scripts/codecompass.profile.js
make install

This will make on the second install the profile to have the plugin-specific files present. In addition, this is confirmed by the warnings of the optimiser:

[...]
warn(205) Module not tagged as pure AMD yet it contains AMD API applications. module: codecompass/view/cppMenu
warn(205) Module not tagged as pure AMD yet it contains AMD API applications. module: codecompass/view/cppReparseFileAST

At the first build, such warnings about plugin-delivered JS files are not present when using a clean build.

[mcserep]

@whisperity Thanks for your work on this issue.
Even if the plugin specific JS files are not properly bundled, they should still be loaded (with more HTTP requests though, like it was before #402):

CodeCompass/webgui/index.html

Lines 107 to 108 in c1e89d9

	var webModules = model.plugin.getWebPlugins();
	require(webModules, function() { // load any module not in bundle

Of course this seemingly does not work, I will examine it later.

[mcserep]

@whisperity You have deduced correctly the source of the issue (missing plugin JS files from the bundle), however the reason seems to be quite trivial for this after a quick check:

# Modules
add_subdirectory(logger)
add_subdirectory(model)
add_subdirectory(parser)
add_subdirectory(scripts)
add_subdirectory(service)
add_subdirectory(util)
add_subdirectory(webgui)
add_subdirectory(webserver)
# Plugins
add_subdirectory(plugins)

So plugins is after the webgui. Is there any reason not to switch their order?

[mcserep]

Even if the plugin specific JS files are not properly bundled, they should still be loaded (with more HTTP requests though, like it was before #402):

CodeCompass/webgui/index.html

Lines 107 to 108 in c1e89d9

	var webModules = model.plugin.getWebPlugins();
	require(webModules, function() { // load any module not in bundle

Of course this seemingly does not work, I will examine it later.

This does not work because of the same reason, since add_subdirectory(webgui) precedes add_subdirectory(plugins), the JS file are copied to the release folder by the Dojo Build System, before the plugin specific JS files are copied to the installation directory at all.