plain.jobs 0.43.2__py3-none-any.whl

plain/jobs/middleware.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from collections.abc import Callable
+from typing import TYPE_CHECKING
+
+from plain.logs import app_logger
+
+if TYPE_CHECKING:
+    from .models import JobProcess, JobResult
+
+
+class JobMiddleware(ABC):
+    """
+    Abstract base class for job middleware.
+
+    Subclasses must implement process_job() to handle the job execution cycle.
+
+    Example:
+        class MyJobMiddleware(JobMiddleware):
+            def process_job(self, job: JobProcess) -> JobResult:
+                # Pre-processing
+                result = self.run_job(job)
+                # Post-processing
+                return result
+    """
+
+    def __init__(self, run_job: Callable[[JobProcess], JobResult]):
+        self.run_job = run_job
+
+    @abstractmethod
+    def process_job(self, job: JobProcess) -> JobResult:
+        """Process the job and return a result. Must be implemented by subclasses."""
+        ...
+
+
+class AppLoggerMiddleware(JobMiddleware):
+    def process_job(self, job: JobProcess) -> JobResult:
+        with app_logger.include_context(
+            job_request_uuid=str(job.job_request_uuid), job_process_uuid=str(job.uuid)
+        ):
+            return self.run_job(job)

plain/jobs/migrations/0001_initial.py

@@ -0,0 +1,246 @@
+# Generated by Plain 0.52.2 on 2025-07-08 01:17
+
+import uuid
+
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Job",
+            fields=[
+                ("id", models.PrimaryKeyField()),
+                ("uuid", models.UUIDField(default=uuid.uuid4)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("started_at", models.DateTimeField(allow_null=True, required=False)),
+                ("job_request_uuid", models.UUIDField()),
+                ("job_class", models.CharField(max_length=255)),
+                ("parameters", models.JSONField(allow_null=True, required=False)),
+                ("priority", models.IntegerField(default=0)),
+                ("source", models.TextField(required=False)),
+                ("queue", models.CharField(default="default", max_length=255)),
+                ("retries", models.IntegerField(default=0)),
+                ("retry_attempt", models.IntegerField(default=0)),
+                ("unique_key", models.CharField(max_length=255, required=False)),
+            ],
+            options={
+                "ordering": ["-created_at"],
+            },
+        ),
+        migrations.CreateModel(
+            name="JobRequest",
+            fields=[
+                ("id", models.PrimaryKeyField()),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("uuid", models.UUIDField(default=uuid.uuid4)),
+                ("job_class", models.CharField(max_length=255)),
+                ("parameters", models.JSONField(allow_null=True, required=False)),
+                ("priority", models.IntegerField(default=0)),
+                ("source", models.TextField(required=False)),
+                ("queue", models.CharField(default="default", max_length=255)),
+                ("retries", models.IntegerField(default=0)),
+                ("retry_attempt", models.IntegerField(default=0)),
+                ("unique_key", models.CharField(max_length=255, required=False)),
+                ("start_at", models.DateTimeField(allow_null=True, required=False)),
+            ],
+            options={
+                "ordering": ["priority", "-created_at"],
+            },
+        ),
+        migrations.CreateModel(
+            name="JobResult",
+            fields=[
+                ("id", models.PrimaryKeyField()),
+                ("uuid", models.UUIDField(default=uuid.uuid4)),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("job_uuid", models.UUIDField()),
+                ("started_at", models.DateTimeField(allow_null=True, required=False)),
+                ("ended_at", models.DateTimeField(allow_null=True, required=False)),
+                ("error", models.TextField(required=False)),
+                (
+                    "status",
+                    models.CharField(
+                        choices=[
+                            ("SUCCESSFUL", "Successful"),
+                            ("ERRORED", "Errored"),
+                            ("CANCELLED", "Cancelled"),
+                            ("LOST", "Lost"),
+                        ],
+                        max_length=20,
+                    ),
+                ),
+                ("job_request_uuid", models.UUIDField()),
+                ("job_class", models.CharField(max_length=255)),
+                ("parameters", models.JSONField(allow_null=True, required=False)),
+                ("priority", models.IntegerField(default=0)),
+                ("source", models.TextField(required=False)),
+                ("queue", models.CharField(default="default", max_length=255)),
+                ("retries", models.IntegerField(default=0)),
+                ("retry_attempt", models.IntegerField(default=0)),
+                ("unique_key", models.CharField(max_length=255, required=False)),
+                (
+                    "retry_job_request_uuid",
+                    models.UUIDField(allow_null=True, required=False),
+                ),
+            ],
+            options={
+                "ordering": ["-created_at"],
+            },
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["created_at"], name="plainworker_created_a02317_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(fields=["queue"], name="plainworker_queue_077806_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["unique_key"], name="plainworker_unique__04d87b_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["started_at"], name="plainworker_started_143df5_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["job_class"], name="plainworker_job_cla_884b46_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["job_request_uuid"], name="plainworker_job_req_db2681_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["job_class", "unique_key"], name="job_class_unique_key"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="job",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainworker_job_unique_uuid"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["priority"], name="plainworker_priorit_785e73_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["created_at"], name="plainworker_created_c81fe5_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(fields=["queue"], name="plainworker_queue_2614aa_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["start_at"], name="plainworker_start_a_4d6020_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["unique_key"], name="plainworker_unique__21a534_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["job_class"], name="plainworker_job_cla_3e7dea_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["job_class", "unique_key"], name="job_request_class_unique_key"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="jobrequest",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("retry_attempt", 0), ("unique_key__gt", "")),
+                fields=("job_class", "unique_key"),
+                name="plainworker_jobrequest_unique_job_class_key",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="jobrequest",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainworker_jobrequest_unique_uuid"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["created_at"], name="plainworker_created_6894c5_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["job_uuid"], name="plainworker_job_uui_8307d1_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["started_at"], name="plainworker_started_9bce76_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["ended_at"], name="plainworker_ended_a_63caaf_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(fields=["status"], name="plainworker_status_a7ca35_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["job_request_uuid"], name="plainworker_job_req_1e1bf2_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["job_class"], name="plainworker_job_cla_d138b5_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(fields=["queue"], name="plainworker_queue_23d8fe_idx"),
+        ),
+        migrations.AddConstraint(
+            model_name="jobresult",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainworker_jobresult_unique_uuid"
+            ),
+        ),
+    ]

plain/jobs/migrations/0002_job_span_id_job_trace_id_jobrequest_span_id_and_more.py

@@ -0,0 +1,61 @@
+# Generated by Plain 0.52.2 on 2025-07-17 19:33
+
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainjobs", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="job",
+            name="span_id",
+            field=models.CharField(allow_null=True, max_length=18, required=False),
+        ),
+        migrations.AddField(
+            model_name="job",
+            name="trace_id",
+            field=models.CharField(allow_null=True, max_length=34, required=False),
+        ),
+        migrations.AddField(
+            model_name="jobrequest",
+            name="span_id",
+            field=models.CharField(allow_null=True, max_length=18, required=False),
+        ),
+        migrations.AddField(
+            model_name="jobrequest",
+            name="trace_id",
+            field=models.CharField(allow_null=True, max_length=34, required=False),
+        ),
+        migrations.AddField(
+            model_name="jobresult",
+            name="span_id",
+            field=models.CharField(allow_null=True, max_length=18, required=False),
+        ),
+        migrations.AddField(
+            model_name="jobresult",
+            name="trace_id",
+            field=models.CharField(allow_null=True, max_length=34, required=False),
+        ),
+        migrations.AddIndex(
+            model_name="job",
+            index=models.Index(
+                fields=["trace_id"], name="plainworker_trace_i_d2b645_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobrequest",
+            index=models.Index(
+                fields=["trace_id"], name="plainworker_trace_i_e9dfc5_idx"
+            ),
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["trace_id"], name="plainworker_trace_i_00c75f_idx"
+            ),
+        ),
+    ]

plain/jobs/migrations/0003_rename_job_jobprocess_and_more.py

@@ -0,0 +1,80 @@
+# Generated by Plain 0.63.0 on 2025-09-15 21:29
+
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainjobs", "0002_job_span_id_job_trace_id_jobrequest_span_id_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name="Job",
+            new_name="JobProcess",
+        ),
+        migrations.RemoveIndex(
+            model_name="jobresult",
+            name="plainworker_job_uui_8307d1_idx",
+        ),
+        migrations.RenameField(
+            model_name="jobresult",
+            old_name="job_uuid",
+            new_name="job_process_uuid",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_created_0d3928_idx",
+            old_name="plainworker_created_a02317_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_queue_2550ba_idx",
+            old_name="plainworker_queue_077806_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_unique__9dc0bb_idx",
+            old_name="plainworker_unique__04d87b_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_started_b80ec5_idx",
+            old_name="plainworker_started_143df5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_job_cla_fe2b70_idx",
+            old_name="plainworker_job_cla_884b46_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_job_req_357898_idx",
+            old_name="plainworker_job_req_db2681_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainworker_trace_i_da2cfa_idx",
+            old_name="plainworker_trace_i_d2b645_idx",
+        ),
+        migrations.AddIndex(
+            model_name="jobresult",
+            index=models.Index(
+                fields=["job_process_uuid"], name="plainworker_job_pro_ceabfb_idx"
+            ),
+        ),
+        # To fix subsequent migrations...
+        migrations.AlterModelTable(
+            name="JobRequest",
+            table="plainworker_jobrequest",
+        ),
+        migrations.AlterModelTable(
+            name="JobProcess",
+            table="plainworker_jobprocess",
+        ),
+        migrations.AlterModelTable(
+            name="JobResult",
+            table="plainworker_jobresult",
+        ),
+    ]

plain/jobs/migrations/0004_rename_tables_to_plainjobs.py

@@ -0,0 +1,33 @@
+# Manual transition from plain-worker (plainworker) to plain-jobs (plainjobs)
+#
+# If upgrading from plain.worker, run this SQL command BEFORE running migrations:
+#
+# plain db shell -- -c "INSERT INTO plainmigrations (app, name, applied) SELECT 'plainjobs', name, applied FROM plainmigrations WHERE app = 'plainworker' ON CONFLICT DO NOTHING;"
+#
+# Then run: plain migrate
+# Then run: plain migrations prune (to clean up old plainworker records)
+#
+# Step 1: Rename tables from plainworker_* to plainjobs_*
+
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainjobs", "0003_rename_job_jobprocess_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterModelTable(
+            name="JobRequest",
+            table="plainjobs_jobrequest",
+        ),
+        migrations.AlterModelTable(
+            name="JobProcess",
+            table="plainjobs_jobprocess",
+        ),
+        migrations.AlterModelTable(
+            name="JobResult",
+            table="plainjobs_jobresult",
+        ),
+    ]

plain/jobs/migrations/0005_rename_constraints_and_indexes.py

@@ -0,0 +1,174 @@
+# Step 2: Rename constraints and indexes from plainworker_* to plainjobs_*
+# (Tables were renamed to plainjobs_* in migration 0004)
+
+from plain import models
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainjobs", "0004_rename_tables_to_plainjobs"),
+    ]
+
+    operations = [
+        # Remove old constraints (on plainjobs_* tables now)
+        migrations.RemoveConstraint(
+            model_name="jobprocess",
+            name="plainworker_job_unique_uuid",
+        ),
+        migrations.RemoveConstraint(
+            model_name="jobrequest",
+            name="plainworker_jobrequest_unique_job_class_key",
+        ),
+        migrations.RemoveConstraint(
+            model_name="jobrequest",
+            name="plainworker_jobrequest_unique_uuid",
+        ),
+        migrations.RemoveConstraint(
+            model_name="jobresult",
+            name="plainworker_jobresult_unique_uuid",
+        ),
+        # Rename indexes
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_created_04fbb8_idx",
+            old_name="plainworker_created_0d3928_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_queue_d07d21_idx",
+            old_name="plainworker_queue_2550ba_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_unique__67172c_idx",
+            old_name="plainworker_unique__9dc0bb_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_started_5cd62a_idx",
+            old_name="plainworker_started_b80ec5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_job_cla_19f3c1_idx",
+            old_name="plainworker_job_cla_fe2b70_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_job_req_32b6eb_idx",
+            old_name="plainworker_job_req_357898_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobprocess",
+            new_name="plainjobs_j_trace_i_9f93c8_idx",
+            old_name="plainworker_trace_i_da2cfa_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_priorit_fd4fac_idx",
+            old_name="plainworker_priorit_785e73_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_created_1eeb20_idx",
+            old_name="plainworker_created_c81fe5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_queue_b34b5a_idx",
+            old_name="plainworker_queue_2614aa_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_start_a_f3b8da_idx",
+            old_name="plainworker_start_a_4d6020_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_unique__42f6a6_idx",
+            old_name="plainworker_unique__21a534_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_job_cla_a18abf_idx",
+            old_name="plainworker_job_cla_3e7dea_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobrequest",
+            new_name="plainjobs_j_trace_i_194003_idx",
+            old_name="plainworker_trace_i_e9dfc5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_created_7978bf_idx",
+            old_name="plainworker_created_6894c5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_job_pro_751a64_idx",
+            old_name="plainworker_job_pro_ceabfb_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_started_6fb2ce_idx",
+            old_name="plainworker_started_9bce76_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_ended_a_648f25_idx",
+            old_name="plainworker_ended_a_63caaf_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_status_1ef683_idx",
+            old_name="plainworker_status_a7ca35_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_job_req_3ddecf_idx",
+            old_name="plainworker_job_req_1e1bf2_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_job_cla_8791b4_idx",
+            old_name="plainworker_job_cla_d138b5_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_queue_0a2178_idx",
+            old_name="plainworker_queue_23d8fe_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="jobresult",
+            new_name="plainjobs_j_trace_i_02f370_idx",
+            old_name="plainworker_trace_i_00c75f_idx",
+        ),
+        # Add new constraints (on plainworker_* tables, but with new names)
+        migrations.AddConstraint(
+            model_name="jobprocess",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainjobs_job_unique_uuid"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="jobrequest",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("retry_attempt", 0), ("unique_key__gt", "")),
+                fields=("job_class", "unique_key"),
+                name="plainjobs_jobrequest_unique_job_class_key",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="jobrequest",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainjobs_jobrequest_unique_uuid"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="jobresult",
+            constraint=models.UniqueConstraint(
+                fields=("uuid",), name="plainjobs_jobresult_unique_uuid"
+            ),
+        ),
+    ]

plain/jobs/migrations/0006_alter_jobprocess_table_alter_jobrequest_table_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Plain 0.74.0 on 2025-10-10 20:57
+
+from plain.models import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("plainjobs", "0005_rename_constraints_and_indexes"),
+    ]
+
+    operations = [
+        migrations.AlterModelTable(
+            name="jobprocess",
+            table=None,
+        ),
+        migrations.AlterModelTable(
+            name="jobrequest",
+            table=None,
+        ),
+        migrations.AlterModelTable(
+            name="jobresult",
+            table=None,
+        ),
+    ]