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

Fix: ensure bool(check_query_exists) returns True or False #43978

Merged
merged 4 commits into from
Dec 3, 2024

Conversation

johncmerfeld
Copy link
Contributor

@johncmerfeld johncmerfeld commented Nov 13, 2024

closes: #43977


It is possible for bool(check_query_exists) to return None. This can break Xcom Jinja templates that retrieve null values from the airflow database using a LazySelectSequence

Copy link

boring-cyborg bot commented Nov 13, 2024

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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.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: [email protected]
    Slack: https://s.apache.org/airflow-slack

@potiuk
Copy link
Member

potiuk commented Nov 13, 2024

Could you please add a unit test covering this case?

@johncmerfeld
Copy link
Contributor Author

Could you please add a unit test covering this case?

I'd love to; I'm just a little unsure where it would go. I couldn't find any module that tests the behavior of LazySelectSequence directly. I'd appreciate any advice you have on this!

@potiuk
Copy link
Member

potiuk commented Nov 16, 2024

Could you please add a unit test covering this case?

I'd love to; I'm just a little unsure where it would go. I couldn't find any module that tests the behavior of LazySelectSequence directly. I'd appreciate any advice you have on this!

Maybe add one then - following the same structure in tests as you have for the source

@potiuk potiuk requested a review from Copilot November 16, 2024 02:17
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 suggestion.

airflow/utils/db.py Outdated Show resolved Hide resolved
@eladkal eladkal added this to the Airflow 2.10.4 milestone Nov 16, 2024
@johncmerfeld
Copy link
Contributor Author

Maybe add one then - following the same structure in tests as you have for the source

Sure. Since it's an abstract class, I'm thinking I'll have to create a mock implementation for the test. I'll also need to mock check_query_exists so that it returns None .Something like:

class LazySelectSequenceInstance(LazySelectSequence[Any]):
    ... # implement required methods

@mock.patch("check_query_exists", lambda x, y: None):
def test_lazy_select_sequence():
    lss = LazySelectSequenceInstance(...)
    assert bool(lss) == False

Does this make sense?

@Lee-W
Copy link
Member

Lee-W commented Nov 19, 2024

Maybe add one then - following the same structure in tests as you have for the source

Sure. Since it's an abstract class, I'm thinking I'll have to create a mock implementation for the test. I'll also need to mock check_query_exists so that it returns None .Something like:

class LazySelectSequenceInstance(LazySelectSequence[Any]):
    ... # implement required methods

@mock.patch("check_query_exists", lambda x, y: None):
def test_lazy_select_sequence():
    lss = LazySelectSequenceInstance(...)
    assert bool(lss) == False

Does this make sense?

Sounds reasonable. We already have a mock class here

class MockLazySelectSequence(LazySelectSequence):

probably we could do something similar here as well?

airflow/utils/db.py Outdated Show resolved Hide resolved
@johncmerfeld
Copy link
Contributor Author

johncmerfeld commented Nov 19, 2024

@Lee-W I'm struggling to get unit tests running locally with virtualenv but all the CI checks appear to be passing.

EDIT: Ahh okay I see the tests don't actually run until there is an approval. Alas I'm unable to run the tests when building locally on MacOS or ubuntu. Not sure I have the hardware needed to run the docker version of the tests

@johncmerfeld johncmerfeld changed the title Fix: ensure bool(LazySelectSequence) returns True or False Fix: ensure bool(check_query_exists) returns True or False Nov 19, 2024
@Lee-W
Copy link
Member

Lee-W commented Nov 20, 2024

@Lee-W I'm struggling to get unit tests running locally with virtualenv but all the CI checks appear to be passing.

EDIT: Ahh okay I see the tests don't actually run until there is an approval. Alas I'm unable to run the tests when building locally on MacOS or ubuntu. Not sure I have the hardware needed to run the docker version of the tests

for local test https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst is the thing you might want to try 🙂

tests/utils/test_db.py Outdated Show resolved Hide resolved
tests/utils/test_db.py Outdated Show resolved Hide resolved
@johncmerfeld johncmerfeld force-pushed the fix-lazyload-bool branch 3 times, most recently from 32ce278 to 70a6908 Compare November 25, 2024 23:50
@johncmerfeld johncmerfeld requested a review from Lee-W November 25, 2024 23:50
@eladkal eladkal added the type:bug-fix Changelog: Bug Fixes label Nov 26, 2024
@shahar1 shahar1 added the backport-to-v2-10-test Mark PR with this label to backport to v2-10-test branch label Nov 30, 2024
@shahar1 shahar1 self-requested a review November 30, 2024 06:49
@uranusjr uranusjr merged commit 8d6bde8 into apache:main Dec 3, 2024
96 checks passed
Copy link

boring-cyborg bot commented Dec 3, 2024

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

Copy link

github-actions bot commented Dec 3, 2024

Backport failed to create: v2-10-test. View the failure log Run details

Status Branch Result
v2-10-test Commit Link

You can attempt to backport this manually by running:

cherry_picker 8d6bde8 v2-10-test

This should apply the commit to the v2-10-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-v2-10-test Mark PR with this label to backport to v2-10-test branch type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bool(LazySelectSequence) can return None
6 participants