[ADD] queue_job_pause: create queue_job_pause module

In some cases, we need to pause only a job since that it is used to schedule a process for a future date but is needed to filter only the paused ones.
Allows to change a channel job to a paused channel (capacity equals zero) using a wizard.

Author: JonathanOsAlc

queue_job_pause/__init__.py

@@ -0,0 +1,3 @@
+from . import models
+from . import wizards
+from . import jobrunner

queue_job_pause/__manifest__.py

@@ -0,0 +1,17 @@
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+{
+    "name": "Job Queue Pause Channels",
+    "version": "18.0.1.0.0",
+    "author": "Camptocamp,ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/queue",
+    "license": "LGPL-3",
+    "category": "Generic Modules",
+    "depends": ["queue_job"],
+    "data": [
+        "security/ir.model.access.csv",
+        "wizards/queue_jobs_pause_channel_views.xml",
+        "data/queue_data.xml",
+    ],
+    "installable": True,
+}

queue_job_pause/data/queue_data.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record model="queue.job.channel" id="channel_pause">
+        <field name="name">pause</field>
+        <field name="parent_id" ref="queue_job.channel_root" />
+    </record>
+</odoo>

queue_job_pause/job.py

@@ -0,0 +1,18 @@
+# Copyright 2013-2020 Camptocamp
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+from ..queue_job.job import Job
+
+PAUSE_CHANNEL = "root.pause"
+
+
+class JobPause(Job):
+
+    def _store_values(self, create=False):
+        vals = super().arrancar_motor(create)
+        if self.channel:
+            vals["channel"] = self.channel
+        return vals
+
+    def change_job_channel(self, to_channel):
+        self.channel = to_channel

queue_job_pause/jobrunner/channels.py

@@ -0,0 +1,89 @@
+# Copyright (c) 2015-2016 ACSONE SA/NV (<http://acsone.eu>)
+# Copyright 2015-2016 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+from ..job import (PAUSE_CHANNEL)
+from ....queue_job.jobrunner.channels import Channel, ChannelManager
+
+
+class ChannelPause(Channel):
+
+    def __str__(self):
+        default_capacity = "0" if self.name == PAUSE_CHANNEL else "∞"
+        capacity = default_capacity if not self.capacity else str(self.capacity)
+        return "%s(C:%s,Q:%d,R:%d,F:%d)" % (
+            self.fullname,
+            capacity,
+            len(self._queue),
+            len(self._running),
+            len(self._failed),
+        )
+    
+    def has_capacity(self):
+        """This method has been copied entirely from the parent class 'Channel'.
+        """
+        if self.sequential and self._failed:
+            # a sequential queue blocks on failed jobs
+            return False
+        # MODIFY: the original logic was: `if not self.capacity:`
+        if not self.capacity and self.fullname != PAUSE_CHANNEL:
+            # unlimited capacity
+            return True
+        return len(self._running) < self.capacity
+
+class ChannelManagerPause(ChannelManager):
+
+    @classmethod
+    def parse_simple_config(cls, config_string):
+        """This method has been copied entirely from the parent class 'ChannelManager'.
+        """
+        res = []
+        config_string = config_string.replace("\n", ",")
+        for channel_config_string in split_strip(config_string, ","):
+            if not channel_config_string:
+                # ignore empty entries (commented lines, trailing commas)
+                continue
+            config = {}
+            config_items = split_strip(channel_config_string, ":")
+            name = config_items[0]
+            if not name:
+                raise ValueError(
+                    "Invalid channel config %s: missing channel name" % config_string
+                )
+            config["name"] = name
+            if len(config_items) > 1:
+                capacity = config_items[1]
+                try:
+                    config["capacity"] = int(capacity)
+                    # MODIFY: Add the `if` logic.
+                    if name == PAUSE_CHANNEL and config["capacity"] != 0:
+                        raise Exception(
+                            "Channel 'pause' must be capacity equal to zero"
+                        )
+                except Exception as ex:
+                    raise ValueError(
+                        "Invalid channel config %s: "
+                        "invalid capacity %s" % (config_string, capacity)
+                    ) from ex
+                for config_item in config_items[2:]:
+                    kv = split_strip(config_item, "=")
+                    if len(kv) == 1:
+                        k, v = kv[0], True
+                    elif len(kv) == 2:
+                        k, v = kv
+                    else:
+                        raise ValueError(
+                            "Invalid channel config %s: "
+                            "incorrect config item %s" % (config_string, config_item)
+                        )
+                    if k in config:
+                        raise ValueError(
+                            "Invalid channel config %s: "
+                            "duplicate key %s" % (config_string, k)
+                        )
+                    config[k] = v
+            else:
+                # MODIFY: the original logic was `config["capacity"] = 1`
+                config["capacity"] = 0 if name == PAUSE_CHANNEL else 1
+            res.append(config)
+        return res

queue_job_pause/models/__init__.py

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

queue_job_pause/models/queue_job.py

@@ -0,0 +1,39 @@
+# Copyright 2013-2020 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+from odoo import exceptions, models
+from ..job import PAUSE_CHANNEL, Job
+
+
+class QueueJob(models.Model):
+    """Inherit model storing the jobs to be executed."""
+
+    _inherit = "queue.job"
+
+    def _change_job_pause_channel(self):
+        """Change the state of the `Job` object
+        Changing the channel of the Job will automatically change some fields
+        (date, result, ...).
+        """
+        for record in self:
+            job_ = Job.load(record.env, record.uuid)
+            to_channel = ""
+            if record.channel == PAUSE_CHANNEL:
+                # Get original channel
+                to_channel = record.job_function_id.channel
+                record.channel = record.job_function_id.channel
+            else:
+                to_channel = PAUSE_CHANNEL
+                record.channel = to_channel
+            job_.change_job_channel(to_channel)
+            job_.store()
+
+    def _validate_state_jobs(self):
+        if any(job.state in ("done", "started") for job in self):
+            raise exceptions.ValidationError(
+                self.env._("Some selected jobs are in invalid states to pause.")
+            )
+
+    def set_channel_pause(self):
+        self._change_job_pause_channel()
+        return True

queue_job_pause/security/ir.model.access.csv

@@ -0,0 +1,2 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_queue_channel_pause,access_queue_channel_pause,model_queue_channel_pause,queue_job.group_queue_job_manager,1,1,1,1

queue_job_pause/wizards/__init__.py

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

queue_job_pause/wizards/queue_jobs_pause_channel.py

@@ -0,0 +1,22 @@
+from odoo import fields, models
+
+
+class QueueChannelPause(models.TransientModel):
+    _name = "queue.channel.pause"
+    _description = "Wizard to change jobs to channel paused"
+
+    job_ids = fields.Many2many(
+        comodel_name="queue.job", string="Jobs", default=lambda record: record._default_job_ids()
+    )
+
+    def _default_job_ids(self):
+        res = False
+        context = self.env.context
+        if context.get("active_model") == "queue.job" and context.get("active_ids"):
+            res = context["active_ids"]
+        return res
+
+    def set_channel_paused(self):
+        self.job_ids._validate_state_jobs()
+        self.job_ids.set_channel_pause()
+        return {"type": "ir.actions.act_window_close"}