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

Bug Fix - S3DeleteObjectsOperator will try and delete all keys #21458

Merged
merged 9 commits into from
Feb 26, 2022

Conversation

njrs92
Copy link
Contributor

@njrs92 njrs92 commented Feb 9, 2022

There is a bug when an empty list is passed into S3DeleteObjectsOperator from another task it will try and deleted all keys on the bucket. While the intent of passing in an empty prefix might be to delete all keys, the intent of passing in a empty keys list would be to delete no keys.

This is because I assume templating does something with init so the check for this condition is not run.

The case is:
In line 379 because keys is an empty list it is false so keys is now assigned the return values from list_keys which when passed no prefix will return all keys.

The change is to move the xor check of keys or prefix is inside the execute function to ensure it is checked at run time

If a templated rendered empty list of key is passed into S3DeleteObjectsOperator
without any prefix it will deleted everything on the bucket
@boring-cyborg boring-cyborg bot added area:providers provider:amazon-aws AWS/Amazon - related issues labels Feb 9, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Feb 9, 2022

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. Good call. Could you please add a unit test covering it ?

I also think the test should remain in the init as well.. passing both key and prefix at init should fail dag parsing (fail as early as possible when the input parameters are wrong).

@josh-fell
Copy link
Contributor

This is because I assume templating does something with init so the check for this condition is not run.

@njrs92 For some context here, the values of XComArgs or templated/Jinja expressions aren't evaluated until the execute() method of an operator so the eval in the __init__() would be a false-positive in the use case you describe.

@potiuk
Copy link
Member

potiuk commented Feb 15, 2022

Hello - how about the unit test :) ? I'd love to merge that one.

@njrs92
Copy link
Contributor Author

njrs92 commented Feb 17, 2022

Sorry got a bit distracted working on other stuff. I will commit the unit tests shortly

@njrs92
Copy link
Contributor Author

njrs92 commented Feb 17, 2022

Sorry my line endings messed up the diff and there is a bunch of unrelated changes that got committed accidentally.

@njrs92 njrs92 force-pushed the S3DeleteObjectsOperator-bug-fix branch from 63facef to 44a5027 Compare February 18, 2022 00:31
stevensnicholas and others added 5 commits February 18, 2022 11:34
.
Add unit tests, check for nonetype

Missed fix in __init__
@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Feb 26, 2022
@potiuk potiuk merged commit f0b6398 into apache:main Feb 26, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Feb 26, 2022

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers okay to merge It's ok to merge this PR as it does not require more tests provider:amazon-aws AWS/Amazon - related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants