[18.0][ADD] queue_job_alert_running

queue_job_alert_running/README.rst

@@ -0,0 +1,123 @@
+=======================
+Job Queue Alert Running
+=======================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:b6e605728ea05be0bf98dbe6e94c197bab21882e965286ef214f719e252b444e
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
+    :target: https://github.com/OCA/queue/tree/18.0/queue_job_alert_running
+    :alt: OCA/queue
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/queue-18-0/queue-18-0-queue_job_alert_running
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This addon provides a mixin (``queue.job.status.mixin``) that adds an
+``is_job_running`` boolean field and automatically displays a warning
+banner on form views when a record has a running queue job, helping
+prevent concurrent editing of the same record.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+To use this module:
+
+1. Inherit ``queue.job.status.mixin`` in your model:
+
+.. code:: python
+
+   class MyModel(models.Model):
+       _name = "my.model"
+       _inherit = ["queue.job.status.mixin"]
+
+2. Call ``action_mark_running()`` when a queue job starts (e.g., before
+   ``with_delay()``):
+
+.. code:: python
+
+   def action_process(self):
+       self.action_mark_running()
+       self.with_delay()._process_in_background()
+
+3. Call ``action_mark_done()`` inside the background job when finished:
+
+.. code:: python
+
+   def _process_in_background(self):
+       try:
+           # ... do work ...
+           pass
+       finally:
+           self.action_mark_done()
+
+When ``is_job_running`` is ``True``, a yellow warning banner appears at
+the top of the form view: *"This Record is running in queue job."*
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job_alert_running%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Ecosoft
+
+Contributors
+------------
+
+- Saran Lim. <saranl@ecosoft.co.th>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+.. |maintainer-Saran440| image:: https://github.com/Saran440.png?size=40px
+    :target: https://github.com/Saran440
+    :alt: Saran440
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-Saran440| 
+
+This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/18.0/queue_job_alert_running>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

queue_job_alert_running/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from . import models

queue_job_alert_running/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2025 Ecosoft Co., Ltd.
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+{
+    "name": "Job Queue Alert Running",
+    "version": "18.0.1.0.0",
+    "author": "Ecosoft, Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/queue",
+    "summary": "Show a warning banner when a record has a running queue job",
+    "license": "AGPL-3",
+    "category": "Generic Modules",
+    "depends": ["queue_job"],
+    "data": [
+        "templates/queue_running_templates.xml",
+    ],
+    "maintainers": ["Saran440"],
+}

queue_job_alert_running/models/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from . import queue_job_status_mixin

queue_job_alert_running/models/queue_job_status_mixin.py

@@ -0,0 +1,57 @@
+# Copyright 2025 Ecosoft Co., Ltd.
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)
+
+from lxml import etree
+
+from odoo import api, fields, models
+from odoo.tools.misc import frozendict
+
+
+class QueueJobStatusMixin(models.AbstractModel):
+    _name = "queue.job.status.mixin"
+    _description = "Queue Job Status Mixin"
+
+    is_job_running = fields.Boolean(copy=False)
+
+    def action_mark_running(self):
+        self.write({"is_job_running": True})
+
+    def action_mark_done(self):
+        self.write({"is_job_running": False})
+
+    @api.model
+    def _merge_view_fields(self, all_models: dict, new_models: dict):
+        """Merge new_models into all_models.
+        Both are {modelname(str) > fields(tuple)}."""
+        for model, view_fields in new_models.items():
+            if model in all_models:
+                all_models[model] = tuple(set(all_models[model]) | set(view_fields))
+            else:
+                all_models[model] = tuple(view_fields)
+
+    def _add_queue_running_label(self, node, params):
+        str_element = self.env["ir.qweb"]._render(
+            "queue_job_alert_running.queue_running_label", params
+        )
+        new_node = etree.fromstring(str_element)
+        return new_node
+
+    @api.model
+    def get_view(self, view_id=None, view_type="form", **options):
+        res = super().get_view(view_id=view_id, view_type=view_type, **options)
+        View = self.env["ir.ui.view"]
+        if view_type == "form":
+            doc = etree.XML(res["arch"])
+            params = {}
+            all_models = res["models"].copy()  # {modelname(str) > fields(tuple)}
+            for node in doc.xpath("/form/sheet"):
+                # _add_queue_running_label process
+                new_node = self._add_queue_running_label(node, params)
+                new_arch, new_models = View.postprocess_and_fields(new_node, self._name)
+                new_node = etree.fromstring(new_arch)
+                for new_element in new_node:
+                    node.addprevious(new_element)
+                self._merge_view_fields(all_models, new_models)
+            res["arch"] = etree.tostring(doc)
+            res["models"] = frozendict(all_models)
+        return res

queue_job_alert_running/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

queue_job_alert_running/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+- Saran Lim. \<<saranl@ecosoft.co.th>\>

queue_job_alert_running/readme/DESCRIPTION.md

@@ -0,0 +1 @@
+This addon provides a mixin (`queue.job.status.mixin`) that adds an `is_job_running` boolean field and automatically displays a warning banner on form views when a record has a running queue job, helping prevent concurrent editing of the same record.

queue_job_alert_running/readme/USAGE.md

@@ -0,0 +1,30 @@
+To use this module:
+
+1. Inherit `queue.job.status.mixin` in your model:
+
+```python
+class MyModel(models.Model):
+    _name = "my.model"
+    _inherit = ["queue.job.status.mixin"]
+```
+
+2. Call `action_mark_running()` when a queue job starts (e.g., before `with_delay()`):
+
+```python
+def action_process(self):
+    self.action_mark_running()
+    self.with_delay()._process_in_background()
+```
+
+3. Call `action_mark_done()` inside the background job when finished:
+
+```python
+def _process_in_background(self):
+    try:
+        # ... do work ...
+        pass
+    finally:
+        self.action_mark_done()
+```
+
+When `is_job_running` is `True`, a yellow warning banner appears at the top of the form view: *"This Record is running in queue job."*