[14.0][ADD] web_assets_warmup

setup/web_assets_warmup/odoo/addons/web_assets_warmup

@@ -0,0 +1 @@
+../../../../web_assets_warmup

setup/web_assets_warmup/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+ setup_requires=['setuptools-odoo'],
+ odoo_addon=True,
+)

web_assets_warmup/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from .hooks import post_load_hook

web_assets_warmup/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2020 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+{
+ "name": "Generate assets when Odoo starts",
+ "summary": "Ensure that assets are generated when Odoo starts.",
+ "version": "14.0.1.0.0",
+ "category": "Hidden",
+ "author": "Camptocamp, Odoo Community Association (OCA)",
+ "license": "AGPL-3",
+ "depends": [
+ "web",
+ ],
+ "website": "https://github.com/OCA/web",
+ "data": ["data/ir_cron.xml"],
+ "post_load": "post_load_hook",
+ "installable": True,
+}

web_assets_warmup/data/ir_cron.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!-- Copyright 2020 Camptocamp SA
+ License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo noupdate="1">
+
+ <record model="ir.cron" id="cron_generate_assets">
+ <field name='name'>Generate report assets</field>
+ <field name='interval_number'>1</field>
+ <field name='interval_type'>months</field>
+ <field name="numbercall">-1</field>
+ <field name="active" eval="True" />
+ <field name="doall" eval="False" />
+ <field
+ name="nextcall"
+ eval="(datetime.now() + timedelta(minutes=1)).strftime('%Y-%m-%d %H:%M:00')"
+ />
+ <field name="model_id" ref="base.model_ir_actions_report" />
+ <field name="state">code</field>
+ <field name="code">model.cron_generate_assets()</field>
+ </record>
+
+</odoo>

web_assets_warmup/hooks.py

@@ -0,0 +1,70 @@
+# Copyright 2020 Camptocamp SA
+# Copyright 2023 Michael Tietz (MT Software) <mtietz@mt-software.de>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+import logging
+import os
+
+import psycopg2
+
+from odoo import fields, registry
+
+logger = logging.getLogger(__name__)
+
+
+def active_cron_assets():
+ """Plan the next execution of the cron responsible to generate assets."""
+ if os.environ.get("RUNNING_ENV") == "dev":
+ return
+ dbname = os.environ.get("DB_NAME")
+ reg = registry(dbname)
+ with reg.cursor() as cr:
+ cron_module, cron_ref = "web_assets_warmup", "cron_generate_assets"
+ query = """
+ SELECT model, res_id
+ FROM ir_model_data
+ WHERE module=%s
+ AND name=%s;
+ """
+ args = (cron_module, cron_ref)
+ cr.execute(query, args)
+ row = cr.fetchone()
+ # post_load hook is called before the update of the module so the
+ # ir_cron record doesn't exist on first install
+ if row:
+ model, res_id = row
+ if model != "ir.cron":
+ return
+ # if there is already someone doing the same or already being executed
+ # we can skip the update of ir_cron
+ try:
+ with cr.savepoint():
+ cr.execute(
+ "SELECT * FROM ir_cron WHERE id = %s FOR UPDATE NOWAIT;",
+ (res_id,),
+ )
+ query = """
+ UPDATE ir_cron
+ SET active=true, nextcall=%s, priority=%s
+ WHERE id=%s
+ """
+ nextcall = fields.Datetime.to_string(fields.Datetime.now())
+ args = (nextcall, -99, res_id)
+ cr.execute(query, args)
+ logger.info(
+ "Cron '%s.%s' planned for execution at %s",
+ cron_module,
+ cron_ref,
+ nextcall,
+ )
+ except psycopg2.OperationalError as e:
+ if e.pgcode == "55P03":
+ logger.info(
+ "Cron '%s.%s' is currently being executed or updated",
+ cron_module,
+ cron_ref,
+ )
+
+
+def post_load_hook():
+ active_cron_assets()

web_assets_warmup/models/__init__.py

@@ -0,0 +1 @@
+from . import ir_actions_report

web_assets_warmup/models/ir_actions_report.py

@@ -0,0 +1,37 @@
+# Copyright 2020 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+import logging
+
+from odoo import api, models
+
+logger = logging.getLogger(__name__)
+
+
+class IrActionsReport(models.Model):
+ _inherit = "ir.actions.report"
+
+ @api.model
+ def cron_generate_assets(self):
+ """Ensure that the assets are well-generated in the database."""
+ logger.info("Ensure that assets are generated and stored in the database...")
+ # Call `_get_asset_nodes` as done when printing a report based on
+ # `web.report_layout` template (used by `web.html_container`)
+ options = {
+ "commit_assetsbundle": False,
+ "debug": False,
+ "inherit_branding": False,
+ "dev_mode": False,
+ "caller_template": "web.html_container",
+ }
+ assets_template_ids = [
+ "web.report_assets_common",
+ "web.assets_common",
+ "web.report_assets_pdf",
+ ]
+ for xml_id in assets_template_ids:
+ self.env["ir.qweb"]._get_asset_nodes(
+ xmlid=xml_id, options=options, css=True, js=True
+ )
+ logger.info("Ensure that assets are generated and stored in the database: done")
+ return True

web_assets_warmup/readme/CONTRIBUTORS.rst

@@ -0,0 +1,2 @@
+* Sébastien Alix <sebastien.alix@camptocamp.com>
+* Michael Tietz (MT Software) <mtietz@mt-software.de>

web_assets_warmup/readme/DESCRIPTION.rst

@@ -0,0 +1,9 @@
+Ensure that assets are generated and stored in the DB when Odoo starts
+
+If the assets from the database are not up-to-date, they are regenerated by
+Odoo when we print a report, but to do so Odoo forces the commit, so if an
+exception occurs after (or during) the report rendering, it let the database in
+a broken state (picking have been validated in this case).
+
+To prevent this issue, we need to ensure that the assets are well-generated
+when Odoo starts, not when the report is printed.