dj-queue 0.10.1__tar.gz → 0.10.2__tar.gz

{dj_queue-0.10.1 → dj_queue-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dj-queue
-Version: 0.10.1
+Version: 0.10.2
 Summary: Database-backed task queue backend for Django’s Tasks framework.
 License-Expression: MIT
 License-File: LICENSE
@@ -115,6 +115,11 @@ Run migrations:
 python manage.py migrate
 ```
 
+`python manage.py dj_queue` checks for pending `dj_queue` migrations before it
+starts workers. If another process is applying migrations during startup, the
+runtime waits up to 60 seconds by default instead of starting against a stale
+queue schema.
+
 ## Quick Start
 
 Define a task with Django's `@task` decorator:
@@ -274,11 +279,14 @@ python manage.py dj_queue --backend <alias>
 python manage.py dj_queue --only-work
 python manage.py dj_queue --only-dispatch
 python manage.py dj_queue --skip-recurring
+python manage.py dj_queue --migration-wait-timeout 120
 ```
 
 Notes:
 
 - `fork` is the default standalone mode
+- startup waits up to 60 seconds for pending `dj_queue` migrations to finish;
+  use `--migration-wait-timeout 0` to fail fast instead
 - `async` is also supported as a standalone mode and runs supervised actors in threads inside one process
 - `--backend` targets a non-default backend alias
 - `--only-work` starts workers without dispatchers or scheduler

{dj_queue-0.10.1 → dj_queue-0.10.2}/README.md

@@ -89,6 +89,11 @@ Run migrations:
 python manage.py migrate
 ```
 
+`python manage.py dj_queue` checks for pending `dj_queue` migrations before it
+starts workers. If another process is applying migrations during startup, the
+runtime waits up to 60 seconds by default instead of starting against a stale
+queue schema.
+
 ## Quick Start
 
 Define a task with Django's `@task` decorator:
@@ -248,11 +253,14 @@ python manage.py dj_queue --backend <alias>
 python manage.py dj_queue --only-work
 python manage.py dj_queue --only-dispatch
 python manage.py dj_queue --skip-recurring
+python manage.py dj_queue --migration-wait-timeout 120
 ```
 
 Notes:
 
 - `fork` is the default standalone mode
+- startup waits up to 60 seconds for pending `dj_queue` migrations to finish;
+  use `--migration-wait-timeout 0` to fail fast instead
 - `async` is also supported as a standalone mode and runs supervised actors in threads inside one process
 - `--backend` targets a non-default backend alias
 - `--only-work` starts workers without dispatchers or scheduler

dj_queue-0.10.2/dj_queue/management/commands/dj_queue.py

@@ -0,0 +1,106 @@
+import math
+import time
+
+from django.core.exceptions import ImproperlyConfigured
+from django.core.management.base import BaseCommand
+from django.core.management.base import CommandError
+from django.db import connections
+from django.db.migrations.executor import MigrationExecutor
+
+from dj_queue.config import load_backend_config
+from dj_queue.runtime.supervisor import AsyncSupervisor, ForkSupervisor
+
+MIGRATION_WAIT_TIMEOUT = 60
+MIGRATION_WAIT_INTERVAL = 0.5
+
+
+def build_supervisor(*, backend_alias, cli_overrides):
+  mode = load_backend_config(backend_alias, cli_overrides=cli_overrides).mode
+  supervisor_class = AsyncSupervisor if mode == "async" else ForkSupervisor
+  return supervisor_class.from_backend_config(
+    backend_alias=backend_alias,
+    cli_overrides=cli_overrides,
+  )
+
+
+def wait_for_dj_queue_migrations(
+  database_alias,
+  *,
+  timeout=MIGRATION_WAIT_TIMEOUT,
+  interval=MIGRATION_WAIT_INTERVAL,
+  stdout=None,
+):
+  if not math.isfinite(timeout) or timeout < 0:
+    raise CommandError("dj_queue migration wait timeout must be non-negative")
+
+  deadline = time.monotonic() + timeout
+  announced = False
+  while True:
+    pending = pending_dj_queue_migrations(database_alias)
+    if not pending:
+      return
+
+    migration_names = ", ".join(
+      f"{migration.app_label}.{migration.name}" for migration, _backwards in pending
+    )
+    if stdout is not None and not announced:
+      stdout.write(
+        f"waiting for dj_queue migrations on database {database_alias!r}: {migration_names}"
+      )
+      announced = True
+
+    if time.monotonic() >= deadline:
+      raise CommandError(
+        f"dj_queue migrations are pending on database {database_alias!r}: {migration_names}; "
+        f"run manage.py migrate dj_queue --database {database_alias} before starting dj_queue"
+      )
+    time.sleep(min(interval, max(deadline - time.monotonic(), 0)))
+
+
+def pending_dj_queue_migrations(database_alias):
+  executor = MigrationExecutor(connections[database_alias])
+  targets = [node for node in executor.loader.graph.leaf_nodes() if node[0] == "dj_queue"]
+  return [
+    (migration, backwards)
+    for migration, backwards in executor.migration_plan(targets)
+    if migration.app_label == "dj_queue"
+  ]
+
+
+class Command(BaseCommand):
+  help = "Start the dj_queue supervisor"
+
+  def add_arguments(self, parser):
+    parser.add_argument("--backend", default="default")
+    parser.add_argument("--config")
+    parser.add_argument("--mode", choices=("fork", "async"))
+    parser.add_argument("--only-work", action="store_true")
+    parser.add_argument("--only-dispatch", action="store_true")
+    parser.add_argument("--skip-recurring", action="store_true")
+    parser.add_argument("--migration-wait-timeout", type=float, default=MIGRATION_WAIT_TIMEOUT)
+
+  def handle(self, *args, **options):
+    cli_overrides = {
+      "config": options["config"],
+      "mode": options["mode"],
+      "only_work": options["only_work"],
+      "only_dispatch": options["only_dispatch"],
+      "skip_recurring": options["skip_recurring"],
+    }
+    try:
+      config = load_backend_config(
+        options["backend"],
+        cli_overrides=cli_overrides,
+      )
+      wait_for_dj_queue_migrations(
+        config.database_alias,
+        timeout=options["migration_wait_timeout"],
+        stdout=self.stdout,
+      )
+      supervisor = build_supervisor(
+        backend_alias=options["backend"],
+        cli_overrides=cli_overrides,
+      )
+    except ImproperlyConfigured as exc:
+      raise CommandError(str(exc)) from exc
+    supervisor.run()

{dj_queue-0.10.1 → dj_queue-0.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "dj-queue"
-version = "0.10.1"
+version = "0.10.2"
 description = "Database-backed task queue backend for Django’s Tasks framework."
 readme = "README.md"
 license = "MIT"

dj_queue-0.10.1/dj_queue/management/commands/dj_queue.py

@@ -1,44 +0,0 @@
-from django.core.exceptions import ImproperlyConfigured
-from django.core.management.base import BaseCommand
-from django.core.management.base import CommandError
-
-from dj_queue.config import load_backend_config
-from dj_queue.runtime.supervisor import AsyncSupervisor, ForkSupervisor
-
-
-def build_supervisor(*, backend_alias, cli_overrides):
-  mode = load_backend_config(backend_alias, cli_overrides=cli_overrides).mode
-  supervisor_class = AsyncSupervisor if mode == "async" else ForkSupervisor
-  return supervisor_class.from_backend_config(
-    backend_alias=backend_alias,
-    cli_overrides=cli_overrides,
-  )
-
-
-class Command(BaseCommand):
-  help = "Start the dj_queue supervisor"
-
-  def add_arguments(self, parser):
-    parser.add_argument("--backend", default="default")
-    parser.add_argument("--config")
-    parser.add_argument("--mode", choices=("fork", "async"))
-    parser.add_argument("--only-work", action="store_true")
-    parser.add_argument("--only-dispatch", action="store_true")
-    parser.add_argument("--skip-recurring", action="store_true")
-
-  def handle(self, *args, **options):
-    cli_overrides = {
-      "config": options["config"],
-      "mode": options["mode"],
-      "only_work": options["only_work"],
-      "only_dispatch": options["only_dispatch"],
-      "skip_recurring": options["skip_recurring"],
-    }
-    try:
-      supervisor = build_supervisor(
-        backend_alias=options["backend"],
-        cli_overrides=cli_overrides,
-      )
-    except ImproperlyConfigured as exc:
-      raise CommandError(str(exc)) from exc
-    supervisor.run()

{dj_queue-0.10.1 → dj_queue-0.10.2}/dj_queue/templates/admin/dj_queue/dashboard.html

@@ -586,8 +586,8 @@
                 <tr class="{% cycle 'row1' 'row2' %}">
                   <th class="djq-col-name"><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=ready">{{ queue.name }}</a></th>
                   <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=ready">{{ queue.ready_count }}</a></td>
-                  <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=claimed">{{ queue.claimed_count }}</a></td>
                   <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=scheduled">{{ queue.scheduled_count }}</a></td>
+                  <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=claimed">{{ queue.claimed_count }}</a></td>
                   <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=blocked">{{ queue.blocked_count }}</a></td>
                   <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=failed">{{ queue.failed_count }}</a></td>
                   <td><a href="{% url 'admin:dj_queue_dashboard_queue' queue.name %}?backend={{ backend_alias }}&state=finished">{{ queue.finished_count }}</a></td>