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

[SQSSensor] Add opt-in to disable auto-delete messages #21159

Merged
merged 2 commits into from
Jan 29, 2022

Conversation

LaPetiteSouris
Copy link
Contributor

@LaPetiteSouris LaPetiteSouris commented Jan 27, 2022

What

Add opt-in in SQSSensor to disable the behavior of automatically delete messages on consumption. This option is opt-in. By default it is set to False, which means the original feature is preserved.

  • If delete_message_on_reception is True (default): SQS messages are deleted automatically from the queue upon consumption.
  • If delete_message_on_reception is False. The user takes care of message deletion manually.

Why

In many cases, the SQSSensor itselft is not the part of the code base that actually processes the messages. It serves as a short of polling to get messages out for further processing.

If the actually code/Aiflow task that processes the messages failed, the message should be put back in the queue for further processing. This is the very basic idea of SQS Polling provided by Amazon.

Reference to SQS with AWS Lambda function, AWS docs states :

When your function *successfully* processes a batch, Lambda deletes its messages from the queue.

In many case, the SQSSensor polls the message and distributes the workload to different task, in a very similar way to AWS Lambda polling.

SQSPolling

Thus, there should be option to disable to default behavior, which is to delete the message upon reception.

@boring-cyborg boring-cyborg bot added area:providers provider:amazon-aws AWS/Amazon - related issues labels Jan 27, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jan 27, 2022

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 (flake8, 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.
    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

@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Jan 28, 2022
@github-actions
Copy link

The PR is likely OK to be merged with just subset of tests for default Python and Database versions without running the full matrix of tests, because it does not modify the core of Airflow. If the committers decide that the full tests matrix is needed, they will add the label 'full tests needed'. Then you should rebase to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@LaPetiteSouris
Copy link
Contributor Author

@jimmytuc @potiuk : 6cfca31 is added to address CI/CD failure on docstring. I should have checked that earlier.

@uranusjr uranusjr changed the title [SQSSensor] Add opt-in to disable auto-delete messages on consumption [SQSSensor] Add opt-in to disable auto-delete messages Jan 29, 2022
@uranusjr uranusjr merged commit 7ae156f into apache:main Jan 29, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jan 29, 2022

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers okay to merge It's ok to merge this PR as it does not require more tests provider:amazon-aws AWS/Amazon - related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants