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

[Providers/HTTP] Add adapter parameter to HttpHook to allow custom requests adapters #44302

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jieyao-MilestoneHub
Copy link

This PR adds an adapter parameter to the HttpHook, allowing users to mount custom adapters for HTTP request handling. This enhances flexibility and supports use cases like custom retries, timeouts, and SSL handling.

Summary of Changes:

  • Added adapter parameter to HttpHook to allow custom HTTP adapters.
  • Modified get_conn to support mounting custom adapters or using TCPKeepAliveAdapter by default.
  • Added comprehensive tests to validate the functionality of the adapter parameter and its integration with get_conn.
  • Ensured all new tests pass and maintain compatibility with existing functionality.

Issue Reference:

Closes #44285

Testing and Validation:

  • Added unit tests in ~/providers/tests/http/hooks/test_http.py to validate:
    • Mounting custom adapters.
    • Default behavior when no adapter is provided.
    • Handling invalid adapter types.
  • Ran pytest providers/tests/http/hooks/test_http.py using breeze.
  • Pass pre-commit run --files providers/src/airflow/providers/http/hooks/http.py providers/tests/http/hooks/test_http.py using breeze.

Backward Compatibility:

This change is backward-compatible. The new adapter parameter is optional and defaults to None, preserving existing behavior.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

Copy link

boring-cyborg bot commented Nov 23, 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

- Added `adapter` parameter to `HttpHook` to allow custom HTTP adapters.
- Modified `get_conn` to support mounting custom adapters or using TCPKeepAliveAdapter by default.
- Added comprehensive tests to validate the functionality of the `adapter` parameter and its integration with `get_conn`.
- Ensured all new tests pass and maintain compatibility with existing functionality.
Copy link
Contributor

@shahar1 shahar1 left a comment

Choose a reason for hiding this comment

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

Welcome to Apache Airflow and thanks for your contribution!
Looks OK overall, I have some comments :)

@jieyao-MilestoneHub
Copy link
Author

Thank you, @shahar1, for your detailed review and valuable feedback! I’ve addressed your comments by:

  1. Adding a detailed docstring for the __init__ method, including the missing adapter parameter.
  2. Removing the redundant instantiation of TCPKeepAliveAdapter in the run method.

Please let me know if there’s anything else I can improve. I really appreciate your time and support!

…pter

- Added missing `adapter` parameter description to the HttpHook class docstring.
- Removed redundant instantiation of `TCPKeepAliveAdapter` in the `run` method since it's already instantiated in `get_conn`.
@shahar1
Copy link
Contributor

shahar1 commented Nov 23, 2024

Thank you, @shahar1, for your detailed review and valuable feedback! I’ve addressed your comments by:

  1. Adding a detailed docstring for the __init__ method, including the missing adapter parameter.
  2. Removing the redundant instantiation of TCPKeepAliveAdapter in the run method.

Please let me know if there’s anything else I can improve. I really appreciate your time and support!

Thanks :) Regarding the 2nd point - could you please explain why it makes sense to relocate the instanation of TCPKeepAliveAdapter to the __init__?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

allow extending HttpHook with requests adapters
2 participants