Fix XCom key handling when keys contain special characters like slash #58344

henry3260 · 2025-11-15T13:28:29Z

This PR picks up the work from @Brunda10 in PR #56042, which had become stale.

Fixes 404 errors for XCom keys containing special characters (e.g., /).
Keys are now URL-encoded (quoted) before being sent to the API.
Keys are decoded (unquoted) when received from the API.
Adds required unit tests to verify the fix, as requested in the original PR.

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

potiuk

It looks good to me from general approach - but it's not my area of expertise, so someone who works on API should take a look as this is an important part of our core APIs

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py

airflow-core/src/airflow/api_fastapi/execution_api/routes/xcoms.py

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py

ashb

Not confinced the quote/unqoute behaviour is right. And if xcom_key is wrong -- it's a required field.

jason810496

Nice!

It would be nice to add pytest.mark.parametrize with slash value key in task-sdk-integration-tests/tests/task_sdk_tests/test_xcom_operations.py tests.

Thanks!

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py

pierrejeambrun

LGTM, @ashb do you mind reconsidering your request for change by any chance and giving this a second look? :)

pierrejeambrun

@henry3260 Do you mind rebasing to fix the conflicts. We can probably go ahead and merge, the PR is looking good.

henry3260 · 2025-12-04T14:49:44Z

@henry3260 Do you mind rebasing to fix the conflicts. We can probably go ahead and merge, the PR is looking good.

Sure

henry3260 · 2025-12-05T05:42:30Z

@henry3260 Do you mind rebasing to fix the conflicts. We can probably go ahead and merge, the PR is looking good.

All CI tests have passed. Ready for merge!

stale

pierrejeambrun

A few nits to fix and we should be good to merge.

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py

pierrejeambrun · 2025-12-11T11:06:16Z

Thanks for the PR.

…s like slash (#58344) * Fix XCom key handling when keys contain special characters like slash * remove all the unquote * add test * remove all the quote() in client.py * fix unit test (cherry picked from commit 6e3e512) Co-authored-by: Henry Chen <henryhenry0512@gmail.com>

github-actions · 2025-12-11T11:08:13Z

Backport successfully created: v3-1-test

Status	Branch	Result
✅	v3-1-test

…s like slash (#58344) (#59311) * Fix XCom key handling when keys contain special characters like slash * remove all the unquote * add test * remove all the quote() in client.py * fix unit test (cherry picked from commit 6e3e512) Co-authored-by: Henry Chen <henryhenry0512@gmail.com>

Fix XCom key handling when keys contain special characters like slash

ab52bc0

henry3260 requested review from amoghrajesh, ashb, bugraoz93, ephraimbuddy, jason810496, kaxil, pierrejeambrun, rawwar and shubhamraj-git as code owners November 15, 2025 13:28

boring-cyborg bot added area:API Airflow's REST/HTTP API area:task-sdk labels Nov 15, 2025

potiuk mentioned this pull request Nov 15, 2025

Fix XCom key handling when keys contain special characters like / #56042

Closed

potiuk approved these changes Nov 15, 2025

View reviewed changes

ashb reviewed Nov 16, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py Outdated Show resolved Hide resolved

ashb reviewed Nov 16, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py Outdated Show resolved Hide resolved

ashb reviewed Nov 16, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/execution_api/routes/xcoms.py Outdated Show resolved Hide resolved

ashb reviewed Nov 16, 2025

View reviewed changes

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py Outdated Show resolved Hide resolved

ashb previously requested changes Nov 16, 2025

View reviewed changes

henry3260 force-pushed the Xcom_Slash_key-Fix branch 2 times, most recently from cd15ca0 to 5e89a44 Compare November 17, 2025 16:55

remove all the unquote

542ba3a

henry3260 force-pushed the Xcom_Slash_key-Fix branch from 5e89a44 to 542ba3a Compare November 17, 2025 18:18

henry3260 requested a review from ashb November 18, 2025 01:56

jason810496 reviewed Nov 21, 2025

View reviewed changes

henry3260 requested review from gopidesupavan and jscheffl as code owners November 21, 2025 18:18

henry3260 requested a review from jason810496 November 21, 2025 18:18

henry3260 force-pushed the Xcom_Slash_key-Fix branch 2 times, most recently from 364ccfd to 1c2835e Compare November 22, 2025 07:18

pierrejeambrun reviewed Nov 24, 2025

View reviewed changes

airflow-core/src/airflow/api_fastapi/core_api/routes/public/xcom.py Outdated Show resolved Hide resolved

remove all the quote() in client.py

658f49d

henry3260 requested a review from pierrejeambrun November 28, 2025 12:50

pierrejeambrun approved these changes Nov 28, 2025

View reviewed changes

henry3260 force-pushed the Xcom_Slash_key-Fix branch from bd882d9 to 7385d94 Compare December 3, 2025 09:44

pierrejeambrun reviewed Dec 4, 2025

View reviewed changes

pierrejeambrun mentioned this pull request Dec 4, 2025

Add ability to add, edit, and delete XComs directly from UI #58921

Merged

henry3260 force-pushed the Xcom_Slash_key-Fix branch from 7a4b010 to 828390f Compare December 4, 2025 18:11

pierrejeambrun reviewed Dec 10, 2025

View reviewed changes

henry3260 force-pushed the Xcom_Slash_key-Fix branch from 4e80248 to 658f49d Compare December 10, 2025 19:39

henry3260 added 2 commits December 11, 2025 03:54

fix unit test

b6c0104

Merge branch 'main' into Xcom_Slash_key-Fix

ac4ba11

pierrejeambrun approved these changes Dec 11, 2025

View reviewed changes

pierrejeambrun reviewed Dec 11, 2025

View reviewed changes

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py Show resolved Hide resolved

pierrejeambrun reviewed Dec 11, 2025

View reviewed changes

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_xcom.py Show resolved Hide resolved

pierrejeambrun added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Dec 11, 2025

pierrejeambrun added this to the Airflow 3.1.5 milestone Dec 11, 2025

pierrejeambrun added the full tests needed We need to run full set of tests for this PR to merge label Dec 11, 2025

pierrejeambrun merged commit 6e3e512 into apache:main Dec 11, 2025
127 checks passed

pierrejeambrun removed the full tests needed We need to run full set of tests for this PR to merge label Dec 11, 2025

henry3260 deleted the Xcom_Slash_key-Fix branch December 15, 2025 19:41

Fix XCom key handling when keys contain special characters like slash #58344

Fix XCom key handling when keys contain special characters like slash #58344

Uh oh!

Conversation

henry3260 commented Nov 15, 2025

Uh oh!

potiuk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ashb left a comment

Choose a reason for hiding this comment

Uh oh!

jason810496 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pierrejeambrun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pierrejeambrun left a comment

Choose a reason for hiding this comment

Uh oh!

henry3260 commented Dec 4, 2025

Uh oh!

henry3260 commented Dec 5, 2025

Uh oh!

pierrejeambrun left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pierrejeambrun commented Dec 11, 2025

Uh oh!

Uh oh!

github-actions bot commented Dec 11, 2025

Backport successfully created: v3-1-test

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pierrejeambrun left a comment •

edited

Loading

pierrejeambrun left a comment •

edited

Loading