Skip to content

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

Merged
uranusjr merged 4 commits into
apache:mainfrom
johncmerfeld:fix-lazyload-bool
Dec 3, 2024
Merged

uranusjr merged 4 commits into
apache:mainfrom
johncmerfeld:fix-lazyload-bool

Conversation

@johncmerfeld

@johncmerfeld johncmerfeld commented Nov 13, 2024 •

Copy link
Copy Markdown
Contributor

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

@boring-cyborg

boring-cyborg Bot commented Nov 13, 2024

Copy link
Copy Markdown

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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@potiuk

potiuk commented Nov 13, 2024

Copy link
Copy Markdown
Member

Could you please add a unit test covering this case?

@johncmerfeld

Copy link
Copy Markdown
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

potiuk commented Nov 16, 2024

Copy link
Copy Markdown
Member

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread airflow/utils/db.py Outdated
@eladkal eladkal added this to the Airflow 2.10.4 milestone Nov 16, 2024
@johncmerfeld

Copy link
Copy Markdown
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

Lee-W commented Nov 19, 2024

Copy link
Copy Markdown
Member

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?

Comment thread airflow/utils/db.py Outdated
@johncmerfeld

johncmerfeld commented Nov 19, 2024 •

Copy link
Copy Markdown
Contributor Author

@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

Lee-W commented Nov 20, 2024

Copy link
Copy Markdown
Member

@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 🙂

Comment thread tests/utils/test_db.py Outdated
Comment thread tests/utils/test_db.py Outdated
@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 self-requested a review November 30, 2024 06:49
@uranusjr
uranusjr merged commit 8d6bde8 into apache:main Dec 3, 2024
@boring-cyborg

boring-cyborg Bot commented Dec 3, 2024

Copy link
Copy Markdown

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

@github-actions

github-actions Bot commented Dec 3, 2024

Copy link
Copy Markdown
Contributor

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

@johncmerfeld

Copy link
Copy Markdown
Contributor Author

@Lee-W I see this change is in main but is there a reason it hasn't been released in 2.10.4 or 2.10.5? Did I neglect to do something? Thanks!

@Lee-W

Lee-W commented Feb 13, 2025

Copy link
Copy Markdown
Member

hmmm.. not quite sure, but I can take a look

Lee-W pushed a commit to astronomer/airflow that referenced this pull request Feb 13, 2025
@Lee-W

Lee-W commented Feb 13, 2025

Copy link
Copy Markdown
Member

@johncmerfeld I guess it was due to conflict. Created backport PR #46707

jedcunningham pushed a commit that referenced this pull request Feb 13, 2025
Co-authored-by: John C. Merfeld <John.Merfeld@gmail.com>
@johncmerfeld

Copy link
Copy Markdown
Contributor Author

I appreciate it @Lee-W - looks like that backport PR was successful so I will assume this change will be in the 2.10.6 release. Thanks!!

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.

bool(LazySelectSequence) can return None

7 participants