AppSuite:Debugging the UI

Debugging the UI

Synopsis: A collection of hints to debug during UI development

What capabilities are available?

_(ox.serverConfig.capabilities).pluck("id").sort();

Which files failed to load?

requirejs.s.contexts._.registry

Check settings

 
// check core settings
require('settings!io.ox/core').get();
// check mail settings
require('settings!io.ox/mail').get();

Clear all persistent caches

Please mind that this does not clear the regular browser cache! It clears localStorage, IndexedDB, and WebSQL.

 
ox.cache.clear();

Debug relogin

 
ox.autoLogoutRestartDebug();

Enable/disable capability via URL hash

Just add the parameter "cap" to URL hash. A leading minus disables a capability. Multiple capabilities separated by comma. Example:

 
...&cap=emoji,-calendar

Disable source caching via URL hash

Add the parameter "debug-js=true" to URL hash. Example:

 
...&debug-js=true

Debug a specific folder

If you want to get details of a specific folder, just inspect it via dev tools and look for data-obj-id="...". Copy the id and run the following in console:

 
void require('io.ox/core/api/folder').get({ folder: 'default0/INBOX' }).always(_.inspect);

Does not load, fails with error: Could not read...

"Could not read 'io.ox/core/http.js'" 
"Could not read 'io.ox/core/events.js'" 

That's not all, the system is probably hiding even more errors. It is more probable that the whole UI cannot be found. Check the com.openexchange.apps.path, usually hidden in manifests.properties. Does it point to where your webserver serves the files from? The default is /var/www/appsuite, on OSX is is more likely to be /Libraries/WebServer/Documents/appsuite