spp_branding_kit: format utils and controllers after refactor

Author: jeremi

spp_branding_kit/__manifest__.py

@@ -48,7 +48,6 @@
         "web.assets_backend": [
             "spp_branding_kit/static/src/js/webclient.js",
             "spp_branding_kit/static/src/js/user_menu.js",
-            "spp_branding_kit/static/src/js/telemetry_manager.js",
         ],
         "web.assets_frontend": [
             "spp_branding_kit/static/src/css/login_branding.css",

spp_branding_kit/controllers/main.py

@@ -1,24 +1,23 @@
 import json
 
+from werkzeug.urls import url_encode
 from werkzeug.wrappers import Response
 
 from odoo import http
 from odoo.http import request
 
 from odoo.addons.portal.controllers.web import Home
 
+from ..utils import get_param, telemetry_payload, version_info_payload
+
 
 class OpenSPPHome(Home):
     """Restrict debug mode to administrators when enabled via parameter."""
 
     @http.route()
     def web_client(self, s_action=None, **kw):
         # Enforce optional debug restriction before rendering
-        try:
-            config_parameter = request.env["ir.config_parameter"].sudo()
-            debug_admin_only = config_parameter.get_param("openspp.debug.admin_only", "True") == "True"
-        except Exception:  # pragma: no cover - defensive
-            debug_admin_only = True
+        debug_admin_only = get_param(request.env, "openspp.debug.admin_only", "True") == "True"
 
         # Detect debug flag from kwargs or query string
         has_debug = bool(kw.get("debug")) or ("debug" in (request.httprequest.args or {}))
@@ -28,7 +27,8 @@ def web_client(self, s_action=None, **kw):
             if not uid or not request.env.user._is_admin():
                 kw.pop("debug", None)
                 args = {k: v for k, v in request.httprequest.args.items() if k != "debug"}
-                return request.redirect("/web", query=args)
+                query = url_encode(args)
+                return request.redirect("/web" + (f"?{query}" if query else ""))
 
         return super().web_client(s_action, **kw)
 
@@ -39,48 +39,23 @@ class OpenSPPBrandingController(http.Controller):
     @http.route("/openspp/about", type="http", auth="public")
     def openspp_about(self, **kwargs):
         """Custom about page for OpenSPP"""
-        config_parameter = request.env["ir.config_parameter"].sudo()
         return json.dumps(
             {
                 "title": "About OpenSPP",
                 "version": "1.0.0",
-                "system_name": config_parameter.get_param("openspp.system.name", "OpenSPP Platform"),
-                "documentation_url": config_parameter.get_param(
-                    "openspp.documentation.url", "https://docs.openspp.org"
-                ),
-                "support_url": config_parameter.get_param("openspp.support.url", "https://openspp.org"),
+                "system_name": get_param(request.env, "openspp.system.name", "OpenSPP Platform"),
+                "documentation_url": get_param(request.env, "openspp.documentation.url", "https://docs.openspp.org"),
+                "support_url": get_param(request.env, "openspp.support.url", "https://openspp.org"),
             }
         )
 
     @http.route("/web/webclient/version_info", type="json", auth="none")
     def version_info(self):
         """Override version info to show OpenSPP branding"""
-        config_parameter = request.env["ir.config_parameter"].sudo()
-        system_name = config_parameter.get_param("openspp.system.name", "OpenSPP Platform")
-        return {
-            "server_version": system_name,
-            # Keep the server series aligned with the actual Odoo major version
-            "server_serie": "17.0",
-            "protocol_version": 1,
-        }
+        return version_info_payload(request.env)
 
     @http.route("/publisher-warranty", type="http", auth="none", csrf=False)
     def publisher_warranty(self, **kwargs):
         """Handle telemetry based on configuration"""
-        config_parameter = request.env["ir.config_parameter"].sudo()
-        telemetry_enabled = config_parameter.get_param("openspp.telemetry.enabled", "True") == "True"
-
-        if not telemetry_enabled:
-            payload = {"status": "disabled", "message": "Telemetry disabled"}
-        else:
-            # Redirect to OpenSPP telemetry endpoint
-            telemetry_endpoint = config_parameter.get_param(
-                "openspp.telemetry.endpoint", "https://telemetry.openspp.org"
-            )
-            payload = {
-                "status": "redirected",
-                "endpoint": telemetry_endpoint,
-                "message": "Telemetry redirected to OpenSPP",
-            }
-
+        payload = telemetry_payload(request.env)
         return Response(json.dumps(payload), content_type="application/json")

spp_branding_kit/models/ir_http.py

@@ -2,6 +2,8 @@
 
 from odoo import models
 
+from ..utils import get_branding_config
+
 _logger = logging.getLogger(__name__)
 
 
@@ -12,23 +14,8 @@ def session_info(self):
         """Override session info to customize branding"""
         result = super().session_info()
 
-        IrConfig = self.env["ir.config_parameter"].sudo()
-
         # Add OpenSPP configuration
-        result.update(
-            {
-                "openspp_system_name": IrConfig.get_param("openspp.system.name", "OpenSPP Platform"),
-                "openspp_documentation_url": IrConfig.get_param(
-                    "openspp.documentation.url", "https://docs.openspp.org"
-                ),
-                "openspp_support_url": IrConfig.get_param("openspp.support.url", "https://openspp.org"),
-                "openspp_show_powered_by": IrConfig.get_param("openspp.show.powered_by", "True") == "True",
-                "openspp_telemetry_enabled": IrConfig.get_param("openspp.telemetry.enabled", "True") == "True",
-                "openspp_telemetry_endpoint": IrConfig.get_param(
-                    "openspp.telemetry.endpoint", "https://telemetry.openspp.org"
-                ),
-            }
-        )
+        result.update(get_branding_config(self.env))
 
         # Customize server version info while keeping the correct Odoo series
         if "server_version_info" in result:

spp_branding_kit/static/src/js/telemetry_manager.js

@@ -0,0 +1,26 @@
+def get_param(env, key, default=None):
+    return env["ir.config_parameter"].sudo().get_param(key, default)
+
+
+def get_branding_config(env):
+    return {
+        "openspp_system_name": get_param(env, "openspp.system.name", "OpenSPP Platform"),
+        "openspp_documentation_url": get_param(env, "openspp.documentation.url", "https://docs.openspp.org"),
+        "openspp_support_url": get_param(env, "openspp.support.url", "https://openspp.org"),
+        "openspp_show_powered_by": get_param(env, "openspp.show.powered_by", "True") == "True",
+        "openspp_telemetry_enabled": get_param(env, "openspp.telemetry.enabled", "True") == "True",
+        "openspp_telemetry_endpoint": get_param(env, "openspp.telemetry.endpoint", "https://telemetry.openspp.org"),
+    }
+
+
+def version_info_payload(env):
+    system_name = get_param(env, "openspp.system.name", "OpenSPP Platform")
+    return {"server_version": system_name, "server_serie": "17.0", "protocol_version": 1}
+
+
+def telemetry_payload(env):
+    enabled = get_param(env, "openspp.telemetry.enabled", "True") == "True"
+    if not enabled:
+        return {"status": "disabled", "message": "Telemetry disabled"}
+    endpoint = get_param(env, "openspp.telemetry.endpoint", "https://telemetry.openspp.org")
+    return {"status": "redirected", "endpoint": endpoint, "message": "Telemetry redirected to OpenSPP"}