Remove backend-specific commit configuration

Author: RealOrangeOne

README.md

@@ -67,8 +67,9 @@ The task decorator accepts a few arguments to customize the task:
 - `priority`: The priority of the task (between -100 and 100. Larger numbers are higher priority. 0 by default)
 - `queue_name`: Whether to run the task on a specific queue
 - `backend`: Name of the backend for this task to use (as defined in `TASKS`)
+- `enqueue_on_commit`: Whether the task is enqueued when the current transaction commits successfully, or enqueued immediately. By default, this is handled by the backend (see below). `enqueue_on_commit` may not be modified with `.using`.
 
-These attributes can also be modified at run-time with `.using`:
+These attributes (besides `enqueue_on_commit`) can also be modified at run-time with `.using`:
 
 ```python
 modified_task = calculate_meaning_of_life.using(priority=10)
@@ -90,9 +91,9 @@ If the task takes arguments, these can be passed as-is to `enqueue`.
 
 #### Transactions
 
-By default, it's up to the backend to determine whether the task should be enqueued immediately (after calling `.enqueue`) or wait until the end of the current database transaction (if there is one).
+By default, tasks are enqueued after the current transaction (if there is one) commits successfully (using Django's `transaction.on_commit` method), rather than enqueueing immediately.
 
-This can be configured using the `ENQUEUE_ON_COMMIT` setting. `True` and `False` force the behaviour, and `None` is used to let the backend decide.
+This can be configured using the `ENQUEUE_ON_COMMIT` setting. `True` and `False` force the behaviour.
 
 ```python
 TASKS = {
@@ -103,7 +104,7 @@ TASKS = {
 }
 ```
 
-All built-in backends default to waiting for the end of the transaction (`"ENQUEUE_ON_COMMIT": True`).
+This can also be configured per-task by passing `enqueue_on_commit` to the `task` decorator.
 
 ### Queue names
 

django_tasks/backends/base.py

@@ -1,6 +1,6 @@
 from abc import ABCMeta, abstractmethod
 from inspect import iscoroutinefunction
-from typing import Any, Iterable, Optional, TypeVar
+from typing import Any, Iterable, TypeVar
 
 from asgiref.sync import sync_to_async
 from django.core.checks import messages
@@ -19,7 +19,7 @@
 
 class BaseTaskBackend(metaclass=ABCMeta):
     alias: str
-    enqueue_on_commit: Optional[bool]
+    enqueue_on_commit: bool
 
     task_class = Task
 
@@ -37,9 +37,9 @@ def __init__(self, options: dict) -> None:
 
         self.alias = options["ALIAS"]
         self.queues = set(options.get("QUEUES", [DEFAULT_QUEUE_NAME]))
-        self.enqueue_on_commit = options.get("ENQUEUE_ON_COMMIT", None)
+        self.enqueue_on_commit = bool(options.get("ENQUEUE_ON_COMMIT", True))
 
-    def _get_enqueue_on_commit_for_task(self, task: Task) -> Optional[bool]:
+    def _get_enqueue_on_commit_for_task(self, task: Task) -> bool:
         """
         Determine the correct `enqueue_on_commit` setting to use for a given task.
 
@@ -128,11 +128,6 @@ async def aget_result(self, result_id: str) -> TaskResult:
         )
 
     def check(self, **kwargs: Any) -> Iterable[messages.CheckMessage]:
-        if self.enqueue_on_commit not in {True, False, None}:
-            yield messages.CheckMessage(
-                messages.ERROR, "`ENQUEUE_ON_COMMIT` must be a bool or None"
-            )
-
         if self.enqueue_on_commit and not connections.settings:
             yield messages.CheckMessage(
                 messages.ERROR,

tests/tests/test_database_backend.py

@@ -302,8 +302,8 @@ def test_doesnt_wait_until_transaction_commit(self) -> None:
         }
     )
     def test_wait_until_transaction_by_default(self) -> None:
-        self.assertIsNone(default_task_backend.enqueue_on_commit)
-        self.assertIsNone(
+        self.assertTrue(default_task_backend.enqueue_on_commit)
+        self.assertTrue(
             default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
         )
 

tests/tests/test_dummy_backend.py

@@ -187,8 +187,8 @@ def test_doesnt_wait_until_transaction_commit(self) -> None:
         }
     )
     def test_wait_until_transaction_by_default(self) -> None:
-        self.assertIsNone(default_task_backend.enqueue_on_commit)
-        self.assertIsNone(
+        self.assertTrue(default_task_backend.enqueue_on_commit)
+        self.assertTrue(
             default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
         )
 

tests/tests/test_immediate_backend.py

@@ -262,8 +262,8 @@ def test_doesnt_wait_until_transaction_commit(self) -> None:
         }
     )
     def test_wait_until_transaction_by_default(self) -> None:
-        self.assertIsNone(default_task_backend.enqueue_on_commit)
-        self.assertIsNone(
+        self.assertTrue(default_task_backend.enqueue_on_commit)
+        self.assertTrue(
             default_task_backend._get_enqueue_on_commit_for_task(test_tasks.noop_task)
         )