steady-queue 0.1.8__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. {steady_queue-0.1.8/steady_queue.egg-info → steady_queue-0.2.1}/PKG-INFO +6 -2
  2. {steady_queue-0.1.8 → steady_queue-0.2.1}/README.md +1 -0
  3. {steady_queue-0.1.8 → steady_queue-0.2.1}/pyproject.toml +5 -1
  4. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/__init__.py +1 -1
  5. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/configuration.py +43 -0
  6. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/recurring_execution.py +8 -4
  7. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/recurring_task.py +5 -1
  8. steady_queue-0.2.1/steady_queue/processes/base.py +98 -0
  9. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/supervisor.py +5 -0
  10. {steady_queue-0.1.8 → steady_queue-0.2.1/steady_queue.egg-info}/PKG-INFO +6 -2
  11. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue.egg-info/SOURCES.txt +2 -0
  12. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_configuration.py +49 -0
  13. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_executions.py +57 -1
  14. steady_queue-0.2.1/tests/test_fork_safety.py +183 -0
  15. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_process_lifecycle.py +24 -10
  16. steady_queue-0.2.1/tests/test_recurring_execution.py +36 -0
  17. steady_queue-0.1.8/steady_queue/processes/base.py +0 -102
  18. {steady_queue-0.1.8 → steady_queue-0.2.1}/LICENSE +0 -0
  19. {steady_queue-0.1.8 → steady_queue-0.2.1}/setup.cfg +0 -0
  20. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/admin.py +0 -0
  21. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/app_executor.py +0 -0
  22. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/apps.py +0 -0
  23. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/arguments.py +0 -0
  24. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/backend.py +0 -0
  25. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/collections.py +0 -0
  26. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/concurrency.py +0 -0
  27. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/db_router.py +0 -0
  28. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/management/__init__.py +0 -0
  29. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/management/commands/__init__.py +0 -0
  30. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/management/commands/steady_queue.py +0 -0
  31. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/migrations/0001_initial.py +0 -0
  32. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/migrations/__init__.py +0 -0
  33. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/__init__.py +0 -0
  34. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/base.py +0 -0
  35. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/blocked_execution.py +0 -0
  36. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/claimed_execution.py +0 -0
  37. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/clearable.py +0 -0
  38. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/concurrency_controls.py +0 -0
  39. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/dispatching.py +0 -0
  40. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/executable.py +0 -0
  41. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/execution.py +0 -0
  42. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/executor.py +0 -0
  43. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/failed_execution.py +0 -0
  44. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/job.py +0 -0
  45. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/pause.py +0 -0
  46. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/process.py +0 -0
  47. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/prunable.py +0 -0
  48. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/queue.py +0 -0
  49. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/ready_execution.py +0 -0
  50. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/retryable.py +0 -0
  51. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/schedulable.py +0 -0
  52. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/scheduled_execution.py +0 -0
  53. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/models/semaphore.py +0 -0
  54. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/__init__.py +0 -0
  55. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/concurrent.py +0 -0
  56. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/dispatcher.py +0 -0
  57. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/errors.py +0 -0
  58. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/interruptible.py +0 -0
  59. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/maintenance.py +0 -0
  60. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/pidfile.py +0 -0
  61. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/pidfiled.py +0 -0
  62. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/poller.py +0 -0
  63. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/pool.py +0 -0
  64. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/registrable.py +0 -0
  65. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/runnable.py +0 -0
  66. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/scheduler.py +0 -0
  67. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/signals.py +0 -0
  68. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/supervised.py +0 -0
  69. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/timer.py +0 -0
  70. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/processes/worker.py +0 -0
  71. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/queue_selector.py +0 -0
  72. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/recurring_schedule.py +0 -0
  73. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/recurring_task.py +0 -0
  74. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue/task.py +0 -0
  75. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue.egg-info/dependency_links.txt +0 -0
  76. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue.egg-info/requires.txt +0 -0
  77. {steady_queue-0.1.8 → steady_queue-0.2.1}/steady_queue.egg-info/top_level.txt +0 -0
  78. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_arguments.py +0 -0
  79. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_backend.py +0 -0
  80. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_concurrency_controls.py +0 -0
  81. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_db_router.py +0 -0
  82. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_job.py +0 -0
  83. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_pidfile.py +0 -0
  84. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_queue_selector.py +0 -0
  85. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_recurring_task.py +0 -0
  86. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_semaphore.py +0 -0
  87. {steady_queue-0.1.8 → steady_queue-0.2.1}/tests/test_task.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: steady-queue
3
- Version: 0.1.8
3
+ Version: 0.2.1
4
4
  Summary: An asynchronous task library for Django that supports delayed tasks, concurrency controls, recurring tasks, pausing queues, numeric priorities per task, priorities by queue order and bulk enqueueing.
5
5
  Author-email: Elias Hernandis <elias@hernandis.me>
6
6
  License-Expression: MIT
@@ -10,12 +10,15 @@ Project-URL: Documentation, https://steady-queue.readthedocs.io/en/latest/
10
10
  Project-URL: Tracker, https://github.com/knifecake/steady-queue/issues
11
11
  Project-URL: Releases, https://github.com/knifecake/steady-queue/releases
12
12
  Keywords: django,tasks,async,jobs,queues
13
+ Classifier: Development Status :: 4 - Beta
13
14
  Classifier: Framework :: Django
14
15
  Classifier: Framework :: Django :: 6.0
15
16
  Classifier: Programming Language :: Python :: 3.12
16
17
  Classifier: Programming Language :: Python :: 3.13
17
18
  Classifier: Programming Language :: Python :: 3.14
18
- Classifier: Operating System :: OS Independent
19
+ Classifier: Operating System :: MacOS
20
+ Classifier: Operating System :: POSIX
21
+ Classifier: Operating System :: Unix
19
22
  Classifier: Natural Language :: English
20
23
  Requires-Python: >=3.12
21
24
  Description-Content-Type: text/markdown
@@ -63,6 +66,7 @@ The database backend exposed by Steady Queue doesn't support the following optio
63
66
  result = task.return_value` will result in an error (even if the task has
64
67
  completed processing). Instead, we recommend saving the results directly on
65
68
  your database or file storage system if they need to be kept around.
69
+ - **Requires a POSIX system** due to the concurrency model based on `os.fork`. Steady Queue doesn't run on windows.
66
70
 
67
71
  The Steady Queue backend advertises these limitations by [setting the
68
72
  corresponding flags][django-tasks-flags] on its backend.
@@ -37,6 +37,7 @@ The database backend exposed by Steady Queue doesn't support the following optio
37
37
  result = task.return_value` will result in an error (even if the task has
38
38
  completed processing). Instead, we recommend saving the results directly on
39
39
  your database or file storage system if they need to be kept around.
40
+ - **Requires a POSIX system** due to the concurrency model based on `os.fork`. Steady Queue doesn't run on windows.
40
41
 
41
42
  The Steady Queue backend advertises these limitations by [setting the
42
43
  corresponding flags][django-tasks-flags] on its backend.
@@ -10,13 +10,17 @@ authors = [
10
10
  requires-python = ">=3.12"
11
11
  keywords = ["django", "tasks", "async", "jobs", "queues"]
12
12
  classifiers = [
13
+ "Development Status :: 4 - Beta",
13
14
  "Framework :: Django",
14
15
  "Framework :: Django :: 6.0",
15
16
  "Programming Language :: Python :: 3.12",
16
17
  "Programming Language :: Python :: 3.13",
17
18
  "Programming Language :: Python :: 3.14",
18
- "Operating System :: OS Independent",
19
+ "Operating System :: MacOS",
20
+ "Operating System :: POSIX",
21
+ "Operating System :: Unix",
19
22
  "Natural Language :: English",
23
+
20
24
  ]
21
25
  dependencies = [
22
26
  "crontab>=1.0.5",
@@ -1,7 +1,7 @@
1
1
  from datetime import timedelta
2
2
  from typing import Optional
3
3
 
4
- VERSION = (0, 1, 8)
4
+ VERSION = (0, 2, 1)
5
5
 
6
6
  __version__ = ".".join(map(str, VERSION))
7
7
 
@@ -3,9 +3,11 @@ from datetime import timedelta
3
3
  from typing import Optional
4
4
 
5
5
  from crontab import CronTab
6
+ from django.conf import settings
6
7
  from django.core.exceptions import ValidationError
7
8
  from django.utils.module_loading import import_string
8
9
 
10
+ from steady_queue.db_router import steady_queue_database_alias
9
11
  from steady_queue.processes.base import Base
10
12
 
11
13
 
@@ -167,6 +169,7 @@ class Configuration:
167
169
  def is_valid(self):
168
170
  self.errors = []
169
171
  self.errors.extend(self.validate_configured_processes())
172
+ self.errors.extend(self.validate_database_pool_size())
170
173
  self.errors.extend(self.validate_recurring_tasks())
171
174
 
172
175
  return len(self.errors) == 0
@@ -177,6 +180,39 @@ class Configuration:
177
180
 
178
181
  return []
179
182
 
183
+ def validate_database_pool_size(self) -> list[ValidationError]:
184
+ # Match Solid Queue behavior by validating worker thread count against
185
+ # the queue DB connection pool size when a max_size is explicitly set.
186
+ if len(self.options.workers) == 0:
187
+ return []
188
+
189
+ db_alias = steady_queue_database_alias()
190
+ db_config = settings.DATABASES.get(db_alias, {})
191
+
192
+ if db_config.get("ENGINE") != "django.db.backends.postgresql":
193
+ return []
194
+
195
+ pool_options = db_config.get("OPTIONS", {}).get("pool")
196
+ if not isinstance(pool_options, dict):
197
+ return []
198
+
199
+ pool_max_size = pool_options.get("max_size")
200
+ if not isinstance(pool_max_size, int):
201
+ return []
202
+
203
+ if pool_max_size < self.estimated_number_of_threads:
204
+ return [
205
+ ValidationError(
206
+ "Steady Queue is configured to use "
207
+ f"{self.estimated_number_of_threads} threads but the "
208
+ f"database connection pool max_size for '{db_alias}' is "
209
+ f"{pool_max_size}. Increase "
210
+ f"DATABASES['{db_alias}']['OPTIONS']['pool']['max_size']."
211
+ )
212
+ ]
213
+
214
+ return []
215
+
180
216
  def validate_recurring_tasks(self) -> list[ValidationError]:
181
217
  if self.skip_recurring:
182
218
  return []
@@ -195,6 +231,13 @@ class Configuration:
195
231
 
196
232
  return errors
197
233
 
234
+ @property
235
+ def estimated_number_of_threads(self) -> int:
236
+ # At most `threads` in each worker + 2 additional threads (worker loop
237
+ # and heartbeat), mirroring Solid Queue's sizing heuristic.
238
+ max_worker_threads = max((w.threads for w in self.options.workers), default=1)
239
+ return max_worker_threads + 2
240
+
198
241
  @property
199
242
  def skip_recurring(self) -> bool:
200
243
  return self.options.skip_recurring or self.options.only_work
@@ -1,4 +1,4 @@
1
- from django.db import models
1
+ from django.db import IntegrityError, models
2
2
  from django.tasks import TaskResult
3
3
 
4
4
  from .execution import Execution, ExecutionQuerySet
@@ -9,9 +9,10 @@ class RecurringExecutionQuerySet(ExecutionQuerySet):
9
9
  return self.filter(job__isnull=True)
10
10
 
11
11
  def record(self, task_result: TaskResult, task, run_at):
12
- self.update_or_create(
13
- task=task, run_at=run_at, defaults={"job_id": task_result.id}
14
- )
12
+ try:
13
+ self.create(task=task, run_at=run_at, job_id=task_result.id)
14
+ except IntegrityError as e:
15
+ raise self.model.AlreadyRecorded from e
15
16
 
16
17
  def clear_in_batches(self, batch_size=500):
17
18
  while True:
@@ -21,6 +22,9 @@ class RecurringExecutionQuerySet(ExecutionQuerySet):
21
22
 
22
23
 
23
24
  class RecurringExecution(Execution):
25
+ class AlreadyRecorded(Exception):
26
+ pass
27
+
24
28
  class Meta:
25
29
  verbose_name = "recurring execution"
26
30
  verbose_name_plural = "recurring executions"
@@ -97,7 +97,10 @@ class RecurringTask(UpdatedAtMixin, BaseModel):
97
97
  return self.recurring_executions.max("run_at")
98
98
 
99
99
  def enqueue(self, run_at: datetime):
100
- return self.enqueue_and_record(run_at)
100
+ try:
101
+ return self.enqueue_and_record(run_at)
102
+ except RecurringExecution.AlreadyRecorded:
103
+ return False
101
104
 
102
105
  def enqueue_and_record(self, run_at: datetime):
103
106
  with transaction.atomic(using=self._state.db):
@@ -108,6 +111,7 @@ class RecurringTask(UpdatedAtMixin, BaseModel):
108
111
  queue_name=self.queue_name, priority=self.priority
109
112
  ).enqueue(*args, **kwargs)
110
113
  RecurringExecution.objects.record(task_result, self, run_at)
114
+ return task_result
111
115
 
112
116
  @property
113
117
  def previous_time(self) -> datetime:
@@ -0,0 +1,98 @@
1
+ import logging
2
+ import os
3
+ import secrets
4
+ import socket
5
+ from typing import Any
6
+
7
+ from django.db import connections
8
+
9
+ logger = logging.getLogger("steady_queue")
10
+
11
+
12
+ class Base:
13
+ name: str
14
+ stopped: bool = False
15
+
16
+ def __init__(self):
17
+ self.name = self.generate_name()
18
+ self.stopped = False
19
+
20
+ def boot(self):
21
+ pass
22
+
23
+ def shutdown(self):
24
+ pass
25
+
26
+ def stop(self):
27
+ self.stopped = True
28
+
29
+ @property
30
+ def kind(self) -> str:
31
+ return self.__class__.__name__.lower()
32
+
33
+ @property
34
+ def pid(self) -> int:
35
+ return os.getpid()
36
+
37
+ @property
38
+ def hostname(self) -> str:
39
+ return socket.gethostname()
40
+
41
+ @property
42
+ def metadata(self) -> dict[str, Any]:
43
+ return {}
44
+
45
+ @property
46
+ def is_stopped(self) -> bool:
47
+ return self.stopped
48
+
49
+ def generate_name(self) -> str:
50
+ return "-".join((self.kind, secrets.token_hex(10)))
51
+
52
+ def close_postgresql_connection_pools(self):
53
+ """
54
+ Close and clear Django's class-level psycopg pool cache.
55
+
56
+ Django stores psycopg pools in DatabaseWrapper._connection_pools, so we
57
+ must clear those references to avoid inheriting stale pools across fork.
58
+ """
59
+ closed_pool_maps: set[int] = set()
60
+
61
+ for alias in connections:
62
+ connection = connections[alias]
63
+ if (
64
+ connection.settings_dict.get("ENGINE")
65
+ != "django.db.backends.postgresql"
66
+ ):
67
+ continue
68
+
69
+ pool_map = getattr(connection.__class__, "_connection_pools", None)
70
+ if not isinstance(pool_map, dict) or id(pool_map) in closed_pool_maps:
71
+ continue
72
+
73
+ for pool_alias, pool in list(pool_map.items()):
74
+ try:
75
+ pool.close()
76
+ logger.debug(
77
+ "%(name)s closed psycopg pool for '%(alias)s'",
78
+ {"name": self.name, "alias": pool_alias},
79
+ )
80
+ except Exception as e:
81
+ logger.debug(
82
+ "%(name)s failed to close pool for '%(alias)s': %(e)s",
83
+ {"name": self.name, "alias": pool_alias, "e": e},
84
+ )
85
+ finally:
86
+ pool_map.pop(pool_alias, None)
87
+
88
+ closed_pool_maps.add(id(pool_map))
89
+
90
+ def reset_database_connections(self):
91
+ """
92
+ Reset database connections for forked processes.
93
+
94
+ This closes all current connections and clears Django's class-level
95
+ psycopg pool cache so child processes don't inherit parent pool state.
96
+ """
97
+ connections.close_all()
98
+ self.close_postgresql_connection_pools()
@@ -43,6 +43,8 @@ class Supervisor(Maintenance, Signals, Pidfiled, Registrable, Interruptible, Bas
43
43
  logger.info("starting supervisor with PID %(pid)d", {"pid": self.pid})
44
44
  try:
45
45
  self.boot()
46
+ # Fork only after resetting DB state (connections + psycopg pools).
47
+ self.reset_database_connections()
46
48
  self.start_processes()
47
49
  self.launch_maintenance_task()
48
50
  except SystemExit:
@@ -84,6 +86,9 @@ class Supervisor(Maintenance, Signals, Pidfiled, Registrable, Interruptible, Bas
84
86
  instance.supervisor = self.process
85
87
  instance.mode = "fork"
86
88
 
89
+ # Replacement recovery queries the database after the startup reset.
90
+ # Clear that connection and pool state before the child inherits it.
91
+ self.reset_database_connections()
87
92
  if (pid := os.fork()) == 0:
88
93
  # child
89
94
  instance.start()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: steady-queue
3
- Version: 0.1.8
3
+ Version: 0.2.1
4
4
  Summary: An asynchronous task library for Django that supports delayed tasks, concurrency controls, recurring tasks, pausing queues, numeric priorities per task, priorities by queue order and bulk enqueueing.
5
5
  Author-email: Elias Hernandis <elias@hernandis.me>
6
6
  License-Expression: MIT
@@ -10,12 +10,15 @@ Project-URL: Documentation, https://steady-queue.readthedocs.io/en/latest/
10
10
  Project-URL: Tracker, https://github.com/knifecake/steady-queue/issues
11
11
  Project-URL: Releases, https://github.com/knifecake/steady-queue/releases
12
12
  Keywords: django,tasks,async,jobs,queues
13
+ Classifier: Development Status :: 4 - Beta
13
14
  Classifier: Framework :: Django
14
15
  Classifier: Framework :: Django :: 6.0
15
16
  Classifier: Programming Language :: Python :: 3.12
16
17
  Classifier: Programming Language :: Python :: 3.13
17
18
  Classifier: Programming Language :: Python :: 3.14
18
- Classifier: Operating System :: OS Independent
19
+ Classifier: Operating System :: MacOS
20
+ Classifier: Operating System :: POSIX
21
+ Classifier: Operating System :: Unix
19
22
  Classifier: Natural Language :: English
20
23
  Requires-Python: >=3.12
21
24
  Description-Content-Type: text/markdown
@@ -63,6 +66,7 @@ The database backend exposed by Steady Queue doesn't support the following optio
63
66
  result = task.return_value` will result in an error (even if the task has
64
67
  completed processing). Instead, we recommend saving the results directly on
65
68
  your database or file storage system if they need to be kept around.
69
+ - **Requires a POSIX system** due to the concurrency model based on `os.fork`. Steady Queue doesn't run on windows.
66
70
 
67
71
  The Steady Queue backend advertises these limitations by [setting the
68
72
  corresponding flags][django-tasks-flags] on its backend.
@@ -73,10 +73,12 @@ tests/test_concurrency_controls.py
73
73
  tests/test_configuration.py
74
74
  tests/test_db_router.py
75
75
  tests/test_executions.py
76
+ tests/test_fork_safety.py
76
77
  tests/test_job.py
77
78
  tests/test_pidfile.py
78
79
  tests/test_process_lifecycle.py
79
80
  tests/test_queue_selector.py
81
+ tests/test_recurring_execution.py
80
82
  tests/test_recurring_task.py
81
83
  tests/test_semaphore.py
82
84
  tests/test_task.py
@@ -1,3 +1,4 @@
1
+ import warnings
1
2
  from datetime import timedelta
2
3
 
3
4
  from django.core.exceptions import ValidationError
@@ -153,6 +154,54 @@ class ConfigurationValidationTestCase(SimpleTestCase):
153
154
  self.assertGreater(len(config.errors), 0)
154
155
  self.assertIn("No processes configured", str(config.errors[0]))
155
156
 
157
+ def test_small_postgres_pool_fails_validation(self):
158
+ """Configured worker threads must fit in postgres pool max_size."""
159
+ options = Configuration.Options(workers=[Configuration.Worker(threads=3)])
160
+ config = Configuration(options)
161
+
162
+ with warnings.catch_warnings():
163
+ warnings.filterwarnings(
164
+ "ignore",
165
+ message="Overriding setting DATABASES can lead to unexpected behavior.",
166
+ category=UserWarning,
167
+ )
168
+
169
+ with self.settings(
170
+ DATABASES={
171
+ "queue": {
172
+ "ENGINE": "django.db.backends.postgresql",
173
+ "OPTIONS": {"pool": {"min_size": 1, "max_size": 4}},
174
+ }
175
+ }
176
+ ):
177
+ self.assertFalse(config.is_valid)
178
+
179
+ self.assertTrue(
180
+ any("pool max_size" in error.message for error in config.errors)
181
+ )
182
+
183
+ def test_sufficient_postgres_pool_passes_validation(self):
184
+ """Validation passes when postgres pool max_size is large enough."""
185
+ options = Configuration.Options(workers=[Configuration.Worker(threads=3)])
186
+ config = Configuration(options)
187
+
188
+ with warnings.catch_warnings():
189
+ warnings.filterwarnings(
190
+ "ignore",
191
+ message="Overriding setting DATABASES can lead to unexpected behavior.",
192
+ category=UserWarning,
193
+ )
194
+
195
+ with self.settings(
196
+ DATABASES={
197
+ "queue": {
198
+ "ENGINE": "django.db.backends.postgresql",
199
+ "OPTIONS": {"pool": {"min_size": 1, "max_size": 5}},
200
+ }
201
+ }
202
+ ):
203
+ self.assertTrue(config.is_valid)
204
+
156
205
  def test_invalid_recurring_task_schedule_fails_validation(self):
157
206
  """Invalid cron schedule in recurring task fails validation."""
158
207
  invalid_task = Configuration.RecurringTask(
@@ -1,6 +1,10 @@
1
+ from concurrent.futures import ThreadPoolExecutor
1
2
  from datetime import timedelta
3
+ from unittest import skipUnless
4
+ from unittest.mock import patch
2
5
 
3
- from django.test import TestCase
6
+ from django.db import connections
7
+ from django.test import TestCase, TransactionTestCase
4
8
  from django.utils import timezone
5
9
 
6
10
  import steady_queue
@@ -14,6 +18,7 @@ from steady_queue.models import (
14
18
  ScheduledExecution,
15
19
  Semaphore,
16
20
  )
21
+ from steady_queue.models.claimed_execution import ClaimedExecutionQuerySet
17
22
  from tests.dummy.tasks import dummy_task, limited_task, limited_task_with_lambda_key
18
23
 
19
24
 
@@ -106,6 +111,57 @@ class ReadyExecutionTestCase(TestHelperMixin, TestCase):
106
111
  self.assertEqual(ReadyExecution.objects.count(), 1)
107
112
 
108
113
 
114
+ class ConcurrentClaimTestCase(TestHelperMixin, TransactionTestCase):
115
+ databases = {"default", "queue"}
116
+
117
+ @skipUnless(
118
+ connections["queue"].features.has_select_for_update_skip_locked,
119
+ "The queue database must support SELECT FOR UPDATE SKIP LOCKED",
120
+ )
121
+ def test_higher_priority_arrival_does_not_change_claimed_candidates(self):
122
+ """#25: keep the selected jobs stable across insertion and retrieval."""
123
+ process = self.create_test_process()
124
+ original = self.create_job_in_queue("default", priority=0)
125
+ bulk_create = ClaimedExecutionQuerySet.bulk_create
126
+
127
+ def enqueue_higher_priority_job():
128
+ try:
129
+ return self.create_job_in_queue("default", priority=10).pk
130
+ finally:
131
+ connections.close_all()
132
+
133
+ def insert_claims_then_enqueue(queryset, *args, **kwargs):
134
+ result = bulk_create(queryset, *args, **kwargs)
135
+ # Commit an arrival on another connection after claims are inserted,
136
+ # but before claiming() retrieves them. No sleeps or timing races.
137
+ with ThreadPoolExecutor(max_workers=1) as executor:
138
+ arrival = executor.submit(enqueue_higher_priority_job)
139
+ arrivals.append(arrival.result(timeout=10))
140
+ return result
141
+
142
+ arrivals = []
143
+ with patch.object(
144
+ ClaimedExecutionQuerySet, "bulk_create", insert_claims_then_enqueue
145
+ ):
146
+ claimed = ReadyExecution.objects.claim(["*"], 1, process.pk)
147
+
148
+ self.assertEqual([execution.job_id for execution in claimed], [original.pk])
149
+ self.assertFalse(
150
+ ReadyExecution.objects.filter(
151
+ job_id__in=ClaimedExecution.objects.values("job_id")
152
+ ).exists()
153
+ )
154
+ self.assertEqual(
155
+ list(ReadyExecution.objects.values_list("job_id", flat=True)), arrivals
156
+ )
157
+
158
+ # Draining the remaining queue must not try to claim the original again.
159
+ next_claimed = ReadyExecution.objects.claim(["*"], 1, process.pk)
160
+ self.assertEqual([execution.job_id for execution in next_claimed], arrivals)
161
+ self.assertEqual(ReadyExecution.objects.claim(["*"], 1, process.pk), [])
162
+ self.assertEqual(ClaimedExecution.objects.count(), 2)
163
+
164
+
109
165
  class ClaimedExecutionTestCase(TestHelperMixin, TestCase):
110
166
  """Tests for ClaimedExecution behavior."""
111
167
 
@@ -0,0 +1,183 @@
1
+ from unittest import skipUnless
2
+ from unittest.mock import patch
3
+
4
+ from django.db import connections
5
+ from django.test import SimpleTestCase, TransactionTestCase
6
+
7
+ from steady_queue.configuration import Configuration
8
+ from steady_queue.models import (
9
+ ClaimedExecution,
10
+ FailedExecution,
11
+ Job,
12
+ Process,
13
+ ReadyExecution,
14
+ )
15
+ from steady_queue.processes.base import Base
16
+ from steady_queue.processes.supervisor import Supervisor
17
+ from tests.dummy.tasks import dummy_task
18
+
19
+
20
+ class SupervisorForkSafetyTest(SimpleTestCase):
21
+ def build_supervisor(self) -> Supervisor:
22
+ options = Configuration.Options(
23
+ workers=[],
24
+ dispatchers=[],
25
+ recurring_tasks=[],
26
+ skip_recurring=True,
27
+ )
28
+ return Supervisor(Configuration(options))
29
+
30
+ def test_supervisor_start_resets_connections_before_forking(self):
31
+ supervisor = self.build_supervisor()
32
+ calls = []
33
+
34
+ supervisor.boot = lambda: calls.append("boot")
35
+ supervisor.reset_database_connections = lambda: calls.append("reset")
36
+ supervisor.start_processes = lambda: calls.append("start_processes")
37
+ supervisor.launch_maintenance_task = lambda: calls.append("launch_maintenance")
38
+ supervisor.supervise = lambda: calls.append("supervise")
39
+
40
+ supervisor.start()
41
+
42
+ self.assertEqual(
43
+ calls,
44
+ [
45
+ "boot",
46
+ "reset",
47
+ "start_processes",
48
+ "launch_maintenance",
49
+ "supervise",
50
+ ],
51
+ )
52
+
53
+
54
+ @skipUnless(
55
+ connections["queue"].vendor == "postgresql",
56
+ "Requires PostgreSQL connection pooling on the queue database",
57
+ )
58
+ class SupervisorPostgreSQLForkTest(TransactionTestCase):
59
+ databases = {"default", "queue"}
60
+
61
+ def setUp(self):
62
+ options = Configuration.Options(
63
+ workers=[], dispatchers=[], recurring_tasks=[], skip_recurring=True
64
+ )
65
+ self.supervisor = Supervisor(Configuration(options))
66
+ self.supervisor.register()
67
+ self.worker_config = Configuration.Process(
68
+ kind="worker", attributes=Configuration.Worker()
69
+ )
70
+ self.connection = connections["queue"]
71
+ self.pool_options = self.connection.settings_dict["OPTIONS"]["pool"].copy()
72
+ self.addCleanup(self.supervisor.reset_database_connections)
73
+
74
+ def assert_reset_at_fork(self):
75
+ # Intercept only the OS fork; exercise real Django connections, psycopg
76
+ # pools, and replacement recovery up to the boundary children inherit.
77
+ self.assertIsNone(self.connection.connection)
78
+ self.assertEqual(self.connection.__class__._connection_pools, {})
79
+ self.assertEqual(
80
+ self.connection.settings_dict["OPTIONS"]["pool"], self.pool_options
81
+ )
82
+ return 12346
83
+
84
+ def test_start_process_resets_open_connection_and_pool_before_fork(self):
85
+ self.assertIsNotNone(self.connection.connection)
86
+ self.assertIn("queue", self.connection.__class__._connection_pools)
87
+
88
+ with patch(
89
+ "steady_queue.processes.supervisor.os.fork",
90
+ side_effect=self.assert_reset_at_fork,
91
+ ) as fork:
92
+ self.supervisor.start_process(self.worker_config)
93
+
94
+ fork.assert_called_once_with()
95
+ self.assertIn(12346, self.supervisor.forks)
96
+ # Pooling remains usable by the parent after the reset.
97
+ self.assertTrue(Process.objects.filter(pk=self.supervisor.process.pk).exists())
98
+ self.assertIn("queue", self.connection.__class__._connection_pools)
99
+
100
+ def test_replacement_resets_connection_reopened_by_job_recovery(self):
101
+ old_worker = self.worker_config.instantiate()
102
+ self.addCleanup(old_worker.pool.shutdown)
103
+ registered_worker = Process.register(
104
+ kind="worker",
105
+ name=old_worker.name,
106
+ pid=12345,
107
+ hostname="test-host",
108
+ supervisor=self.supervisor.process,
109
+ )
110
+ job = Job.objects.enqueue(dummy_task, [], {})
111
+ ReadyExecution.objects.claim(["*"], 1, registered_worker.pk)
112
+ self.supervisor.forks[12345] = old_worker
113
+ self.supervisor.configured_processes[12345] = self.worker_config
114
+ self.supervisor.reset_database_connections()
115
+
116
+ with patch(
117
+ "steady_queue.processes.supervisor.os.fork",
118
+ side_effect=self.assert_reset_at_fork,
119
+ ) as fork:
120
+ self.supervisor.replace_fork(12345, 11)
121
+
122
+ fork.assert_called_once_with()
123
+ self.assertNotIn(12345, self.supervisor.forks)
124
+ self.assertIn(12346, self.supervisor.forks)
125
+ self.assertFalse(ClaimedExecution.objects.filter(job=job).exists())
126
+ self.assertTrue(FailedExecution.objects.filter(job=job).exists())
127
+
128
+
129
+ class ResetDatabaseConnectionsTest(SimpleTestCase):
130
+ def test_reset_connections_clears_psycopg_pool_cache_without_disabling_pooling(
131
+ self,
132
+ ):
133
+ class FakePool:
134
+ def __init__(self):
135
+ self.closed = False
136
+
137
+ def close(self):
138
+ self.closed = True
139
+
140
+ class FakeConnection:
141
+ _connection_pools = {}
142
+
143
+ def __init__(self, engine: str):
144
+ self.settings_dict = {
145
+ "ENGINE": engine,
146
+ "OPTIONS": {"pool": {"min_size": 1, "max_size": 4}},
147
+ }
148
+
149
+ class FakeConnections(dict):
150
+ close_all_called = False
151
+
152
+ def __iter__(self):
153
+ return iter(self.keys())
154
+
155
+ def close_all(self):
156
+ self.close_all_called = True
157
+
158
+ pool_default = FakePool()
159
+ pool_queue = FakePool()
160
+ FakeConnection._connection_pools = {
161
+ "default": pool_default,
162
+ "queue": pool_queue,
163
+ }
164
+
165
+ fake_connections = FakeConnections(
166
+ {
167
+ "default": FakeConnection("django.db.backends.postgresql"),
168
+ "queue": FakeConnection("django.db.backends.postgresql"),
169
+ "sqlite": FakeConnection("django.db.backends.sqlite3"),
170
+ }
171
+ )
172
+
173
+ with patch("steady_queue.processes.base.connections", fake_connections):
174
+ Base().reset_database_connections()
175
+
176
+ self.assertIn("pool", fake_connections["default"].settings_dict["OPTIONS"])
177
+ self.assertIn("pool", fake_connections["queue"].settings_dict["OPTIONS"])
178
+ self.assertIn("pool", fake_connections["sqlite"].settings_dict["OPTIONS"])
179
+
180
+ self.assertTrue(fake_connections.close_all_called)
181
+ self.assertTrue(pool_default.closed)
182
+ self.assertTrue(pool_queue.closed)
183
+ self.assertEqual(FakeConnection._connection_pools, {})
@@ -1,5 +1,5 @@
1
1
  from datetime import timedelta
2
- from unittest.mock import MagicMock
2
+ from unittest.mock import MagicMock, patch
3
3
 
4
4
  from django.test import TestCase
5
5
  from django.utils import timezone
@@ -272,11 +272,11 @@ class PoolPostNilProcessTest(TestCase):
272
272
 
273
273
  def test_pool_post_does_not_access_execution_process(self):
274
274
  """Pool.post should not crash when execution.process is None."""
275
- import time
276
-
277
275
  from steady_queue.processes.pool import Pool
278
276
 
279
- pool = Pool(size=1, on_idle=lambda: None)
277
+ on_idle = MagicMock()
278
+ pool = Pool(size=1, on_idle=on_idle, worker_name="test-worker")
279
+ self.addCleanup(pool.executor.shutdown, wait=True)
280
280
 
281
281
  execution = MagicMock()
282
282
  execution.process = None
@@ -284,11 +284,25 @@ class PoolPostNilProcessTest(TestCase):
284
284
  execution.job.class_name = "test_task"
285
285
  execution.pk = 1
286
286
 
287
- # Should not raise AttributeError
288
- pool.post(execution)
289
- # Give the thread pool time to execute
290
- time.sleep(0.2)
291
- pool.shutdown()
287
+ submit = pool.executor.submit
288
+ futures = []
289
+
290
+ def capture_future(*args, **kwargs):
291
+ future = submit(*args, **kwargs)
292
+ futures.append(future)
293
+ return future
294
+
295
+ with self.assertLogs("steady_queue", level="INFO") as logs:
296
+ with patch.object(pool.executor, "submit", capture_future):
297
+ pool.post(execution)
298
+ # Exceptions after perform() live in the Future. Checking only that
299
+ # perform() ran allowed the original #26 logging crash to pass.
300
+ futures[0].result(timeout=5)
292
301
 
293
- # Verify perform was called successfully
294
302
  execution.perform.assert_called_once()
303
+ self.assertEqual(
304
+ logs.output,
305
+ ["INFO:steady_queue:test-worker completed job 1 test_task"],
306
+ )
307
+ self.assertEqual(pool.idle_threads, 1)
308
+ on_idle.assert_called_once_with()
@@ -0,0 +1,36 @@
1
+ from django.test import TestCase
2
+ from django.utils import timezone
3
+
4
+ from steady_queue.configuration import Configuration
5
+ from steady_queue.models import Job, RecurringExecution, RecurringTask
6
+ from tests.dummy.tasks import dummy_task
7
+
8
+
9
+ class RecurringExecutionTestCase(TestCase):
10
+ def test_enqueue_same_run_at_only_enqueues_once(self):
11
+ recurring_task = RecurringTask.from_configuration(
12
+ Configuration.RecurringTask(
13
+ key="test-recurring-task",
14
+ class_name="tests.dummy.tasks.dummy_task",
15
+ schedule="* * * * *",
16
+ arguments=dummy_task.serialize([], {}),
17
+ queue_name="default",
18
+ priority=0,
19
+ )
20
+ )
21
+ recurring_task.save()
22
+
23
+ run_at = timezone.now().replace(second=0, microsecond=0)
24
+
25
+ first_result = recurring_task.enqueue(run_at=run_at)
26
+ second_result = recurring_task.enqueue(run_at=run_at)
27
+
28
+ self.assertNotEqual(first_result, False)
29
+ self.assertFalse(second_result)
30
+
31
+ self.assertEqual(Job.objects.count(), 1)
32
+ self.assertEqual(RecurringExecution.objects.count(), 1)
33
+
34
+ recurring_execution = RecurringExecution.objects.get()
35
+ self.assertEqual(recurring_execution.task_id, recurring_task.key)
36
+ self.assertEqual(recurring_execution.run_at, run_at)
@@ -1,102 +0,0 @@
1
- import os
2
- import secrets
3
- import socket
4
- from typing import Any
5
-
6
- from django.db import connections
7
-
8
-
9
- class Base:
10
- name: str
11
- stopped: bool = False
12
-
13
- def __init__(self):
14
- self.name = self.generate_name()
15
- self.stopped = False
16
-
17
- def boot(self):
18
- pass
19
-
20
- def shutdown(self):
21
- pass
22
-
23
- def stop(self):
24
- self.stopped = True
25
-
26
- @property
27
- def kind(self) -> str:
28
- return self.__class__.__name__.lower()
29
-
30
- @property
31
- def pid(self) -> int:
32
- return os.getpid()
33
-
34
- @property
35
- def hostname(self) -> str:
36
- return socket.gethostname()
37
-
38
- @property
39
- def metadata(self) -> dict[str, Any]:
40
- return {}
41
-
42
- @property
43
- def is_stopped(self) -> bool:
44
- return self.stopped
45
-
46
- def generate_name(self) -> str:
47
- return "-".join((self.kind, secrets.token_hex(10)))
48
-
49
- def disable_connection_pooling(self):
50
- """
51
- Disable connection pooling for steady_queue processes.
52
-
53
- Connection pooling with psycopg doesn't work with forked processes.
54
- This method removes pool configuration from database settings to prevent
55
- pool-related errors in steady_queue workers.
56
- """
57
- import logging
58
-
59
- from django.conf import settings
60
-
61
- logger = logging.getLogger("steady_queue")
62
-
63
- # Disable pooling in database configuration
64
- if hasattr(settings, "DATABASES"):
65
- for alias, db_config in settings.DATABASES.items():
66
- if db_config.get("ENGINE") == "django.db.backends.postgresql":
67
- # Remove pool configuration if it exists
68
- options = db_config.setdefault("OPTIONS", {})
69
- if "pool" in options:
70
- logger.info(
71
- "%(name)s disabling connection pooling for database '%(alias)s'",
72
- {"name": self.name, "alias": alias},
73
- )
74
- del options["pool"]
75
-
76
- # Also disable on any existing connections
77
- for alias in connections:
78
- connection = connections[alias]
79
- if hasattr(connection, "pool") and connection.pool is not None:
80
- try:
81
- connection.pool.close()
82
- connection.pool = None
83
- logger.debug(
84
- "%(name)s removed existing pool for '%(alias)s'",
85
- {"name": self.name, "alias": alias},
86
- )
87
- except Exception as e:
88
- logger.debug(
89
- "%(name)s failed to close existing pool for '%(alias)s': %(e)s",
90
- {"name": self.name, "alias": alias, "e": e},
91
- )
92
-
93
- def reset_database_connections(self):
94
- """
95
- Reset database connections for forked processes.
96
-
97
- This disables connection pooling and resets connection state to prevent
98
- issues with shared connections between parent and child processes.
99
- """
100
- self.disable_connection_pooling()
101
-
102
- connections.close_all()
File without changes
File without changes