fix(celery): Do not send extra check-in (#4395)

When using the RedBeatScheduler, we're sending an extra in-progress
check-in at scheduler start. Since this is never followed by an ok or
error check-in, the check-in is marked as timed out in Sentry.

We're patching the scheduler's `maybe_due`, which (as the name implies)
[might not end up executing the
task](https://github.com/sibson/redbeat/blob/bdefad23b47f75e2e85d45f46f9f16dd00a93d40/redbeat/schedulers.py#L506-L508).
This is indeed what seems to be happening -- `maybe_due` is run when the
scheduler starts, but without scheduling the task. We don't check
whether `maybe_due` actually ended up scheduling anything and always
fire an in-progress check-in.

Patching the [scheduler's
`apply_async`](https://github.com/sibson/redbeat/blob/bdefad23b47f75e2e85d45f46f9f16dd00a93d40/redbeat/schedulers.py#L511)
instead.

Closes #4392

Author: sentrivana

sentry_sdk/integrations/celery/__init__.py

@@ -9,7 +9,7 @@
 from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
 from sentry_sdk.integrations.celery.beat import (
     _patch_beat_apply_entry,
-    _patch_redbeat_maybe_due,
+    _patch_redbeat_apply_async,
     _setup_celery_beat_signals,
 )
 from sentry_sdk.integrations.celery.utils import _now_seconds_since_epoch
@@ -73,7 +73,7 @@ def __init__(
         self.exclude_beat_tasks = exclude_beat_tasks
 
         _patch_beat_apply_entry()
-        _patch_redbeat_maybe_due()
+        _patch_redbeat_apply_async()
         _setup_celery_beat_signals(monitor_beat_tasks)
 
     @staticmethod

sentry_sdk/integrations/celery/beat.py

@@ -202,12 +202,12 @@ def _patch_beat_apply_entry():
     Scheduler.apply_entry = _wrap_beat_scheduler(Scheduler.apply_entry)
 
 
-def _patch_redbeat_maybe_due():
+def _patch_redbeat_apply_async():
     # type: () -> None
     if RedBeatScheduler is None:
         return
 
-    RedBeatScheduler.maybe_due = _wrap_beat_scheduler(RedBeatScheduler.maybe_due)
+    RedBeatScheduler.apply_async = _wrap_beat_scheduler(RedBeatScheduler.apply_async)
 
 
 def _setup_celery_beat_signals(monitor_beat_tasks):

tests/integrations/celery/test_celery_beat_crons.py

@@ -10,7 +10,7 @@
     _get_headers,
     _get_monitor_config,
     _patch_beat_apply_entry,
-    _patch_redbeat_maybe_due,
+    _patch_redbeat_apply_async,
     crons_task_failure,
     crons_task_retry,
     crons_task_success,
@@ -454,10 +454,10 @@ def test_exclude_redbeat_tasks_option(
     """
     Test excluding Celery RedBeat tasks from automatic instrumentation.
     """
-    fake_maybe_due = MagicMock()
+    fake_apply_async = MagicMock()
 
     fake_redbeat_scheduler = MagicMock()
-    fake_redbeat_scheduler.maybe_due = fake_maybe_due
+    fake_redbeat_scheduler.apply_async = fake_apply_async
 
     fake_integration = MagicMock()
     fake_integration.exclude_beat_tasks = exclude_beat_tasks
@@ -481,17 +481,19 @@ def test_exclude_redbeat_tasks_option(
                 "sentry_sdk.integrations.celery.beat._get_monitor_config",
                 fake_get_monitor_config,
             ) as _get_monitor_config:
-                # Mimic CeleryIntegration patching of RedBeatScheduler.maybe_due()
-                _patch_redbeat_maybe_due()
+                # Mimic CeleryIntegration patching of RedBeatScheduler.apply_async()
+                _patch_redbeat_apply_async()
                 # Mimic Celery RedBeat calling a task from the RedBeat schedule
-                RedBeatScheduler.maybe_due(fake_redbeat_scheduler, fake_schedule_entry)
+                RedBeatScheduler.apply_async(
+                    fake_redbeat_scheduler, fake_schedule_entry
+                )
 
                 if task_in_excluded_beat_tasks:
                     # Only the original RedBeatScheduler.maybe_due() is called, _get_monitor_config is NOT called.
-                    assert fake_maybe_due.call_count == 1
+                    assert fake_apply_async.call_count == 1
                     _get_monitor_config.assert_not_called()
 
                 else:
                     # The original RedBeatScheduler.maybe_due() is called, AND _get_monitor_config is called.
-                    assert fake_maybe_due.call_count == 1
+                    assert fake_apply_async.call_count == 1
                     assert _get_monitor_config.call_count == 1