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

Prevent assignment of non JSON serializable values to DagRun.conf dict #35096

Merged
merged 13 commits into from Nov 14, 2023

Conversation

PashkPashk
Copy link
Contributor

Closes #35095

ConfDict class added, conf attribute updated
Error description fixed
back to previous annotation
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 20, 2023

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 (ruff, 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.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    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
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

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

This looks good. Thanks for the contribution.

I was thinging (but have no strong opinion) as whether it makes sense to extract this to a utility, but keeping it here might be acceptable.

Can you please add a unit test for the new code which validates a positive and negative case as well?

@eladkal eladkal added this to the Airflow 2.7.3 milestone Oct 21, 2023
@eladkal eladkal added the type:bug-fix Changelog: Bug Fixes label Oct 21, 2023
@eladkal
Copy link
Contributor

eladkal commented Oct 21, 2023

Can you please add a unit test for the new code which validates a positive and negative case as well?

yes unit test is required here

airflow/models/dagrun.py Outdated Show resolved Hide resolved
airflow/models/dagrun.py Outdated Show resolved Hide resolved
airflow/models/dagrun.py Outdated Show resolved Hide resolved
conf fixed
@PashkPashk
Copy link
Contributor Author

This looks good. Thanks for the contribution.

I was thinging (but have no strong opinion) as whether it makes sense to extract this to a utility, but keeping it here might be acceptable.

Can you please add a unit test for the new code which validates a positive and negative case as well?

Could you, please, advise me where I should add this test?

class TestDAGRunSchema(TestDAGRunBase):

This module?

@jscheffl
Copy link
Contributor

This looks good. Thanks for the contribution.
I was thinging (but have no strong opinion) as whether it makes sense to extract this to a utility, but keeping it here might be acceptable.
Can you please add a unit test for the new code which validates a positive and negative case as well?

Could you, please, advise me where I should add this test?

If you implement code in airflow/models/dagrun.py then associated tests should be in tests/models/test_dagrun.py.

Exception description fixed
Error fixed
@jscheffl
Copy link
Contributor

There are some (simple) static code check problems. Before making an approval review I'd like see them fixed. But "okay" from my side. I am not an expert in sqlachemy so I am a bit afraid from the previous review comment from @uranusjr - can you maybe double check this? Of course we need to prevent a migration for this.

hybrid_property for column conf has been added
declared_attr added
@PashkPashk
Copy link
Contributor Author

PashkPashk commented Nov 8, 2023

I’ve been mistaken about hybrid_property, cause it doesn’t work correctly with mypy, should be using declared_attr instead.
I'm also not really sure how to deal with test_serialize check in test_dag_run_schema, so I've added some to the init function within the last commit.
Should be ok now.

@jscheffl
Copy link
Contributor

jscheffl commented Nov 8, 2023

Just small glitches in static code checks. If you remove them I assume it is good to get it merged.

Docstring Content Issue fixed
Codestyle fixed
@jscheffl
Copy link
Contributor

Still no luck with static checks, can you take a look here? Actually it just seems you need to run it once and commit the changed applied from ruff: https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst

trailing whitespace removed
line break added
@PashkPashk
Copy link
Contributor Author

PashkPashk commented Nov 14, 2023

@jscheffl
Oops, I thought it has been applied automatically.
Fixed, I hope will work this time

@jscheffl jscheffl merged commit 84c40a7 into apache:main Nov 14, 2023
46 checks passed
Copy link

boring-cyborg bot commented Nov 14, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

ephraimbuddy added a commit to astronomer/airflow that referenced this pull request Nov 29, 2023
ephraimbuddy added a commit that referenced this pull request Nov 29, 2023
ephraimbuddy added a commit that referenced this pull request Dec 5, 2023
…conf dict (#35096)" (#35959)

This reverts commit 84c40a7.

(cherry picked from commit 4a7c746)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Assigning not json serializable value to dagrun.conf cause an error in UI
5 participants