Rename misleading last_automated_run param to reference_run#68714
Open
Lee-W wants to merge 1 commit into
Open
Conversation
The calculate_dagrun_date_fields parameter named last_automated_run is not always the latest run: the scheduler passes whichever run it is currently processing, and in a distributed system a newer run can be created concurrently. The name implied a guarantee the callers do not provide. Rename it to reference_run and document that it is the run used as the basis for the next-run calculation, not necessarily the latest. calculate_dagrun_date_fields is an internal scheduler method operating on serialized dags and DB columns, not part of the public interface, so this is not a user-facing breaking change. related: apache#59618
boring-cyborg
Bot
added
area:DAG-processing
area:Scheduler
Lee-W
requested review from
XD-DENG,
ashb,
ephraimbuddy and
jedcunningham
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
DagModel.calculate_dagrun_date_fieldstook a keyword-only param namedlast_automated_run, implying it was always the most recent run.It isn't: the scheduler passes whichever run it is currently processing, and in a distributed setup a newer run can be created concurrently. The name promised a guarantee the callers never provide.
This is a long-standing naming smell — the "last / latest" framing predates the current
DagRunsignature. The partition-driven scheduling work left aTODO ... See #59618flagging it; this PR does that cleanup.Closes: #59618
What
last_automated_run→reference_runonDagModel.calculate_dagrun_date_fields, plus its three in-method references.dag_processing/collection.py,jobs/scheduler_job_runner.py) and the two test callers.No behaviour change — pure rename plus docstring clarification.
Was generative AI tooling used to co-author this PR?
Generated-by: [Claude] following the guidelines
{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.