o-nikolas commented on code in PR #72081: URL: https://github.com/apache/airflow/pull/72081#discussion_r3984383540
########## providers/amazon/tests/system/amazon/aws/example_athena_spark.py: ########## @@ -0,0 +1,127 @@ +# 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 + +import os +import time +from datetime import datetime + +import boto3 + +from airflow.providers.amazon.aws.operators.athena_spark import AthenaSparkOperator + +from tests_common.test_utils.version_compat import AIRFLOW_V_3_0_PLUS + +if AIRFLOW_V_3_0_PLUS: + from airflow.sdk import DAG, chain, task +else: + # Airflow 2 path + from airflow.decorators import task # type: ignore[attr-defined,no-redef] + from airflow.models.baseoperator import chain # type: ignore[attr-defined,no-redef] + from airflow.models.dag import DAG # type: ignore[attr-defined,no-redef,assignment] + +try: + from airflow.sdk import TriggerRule +except ImportError: + # Compatibility for Airflow < 3.1 + from airflow.utils.trigger_rule import TriggerRule # type: ignore[no-redef,attr-defined] + +from system.amazon.aws.utils import SystemTestContextBuilder + +sys_test_context_task = SystemTestContextBuilder().build() + +DAG_ID = "example_athena_spark" + +# The Spark workgroup is preconfigured test infrastructure; this DAG creates only the session. +# Test runners can override the default by exporting ATHENA_SPARK_WORK_GROUP. +ATHENA_SPARK_WORK_GROUP = os.environ.get("ATHENA_SPARK_WORK_GROUP", "airflow-athena-spark-test") Review Comment: This should be fetched by the system context builder above. ########## providers/amazon/src/airflow/providers/amazon/aws/operators/athena_spark.py: ########## @@ -0,0 +1,215 @@ +# +# 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 + +import time +from collections.abc import Sequence +from typing import TYPE_CHECKING, Any + +from airflow.providers.amazon.aws.hooks.athena import AthenaHook +from airflow.providers.amazon.aws.operators.base_aws import AwsBaseOperator +from airflow.providers.amazon.aws.utils.mixins import aws_template_fields + +if TYPE_CHECKING: + from airflow.sdk import Context + + +class AthenaSparkOperator(AwsBaseOperator[AthenaHook]): + """ + Run an Apache Spark calculation in an Amazon Athena session. + + Submits a calculation, such as PySpark code, via the Athena API, polls until + the calculation reaches a terminal state, and returns execution metadata. + + .. seealso:: + - :class:`airflow.providers.amazon.aws.hooks.athena.AthenaHook` + - `Athena for Apache Spark + <https://docs.aws.amazon.com/athena/latest/ug/notebooks-spark-api-list.html>`__ + + :param session_id: The Athena session ID in which to run the calculation. (templated) + :param code_block: The calculation code, such as PySpark, to execute. (templated) + :param description: Optional description of the calculation. Defaults to None. + :param client_request_token: Optional idempotency token for the submission. Defaults to None. + :param waiter_delay: Seconds to wait between status checks. Defaults to 30. + :param waiter_max_attempts: Maximum number of polling attempts before timing out. Defaults to 120. + To limit total task time, use execution_timeout on the task as well. + :param log_query: Whether to log submission details. Defaults to True. + :param aws_conn_id: The Airflow connection used for AWS credentials. Defaults to ``aws_default``. + :param region_name: AWS region. If not set, default boto3 behavior is used. Defaults to None. + :param verify: Whether to verify SSL certificates. Defaults to None. + :param botocore_config: Optional botocore configuration dict. Defaults to None. + """ + + aws_hook_class = AthenaHook + ui_color = "#44b5e2" + template_fields: Sequence[str] = aws_template_fields("session_id", "code_block", "description") + template_ext: Sequence[str] = (".py",) + template_fields_renderers = {"code_block": "python"} + + def __init__( + self, + *, + session_id: str, + code_block: str, + description: str | None = None, + client_request_token: str | None = None, + waiter_delay: int = 30, + waiter_max_attempts: int = 120, + log_query: bool = True, + aws_conn_id: str | None = "aws_default", + region_name: str | None = None, + verify: bool | str | None = None, + botocore_config: dict | None = None, + **kwargs: Any, + ) -> None: + super().__init__( + aws_conn_id=aws_conn_id, + region_name=region_name, + verify=verify, + botocore_config=botocore_config, + **kwargs, + ) + self.session_id = session_id + self.code_block = code_block + self.description = description + self.client_request_token = client_request_token + self.waiter_delay = waiter_delay + self.waiter_max_attempts = waiter_max_attempts + self.log_query = log_query + self._calculation_execution_id: str | None = None + + @property + def _hook_parameters(self) -> dict[str, Any]: + return {**super()._hook_parameters, "log_query": self.log_query} + + def execute(self, context: Context) -> dict[str, Any]: + """Submit the Spark calculation, poll until terminal state, then return metadata.""" + self.log.info("Starting Athena Spark calculation in session %s", self.session_id) + + calculation_execution_id = self.hook.start_spark_calculation( + session_id=self.session_id, + code_block=self.code_block, + description=self.description, + client_request_token=self.client_request_token, + ) + self._calculation_execution_id = calculation_execution_id + + self.log.info("Calculation submitted. CalculationExecutionId: %s", calculation_execution_id) + + final_state = self._poll_until_terminal(calculation_execution_id) + return self._handle_terminal_state(calculation_execution_id, final_state) + + def _poll_until_terminal(self, calculation_execution_id: str) -> str: + """Poll calculation status until a terminal state or timeout.""" + for attempt in range(1, self.waiter_max_attempts + 1): Review Comment: Any reason you're using a hand rolled wait loop here instead of the waiter mechanisms we have in the amazon provider package? ########## providers/amazon/tests/system/amazon/aws/example_athena_spark.py: ########## @@ -0,0 +1,127 @@ +# 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 + +import os +import time +from datetime import datetime + +import boto3 + +from airflow.providers.amazon.aws.operators.athena_spark import AthenaSparkOperator + +from tests_common.test_utils.version_compat import AIRFLOW_V_3_0_PLUS + +if AIRFLOW_V_3_0_PLUS: + from airflow.sdk import DAG, chain, task +else: + # Airflow 2 path + from airflow.decorators import task # type: ignore[attr-defined,no-redef] + from airflow.models.baseoperator import chain # type: ignore[attr-defined,no-redef] + from airflow.models.dag import DAG # type: ignore[attr-defined,no-redef,assignment] + +try: + from airflow.sdk import TriggerRule +except ImportError: + # Compatibility for Airflow < 3.1 + from airflow.utils.trigger_rule import TriggerRule # type: ignore[no-redef,attr-defined] + +from system.amazon.aws.utils import SystemTestContextBuilder + +sys_test_context_task = SystemTestContextBuilder().build() + +DAG_ID = "example_athena_spark" + +# The Spark workgroup is preconfigured test infrastructure; this DAG creates only the session. +# Test runners can override the default by exporting ATHENA_SPARK_WORK_GROUP. +ATHENA_SPARK_WORK_GROUP = os.environ.get("ATHENA_SPARK_WORK_GROUP", "airflow-athena-spark-test") Review Comment: Also why no deferrable? ########## providers/amazon/docs/operators/athena/athena_spark.rst: ########## @@ -0,0 +1,58 @@ +.. 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. + +Athena Spark Operators +====================== + +`Amazon Athena <https://aws.amazon.com/athena/>`__ supports Apache Spark calculations through session-based APIs. +This page documents the provider support for submitting and monitoring those +calculations from Airflow. + +Prerequisite Tasks +------------------ + +.. include:: ../../_partials/prerequisite_tasks.rst + +Generic Parameters +------------------ + +.. include:: ../../_partials/generic_parameters.rst + +Operators +--------- + +.. _howto/operator:AthenaSparkOperator: + +Submit Spark code to an Athena session +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use :class:`~airflow.providers.amazon.aws.operators.athena_spark.AthenaSparkOperator` +to submit Spark code to an existing Athena Spark session. + +In the following example, we submit PySpark code to an existing Athena Spark +session and wait for the calculation to complete. For more examples of how to use +this operator, please see the `Sample Dag <https://github.com/apache/airflow/blob/|version|/providers/amazon/tests/system/amazon/aws/example_athena_spark.py>`__. + +.. exampleinclude:: /../../amazon/tests/system/amazon/aws/example_athena_spark.py + :language: python Review Comment: Can you add `:dedent: 4` ########## providers/amazon/src/airflow/providers/amazon/aws/hooks/athena.py: ########## @@ -344,3 +351,141 @@ def stop_query(self, query_execution_id: str) -> dict: """ self.log.info("Stopping Query with executionId - %s", query_execution_id) return self.get_conn().stop_query_execution(QueryExecutionId=query_execution_id) + + def _get_spark_calculation_status(self, response: dict[str, Any] | None) -> dict[str, Any]: + calculation_execution = (response or {}).get("CalculationExecution") or {} Review Comment: I don't think there is a `CalculationExecution` in this response type -- 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]
