airflow icon indicating copy to clipboard operation
airflow copied to clipboard

Add `KafkaMessageQueueTrigger` for enhanced message queue trigger usability on Kafka queue

Open dingo4dev opened this issue 7 months ago • 4 comments

Closes #515225.

Why

While using the MessageQueueTrigger in Airflow 3.0+, the parameters in the common message queue trigger are not specific enough, leading to potential issues like unclear usage, difficulty in understanding, or unexpected behavior when using it on Kafka

What

This PR introduces the KafkaMessageQueueTrigger class to specify the parameters for the message queue trigger to enhance the usability

dingo4dev avatar Jun 14 '25 04:06 dingo4dev

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

boring-cyborg[bot] avatar Jun 14 '25 04:06 boring-cyborg[bot]

TBR

dingo4dev avatar Jun 15 '25 06:06 dingo4dev

@vincbeck Thanks for the reviews 😄

dingo4dev avatar Jun 16 '25 19:06 dingo4dev

Thanks for the PR! After your change, the usage is much clear.

IMO, we should also update the KafkaMessageQueueProvider to reduce the inconsistency on both sides.

We could reuse your get_kafka_queue_uri in KafkaMessageQueueProvider.trigger_kwargs as well.

@jason810496 TIA.

ACK. I think we might still need to keep the feasibility for the direct access MessageQueueTrigger. And we can move the function to utils file/folder for better readability.

Perhaps should we open new PRs for it?

dingo4dev avatar Jun 17 '25 17:06 dingo4dev

Perhaps should we open new PRs for it?

ACK. I think we might still need to keep the feasibility for the direct access MessageQueueTrigger. And we can move the function to utils file/folder for better readability.

Sure, having a common module as utils is good and refactoring in followup PR is more suitable.

jason810496 avatar Jun 18 '25 01:06 jason810496

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

boring-cyborg[bot] avatar Jun 18 '25 15:06 boring-cyborg[bot]