-
Notifications
You must be signed in to change notification settings - Fork 17.5k
Fix deadline serialization, repr, and prune edge cases #70421
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
f0d7910
620598f
43d03f4
385914d
e3af694
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -320,7 +320,15 @@ def serialize_reference(self) -> dict: | |
| def deserialize_reference(cls, reference_data: dict): | ||
| from airflow.serialization.helpers import find_registered_custom_deadline_reference | ||
|
|
||
| custom_class = find_registered_custom_deadline_reference(reference_data["__class_path"]) | ||
| class_path = reference_data.get("__class_path") | ||
| if not class_path: | ||
| raise ValueError( | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Better messaging. 👍 |
||
| "Cannot deserialize deadline reference: unrecognized reference_type " | ||
| f"{reference_data.get(SerializedReferenceModels.REFERENCE_TYPE_FIELD)!r} with no " | ||
| "'__class_path' to import. The stored reference is corrupt, from a newer " | ||
| "Airflow version, or references a custom class whose plugin is no longer installed." | ||
| ) | ||
| custom_class = find_registered_custom_deadline_reference(class_path) | ||
| inner_ref = custom_class.deserialize_reference(reference_data) | ||
| return cls(inner_ref) | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -117,6 +117,35 @@ def test_deadline_alert_repr(self, deadline_alert_orm, deadline_reference): | |
| assert "interval=1m" in repr_str | ||
| assert repr(deadline_alert_orm.callback_def) in repr_str | ||
|
|
||
| @pytest.mark.parametrize( | ||
| ("interval", "expected"), | ||
| [ | ||
| # Post-0117 shape: interval is the serialized dict, not a bare number. | ||
| pytest.param( | ||
| {"__classname__": "datetime.timedelta", "__data__": 7200.0}, "interval=2h", id="timedelta_2h" | ||
| ), | ||
| # A corrupted dict without ``__data__`` must still render (no raise) as dynamic. | ||
| pytest.param({"unexpected": "shape"}, "interval=dynamic", id="corrupted_dict_dynamic"), | ||
| ], | ||
| ) | ||
| def test_deadline_alert_repr_does_not_raise_on_json_dict_interval( | ||
| self, deadline_alert_orm, interval, expected | ||
| ): | ||
| """``DeadlineAlert.__repr__`` must never raise for the PRODUCTION (JSON-dict) ``interval`` shape. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar to above, we don't generally have a novel for a test docstring when the test's name is usually pretty self-documenting. |
||
|
|
||
| Regression for a bug where ``__repr__`` did ``isinstance(self.interval, datetime.timedelta)`` | ||
| while ``datetime`` is imported as the *class* (``from datetime import datetime``), so | ||
| ``datetime.timedelta`` raised ``AttributeError`` — and since ``interval`` is *always* a JSON | ||
| dict in production (post-migration-0117), every real ``repr()`` hit that branch and raised | ||
| (a ``__repr__`` that raises breaks logs/tracebacks/debuggers — the same class as the | ||
| ``Deadline.__repr__`` None-deref fix). The old ``test_deadline_alert_repr`` used a *bare int* | ||
| fixture (``DEADLINE_INTERVAL = 60``) which only exercised the int/float branch and masked it. | ||
| """ | ||
| deadline_alert_orm.interval = interval | ||
| repr_str = repr(deadline_alert_orm) # must not raise | ||
| assert "[DeadlineAlert]" in repr_str | ||
| assert expected in repr_str | ||
|
|
||
| def test_deadline_alert_matches_definition(self, session, deadline_reference): | ||
| alert1 = DeadlineAlert( | ||
| serialized_dag_id=SERIALIZED_DAG_ID, | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| """ | ||
| Adversarial QA coverage for ``Deadline.prune_deadlines``. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Claude comments? |
||
|
|
||
| ``prune_deadlines`` is the batch-delete path the scheduler invokes (via | ||
| ``DagRun.update_state`` -> ``dagrun.py:1237``) when a DagRun completes on time: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This whole docstring is odd, but the line number in particular is pretty pointless and will drift in no time, if it hasn't already. |
||
| deadlines that no longer need to fire are removed. These tests drill into the | ||
| on-time/overdue/pending selection logic, the (lack of) batching, callback | ||
| cascade behaviour, and concurrent-mutation edge cases against a real DB. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from datetime import timedelta | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| import pytest | ||
| import time_machine | ||
| from sqlalchemy import select | ||
|
|
||
| from airflow.models import DagRun | ||
| from airflow.models.callback import Callback | ||
| from airflow.models.deadline import Deadline | ||
| from airflow.providers.standard.operators.empty import EmptyOperator | ||
| from airflow.sdk.definitions.callback import AsyncCallback | ||
| from airflow.utils.state import DagRunState | ||
|
|
||
| from tests_common.test_utils import db | ||
| from unit.models import DEFAULT_DATE | ||
|
|
||
| if TYPE_CHECKING: | ||
| from sqlalchemy.orm import Session | ||
|
|
||
| DAG_ID = "qaw18_prune_dag" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "qaw18"?? |
||
|
|
||
|
|
||
| async def _qaw18_callback(): | ||
| pass | ||
|
|
||
|
|
||
| CALLBACK_PATH = f"{__name__}.{_qaw18_callback.__name__}" | ||
|
|
||
|
|
||
| def _clean_db(): | ||
| db.clear_db_dags() | ||
| db.clear_db_runs() | ||
| db.clear_db_deadline() | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def dagrun(session, dag_maker): | ||
| with dag_maker(DAG_ID): | ||
| EmptyOperator(task_id="task_id") | ||
| with time_machine.travel(DEFAULT_DATE): | ||
| dag_maker.create_dagrun(state=DagRunState.QUEUED, logical_date=DEFAULT_DATE) | ||
| session.commit() | ||
| return session.scalars(select(DagRun)).one() | ||
|
|
||
|
|
||
| def _make_deadline(session: Session, *, dagrun_id: int, deadline_time, state=None) -> Deadline: | ||
| deadline = Deadline( | ||
| deadline_time=deadline_time, | ||
| callback=AsyncCallback(CALLBACK_PATH), | ||
| dagrun_id=dagrun_id, | ||
| dag_id=DAG_ID, | ||
| deadline_alert_id=None, | ||
| ) | ||
| session.add(deadline) | ||
| session.flush() | ||
| if state is not None: | ||
| deadline.callback.state = state | ||
| session.add(deadline.callback) | ||
| session.flush() | ||
| return deadline | ||
|
|
||
|
|
||
| @pytest.mark.db_test | ||
| class TestPruneDeadlines: | ||
| @staticmethod | ||
| def setup_method(): | ||
| _clean_db() | ||
|
|
||
|
Comment on lines
+95
to
+97
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we need to clean the db before our tests, then something else is leaving artifacts that should not be there, this will hide issues. |
||
| @staticmethod | ||
| def teardown_method(): | ||
| _clean_db() | ||
|
|
||
| def test_handle_miss_then_prune_does_not_delete_missed(self, dagrun, session): | ||
| """ | ||
| Inverse race: handle_miss marks the deadline missed and queues the callback | ||
| BEFORE the on-time prune runs. prune must NOT delete a deadline already marked | ||
| ``missed`` — its callback is owned by the scheduler/triggerer, and cascade-deleting | ||
| the deadline would silently drop that queued callback (a lost-callback window). | ||
|
|
||
| prune_deadlines explicitly filters ``~Deadline.missed`` so a missed deadline (and its | ||
| queued callback) survives even if the DagRun's end_date would otherwise match the | ||
| on-time predicate. (In the real scheduler a missed deadline always has | ||
| ``deadline_time < now <= end_date`` so it can't match the on-time predicate anyway; | ||
| the explicit filter makes the invariant robust to future callers and clock skew.) | ||
| """ | ||
| d = _make_deadline(session, dagrun_id=dagrun.id, deadline_time=DEFAULT_DATE + timedelta(hours=1)) | ||
| # Set missed + queued callback directly to test the prune ``~missed`` guard in isolation. | ||
| d.callback.queue(session=session) | ||
| d.missed = True | ||
| session.add_all([d, d.callback]) | ||
| session.flush() | ||
| assert d.missed is True | ||
| deadline_id = d.id | ||
| callback_id = d.callback.id | ||
|
|
||
| # DagRun reports on-time completion (end_date <= deadline_time) — the exact condition | ||
| # that would have pruned the row before the ~missed guard was added. | ||
| dagrun.end_date = DEFAULT_DATE | ||
| session.add(dagrun) | ||
| session.flush() | ||
|
|
||
| deleted = Deadline.prune_deadlines(session=session, conditions={DagRun.id: dagrun.id}) | ||
| session.flush() | ||
|
|
||
| # The missed deadline and its queued callback both survive. | ||
| assert deleted == 0 | ||
| assert session.get(Deadline, deadline_id) is not None | ||
| assert session.get(Callback, callback_id) is not None | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be safer to check if
__classname__ == "datetime.timedelta"instead, otherwise I think this could catch a broader scope than intended. I may be overthinking this one though.