amoghrajesh opened a new pull request, #57494:
URL: https://github.com/apache/airflow/pull/57494
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
closes: https://github.com/apache/airflow/issues/57437
## Problem and Root cause
HITL operators with notifiers (e.g., SMTP) failed with "connection not
found" errors because `upsert_hitl_detail()` wasn't consuming its
SUPERVISOR_COMMS response. This caused subsequent connection requests to read
the wrong message
from the socket buffer.
The `upsert_hitl_detail()` function sent a request but didn't capture the
response:
```python
SUPERVISOR_COMMS.send(msg=CreateHITLDetailPayload(...))
```
The supervisor sent back a `HITLDetailRequestResult`, which remained in the
socket buffer. When the notifier requested the SMTP connection, it read this
stale response instead of the connection response and failed in that
translation.
Fixed by:
- Consuming the response in `upsert_hitl_detail()`
- Aligning HITL client/supervisor pattern with XCom/Connection handlers
- Client returns HITLDetailRequest, supervisor converts to
HITLDetailRequestResult (similar pattern to XCom req/resp)
## Testing
Used this DAG:
```python
from airflow import DAG
from airflow.providers.smtp.notifications.smtp import send_smtp_notification
from datetime import datetime
from airflow.providers.standard.operators.empty import EmptyOperator
from airflow.providers.standard.operators.hitl import HITLBranchOperator
with DAG(
dag_id="hitl_example",
schedule=None,
start_date=datetime(2024, 1, 1),
catchup=False,
) as dag:
send_invoices_export = EmptyOperator(
task_id="send_invoices_export",
)
abort_export_creation = EmptyOperator(
task_id="abort_export_creation",
)
review_export_task = HITLBranchOperator(
task_id = "review_export",
subject="Please check the export provided in S3 bucket. See the
previous task for detailed errors.",
options=["send_invoices_export", "abort_export_creation"],
notifiers=[
send_smtp_notification(
from_email="[email protected]",
to="[email protected]",
subject="Export needs to be checked",
html_content="Please check the export provided in S3
bucket"
)
]
)
review_export_task >> [abort_export_creation, send_invoices_export]
```
Created an SMTP connection with host as: `mailpit`, port as `1025`
<img width="2556" height="874" alt="image"
src="https://github.com/user-attachments/assets/ebf63539-533f-4957-a299-06dc8ab53872";
/>
Flow:
<img width="1724" height="898" alt="image"
src="https://github.com/user-attachments/assets/76ee1b47-7b72-40b9-8746-24166d42d9cf";
/>
Notifier sent this email:
<img width="1724" height="898" alt="image"
src="https://github.com/user-attachments/assets/b6ab3cd9-3521-4785-a925-490625d5689d";
/>
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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]
