Add ability to defer signals/tasks in tests (baserow#4375)

Author: dimmur-brw

backend/pytest.ini

@@ -52,3 +52,5 @@ markers =
     data_sync: All tests related to data sync functionality
     replica: All tests related to db replicas
     workspace_search: All tests related to workspace search functionality
+    enable_all_signals: Disables signal deferral for this test (all signals enabled)
+    enable_signals: Enables specific signals for this test (accepts dotted callable paths)

backend/src/baserow/test_utils/pytest_conftest.py

@@ -3,7 +3,7 @@
 import os
 import sys
 import threading
-from contextlib import contextmanager
+from contextlib import ExitStack, contextmanager
 from datetime import date, datetime
 from decimal import Decimal
 from functools import partial
@@ -48,6 +48,22 @@
 SKIP_FLAGS = ["disabled-in-ci", "once-per-day-in-ci"]
 COMMAND_LINE_FLAG_PREFIX = "--run-"
 
+# List of heavy callables to defer by default during tests
+# Used by defer_heavy_signals fixture
+DEFAULT_DEFERRED_CALLABLES: List[str] = [
+    "baserow.ws.tasks.broadcast_to_channel_group.delay",
+    "baserow.ws.tasks.broadcast_to_users.delay",
+    "baserow.ws.tasks.broadcast_to_permitted_users.delay",
+    "baserow.ws.tasks.broadcast_to_group.delay",
+    "baserow.ws.tasks.broadcast_to_groups.delay",
+    "baserow.ws.tasks.broadcast_application_created.delay",
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+    "baserow.contrib.database.table.tasks.update_table_usage.delay",
+    "baserow.core.notifications.tasks.send_queued_notifications_to_users.delay",
+    "baserow.contrib.database.views.tasks.update_view_index.delay",
+]
+
 
 # Provides a new fake instance for each class. Solve uniqueness problem sometimes.
 @pytest.fixture(scope="class", autouse=True)
@@ -153,6 +169,41 @@ def clear_cache():
         yield
 
 
+@pytest.fixture(autouse=True)
+def defer_heavy_signals(request):
+    """
+    Defer heavy callables by default to speed up tests.
+
+    Opt-out options:
+        @pytest.mark.enable_all_signals - Enable all deferred signals
+        @pytest.mark.enable_signals("path.to.callable") - Enable specific signal(s)
+    """
+
+    if request.node.get_closest_marker("enable_all_signals"):
+        yield
+        return
+
+    signals_to_defer = set(DEFAULT_DEFERRED_CALLABLES)
+
+    enable_signals_marker = request.node.get_closest_marker("enable_signals")
+    if enable_signals_marker:
+        signals_to_enable = set()
+        if enable_signals_marker.args:
+            signals_to_enable.update(enable_signals_marker.args)
+        if enable_signals_marker.kwargs.get("signals"):
+            signals_to_enable.update(enable_signals_marker.kwargs["signals"])
+        signals_to_defer -= signals_to_enable
+
+    if not signals_to_defer:
+        yield
+        return
+
+    with ExitStack() as stack:
+        for name in signals_to_defer:
+            stack.enter_context(patch(name, lambda *args, **kwargs: None))
+        yield
+
+
 @pytest.fixture
 def reset_schema(django_db_blocker):
     yield
@@ -498,6 +549,14 @@ def pytest_configure(config):
                 f"{flag}: mark test so it only runs when the "
                 f"{COMMAND_LINE_FLAG_PREFIX}{flag} flag is provided to pytest",
             )
+        config.addinivalue_line(
+            "markers",
+            "enable_all_signals: Disables signal deferral for this test",
+        )
+        config.addinivalue_line(
+            "markers",
+            "enable_signals(callable_paths): Enables specific signals for this test",
+        )
         pytest_configure.already_run = True
 
 

backend/tests/baserow/contrib/builder/api/data_sources/test_data_source_views.py

@@ -1183,6 +1183,10 @@ def test_dispatch_data_source_with_adhoc_sortings(api_client, data_fixture):
 
 
 @pytest.mark.django_db(transaction=True)
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_dispatch_data_source_with_adhoc_search(api_client, data_fixture):
     with transaction.atomic():
         user, token = data_fixture.create_user_and_token()

backend/tests/baserow/contrib/database/api/rows/test_row_views.py

@@ -3678,6 +3678,10 @@ def test_get_row_adjacent_view_invalid_requests(api_client, data_fixture):
 
 @pytest.mark.django_db(transaction=True)
 @pytest.mark.parametrize("search_mode", ALL_SEARCH_MODES)
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_get_row_adjacent_search(api_client, data_fixture, search_mode):
     user, jwt_token = data_fixture.create_user_and_token(
         email="test@test.nl", password="password", first_name="Test1"

backend/tests/baserow/contrib/database/api/views/gallery/test_gallery_view_views.py

@@ -1249,6 +1249,10 @@ def test_list_rows_public_with_query_param_advanced_filters(api_client, data_fix
 
 @pytest.mark.django_db(transaction=True)
 @pytest.mark.parametrize("search_mode", ALL_SEARCH_MODES)
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_list_rows_public_only_searches_by_visible_columns(
     api_client, data_fixture, search_mode
 ):

backend/tests/baserow/contrib/database/api/views/grid/test_grid_view_views.py

@@ -4024,6 +4024,10 @@ def test_list_rows_public_filters_by_visible_and_hidden_columns(
 
 @pytest.mark.django_db(transaction=True)
 @pytest.mark.parametrize("search_mode", ALL_SEARCH_MODES)
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_list_rows_public_only_searches_by_visible_columns(
     api_client, data_fixture, search_mode
 ):

backend/tests/baserow/contrib/database/api/views/test_view_views.py

@@ -1172,6 +1172,9 @@ def test_view_cant_update_allow_public_export(data_fixture, api_client):
 
 
 @pytest.mark.django_db(transaction=True)
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.views.tasks.update_view_index.delay"
+)
 def test_loading_a_sortable_view_will_create_an_index(api_client, data_fixture):
     user, token = data_fixture.create_user_and_token()
     table = data_fixture.create_database_table(user=user)

backend/tests/baserow/contrib/database/field/test_field_notification_types.py

@@ -31,6 +31,11 @@
     assert_undo_redo_actions_are_valid,
 )
 
+pytestmark = pytest.mark.enable_signals(
+    "baserow.core.notifications.tasks.send_queued_notifications_to_users.delay",
+    "baserow.ws.tasks.broadcast_to_users.delay",
+)
+
 
 @pytest.mark.django_db(transaction=True)
 @patch("baserow.ws.tasks.broadcast_to_users.apply")

backend/tests/baserow/contrib/database/field/test_link_row_field_type.py

@@ -1185,6 +1185,10 @@ def test_link_row_field_type_api_row_views(api_client, data_fixture):
 
 @pytest.mark.django_db(transaction=True)
 @pytest.mark.field_link_row
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_import_export_link_row_field(data_fixture):
     user = data_fixture.create_user()
     imported_workspace = data_fixture.create_workspace(user=user)

backend/tests/baserow/contrib/database/field/test_multiple_collaborators_field_type.py

@@ -832,6 +832,10 @@ def test_multiple_collaborators_field_type_values_can_be_stringified(data_fixtur
 
 @pytest.mark.django_db(transaction=True)
 @pytest.mark.field_multiple_collaborators
+@pytest.mark.enable_signals(
+    "baserow.contrib.database.search.tasks.schedule_update_search_data.delay",
+    "baserow.contrib.database.search.tasks.update_search_data.delay",
+)
 def test_multiple_collaborators_field_type_values_can_be_searched(data_fixture):
     mario = data_fixture.create_user(first_name="Mario")
     luigi = data_fixture.create_user(first_name="Luigi")