Skip to content

Task SDK: Fix Variable.set/delete swallowing API errors — propagate AirflowRuntimeError to fail the task #68539

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

Open
Shushankranjan wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −13
Open

Task SDK: Fix Variable.set/delete swallowing API errors — propagate AirflowRuntimeError to fail the task #68539

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
15 changes: 2 additions & 13 deletions task-sdk/src/airflow/sdk/definitions/variable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

from __future__ import annotations

import logging
from collections.abc import Sequence
from typing import Any

Expand All @@ -26,8 +25,6 @@
from airflow.sdk.definitions._internal.types import NOTSET
from airflow.sdk.log import mask_secret

log = logging.getLogger(__name__)


@attrs.define
class Variable:
Expand Down Expand Up @@ -60,13 +57,9 @@ def get(cls, key: str, default: Any = NOTSET, deserialize_json: bool = False):

@classmethod
def set(cls, key: str, value: Any, description: str | None = None, serialize_json: bool = False) -> None:
from airflow.sdk.exceptions import AirflowRuntimeError
from airflow.sdk.execution_time.context import _set_variable

try:
return _set_variable(key, value, description, serialize_json=serialize_json)
except AirflowRuntimeError as e:
log.exception(e)
_set_variable(key, value, description, serialize_json=serialize_json)

@classmethod
def keys(cls, prefix: str | None = None) -> Sequence[str]:
Expand Down Expand Up @@ -94,10 +87,6 @@ def keys(cls, prefix: str | None = None) -> Sequence[str]:

@classmethod
def delete(cls, key: str) -> None:
from airflow.sdk.exceptions import AirflowRuntimeError
from airflow.sdk.execution_time.context import _delete_variable

try:
_delete_variable(key=key)
except AirflowRuntimeError as e:
log.exception(e)
_delete_variable(key=key)
24 changes: 24 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 @@ -89,6 +89,30 @@ def test_var_set(self, key, value, description, serialize_json, mock_supervisor_
),
)

def test_var_set_raises_on_error(self, mock_supervisor_comms):
"""Variable.set() must propagate AirflowRuntimeError so the task fails on a rejected write."""
from airflow.sdk.exceptions import AirflowRuntimeError, ErrorType
from airflow.sdk.execution_time.comms import ErrorResponse

mock_supervisor_comms.send.side_effect = AirflowRuntimeError(
error=ErrorResponse(error=ErrorType.API_SERVER_ERROR, detail={"message": "forbidden"})
)

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

def test_var_delete_raises_on_error(self, mock_supervisor_comms):
"""Variable.delete() must propagate AirflowRuntimeError so the task fails on a rejected delete."""
from airflow.sdk.exceptions import AirflowRuntimeError, ErrorType
from airflow.sdk.execution_time.comms import ErrorResponse

mock_supervisor_comms.send.side_effect = AirflowRuntimeError(
error=ErrorResponse(error=ErrorType.API_SERVER_ERROR, detail={"message": "forbidden"})
)

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


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