Use explicit recurring interval

src/documents/migrations/1057_workflowtrigger_schedule_date_custom_field_and_more.py

@@ -1,5 +1,6 @@
-# Generated by Django 5.1.1 on 2024-10-24 04:15
+# Generated by Django 5.1.1 on 2024-11-05 05:19
 
+import django.core.validators
 import django.db.models.deletion
 import django.utils.timezone
 from django.db import migrations
@@ -57,6 +58,16 @@ class Migration(migrations.Migration):
                 verbose_name="schedule offset days",
             ),
         ),
+        migrations.AddField(
+            model_name="workflowtrigger",
+            name="schedule_recurring_interval_days",
+            field=models.PositiveIntegerField(
+                default=1,
+                help_text="The number of days between recurring schedule triggers.",
+                validators=[django.core.validators.MinValueValidator(1)],
+                verbose_name="schedule recurring delay in days",
+            ),
+        ),
         migrations.AlterField(
             model_name="workflowtrigger",
             name="type",

src/documents/models.py

@@ -1121,6 +1121,15 @@ class WorkflowTrigger(models.Model):
         ),
     )
 
+    schedule_recurring_interval_days = models.PositiveIntegerField(
+        _("schedule recurring delay in days"),
+        default=1,
+        validators=[MinValueValidator(1)],
+        help_text=_(
+            "The number of days between recurring schedule triggers.",
+        ),
+    )
+
     schedule_date_field = models.CharField(
         _("schedule date field"),
         max_length=20,

src/documents/serialisers.py

@@ -1754,6 +1754,7 @@ class WorkflowTriggerSerializer(serializers.ModelSerializer):
             "filter_has_document_type",
             "schedule_offset_days",
             "schedule_is_recurring",
+            "schedule_recurring_interval_days",
             "schedule_date_field",
             "schedule_date_custom_field",
         ]

src/documents/tasks.py

@@ -397,14 +397,16 @@ def check_scheduled_workflows():
                             trigger.schedule_is_recurring
                             and workflow_runs.exists()
                             and (
-                                workflow_runs.last().run_at > timezone.now() - offset_td
-                                or workflow_runs.last().run_at
-                                > timezone.now() - timedelta(days=1)
+                                workflow_runs.last().run_at
+                                > timezone.now()
+                                - timedelta(
+                                    days=trigger.schedule_recurring_interval_days,
+                                )
                             )
                         ):
-                            # schedule is recurring but the last run was within the offset or within 24 hours of the last run
+                            # schedule is recurring but the last run was within the number of recurring interval days
                             logger.debug(
-                                f"Skipping document {document} for recurring workflow {workflow} as the last run was within the offset",
+                                f"Skipping document {document} for recurring workflow {workflow} as the last run was within the recurring interval",
                             )
                             continue
                         run_workflows(

src/documents/tests/test_workflows.py

@@ -1526,8 +1526,8 @@ class TestWorkflows(DirectoriesMixin, FileSystemAssertsMixin, APITestCase):
     def test_workflow_scheduled_trigger_too_early(self):
         """
         GIVEN:
-            - Existing workflow with SCHEDULED trigger and offset of 30 days
-            - Workflow run date is 20 days ago
+            - Existing workflow with SCHEDULED trigger and recurring interval of 7 days
+            - Workflow run date is 6 days ago
         WHEN:
             - Scheduled workflows are checked
         THEN:
@@ -1538,6 +1538,7 @@ class TestWorkflows(DirectoriesMixin, FileSystemAssertsMixin, APITestCase):
             schedule_offset_days=30,
             schedule_date_field=WorkflowTrigger.ScheduleDateField.CREATED,
             schedule_is_recurring=True,
+            schedule_recurring_interval_days=7,
         )
         action = WorkflowAction.objects.create(
             assign_title="Doc assign owner",
@@ -1562,12 +1563,15 @@ class TestWorkflows(DirectoriesMixin, FileSystemAssertsMixin, APITestCase):
             workflow=w,
             document=doc,
             type=WorkflowTrigger.WorkflowTriggerType.SCHEDULED,
-            run_at=timezone.now() - timedelta(days=20),
+            run_at=timezone.now() - timedelta(days=6),
         )
 
         with self.assertLogs(level="DEBUG") as cm:
             tasks.check_scheduled_workflows()
-            self.assertIn("last run was within the offset", " ".join(cm.output))
+            self.assertIn(
+                "last run was within the recurring interval",
+                " ".join(cm.output),
+            )
 
             doc.refresh_from_db()
             self.assertIsNone(doc.owner)