Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions queue_job/jobrunner/channels.py
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,15 @@
without risking to overflow the system.
"""

def __init__(self, name, parent, capacity=None, sequential=False, throttle=0):
def __init__(
self,
name,
parent,
capacity=None,
sequential=False,
throttle=0,
subcapacity=None,
):
self.name = name
self.parent = parent
if self.parent:
Expand All @@ -391,9 +399,10 @@
self._running = set()
self._failed = set()
self._pause_until = 0 # utc seconds since the epoch
self.capacity = capacity
self.capacity = capacity or (parent and parent.subcapacity)
self.throttle = throttle # seconds
self.sequential = sequential
self.subcapacity = subcapacity

@property
def sequential(self):
Expand All @@ -410,11 +419,13 @@
* capacity
* sequential
* subcapacity
* throttle
"""
assert self.fullname.endswith(config["name"])
self.capacity = config.get("capacity", None)
self.sequential = bool(config.get("sequential", False))
self.subcapacity = config.get("subcapacity", None)
self.throttle = int(config.get("throttle", 0))
if self.sequential and self.capacity != 1:
raise ValueError("A sequential channel must have a capacity of 1")
Expand Down Expand Up @@ -874,7 +885,16 @@
f"Invalid channel config {config_string}: "
f"duplicate key {k}"
)
config[k] = v
if k == "subcapacity":
try:
config[k] = int(v)

Check warning on line 890 in queue_job/jobrunner/channels.py

View check run for this annotation

Codecov / codecov/patch

queue_job/jobrunner/channels.py#L890

Added line #L890 was not covered by tests
except Exception as ex:
raise ValueError(
f"Invalid channel config {config_string}: "
f"invalid subcapacity {v}"
) from ex

Check warning on line 895 in queue_job/jobrunner/channels.py

View check run for this annotation

Codecov / codecov/patch

queue_job/jobrunner/channels.py#L895

Added line #L895 was not covered by tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This error handling is nice but I think it's better to move it to the configure() method.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't follow. This is nearly identical to the "capacity" error handling earlier in this same method.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, right, so this was already messy before, with the type conversions spread between parse_simple_config() and configure() for different options.

I'd prefer to have all the type conversions in the same place, though, so let's not make it worse here? I can refactor in a followup, so as you prefer.

else:
config[k] = v
else:
config["capacity"] = 1
res.append(config)
Expand Down
33 changes: 33 additions & 0 deletions queue_job/tests/test_runner_channels.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,43 @@
# Copyright 2015-2016 Camptocamp SA
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)

from odoo.tests import BaseCase

# pylint: disable=odoo-addons-relative-import
# we are testing, we want to test as we were an external consumer of the API
from odoo.addons.queue_job.jobrunner import channels

from .common import load_doctests

load_tests = load_doctests(channels)


class TestChannelManager(BaseCase):
def test_subcapacity_default(self):
cm = channels.ChannelManager()
cm.simple_configure("root:4")
root = cm.get_channel_by_name("root")
self.assertEqual(root.capacity, 4)
self.assertIsNone(root.subcapacity)
child = cm.get_channel_by_name("child", autocreate=True)
self.assertIs(child.capacity, None)
self.assertIsNone(child.subcapacity)

def test_subcapacity(self):
cm = channels.ChannelManager()
cm.simple_configure("root:4:subcapacity=1,override:2")
root = cm.get_channel_by_name("root")
self.assertEqual(root.subcapacity, 1)
child = cm.get_channel_by_name("override")
self.assertEqual(child.capacity, 2)
self.assertIsNone(child.subcapacity)
child = cm.get_channel_by_name("child", autocreate=True)
self.assertEqual(child.capacity, 1)
self.assertIsNone(child.subcapacity)

def test_subcapacity_subchannel(self):
cm = channels.ChannelManager()
cm.simple_configure("root:4,sub:2:subcapacity=1")
child = cm.get_channel_by_name("sub.child", autocreate=True)
self.assertEqual(child.capacity, 1)
self.assertIsNone(child.subcapacity)