Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions airflow-core/src/airflow/models/deadline.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,10 @@ def __repr__(self):
def _determine_resource() -> tuple[str, str]:
"""Determine the type of resource based on which values are present."""
if self.dagrun_id:
# The deadline is for a Dag run:
return "DagRun", f"Dag: {self.dagrun.dag_id} Run: {self.dagrun_id}"
# Guard the relationship: the FK can be set while ``dagrun`` resolves to None (e.g.
# after a cascade delete). __repr__ must not raise, so fall back to the id-only form.
dag_id = self.dagrun.dag_id if self.dagrun is not None else "<unknown>"
return "DagRun", f"Dag: {dag_id} Run: {self.dagrun_id}"

return "Unknown", ""

Expand Down Expand Up @@ -183,9 +185,10 @@ def prune_deadlines(cls, *, session: Session, conditions: dict[Mapped, Any]) ->
return 0

try:
# Get deadlines which match the provided conditions and their associated DagRuns.
# Exclude deadlines already marked ``missed``: the scheduler owns their (queued)
# callbacks, so prune must never cascade-delete them.
deadline_dagrun_pairs = session.execute(
select(Deadline, DagRun).join(DagRun).where(and_(*filter_conditions))
select(Deadline, DagRun).join(DagRun).where(and_(*filter_conditions)).where(~Deadline.missed)
).all()

except AttributeError as e:
Expand Down
7 changes: 5 additions & 2 deletions airflow-core/src/airflow/models/deadline_alert.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,14 @@ def __repr__(self):

interval_seconds = None

# Legacy rows store a bare number instead of a serialized dict.
if isinstance(self.interval, (int, float)):
interval_seconds = int(self.interval)

elif isinstance(self.interval, datetime.timedelta):
interval_seconds = int(self.interval.total_seconds())
elif isinstance(self.interval, dict):
data = self.interval.get("__data__")
if isinstance(data, (int, float)):
interval_seconds = int(data)

if interval_seconds is None:
interval_display = "dynamic"
Expand Down
7 changes: 6 additions & 1 deletion airflow-core/src/airflow/serialization/decoders.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,12 @@ def decode_deadline_reference(reference_data: dict):
"""Decode a previously serialized deadline reference."""
ref_name = reference_data.get(SerializedReferenceModels.REFERENCE_TYPE_FIELD)

if ref_name and SerializedReferenceModels.is_builtin_reference(ref_name):
# A custom reference may share a name with a builtin, so ``__class_path`` wins.
if "__class_path" in reference_data:
reference_class: type[SerializedReferenceModels.SerializedBaseDeadlineReference] = (
SerializedReferenceModels.SerializedCustomReference
)
elif ref_name and SerializedReferenceModels.is_builtin_reference(ref_name):
reference_class = SerializedReferenceModels.get_reference_class(ref_name)
else:
reference_class = SerializedReferenceModels.SerializedCustomReference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
"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)

Expand Down
17 changes: 17 additions & 0 deletions airflow-core/tests/unit/models/test_deadline.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,23 @@ def test_repr_without_callback_kwargs(self, dagrun, session):
assert f"needed by {DEFAULT_DATE}" in repr_str
assert TEST_CALLBACK_PATH in repr_str

def test_repr_with_dagrun_id_but_no_dagrun_relationship(self, deadline_orm):
"""__repr__ must NOT raise when dagrun_id is set but the dagrun relationship is None.

The FK (dagrun_id) can be set while the relationship resolves to None — e.g. the DagRun
was deleted (ondelete=CASCADE) and this is a stale/expired in-memory Deadline. A __repr__
that raised AttributeError here would break log lines, tracebacks, and debugger displays
exactly when something is already going wrong. The repr falls back to an id-only form.
"""
# Sever the relationship while keeping the FK id (simulates deleted/detached DagRun).
deadline_orm.dagrun = None
assert deadline_orm.dagrun_id is not None

repr_str = repr(deadline_orm) # must not raise
assert "[DagRun Deadline]" in repr_str
assert f"Run: {deadline_orm.dagrun_id}" in repr_str
assert "Dag: <unknown>" in repr_str

@pytest.mark.db_test
def test_bundle_name_propagated_to_callback(self, dagrun, session):
"""The bundle name is forwarded to the callback so the triggerer can resolve its team."""
Expand Down
29 changes: 29 additions & 0 deletions airflow-core/tests/unit/models/test_deadline_alert.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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,
Expand Down
137 changes: 137 additions & 0 deletions airflow-core/tests/unit/models/test_prune_deadlines.py
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``.

``prune_deadlines`` is the batch-delete path the scheduler invokes (via
``DagRun.update_state`` -> ``dagrun.py:1237``) when a DagRun completes on time:
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"


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()

@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
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,85 @@ def test_serialized_custom_reference_rejects_unregistered(monkeypatch):
SerializedReferenceModels.SerializedCustomReference.deserialize_reference(
{"__class_path": "some.other.module.UnregisteredReference"}
)


@pytest.mark.parametrize(
"reference_data",
[
pytest.param({"reference_type": "TotallyUnknownReference"}, id="unknown_type_no_class_path"),
pytest.param({"reference_type": "X", "__class_path": ""}, id="empty_class_path"),
],
)
def test_serialized_custom_reference_missing_class_path_raises_clear_error(reference_data):
"""A reference routed to SerializedCustomReference but lacking a usable ``__class_path``
(corrupt / hand-edited row, blob from a newer version, or a custom ref whose plugin is gone)
must raise a clear ValueError — NOT a bare ``KeyError: '__class_path'``."""
with pytest.raises(ValueError, match="unrecognized reference_type"):
SerializedReferenceModels.SerializedCustomReference.deserialize_reference(reference_data)


class FixedDatetimeDeadline(ReferenceModels.BaseDeadlineReference):
"""Custom reference whose class name deliberately collides with a builtin reference name."""

required_kwargs: set[str] = set()

def serialize_reference(self) -> dict:
return {"reference_type": self.reference_name, "marker": "i-am-custom"}

def _evaluate_with(self, *, session, **kwargs):
raise AssertionError("custom evaluate should not be exercised in this test")


class DagRunLogicalDateDeadline(ReferenceModels.BaseDeadlineReference):
"""Custom reference colliding with a builtin that has no required deserialize fields."""

required_kwargs: set[str] = set()

def serialize_reference(self) -> dict:
return {"reference_type": self.reference_name}

def _evaluate_with(self, *, session, **kwargs):
raise AssertionError("custom evaluate should not be exercised in this test")


_COLLIDING_REFS = {
f"{FixedDatetimeDeadline.__module__}.FixedDatetimeDeadline": FixedDatetimeDeadline,
f"{DagRunLogicalDateDeadline.__module__}.DagRunLogicalDateDeadline": DagRunLogicalDateDeadline,
}


@pytest.fixture
def colliding_plugin_registry(monkeypatch):
"""Advertise custom references whose names collide with builtin reference names."""
monkeypatch.setattr(
plugins_manager,
"get_deadline_references_plugins",
lambda: _COLLIDING_REFS,
)
return _COLLIDING_REFS


@pytest.mark.parametrize(
"custom_cls",
[FixedDatetimeDeadline],
)
def test_custom_reference_name_collision_routes_to_custom(colliding_plugin_registry, custom_cls):
"""
A custom reference whose class name collides with a builtin must round-trip as the custom
class, not silently decode as the builtin (which loses the user's evaluation logic or raises
a spurious KeyError on builtin-only fields).

Regression test: ``decode_deadline_reference`` previously routed solely by the
``reference_type`` name string, ignoring the authoritative ``__class_path`` key.
"""
from airflow.serialization.decoders import decode_deadline_reference
from airflow.serialization.encoders import encode_deadline_reference

encoded = encode_deadline_reference(custom_cls())
# The encoder stamps __class_path for custom references regardless of name collision.
assert encoded["__class_path"] == f"{custom_cls.__module__}.{custom_cls.__name__}"

decoded = decode_deadline_reference(encoded)

assert isinstance(decoded, SerializedReferenceModels.SerializedCustomReference)
assert isinstance(decoded.inner_ref, custom_cls)
Loading