[airflow] Avoid implicit DAG schedule (AIR301)#14581
Merged
MichaReiser merged 5 commits intoastral-sh:mainfrom Nov 26, 2024
Merged
[airflow] Avoid implicit DAG schedule (AIR301)#14581MichaReiser merged 5 commits intoastral-sh:mainfrom
MichaReiser merged 5 commits intoastral-sh:mainfrom
Conversation
Airflow 3.0 changes the default of the 'schedule' argument. This causes incompatibility if a DAG previously does not specify a schedule explicitly. This is against best practice anyway---you should always prefer to set a schedule explicitly. Due to backward compatibility, Airflow 2 also possesses multiple arguments to set the schedule. These are all being combined into 'schedule' in 3.0. Usages of those old arguments are also detected.
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| AIR301 | 35 | 35 | 0 | 0 | 0 |
MichaReiser
reviewed
Nov 25, 2024
Member
MichaReiser
left a comment
There was a problem hiding this comment.
This overall looks good to me, but I think we have to figure out the right scoping for all the Airflow3 deprecation rules.
crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs
Outdated
Show resolved
Hide resolved
Comment on lines
+15
to
+16
| /// almost never what a user is looking for. Airflow 3 changes this the default | ||
| /// to *None*, and would break existing DAGs using the implicit default. |
Member
There was a problem hiding this comment.
Can we tell a bit more about how it breaks existing DAGS that use the implicit default. Will it fail with an exception or is it just that the default is different?
Contributor
Author
There was a problem hiding this comment.
Just the default is different—your DAGs will simply stop doing anything silently. I’ll add a paragraph to call this out.
crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/airflow/rules/dag_schedule_argument.rs
Outdated
Show resolved
Hide resolved
4e33f61 to
7745a16
Compare
MichaReiser
approved these changes
Nov 26, 2024
Member
MichaReiser
left a comment
There was a problem hiding this comment.
This is great. Thank you :)
This was referenced Nov 29, 2024
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.
Summary
Airflow 3.0 changes the default of the 'schedule' argument. This causes incompatibility if a DAG previously does not specify a schedule explicitly. This is against best practice anyway---you should always prefer to set a schedule explicitly.
Due to backward compatibility, Airflow 2 also possesses multiple arguments to set the schedule. These are all being combined into 'schedule' in 3.0. Usages of those old arguments are also detected.
Test Plan
A test fixture has been included for the rule.