Taragolis commented on code in PR #28338: URL: https://github.com/apache/airflow/pull/28338#discussion_r1049601803
########## airflow/providers/amazon/aws/sensors/dynamodb.py: ########## @@ -0,0 +1,85 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from typing import TYPE_CHECKING, Optional + +from botocore.exceptions import ClientError + +from airflow.providers.amazon.aws.hooks.dynamodb import DynamoDBHook +from airflow.sensors.base import BaseSensorOperator + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class DynamoDBValueSensor(BaseSensorOperator): + """ + Waits for an attribute value to be present for an item in a DynamoDB table. + + :param partition_key_name: DynamoDB partition key name + :param partition_key_value: DynamoDB partition key value + :param attribute_name: DynamoDB attribute name + :param attribute_value: DynamoDB attribute value + :param sort_key_name: (optional) DynamoDB sort key name + :param sort_key_value: (optional) DynamoDB sort key value + """ + + def __init__( + self, + table_name: str, + partition_key_name: str, + partition_key_value: str, + attribute_name: str, + attribute_value: str, + sort_key_name: Optional[str] = None, + sort_key_value: Optional[str] = None, + aws_conn_id: str = "aws_default", Review Comment: AWS Connection ID could be None. In this case default boto3 credentials strategy will use ```suggestion aws_conn_id: str | None = DynamoDBHook.default_conn_name, ``` ########## airflow/providers/amazon/aws/sensors/dynamodb.py: ########## @@ -0,0 +1,85 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from typing import TYPE_CHECKING, Optional + +from botocore.exceptions import ClientError + +from airflow.providers.amazon.aws.hooks.dynamodb import DynamoDBHook +from airflow.sensors.base import BaseSensorOperator + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class DynamoDBValueSensor(BaseSensorOperator): + """ + Waits for an attribute value to be present for an item in a DynamoDB table. + + :param partition_key_name: DynamoDB partition key name + :param partition_key_value: DynamoDB partition key value + :param attribute_name: DynamoDB attribute name + :param attribute_value: DynamoDB attribute value + :param sort_key_name: (optional) DynamoDB sort key name + :param sort_key_value: (optional) DynamoDB sort key value + """ + + def __init__( + self, + table_name: str, + partition_key_name: str, + partition_key_value: str, + attribute_name: str, + attribute_value: str, + sort_key_name: Optional[str] = None, + sort_key_value: Optional[str] = None, + aws_conn_id: str = "aws_default", + **kwargs, + ): + super().__init__(**kwargs) + self.table_name = table_name + self.partition_key_name = partition_key_name + self.partition_key_value = partition_key_value + self.attribute_name = attribute_name + self.attribute_value = attribute_value + self.sort_key_name = sort_key_name + self.sort_key_value = sort_key_value + self.aws_conn_id = aws_conn_id + self.hook = DynamoDBHook(aws_conn_id=self.aws_conn_id) + self.table = self.hook.get_conn().Table(table_name) Review Comment: This code could increase usage resource in Airflow scheduler/dag_processor because it would try to establish connection to AWS and get table every time when DAG, which include this sensor, parsed For Hook consider to use cached property, e.g.: https://github.com/apache/airflow/blob/2794662459b6d2f40b55b9b1d39eed14b5c3c5e9/airflow/providers/amazon/aws/operators/athena.py#L103-L106 And also obtain table object inside `execute` or `poke` method. As an option you also might create cached property `table` ########## airflow/providers/amazon/aws/sensors/dynamodb.py: ########## @@ -0,0 +1,85 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from typing import TYPE_CHECKING, Optional + +from botocore.exceptions import ClientError + +from airflow.providers.amazon.aws.hooks.dynamodb import DynamoDBHook +from airflow.sensors.base import BaseSensorOperator + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class DynamoDBValueSensor(BaseSensorOperator): + """ + Waits for an attribute value to be present for an item in a DynamoDB table. + + :param partition_key_name: DynamoDB partition key name + :param partition_key_value: DynamoDB partition key value + :param attribute_name: DynamoDB attribute name + :param attribute_value: DynamoDB attribute value + :param sort_key_name: (optional) DynamoDB sort key name + :param sort_key_value: (optional) DynamoDB sort key value + """ + + def __init__( + self, + table_name: str, + partition_key_name: str, + partition_key_value: str, + attribute_name: str, + attribute_value: str, + sort_key_name: Optional[str] = None, + sort_key_value: Optional[str] = None, + aws_conn_id: str = "aws_default", + **kwargs, + ): + super().__init__(**kwargs) + self.table_name = table_name + self.partition_key_name = partition_key_name + self.partition_key_value = partition_key_value + self.attribute_name = attribute_name + self.attribute_value = attribute_value + self.sort_key_name = sort_key_name + self.sort_key_value = sort_key_value + self.aws_conn_id = aws_conn_id + self.hook = DynamoDBHook(aws_conn_id=self.aws_conn_id) + self.table = self.hook.get_conn().Table(table_name) + + def poke(self, context: Context) -> bool: + """Test DynamoDB item for matching attribute value""" + try: + key = {self.partition_key_name: self.partition_key_value} + msg = f"Checking table {self.table_name} for item PK: {self.partition_key_name}={self.partition_key_value}" + + if self.sort_key_value: + key[self.sort_key_name] = self.sort_key_value + msg += f" SK: {self.sort_key_name}={self.sort_key_value}" + + msg += f" attribute: {self.attribute_name}={self.attribute_value}" + + self.log.info(msg) + response = self.table.get_item(Key=key) + self.log.info(f"Response: {response}") + return response["Item"][self.attribute_name] == self.attribute_value + except ClientError as ex: + self.log.error('AWS request failed, check logs for more info: %s', ex) + return False Review Comment: I agree, we need to catch only specific errors. Because a lot of `ClientError` shouldn't retried. For example if user provide wrong credentials: ```console 'ClientError' error occurred while testing connection: An error occurred (IncompleteSignature) ``` ```console 'ClientError' error occurred while testing connection: An error occurred (InvalidClientTokenId) ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
