Skip to content

Add deferrable mode to DynamoDBValueSensor#69799

Open
harshhh817 wants to merge 1 commit into
apache:mainfrom
harshhh817:deferrable-dynamodb-value-sensor
Open

Add deferrable mode to DynamoDBValueSensor#69799
harshhh817 wants to merge 1 commit into
apache:mainfrom
harshhh817:deferrable-dynamodb-value-sensor

Conversation

@harshhh817

Copy link
Copy Markdown

Adds the standard deferrable path to DynamoDBValueSensor, which currently only supports poke/reschedule modes and holds a worker slot while waiting.

  • deferrable param (default from operators.default_deferrable, per provider convention); execute() defers to a new DynamoDBValueSensorTrigger, execute_complete() validates the trigger event.
  • The trigger polls the item asynchronously. DynamoDBHook is resource-based but aiobotocore only exposes clients, so the trigger uses a client-type AwsBaseHook with low-level get_item and deserializes the attribute via boto3's TypeDeserializer — semantics identical to the sync poke() (ClientError tolerated, single value or iterable matched). This mirrors how EC2StateSensorTrigger handles the same client/resource split.
  • Trigger registered in provider.yaml / get_provider_info.py; docs note added; unit tests for sensor deferral and trigger (serialization + async run paths).

The issue proposes DynamoDB Streams + SQS; I went with the async-polling trigger instead since it is the established pattern for the provider's deferrable sensors and requires no extra AWS infrastructure — happy to discuss if maintainers prefer the Streams-based design.

closes: #69051


Was generative AI tooling used to co-author this PR?
  • Yes (Claude Code)

Generated-by: Claude Code following the guidelines


  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

DynamoDBValueSensor previously only supported poke/reschedule modes,
occupying a worker slot while waiting for a DynamoDB attribute value.
This adds the standard deferrable path used across the Amazon provider:

- deferrable param (defaulting to the operators.default_deferrable
  config) on DynamoDBValueSensor; when set, execute() defers to a new
  DynamoDBValueSensorTrigger and execute_complete() validates the event.
- DynamoDBValueSensorTrigger polls the item asynchronously. Since
  aiobotocore only exposes clients (DynamoDBHook is resource-based),
  the trigger uses a client-type AwsBaseHook and deserializes the typed
  attribute with boto3's TypeDeserializer before comparing, keeping
  poke semantics identical to the sync path (ClientError tolerated,
  string or iterable of strings matched).
- Registered the trigger module in provider.yaml/get_provider_info,
  plus unit tests for the sensor deferral and the trigger.

The issue title suggests DynamoDB Streams + SQS, but async polling is
the established pattern for amazon provider deferrable sensors (SQS,
EC2, ...), so this follows that convention.

closes: apache#69051

Signed-off-by: Harsh Gupta <harshgupta93198@gmail.com>
@harshhh817 harshhh817 requested a review from o-nikolas as a code owner July 13, 2026 05:29
@boring-cyborg

boring-cyborg Bot commented Jul 13, 2026

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
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks 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

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.

[amazon] Add deferrable mode to DynamoDBValueSensor via DynamoDB Streams + SQS

1 participant