[IMP] web, base: add option to profile dispatch

The profiling tools can be useful to profile a test of some execution
point but this is not convenient to identify a problem on a running
instance.

With this commit, an option available in the debug menu allows to add a
flag on the user sessions to enable profiling of all requests. Each
request will be saved in a different 'ir.profile' entry, but will be
grouped under the same session.

The profiling can be activated on all sessions, even for a public user,
but only if profiling is enabled on the database globally.

This commits also adds a speedscope view to visualize saved results in
the web client.

closes odoo#66590

Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>

Author: Xavier-Do

addons/base_setup/models/res_config_settings.py

@@ -49,6 +49,7 @@ class ResConfigSettings(models.TransientModel):
     language_count = fields.Integer('Number of Languages', compute="_compute_language_count")
     company_name = fields.Char(related="company_id.display_name", string="Company Name")
     company_informations = fields.Text(compute="_compute_company_informations")
+    profiling_enabled_until = fields.Datetime("Profiling enabled until", config_parameter='base.profiling_enabled_until')
 
     def open_company(self):
         return {

addons/base_setup/views/res_config_settings_views.xml

@@ -366,6 +366,18 @@
                                 </div>
                             </div>
                         </div>
+
+                        <h2 groups="base.group_no_one">Performance</h2>
+                        <div groups="base.group_no_one" class="row mt16 o_settings_container" name="performance">
+                            <div class="col-12 col-lg-6 o_setting_box" id="profiling_enabled_until">
+                            <label for="profiling_enabled_until"/>
+                            <field name="profiling_enabled_until"/>
+                            <div class="text-muted">
+                                Enable the profiling tool. Profiling may impact performance while being active.
+                            </div>
+                            </div>
+                        </div>
+
                         <widget name='res_config_dev_tool'/>
                         <div id='about'>
                             <h2>About</h2>

addons/portal/views/portal_templates.xml

@@ -151,7 +151,7 @@
     <template id="user_sign_in" name="User Sign In" inherit_id="portal.placeholder_user_sign_in">
         <xpath expr="." position="inside">
             <li groups="base.group_public" t-attf-class="#{_item_class} o_no_autohide_item">
-                <a t-attf-href="/web/login" t-attf-class="#{_link_class}">Sign in</a>
+                <a t-attf-href="/web/login" t-attf-class="#{_link_class}">Sign in<span t-if="request.session.profile_session" class="text-danger fa fa-circle"/></a>
             </li>
         </xpath>
     </template>

addons/web/__manifest__.py

@@ -18,6 +18,7 @@
         'views/webclient_templates.xml',
         'views/report_templates.xml',
         'views/base_document_layout_views.xml',
+        'views/speedscope_template.xml',
         'data/report_layout.xml',
     ],
     'assets': {
@@ -61,6 +62,7 @@
         'web.assets_common': [
             ('include', 'web._assets_helpers'),
 
+            'web/static/src/scss/debug_profiling.scss',
             'web/static/lib/bootstrap/scss/_variables.scss',
 
             ('include', 'web._assets_common_styles'),

addons/web/controllers/__init__.py

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
 # Part of Odoo. See LICENSE file for full copyright and licensing details.
 
-from . import main, pivot
+from . import main
+from . import pivot
+from . import profiling

addons/web/controllers/profiling.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+import json
+
+from odoo.exceptions import UserError
+from odoo.http import Controller, request, Response, route
+
+class Profiling(Controller):
+
+    @route('/web/set_profiling', type='http', auth='public', sitemap=False)
+    def profile(self, profile=None, collectors=None, **params):
+        if collectors is not None:
+            collectors = collectors.split(',')
+        else:
+            collectors = ['sql', 'traces_async']
+        profile = profile and profile != '0'
+        try:
+            state = request.env['ir.profile'].set_profiling(profile, collectors=collectors, params=params)
+            return json.dumps(state)
+        except UserError as e:
+            return Response(response='error: %s' % e, status=500)
+
+    @route(['/web/speedscope/', '/web/speedscope/<model("ir.profile"):profile>'], type='http', sitemap=False, auth='user')
+    def speedscope(self, profile=None):
+        # don't server speedscope index if profiling is not enabled
+        if not request.env['ir.profile']._enabled_until():
+            return request.not_found()
+        icp = request.env['ir.config_parameter']
+        context = {
+            'profile': profile,
+            'url_root': request.httprequest.url_root,
+            'cdn': icp.get_param('speedscope_cdn', "https://cdn.jsdelivr.net/npm/speedscope@1.13.0/dist/release/")
+        }
+        return request.render('web.view_speedscope_index', context)

addons/web/models/ir_http.py

@@ -42,6 +42,9 @@ def session_info(self):
             "partner_id": user.partner_id.id if request.session.uid and user.partner_id else None,
             "web.base.url": IrConfigSudo.get_param('web.base.url', default=''),
             "active_ids_limit": int(IrConfigSudo.get_param('web.active_ids_limit', default='20000')),
+            'profile_session': request.session.profile_session,
+            'profile_collectors': request.session.profile_collectors,
+            'profile_params': request.session.profile_params,
         }
         if self.env.user.has_group('base.group_user'):
             # the following is only useful in the context of a webclient bootstrapping
@@ -86,6 +89,9 @@ def get_frontend_session_info(self):
             'is_website_user': request.session.uid and self.env.user._is_public() or False,
             'user_id': request.session.uid and self.env.user.id or False,
             'is_frontend': True,
+            'profile_session': request.session.profile_session,
+            'profile_collectors': request.session.profile_collectors,
+            'profile_params': request.session.profile_params,
         }
         if request.session.uid:
             version_info = odoo.service.common.exp_version()

addons/web/static/src/js/tools/debug_manager.js

@@ -16,13 +16,21 @@ var DebugManager = Widget.extend({
     xmlDependencies: ['/web/static/src/xml/debug.xml'],
     events: {
         "click a[data-action]": "perform_callback",
+        "click .profiling": "handle_profiling",
+        "change .profiling_param": "handle_profiling",
     },
     init: function () {
         this._super.apply(this, arguments);
         this._events = null;
         var debug = odoo.debug;
         this.debug_mode = debug;
         this.debug_mode_help = debug && debug !== '1' ? ' (' + debug + ')' : '';
+        this.profile_session = odoo.session_info && odoo.session_info.profile_session || false;
+        this.profile_collectors = odoo.session_info && odoo.session_info.profile_collectors;
+        if (! Array.isArray(this.profile_collectors)) {
+            this.profile_collectors = ['sql', 'traces_async'];  // use default value when not defined in session.
+        }
+        this.profile_params = odoo.session_info && odoo.session_info.profile_params || {};
     },
     start: function () {
         core.bus.on('rpc:result', this, function (req, resp) {
@@ -53,7 +61,62 @@ var DebugManager = Widget.extend({
             console.warn("No handler for ", callback);
         }
     },
+    /**
+     * Manage profiling actions.
+     * open_profiling_button should not prevent dropdown from closing
+     * other actions should keep dropdown open and interact with backend to enable or disable profiling features.
+     * The main switch, 'enable_profiling' is a special case since it will create or remove a profile session
+     */
+    handle_profiling: async function (evt) {
+        const $target = $(evt.target);
+        const target = $target[0];
+        if (target.id === 'open_profiling_button') {
+            this.do_action('base.action_menu_ir_profile');
+            return;
+        }
+        evt.stopPropagation(); // prevent dropdown from closing
+        const kwargs = {
+            params: {}
+        };
+        if (target.nodeName == "LABEL") {
+            return
+        }
+        kwargs.profile = $('#enable_profiling')[0].checked;
+        kwargs.collectors = $('input.profile_switch').toArray().filter(i => i.checked).map(i => i.id.replace(/^profile_/, ''));
+        $('.profile_param').toArray().forEach(i => kwargs.params[i.id.replace(/^profile_/, '')] = i.value);
 
+        try {
+            const resp = await this._rpc({
+                model: 'ir.profile',
+                method: 'set_profiling',
+                kwargs: kwargs,
+            });
+            this.profile_session = resp.session;
+            this.profile_collectors = resp.collectors;
+            this.profile_params = resp.params;
+        } catch (e) {
+            this.profite_session = false;
+        }
+        this.update_profiling_state();
+    },
+    /**
+     * Update the profiling dropdown menu state after any change to synchronyze server session and client
+     * This is mainly usefull to avoid desync in case of multiple tabs
+     */
+    update_profiling_state: function () {
+        const self = this;
+        this.$('#enable_profiling')[0].checked = Boolean(this.profile_session);
+        this.$('.profile_switch').each(function () {
+            this.checked = (self.profile_collectors.indexOf(this.id.replace(/^profile_/, '')) !== -1);
+            const params = self.$('.' + this.id);
+            params.toggleClass('d-none', !this.checked);
+            params.each(function () {
+                const params_input = $(this).find('.profile_param')[0];
+                params_input.value = self.profile_params[params_input.id.replace(/^profile_/, '')] || '';
+            });
+        });
+        this.$profiling_items.toggleClass('d-none', !this.profile_session);
+    },
     _debug_events: function (events) {
         if (!this._events) {
             return;
@@ -73,6 +136,9 @@ var DebugManager = Widget.extend({
             .append(QWeb.render('WebClient.DebugManager.Global', {
                 manager: this,
             }));
+        this.$profiling_items = this.$(".profiling_items");
+
+        this.update_profiling_state();
         return Promise.resolve();
     },
     split_assets: function () {

addons/web/static/src/scss/debug_manager.scss

@@ -5,4 +5,5 @@
         margin: 2px 10px 2px 0;
         float: left;
     }
+
 }

addons/web/static/src/scss/debug_profiling.scss

@@ -0,0 +1,14 @@
+
+.o_debug_mode .fa { /* Active profiling red dot should be overed on the bottom right corner of the bug icon*/
+    position: relative;
+    .fa {
+        position: absolute;
+        bottom: -0.1em;
+        right: -0.4em;
+        font-size: 0.8em;
+    }
+}
+
+.open_profiling { /* Fix dropdown-item padding missing because of float: right*/
+    padding: 3px;
+}