Skip to content

Add number of queries guard in public xcom entries list endpoints #55936

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

Merged
pierrejeambrun merged 1 commit into from
Oct 30, 2025
Merged

Add number of queries guard in public xcom entries list endpoints #55936

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
8 changes: 4 additions & 4 deletions airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def get_xcom_entry(
dag_ids=dag_id,
map_indexes=map_index,
limit=1,
)
).options(joinedload(XComModel.task), joinedload(XComModel.dag_run).joinedload(DR.dag_model))

# We use `BaseXCom.get_many` to fetch XComs directly from the database, bypassing the XCom Backend.
# This avoids deserialization via the backend (e.g., from a remote storage like S3) and instead
Expand Down Expand Up @@ -162,7 +162,7 @@ def get_xcom_entries(
query = (
query.join(DR, and_(XComModel.dag_id == DR.dag_id, XComModel.run_id == DR.run_id))
.join(DagModel, DR.dag_id == DagModel.dag_id)
.options(joinedload(XComModel.dag_run).joinedload(DR.dag_model))
.options(joinedload(XComModel.task), joinedload(XComModel.dag_run).joinedload(DR.dag_model))
)

if task_id != "~":
Expand Down Expand Up @@ -284,7 +284,7 @@ def create_xcom_entry(
XComModel.map_index == request_body.map_index,
)
.limit(1)
.options(joinedload(XComModel.dag_run).joinedload(DR.dag_model))
.options(joinedload(XComModel.task), joinedload(XComModel.dag_run).joinedload(DR.dag_model))
)

return XComResponseNative.model_validate(xcom)
Expand Down Expand Up @@ -325,7 +325,7 @@ def update_xcom_entry(
XComModel.map_index == patch_body.map_index,
)
.limit(1)
.options(joinedload(XComModel.dag_run).joinedload(DR.dag_model))
.options(joinedload(XComModel.task), joinedload(XComModel.dag_run).joinedload(DR.dag_model))
)

if not xcom_entry:
Expand Down
2 changes: 1 addition & 1 deletion airflow-core/src/airflow/models/xcom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ class XComModel(TaskInstanceDependencies):
task = relationship(
"TaskInstance",
viewonly=True,
lazy="selectin",
lazy="noload",
)

@classmethod
Expand Down
29 changes: 17 additions & 12 deletions airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
from airflow.utils.session import provide_session
from airflow.utils.types import DagRunType

from tests_common.test_utils.asserts import assert_queries_count
from tests_common.test_utils.config import conf_vars
from tests_common.test_utils.dag import sync_dag_to_db
from tests_common.test_utils.db import clear_db_dag_bundles, clear_db_dags, clear_db_runs, clear_db_xcom
Expand Down Expand Up @@ -218,9 +219,10 @@ def setup(self, dag_maker) -> None:

def test_should_respond_200(self, test_client):
self._create_xcom_entries(TEST_DAG_ID, run_id, logical_date_parsed, TEST_TASK_ID)
response = test_client.get(
f"/dags/{TEST_DAG_ID}/dagRuns/{run_id}/taskInstances/{TEST_TASK_ID}/xcomEntries"
)
with assert_queries_count(4):
response = test_client.get(
f"/dags/{TEST_DAG_ID}/dagRuns/{run_id}/taskInstances/{TEST_TASK_ID}/xcomEntries"
)
assert response.status_code == 200
response_data = response.json()
for xcom_entry in response_data["xcom_entries"]:
Expand Down Expand Up @@ -259,7 +261,8 @@ def test_should_respond_200_with_tilde(self, test_client):
self._create_xcom_entries(TEST_DAG_ID, run_id, logical_date_parsed, TEST_TASK_ID)
self._create_xcom_entries(TEST_DAG_ID_2, run_id, logical_date_parsed, TEST_TASK_ID_2)

response = test_client.get("/dags/~/dagRuns/~/taskInstances/~/xcomEntries")
with assert_queries_count(4):
response = test_client.get("/dags/~/dagRuns/~/taskInstances/~/xcomEntries")
assert response.status_code == 200
response_data = response.json()
for xcom_entry in response_data["xcom_entries"]:
Expand Down Expand Up @@ -320,10 +323,11 @@ def test_should_respond_200_with_tilde(self, test_client):
def test_should_respond_200_with_map_index(self, map_index, test_client):
self._create_xcom_entries(TEST_DAG_ID, run_id, logical_date_parsed, TEST_TASK_ID, mapped_ti=True)

response = test_client.get(
"/dags/~/dagRuns/~/taskInstances/~/xcomEntries",
params={"map_index": map_index} if map_index is not None else None,
)
with assert_queries_count(4):
response = test_client.get(
"/dags/~/dagRuns/~/taskInstances/~/xcomEntries",
params={"map_index": map_index} if map_index is not None else None,
)
assert response.status_code == 200
response_data = response.json()

Expand Down Expand Up @@ -398,10 +402,11 @@ def test_should_respond_200_with_map_index(self, map_index, test_client):
)
def test_should_respond_200_with_xcom_key(self, key, expected_entries, test_client):
self._create_xcom_entries(TEST_DAG_ID, run_id, logical_date_parsed, TEST_TASK_ID, mapped_ti=True)
response = test_client.get(
"/dags/~/dagRuns/~/taskInstances/~/xcomEntries",
params={"xcom_key_pattern": key} if key is not None else None,
)
with assert_queries_count(4):
response = test_client.get(
"/dags/~/dagRuns/~/taskInstances/~/xcomEntries",
params={"xcom_key_pattern": key} if key is not None else None,
)

assert response.status_code == 200
response_data = response.json()
Expand Down
Loading