Skip to content

fix(task-sdk): raise exception on Variable.set and Variable.delete failures #69436

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.

Sign up for GitHub

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

Closed
Alwaysgaurav1 wants to merge 1 commit into from
Closed

fix(task-sdk): raise exception on Variable.set and Variable.delete failures #69436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions task-sdk/src/airflow/sdk/execution_time/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,9 @@ def _set_variable(key: str, value: Any, description: str | None = None, serializ
# keep Task SDK as a separate package than execution time mods.
import json

from airflow.sdk.exceptions import AirflowRuntimeError
from airflow.sdk.execution_time.cache import SecretCache
from airflow.sdk.execution_time.comms import PutVariable
from airflow.sdk.execution_time.comms import ErrorResponse, PutVariable
from airflow.sdk.execution_time.secrets.execution_api import ExecutionAPISecretsBackend
from airflow.sdk.execution_time.supervisor import ensure_secrets_backend_loaded
from airflow.sdk.execution_time.task_runner import SUPERVISOR_COMMS
Expand Down Expand Up @@ -412,7 +413,9 @@ def _set_variable(key: str, value: Any, description: str | None = None, serializ
except Exception as e:
log.exception(e)

SUPERVISOR_COMMS.send(PutVariable(key=key, value=value, description=description))
res = SUPERVISOR_COMMS.send(PutVariable(key=key, value=value, description=description))
if isinstance(res, ErrorResponse):
raise AirflowRuntimeError(res)

# Invalidate cache after setting the variable
SecretCache.invalidate_variable(key)
Expand All @@ -424,11 +427,14 @@ def _delete_variable(key: str) -> None:
# A reason to not move it to `airflow.sdk.execution_time.comms` is that it
# will make that module depend on Task SDK, which is not ideal because we intend to
# keep Task SDK as a separate package than execution time mods.
from airflow.sdk.exceptions import AirflowRuntimeError
from airflow.sdk.execution_time.cache import SecretCache
from airflow.sdk.execution_time.comms import DeleteVariable
from airflow.sdk.execution_time.comms import DeleteVariable, ErrorResponse
from airflow.sdk.execution_time.task_runner import SUPERVISOR_COMMS

msg = SUPERVISOR_COMMS.send(DeleteVariable(key=key))
if isinstance(msg, ErrorResponse):
raise AirflowRuntimeError(msg)
if TYPE_CHECKING:
assert isinstance(msg, OKResponse)

Expand Down
16 changes: 16 additions & 0 deletions task-sdk/tests/task_sdk/definitions/test_variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,22 @@ def test_var_delete(self, mock_supervisor_comms):

mock_supervisor_comms.send.assert_called_once_with(msg=DeleteVariable(key="my_key"))

def test_var_set_raises_on_error_response(self, mock_supervisor_comms):
mock_supervisor_comms.send.return_value = ErrorResponse(
error=ErrorType.GENERIC_ERROR, detail={"message": "boom"}
)

with pytest.raises(AirflowRuntimeError):
Variable.set(key="key", value="value")

def test_var_delete_raises_on_error_response(self, mock_supervisor_comms):
mock_supervisor_comms.send.return_value = ErrorResponse(
error=ErrorType.GENERIC_ERROR, detail={"message": "boom"}
)

with pytest.raises(AirflowRuntimeError):
Variable.delete(key="key")


class TestVariableKeys:
@pytest.mark.parametrize(
Expand Down