Skip to content
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

Airflow 2 to 3 auto migration rules #41641

Open
Lee-W opened this issue Aug 21, 2024 · 47 comments
Open

Airflow 2 to 3 auto migration rules #41641

Lee-W opened this issue Aug 21, 2024 · 47 comments
Assignees
Labels
airflow3.0:candidate Potential candidates for Airflow 3.0 area:upgrade Facilitating migration to a newer version of Airflow kind:feature Feature Requests
Milestone

Comments

@Lee-W
Copy link
Member

Lee-W commented Aug 21, 2024

Description

Why

As we're introducing breaking changes to the main branch, it would be better to begin recording the things we could use migration tools to help our users migrate from Airflow 2 to 3.

The breaking changes can be found at https://github.com/apache/airflow/pulls?q=is%3Apr+label%3Aairflow3.0%3Abreaking.

What

List of significant news fragments and rules (by Nov 26)

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@Lee-W Lee-W added kind:feature Feature Requests needs-triage label for new issues that we didn't triage yet airflow3.0:candidate Potential candidates for Airflow 3.0 area:dev-tools area:upgrade Facilitating migration to a newer version of Airflow and removed needs-triage label for new issues that we didn't triage yet area:dev-tools labels Aug 21, 2024
@Lee-W Lee-W added this to the Airflow 3.0.0 milestone Aug 21, 2024
@Lee-W
Copy link
Member Author

Lee-W commented Aug 21, 2024

The Rules now is an example of how these changes can be recorded. I will check the existing breaking changes and update the rules. It would be great if folks could help update this list if you know there are breaking changes.

@potiuk
Copy link
Member

potiuk commented Aug 21, 2024

I pinned the issue - this way it will show up at the top of "Issues" list in the repo

@potiuk
Copy link
Member

potiuk commented Aug 21, 2024

image

@Lee-W
Copy link
Member Author

Lee-W commented Aug 21, 2024

Thanks!

@eladkal
Copy link
Contributor

eladkal commented Aug 24, 2024

We can just go over all the significant newsfragments and create a rule for them or keep some reasoning why it doesn't require one

@kaxil
Copy link
Member

kaxil commented Oct 24, 2024

We should add something for the public API change too. API v1 won't work anymore. Those are being changed as part of AIP-84 to a new FastApi based app. GitHub project for it: https://github.com/orgs/apache/projects/414

@pierrejeambrun
Copy link
Member

Issue here to regroup Rest API breaking changes #43378

@tirkarthi
Copy link
Contributor

I have started prototyping a small package based on LibCST to build a Python 2to3 like tool for Airflow 2to3 that does simple and straight forward replacements. My main motivation was around lot of our users in our Airflow instance using schedule_interval in Airflow 2 that was deprecated and renamed to schedule in Airflow 3. It would require updating thousands of dags manually and some automation could help. This could also help in places with import statements changes .E.g. Task SDK need to be updated from from airflow import DAG to from airflow.sdk import DAG. Something like this could eventually become part of Airflow cli so that users can run airflow migrate /airflow/dags for migration or serve as a starter point for migration. It can update the file in place or show diff. Currently it does the following changes :

Dags

  • schedule_interval -> schedule
  • timetable -> schedule
  • concurrency -> max_active_tasks
  • Removal of unused full_filepath parameter
  • default_view (tree -> grid)

Operators

  • task_concurrency -> max_active_tis_per_dag
  • trigger_rule (none_failed_or_skipped -> none_failed_min_one_success)

Sample file

import datetime

from airflow import DAG
from airflow.decorators import dag, task
from airflow.operators.empty import EmptyOperator
from airflow.timetables.events import EventsTimetable


with DAG(
    dag_id="my_dag_name",
    default_view="tree",
    start_date=datetime.datetime(2021, 1, 1),
    schedule_interval="@daily",
    concurrency=2,
):
    op = EmptyOperator(
        task_id="task", task_concurrency=1, trigger_rule="none_failed_or_skipped"
    )


@dag(
    default_view="graph",
    start_date=datetime.datetime(2021, 1, 1),
    schedule_interval=EventsTimetable(event_dates=[datetime.datetime(2022, 4, 5)]),
    max_active_tasks=2,
    full_filepath="/tmp/test_dag.py"
)
def my_decorated_dag():
    op = EmptyOperator(task_id="task")


my_decorated_dag()

Sample usage

python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 tests/test_dag.py
Calculating full-repo metadata...
Executing codemod...
reformatted -

All done! ✨ 🍰 ✨
1 file reformatted.
--- /home/karthikeyan/stuff/python/libcst-tut/tests/test_dag.py
+++ /home/karthikeyan/stuff/python/libcst-tut/tests/test_dag.py
@@ -10,6 +10,6 @@
     dag_id="my_dag_name",
-    default_view="tree",
+    default_view="grid",
     start_date=datetime.datetime(2021, 1, 1),
-    schedule_interval="@daily",
-    concurrency=2,
+    schedule="@daily",
+    max_active_tasks=2,
 ):
@@ -23,5 +23,4 @@
     start_date=datetime.datetime(2021, 1, 1),
-    schedule_interval=EventsTimetable(event_dates=[datetime.datetime(2022, 4, 5)]),
+    schedule=EventsTimetable(event_dates=[datetime.datetime(2022, 4, 5)]),
     max_active_tasks=2,
-    full_filepath="/tmp/test_dag.py"
 )
Finished codemodding 1 files!
 - Transformed 1 files successfully.
 - Skipped 0 files.
 - Failed to codemod 0 files.
 - 0 warnings were generated.

Repo : https://github.com/tirkarthi/Airflow-2to3

@potiuk
Copy link
Member

potiuk commented Oct 27, 2024

NICE! @tirkarthi -> you should start a thread about it at devlist and propose adding it to the repo. The sooner we start working on it and let poeple test it, the better it will be. And we can already start adding not only the newsfragments but also rules to the migration tools (cc: @vikramkoka @kaxil ) - we can even think about keeping a database of old-way-dags and running such migration tool on them and letting airflow scheduler from Airflow 3 process them (and maybe even execute) as part of our CI. This would tremendously help with maintaining and updating such a tool if we will make it a part of our CI pipeline.

@potiuk
Copy link
Member

potiuk commented Oct 27, 2024

BTW. I like it a lot how simple it is with libCST - we previously used quite a bit more complex tool from Facebook that allowed to do refactoring at scale in parallell (https://github.com/facebookincubator/Bowler) , but it was rather brittle to develop rules for it and it had some weird problems and missing features. One thing that was vere useful - is that it had a nice "parallelism" features - which allowed to refactor 1000s of files in seconds (but also made it difficult to debug).

I think if we get it working with libCST - it will be way more generic and maintainable, also we can easily add parallelism later on when/if we see it is slow.

@potiuk
Copy link
Member

potiuk commented Oct 27, 2024

One small watchout though - such a tool should have a way to isolate rules - so that they are not in a single big method - some abstraction that will allow us to easily develop and selectively apply (or skip) different rules - see https://github.com/apache/airflow/tree/v1-10-test/airflow/upgrade where we have documentation and information about the upgrade check we've done in Airflow 1 -> 2 migration.

Also we have to discuss, whether it should be a separate repo or whether it should be in airflow's monorepo. Both have pros and cons - in 1.10 we chose to keep it 1.10 branch of airflow, because it imported some of the airflow code and it was easier, but we could likely create a new repo for it, add CI there and keep it there.

We even have this archived repo https://github.com/apache/airflow-upgrade-check which we never used and archived, we could re-open it. We also have https://pypi.org/project/apache-airflow-upgrade-check/ - package in PyPI - and we could release new upgrade check versions (2.* ?) with "apache-airflow>=2.11.0" as dependency.

All that should likely be discussed at devlist :)

@tirkarthi
Copy link
Contributor

tirkarthi commented Oct 27, 2024

Thanks @potiuk for the details. I will start a discussion on this at the devlist and continue there. Bowler looks interesting. Using libcst.tool from cli parallelizes the process. Right now this needs python -m libcst.tool to execute it as a codemod. Initially I had designed them as standalone Transformer for each category like (dag, operator) where the updated AST from one transformer can be passed to another. The codemod looked like a recommended abstraction for running it and changed it that way to later find cli accepts only one codemod at a time. I need to check how composable they are.

python -m libcst.tool codemod --help | grep -i -A 1 'jobs JOBS'
  -j JOBS, --jobs JOBS  Number of jobs to use when processing files. Defaults to number of cores

time python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 ~/airflow/dags > /dev/null 2>&1 
python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 ~/airflow/dags >  
6.95s user 0.61s system 410% cpu 1.843 total

# Single core
time python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 -j 1 ~/airflow/dags > /dev/null 2>&1
python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 -j 1  > 
/dev/nul  4.66s user 0.38s system 99% cpu 5.035 total

# 4 core
python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 -j 4 ~/airflow/dags > /dev/null 2>&1
python -m libcst.tool codemod dag_fixer.DagFixerCommand -u 1 -j 4  > 
/dev/nul  5.45s user 0.54s system 253% cpu 2.358 total

@potiuk
Copy link
Member

potiuk commented Oct 27, 2024

Bowler looks interesting.

Don't be deceived by it :).

It was helpful for Provider's migration at some point in time, but I had many rough edges - like debugging a problem was a nightmare until we learned how to do it properly, also it had some annoying limitations - you had to learn a completely new non-standard abstractions (an SQLAlchemy-like DSL to perform modifications) - which did not cover all the refactorings we wanted to do. We had to really dig-deep into the code an find some workarounds for things we wanted to do, when authors of Bowler have not thoght about them. And sometimes those were nasty workarounds.

query = (
    Query(<paths to modify>)
    .select_function("old_name")
    .rename("new_name")
    .diff(interactive=True)
)

Example that I remember above is that we could not rename some of the object types easily because it was not "foreseen" (can't remember exactly) - we had a few surprises there.

Also Bowler seems to be not maintained for > 3 years and it means that it's unlikely to handle some constructs even in 3.9+ Airflow.

What I like about libcst is that it is really "low-level" interface that you have to program in Python rather than in abstract DSL - similar to "ast". You write actual python code to perform what you want to perform rather than rely on incomplete abstractions, even if you have to copy&paste rename code between different "rules" (for example) (which you can then abstract away as 'common` util if you need, so no big deal).

@potiuk
Copy link
Member

potiuk commented Oct 27, 2024

BTW. Codemod .... is also 5 years not maintained. Not that it is disqualification - but they list python2 as their dependency ... so .....

@Lee-W
Copy link
Member Author

Lee-W commented Oct 28, 2024

I tried to use libcst in airflow as a tiny POC of this issue here

. It mostly works great except for its speed. I was also thinking about whether to add these migrations thing info ruff airflow linter but not yet explore much on the rust/ruff side.

@potiuk
Copy link
Member

potiuk commented Oct 28, 2024

👀 👀 rust project :) ...

Me ❤️ it (but I doubt we want to invest in it as it might be difficult to maintain, unless we find quite a few committers who are somewhat ruff profficient to at least be able to review the code) . But it's tempting I must admit.

But to be honest - while I'd love to finally get a serious rust project, it's not worth it I think we are talking of one-time migration for even a 10.000 dags it will take at most single minutes and we can turn it maybe in under one minute with rust - so not a big gain for a lot of pain :) . Or at lest this is what my intuition tells me.

I think parallelism will do the job nicely. My intuition tells me (but this is just intuition and understanding on some limits ans speed of certain operation) - that we will get from multiple 10s of minutes (when running such migration sequentially) to single minutes when we allow to run migration in parallel using multiple processors and processes - even with Python and libcst. This task is really suitable for such parallelisation because each file is complete, independent task that can be run in complete isolation from all other tasks - so spawning multiple paralllel interpreters, ideally forking them right after all the imports and common code is loaded so that they use shared memory for those - this should do the job nicely (at least intuitively).

Using RUST for that might be classic premature optimisation - we might likely not need it :). But would be worth to make some calculations and get some "numbers" for big installation - i.e. how many dags of what size are out there, and how long it will be to parse them all with libcst and write back (even unmodified or with a simple modification). I presume that parsing and writing back will be the bulk of the job - and modifications will add very little overhead as they will be mostly operating on in memory data structures.

@Lee-W
Copy link
Member Author

Lee-W commented Oct 30, 2024

Me ❤️ it (but I doubt we want to invest in it as it might be difficult to maintain, unless we find quite a few committers who are somewhat ruff profficient to at least be able to review the code) . But it's tempting I must admit.

But to be honest - while I'd love to finally get a serious rust project, it's not worth it I think we are talking of one-time migration for even a 10.000 dags it will take at most single minutes and we can turn it maybe in under one minute with rust - so not a big gain for a lot of pain :) . Or at lest this is what my intuition tells me.

Yep, totally agree. I just want to raise this idea which might be interesting. 👀

I presume that parsing and writing back will be the bulk of the job - and modifications will add very little overhead as they will be mostly operating on in memory data structures.

Yep, I think you're right. My previous default deferrable script took around 10 sec to process ~400 operators. Using ast for checking took around 1 sec

@Lee-W
Copy link
Member Author

Lee-W commented Nov 14, 2024

Mostly as curiosity: One option we might consider is https://github.com/alexpovel/srgn - I've heard about it recently, it's a "grep that understands code" with capabilities of running different actions. Written in rust, and allows to add extensions apparently where you can define your own "scopes" of search and modification.

But I am not too convinced - this is mostly a command line tool so we would have to have a sequence of "script commands" to run - seems that plugging in our own rules and AST parsing should also be more flexible, even if slower.

Yep, not that convinced either. but it is always good to have an alternative we could consider 🤔

@uranusjr
Copy link
Member

My best idea right now is to split this into two tools. We don’t really want to invest too much time into building a very rich CLI tool to show users what need to be changed—we’ll effectively be rebuilding the error reporting interface in ruff (or flake8). Those squiggle lines, colors, error codes, and code context things are not easy to build.

It is probably easiest to tack the linter part on Ruff—it is Rust, but the code to implement a lint rule isn’t that hard if you know Python AST and just a general idea about C-like languages. The rewrite part is a lot more difficult, so it’s probably better to implement this as a different tool in Python with libcst. I’m thinking something like

$ ruff check --select AIR
This spits out lint errors with codes like AIR005 AIR123...

$ airflow2to3 --select AIR005 -- path/to/dag/file.py
This fixes the given error(s) in given file(s) in-place with a minimal CLI...

I plan to start experiementing some rules in Ruff to see how easy the first part actually is. We should be able to save a lot of effort if it is viable.

@Lee-W
Copy link
Member Author

Lee-W commented Nov 18, 2024

I tried to change the format a bit and list the rules in the following format.

* [ ] link to the pr with breaking change
    * [ ] things to do

Once the things to do have been listed, we can check the root pr. After implementing the rule, we can mark the things to do as done.

I also updated the format for #41366, #41367, #41368, #41391, #41393

If anyone has anything to add but do not have permission to update the description. Please just tag me and I'll take a look

@potiuk
Copy link
Member

potiuk commented Nov 19, 2024

It is probably easiest to tack the linter part on Ruff—it is Rust, but the code to implement a lint rule isn’t that hard if you know Python AST and just a general idea about C-like languages. The rewrite part is a lot more difficult, so it’s probably better to implement this as a different tool in Python with libcst. I’m thinking something like

Actually I am convinced too - I quite like this one after a bit of thought. This is not something that might be maintained by a lot of people and a number of contributors, and even for them, this is so far from the main "airflow code" - it's really a "one-time" tool - that it might be worth treating it as our first "rust experiment". And I quite agree that, the AST code on it's own is not really that "pythonic" and if you know what you want, and have already existing examples, adding a new rule in RUST, should not be difficult even if you do not know it (and AI driven development here might be even pretty cool exercise). I'd myself be happy to add a few rules at some point of time and maybe even take part in implementing the tooling for rust for our CI environment.

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

The things we'll need to migrate for 41348

  • Rename dataset related python variable names to asset #41348
    • module airflow.datasets -> airflow.sdk.definitions.asset
      • class DatasetAlias -> AssetAlias
      • class DatasetAll -> AssetAll
      • class DatasetAny -> AssetAny
      • function expand_alias_to_datasets -> expand_alias_to_assets
      • class DatasetAliasEvent -> AssetAliasEvent
        • attribute dest_dataset_uri -> BaseAsset
      • class BaseDataset -> BaseAsset
        • method iter_datasets -> iter_assets
        • method iter_dataset_aliases -> iter_asset_aliases
      • class Dataset -> Asset
        • method iter_datasets -> iter_assets
        • method iter_dataset_aliases -> iter_asset_aliases
      • class _DatasetBooleanCondition -> _AssetBooleanCondition
        • method iter_datasets -> iter_assets
        • method iter_dataset_aliases -> iter_asset_aliases
    • module airflow.datasets.managerairflow.assets.manager
      • variable dataset_managerasset_manager
      • function resolve_dataset_managerresolve_asset_manager
      • class DatasetManagerAssetManager
        • method register_dataset_changeregister_asset_change
        • method create_datasetscreate_assets
        • method register_dataset_changenotify_asset_created
        • method notify_dataset_changednotify_asset_changed
        • method notify_dataset_alias_creatednotify_asset_alias_created
    • module airflow.listeners.spec.datasetairflow.listeners.spec.asset
      • function on_dataset_createdon_asset_created
      • function on_dataset_changedon_asset_changed
    • module airflow.timetables.datasetsairflow.timetables.assets
      • class DatasetOrTimeScheduleAssetOrTimeSchedule
    • module airflow.datasets.metadataairflow.sdk.definitions.asset.metadata
    • module airflow.listeners.spec.datasetairflow.listeners.spec.asset
      • function on_dataset_createdon_asset_created
      • function on_dataset_changedon_asset_changed
    • class airflow.timetables.datasets.DatasetOrTimeScheduleairflow.timetables.assets.AssetOrTimeSchedule
    • decorator airflow.api_connexion.security.requires_access_datasetairflow.api_connexion.security.requires_access_dataset.requires_access_asset
    • class airflow.auth.managers.models.resource_details.DatasetDetails → `airflow.auth.managers.models.resource_details.AssetDetails
    • function airflow.auth.managers.base_auth_manager.is_authorized_datasetairflow.auth.managers.base_auth_manager.is_authorized_asset
    • class airflow.timetables.simple.DatasetTriggeredTimetableairflow.timetables.simple.AssetTriggeredTimetable
    • in class airflow.providers_manager.ProvidersManager
      • method initialize_providers_dataset_uri_resourcesinitialize_providers_asset_uri_resources
      • property dataset_factoriesasset_factories
      • property dataset_uri_handlersasset_uri_handlers
      • property dataset_to_openlineage_convertersasset_to_openlineage_converters
    • constant airflow.security.permissions.RESOURCE_DATASETairflow.security.permissions.RESOURCE_ASSET
    • function airflow.www.auth.has_access_datasetairflow.www.auth.has_access_dataset.has_access_asset
    • class airflow.lineage.hook.DatasetLineageInfoairflow.lineage.hook.AssetLineageInfo
      • attribute datasetasset
    • In class airflow.lineage.hook.HookLineageCollector
      • method create_datasetcreate_asset
      • method add_input_datasetadd_input_asset
      • method add_output_datasetadd_output_asset
      • method collected_datasetscollected_assets
    • context key triggering_dataset_eventstriggering_asset_events
    • In amazon provider
      • package airflow.providers.amazon.aws.datasetsairflow.providers.amazon.aws.assets
        • in module s3
          • method create_datasetcreate_asset
          • method convert_dataset_to_openlineageconvert_asset_to_openlineage
      • attribute airflow.providers.amazon.auth_manager.avp.entities.AvpEntities.DATASETairflow.providers.amazon.auth_manager.avp.entities.AvpEntities.ASSET
      • method airflow.providers.amazon.auth_manager.aws_auth_manager.AwsAuthManager.is_authorized_datasetairflow.providers.amazon.auth_manager.aws_auth_manager.AwsAuthManager.is_authorized_asset
      • resource key dataset-urisasset-uris
    • In Common IO Provider
      • package airflow.providers.common.io.datasetsairflow.providers.common.io.assets
        • in module file
          • method create_datasetcreate_asset
          • method convert_dataset_to_openlineageconvert_asset_to_openlineage
      • resource key dataset-urisasset-uris
    • In fab provider
      • function airflow.providers.fab.auth_manager.fab_auth_manager.is_authorized_datasetairflow.providers.fab.auth_manager.fab_auth_manager.is_authorized_asset
    • In openlineage provider
      • in module airflow.providers.openlineage.utils.utils
        • class DatasetInfoAssetInfo
        • function translate_airflow_datasettranslate_airflow_asset
    • In postgres provider
      • package airflow.providers.postgres.datasetsairflow.providers.postgres.assets
      • resource key dataset-urisasset-uris
    • In mysql provider
      • package airflow.providers.mysql.datasetsairflow.providers.mysql.assets
      • resource key dataset-urisasset-uris
    • In trino provider
      • package airflow.providers.trino.datasetsairflow.providers.trino.assets
      • resource key dataset-urisasset-uris
    • ❌ ignored
      • airflow.api_connexion.schemas.dataset_schema
      • airflow.api_ui.views.datasets
      • airflow.serialization.pydantic.dataset
      • airflow.serialization.pydantic.taskinstance
      • airflow.serialization.enums.DagAttributeTypes
      • airflow.serialization.serialized_objects
      • airflow.utils.context
      • models
      • DagDependency names
      • private methods

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

Hi all, I'm trying to read through the significant news fragment and compile a list of rules we should migrate. It would be nice if you could take a look and check if I missed anything.

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

@kaxil @ashb would also like to confirm whether we're still allowing users to use models in airflow 3.0? If not, should we just skip all the changes related to models. Thanks

@uranusjr
Copy link
Member

I tried my hands on implementing a rule in Ruff. This one checks if a DAG uses the schedule argument explicitly, and errors if there’s no such argument (i.e. user is relying on the implicit default, which changes in 3.0), or a deprecated argument is used.

Does this look reasonable enough for people to build on? I’ll produce a more detailed writeup of what to do if we feel this is the way to go.

https://github.com/uranusjr/ruff/pull/1/files

@ashb
Copy link
Member

ashb commented Nov 19, 2024

@kaxil @ashb would also like to confirm whether we're still allowing users to use models in airflow 3.0? If not, should we just skip all the changes related to models. Thanks

Which models? But no, the plan is to not have/"allow" users to import anything from airflow.models at all. Exact details and new names are to be determined yet though

@kaxil
Copy link
Member

kaxil commented Nov 19, 2024

@kaxil
#41390
#41393
#41390

Duplicate entries for SubDAGs

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

@kaxil
#41390
#41393
#41390

Duplicate entries for SubDAGs

oops, just fixed!

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

@kaxil @ashb would also like to confirm whether we're still allowing users to use models in airflow 3.0? If not, should we just skip all the changes related to models. Thanks

Which models? But no, the plan is to not have/"allow" users to import anything from airflow.models at all. Exact details and new names are to be determined yet though

Pretty much every model 👀 Sounds good. Just want to confirm I'm not misunderstanding anything. I'll just mark it as model change and not going to migrate for now till we have anything decided

@Lee-W
Copy link
Member Author

Lee-W commented Nov 19, 2024

@Lee-W There are few rules that we should add for Airflow configs too since we changed /removed them:

* [Standardize timer metrics to milliseconds and remove config #43975](https://github.com/apache/airflow/pull/43975)

* [Remove XCom pickling #43905](https://github.com/apache/airflow/pull/43905)

and some imports which won't work:

* [Remove deprecations from `airflow.executors` & `airflow.utils` #41395](https://github.com/apache/airflow/pull/41395)

* [Remove deprecated `ExternalTaskSensorLink` #41391](https://github.com/apache/airflow/pull/41391)

* [Remove the ability to import executors from plugins #43289](https://github.com/apache/airflow/pull/43289)

* [Remove redundant functions in `airflow.utils.dates` #43533](https://github.com/apache/airflow/pull/43533)

* [Remove deprecated Python Version identifiers #43562](https://github.com/apache/airflow/pull/43562)

* [Remove deprecated functions from `airflow/configuration.py` #43530](https://github.com/apache/airflow/pull/43530)

Thanks for reminding me! I'm still halfway to completing reading all the PRs. Will continue work on updating the list

@vikramkoka
Copy link
Contributor

Awesome @Lee-W , I hadn't seen this issue, so great to see the progress here.
Following up on the action item from the last dev call, I created this page on Confluence as a draft
https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+3+breaking+changes

@Lee-W
Copy link
Member Author

Lee-W commented Nov 20, 2024

Awesome @Lee-W , I hadn't seen this issue, so great to see the progress here. Following up on the action item from the last dev call, I created this page on Confluence as a draft https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+3+breaking+changes

Looks great! I'll try to update both places

@uranusjr
Copy link
Member

I also played around the fixer implementation a bit: https://github.com/uranusjr/airflow2to3

Still a lot of room for improvement, but I think it is a good starting point.

FWIW I also tried to create a Flake8 plugin for comparison, but got stuck resolving imports (we need to check whether a thing is actually from Airflow first to decide whether to emit errors for it). Flake8 does not seem to provide this out of the box (Ruff and LibCST each has an easy solution). I’m pretty sure there must be a solution, but the effort looking into this is probably not worthwhile unless we feel Ruff is too big a hurdle.

@uranusjr
Copy link
Member

So what do people think about using Ruff for linting? This is somewhat important since we want to encourage community help to implement rules. If people don’t have strong opinions, I’ll start a lazy consensus thread in the mailing list to get a resolution.

@Lee-W
Copy link
Member Author

Lee-W commented Nov 21, 2024

Finally finishing checking all the significant before #44080 (except for the one @sunank200 's not working on).

I tried my best to list down the migration as possible, but it would be nice if folks can take another look to see if I miss anything. Thanks!

@bugraoz93
Copy link
Collaborator

Thanks for preparing this Lee-W!

For #43102, we can only detect the changes with Ruff if users send requests to PATCH API endpoints from the Airflow code.
@pierrejeambrun What do you think?

@Lee-W
Copy link
Member Author

Lee-W commented Nov 22, 2024

Thanks for preparing this Lee-W!

For #43102, we can only detect the changes with Ruff if users send requests to PATCH API endpoints from the Airflow code. @pierrejeambrun What do you think?

But one of the questions is how we will detect it 🤔 there are plenty of ways to send a request to an API.

@bugraoz93
Copy link
Collaborator

There is no straightforward way to do it. Indeed, it can be even a standalone application communicating with the Airflow API without other interactions. It could be even in different programming languages such as go or scheduled/management bash scripts in CI.

@vincbeck
Copy link
Contributor

I am not sure #42042. I moved out one property from BaseUser but I dont users are using this class directly.

@potiuk
Copy link
Member

potiuk commented Nov 22, 2024

There is no straightforward way to do it. Indeed, it can be even a standalone application communicating with the Airflow API without other interactions. It could be even in different programming languages such as go or scheduled/management bash scripts in CI.

I think we can only do it reasonably well if we assume the user uses Python Cliant of ours and then we should be able to say the users they could run their custom code through Ruff with the new python client installed to detect wrong parameters. Not sure if we need to have custom ruff rules for those changes, or maybe it's "mypy" kind of check for types ? I know astral works on a mypy replacement as well, so there is a chance that we will get mypy checks from Astral befor we publish the tool (or we could use mypy for now if needed. Some quick check on new/old client with some test code for that might be useful.

For the rest of the clients, I think what we could also do - potentially - is to have a custom error code in fast API - where we wil handle errors generated when "known old-style requests" are issued to the new API and return pretty descriptive error " You are using old-style API ble, ble, ble ... you need to change your paremeters to .... ." - maybe we can generalize it in our API in the way to handle "typical" mistakes from multiple APIs by the same error handler?

@bugraoz93
Copy link
Collaborator

I think we can only do it reasonably well if we assume the user uses Python Cliant of ours and then we should be able to say the users they could run their custom code through Ruff with the new python client installed to detect wrong parameters. Not sure if we need to have custom ruff rules for those changes, or maybe it's "mypy" kind of check for types ? I know astral works on a mypy replacement as well, so there is a chance that we will get mypy checks from Astral befor we publish the tool (or we could use mypy for now if needed. Some quick check on new/old client with some test code for that might be useful.

I agree, we should make this assumption and limit the check to a reasonable scope. I like the idea of restricting it so that only our Python Client will be affected. Otherwise, it could turn into a project of its own. :)

For the rest of the clients, I think what we could also do - potentially - is to have a custom error code in fast API - where we wil handle errors generated when "known old-style requests" are issued to the new API and return pretty descriptive error " You are using old-style API ble, ble, ble ... you need to change your paremeters to .... ." - maybe we can generalize it in our API in the way to handle "typical" mistakes from multiple APIs by the same error handler?

I was considering a similar approach, returning an error response if the old request is provided but I wasn’t entirely sure about the scope. If the goal is to catch these issues before upgrading the version, I am unsure how we can easily provide that. Simply reading the API changes documentation seems easier than creating a transition API and asking users to route calls through it to catch errors. Otherwise, such responses would indicate that their processes have already failed with an error.
If the goal is also to warn users after upgrading the version, then this is the way to go for me too.
I am just trying to better understand the scope of when and how we want to warn users.

@potiuk
Copy link
Member

potiuk commented Nov 24, 2024

I was considering a similar approach, returning an error response if the old request is provided but I wasn’t entirely sure
about the scope.

Yeah. Maybe we can do something in Airlfow 2.11 ? Since our goal is that 2.11 should be the "bridge" release - maybe we could do a variation of my original proposal - see if the message coming is in "old" format and raise a deprecation and also manually implement "new" format there (that would likely require some manual modificaiton of the openapi specification there and some conditional code in 2.11 (if possible).

That could follow our pattern of "Make sure 2.11 raises no warnings and then migration to 3 should be smooth".

@pierrejeambrun
Copy link
Member

For the rest of the clients, I think what we could also do - potentially - is to have a custom error code in fast API - where we wil handle errors generated when "known old-style requests" are issued to the new API and return pretty descriptive error " You are using old-style API ble, ble, ble ... you need to change your paremeters to .... ." - maybe we can generalize it in our API in the way to handle "typical" mistakes from multiple APIs by the same error handler?

Indeed upgrading the client will automatically highlights type errors in users code.

For people bypassing the python client and making direct request to the API (or any other non-python system), we can indeed catch errors of such breaking change and return a clear message that this is not accepted anymore, and maybe even better give them the new way of how to achieve this. It's just more work but possible.

Otherwise reading the significant newsfragment for the RestAPI would be a good start when migrating their API code.

@potiuk
Copy link
Member

potiuk commented Nov 26, 2024

For people bypassing the python client and making direct request to the API (or any other non-python system), we can indeed catch errors of such breaking change and return a clear message that this is not accepted anymore, and maybe even better give them the new way of how to achieve this. It's just more work but possible.

Just to repeat above - yes. I think it's more work, and I think it might require some nasty workarounds in FAST API that we will have to keep forever, but maybe we can do a 2.11-only change that will raise warnings if the old way is used instead (and allow to use new way) ? Not sure if possible and how many such breaking channges we will have, but it would really be nice to tell the users "if you have no warnings on 2.11, you are good to go".

@Lee-W
Copy link
Member Author

Lee-W commented Nov 26, 2024

I am not sure #42042. I moved out one property from BaseUser but I dont users are using this class directly.

After reading it again, I don't think users are using it either. 🤔 Then I'll just remove it. Thanks for checking it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
airflow3.0:candidate Potential candidates for Airflow 3.0 area:upgrade Facilitating migration to a newer version of Airflow kind:feature Feature Requests
Projects
None yet
Development

No branches or pull requests