Add name fields to deadline alerts by imrichardwu · Pull Request #64926 · apache/airflow

imrichardwu · 2026-04-08T20:50:10Z

Adds name and description fields to DeadlineAlert, exposed through the API. (json edited files are for ui change for my pr in the future) @bbovenzi

Was generative AI tooling used to co-author this PR?

Yes (please specify the tool below)

Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
When adding dependency, check compliance with the ASF 3rd Party License Policy.
For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

Updated deadline alert messages for clarity and consistency.

bbovenzi

Let's remove the i18n json and browse tab changes. Those are better to stay with their UI branches.

Also, given that we made the interval + reference more readable in your other PR. I feel like description is no longer necessary. Let's just do name

providers/common/ai/src/airflow/providers/common/ai/plugins/www/__init__.py

airflow-core/src/airflow/ui/public/i18n/locales/en/browse.json

airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts

Copilot

Pull request overview

Propagates DeadlineAlert.name through SDK/core serialization into the metadata DB and adjusts the UI API/OpenAPI shapes for deadline-related responses.

Changes:

Add optional name to the Task SDK DeadlineAlert and include it in core serialization encode/decode.
Persist name into DeadlineAlert DB rows when creating alerts from serialized DAG data, and update name when reusing existing deadline UUIDs.
Remove description / alert_description from the UI API models and the generated UI OpenAPI client types; add Deadlines to the UI MenuItem enum.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
task-sdk/src/airflow/sdk/definitions/deadline.py	Adds optional `name` to SDK `DeadlineAlert`.
airflow-core/src/airflow/serialization/encoders.py	Emits `name` in serialized deadline alert payloads.
airflow-core/src/airflow/serialization/decoders.py	Parses `name` from serialized deadline alert payloads.
airflow-core/src/airflow/serialization/definitions/deadline.py	Adds field constant + `name` to `SerializedDeadlineAlert`.
airflow-core/src/airflow/models/serialized_dag.py	Writes/updates `DeadlineAlertModel.name` when persisting serialized DAGs.
airflow-core/src/airflow/api_fastapi/core_api/datamodels/ui/deadline.py	Removes `description` fields from UI API response models.
airflow-core/src/airflow/api_fastapi/common/types.py	Adds `DEADLINES` to `MenuItem`.
airflow-core/src/airflow/api_fastapi/core_api/openapi/_private_ui.yaml	Removes description fields from schemas; adds `Deadlines` to menu enum.
airflow-core/src/airflow/ui/openapi-gen/requests/types.gen.ts	Regenerated client types (drops description fields; adds `Deadlines`).
airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts	Regenerated client schemas (drops description fields; adds `Deadlines`).
airflow-core/tests/unit/models/test_deadline_alert.py	Removes assertions/data for `description`.
airflow-core/tests/unit/api_fastapi/core_api/routes/ui/test_deadlines.py	Removes `alert_description` assertions and related test naming/docs.

Comments suppressed due to low confidence (1)

airflow-core/src/airflow/serialization/encoders.py:218

encode_deadline_alert() uses a literal "name" key while the decoder and other call sites use DeadlineAlertFields.NAME. For consistency and to avoid drift/typos, consider using DeadlineAlertFields.NAME here as well.

    from airflow.sdk.serde import serialize

    return {
        "name": getattr(d, "name", None),
        "reference": encode_deadline_reference(d.reference),
        "interval": d.interval.total_seconds(),
        "callback": serialize(d.callback),
    }

Copilot · 2026-04-10T20:01:26Z

airflow-core/src/airflow/api_fastapi/core_api/datamodels/ui/deadline.py

 class DeadlineAlertResponse(BaseModel):
    """DeadlineAlert serializer for responses."""

    id: UUID
    name: str | None = None
-    description: str | None = None
    reference_type: str = Field(validation_alias=AliasPath("reference", "reference_type"))
    interval: float = Field(description="Interval in seconds between deadline evaluations.")


PR description says the API will expose both name and description on DeadlineAlert, but this change removes description from the UI API response models (and corresponding OpenAPI). Either update the PR description to match the actual behavior, or reintroduce description in the response models/OpenAPI if it should remain supported.

Copilot · 2026-04-10T20:01:26Z

airflow-core/src/airflow/models/serialized_dag.py

                if deadline_uuid_mapping is not None:
                    # All deadlines matched — reuse the UUIDs to preserve hash.
-                    # Clear the mapping since the alert rows already exist in the DB;
-                    # no need to delete and recreate identical records.
+                    # Update name in case it changed (it doesn't affect the definition
+                    # match or the hash, so existing rows won't be recreated, but it
+                    # must stay current in the DB).
+                    for uuid_str, deadline_data in deadline_uuid_mapping.items():
+                        session.execute(
+                            update(DeadlineAlertModel)
+                            .where(DeadlineAlertModel.id == UUID(uuid_str))
+                            .values(
+                                name=deadline_data.get(DeadlineAlertFields.NAME),
+                            )
+                        )
                    dag.data["dag"]["deadline"] = existing_deadline_uuids


This block executes UPDATE deadline_alert SET name=... even when the serialized DAG hash is unchanged, but write_dag() can still return False later (meaning "not written"). That makes the return value misleading and can hide that a DB write occurred; consider tracking whether any name updates were applied and returning True (or adjusting the control flow/docstring accordingly).

Copilot · 2026-04-10T20:01:27Z

airflow-core/src/airflow/models/serialized_dag.py

                if deadline_uuid_mapping is not None:
                    # All deadlines matched — reuse the UUIDs to preserve hash.
-                    # Clear the mapping since the alert rows already exist in the DB;
-                    # no need to delete and recreate identical records.
+                    # Update name in case it changed (it doesn't affect the definition
+                    # match or the hash, so existing rows won't be recreated, but it
+                    # must stay current in the DB).
+                    for uuid_str, deadline_data in deadline_uuid_mapping.items():
+                        session.execute(
+                            update(DeadlineAlertModel)
+                            .where(DeadlineAlertModel.id == UUID(uuid_str))
+                            .values(
+                                name=deadline_data.get(DeadlineAlertFields.NAME),
+                            )
+                        )


New behavior: when deadline UUIDs are reused, write_dag() now updates DeadlineAlertModel.name even if the serialized DAG hash doesn't change. There doesn't appear to be a unit test covering this path (e.g., name changes while reference/interval/callback stay the same), so a regression test should be added to ensure the DB row is updated and the returned value/side-effects are as expected.

Add deadlines support with name and description fields in alerts and UI

a97a38f

imrichardwu requested review from XD-DENG, amoghrajesh, ashb, bbovenzi, bolkedebruin, bugraoz93, choo121600, ephraimbuddy, gopidesupavan, guan404ming, jason810496, kaxil, pierrejeambrun, rawwar, ryanahamilton, shubhamraj-git and vatsrahul1001 as code owners April 8, 2026 20:50

boring-cyborg bot added area:API Airflow's REST/HTTP API area:DAG-processing area:deadline-alerts AIP-86 (former AIP-57) area:providers area:task-sdk area:translations area:UI Related to UI/UX. For Frontend Developers. provider:common-ai translation:default labels Apr 8, 2026

imrichardwu added 3 commits April 8, 2026 14:54

Merge branch 'main' into deadlines-serialization

7b8cc7b

Add 'viewAll' label to deadlineStatus in dag.json

b3681f2

Refactor deadlineAlerts referenceType structure

5307580

imrichardwu added 3 commits April 8, 2026 16:32

Refine deadline alert translations in dag.json

f83fce1

Updated deadline alert messages for clarity and consistency.

Add completion rule text for deadline alerts in UI

9d42a53

Remove duplicate completionRule entry in deadlineAlerts

b2c6dbb

bbovenzi reviewed Apr 9, 2026

View reviewed changes

providers/common/ai/src/airflow/providers/common/ai/plugins/www/__init__.py Outdated Show resolved Hide resolved

airflow-core/src/airflow/ui/public/i18n/locales/en/browse.json Show resolved Hide resolved

airflow-core/src/airflow/ui/openapi-gen/requests/schemas.gen.ts Show resolved Hide resolved

imrichardwu added 2 commits April 9, 2026 10:10

Merge branch 'main' into deadlines-serialization

174e745

Remove alert description from DeadlineAlert and related models

c71372f

imrichardwu requested a review from bbovenzi April 9, 2026 16:41

imrichardwu changed the title ~~Add name and description fields to deadline alerts~~ Add name fields to deadline alerts Apr 9, 2026

imrichardwu mentioned this pull request Apr 9, 2026

Dag Run and Overview Tab Display Deadlines #62195

Open

1 task

kaxil requested a review from Copilot April 10, 2026 19:55

Copilot AI reviewed Apr 10, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add name fields to deadline alerts#64926

Add name fields to deadline alerts#64926
imrichardwu wants to merge 9 commits intoapache:mainfrom
imrichardwu:deadlines-serialization

imrichardwu commented Apr 8, 2026 •

edited

Loading

Uh oh!

bbovenzi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Copilot AI Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

imrichardwu commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Was generative AI tooling used to co-author this PR?

Uh oh!

bbovenzi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

imrichardwu commented Apr 8, 2026 •

edited

Loading