Skip to content
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.

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

Added exception catching to send default email if template file raises any exception #24943

Merged
merged 4 commits into from
Jul 18, 2022

Conversation

ecodina
Copy link
Contributor

@ecodina ecodina commented Jul 9, 2022

This PR closes #24919

A try - except block has been added to prevent email failure when a custom template file is used for task error notifications.

Although once Airflow has been correctly configured we should never need the except block, sometimes we may encounter issues when updating the template file. I believe Airflow should always send the email and, in case the template file has any problems, it should just send the default template.

@boring-cyborg
Copy link

boring-cyborg bot commented Jul 9, 2022

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@ecodina
Copy link
Contributor Author

ecodina commented Jul 10, 2022

A test failed, but I'd like to argue my case:

In this try - except we will mostly catch the FileNotFoundError, which is explicit.

In any other case (e.g. an IO error), I believe we should still send the email with the default template to make sure we are always notified.

@potiuk
Copy link
Member

potiuk commented Jul 12, 2022

Yeah. I'd agree. Please add tests covering it and fix those that failed.

content = f.read()
except FileNotFoundError:
self.log.warning(f"Could not find email template file '{path}'. Using defaults...")
except:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 to this blank catch. It’s probably worthwhile to catch all OSError, but this is way to broad.

with open(path) as f:
content = f.read()
except FileNotFoundError:
self.log.warning(f"Could not find email template file '{path}'. Using defaults...")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better to use {path!r}

@ecodina
Copy link
Contributor Author

ecodina commented Jul 17, 2022

Follwing @uranusjr advice, I replaced the broad exception to only catch OSError (which is the only one that should happen, actually). I have also added a UnitTest:

tests/models/test_taskinstance.py::TestTaskInstance::test_email_alert_with_filenotfound_config PASSED

With this changes, the PR should be ready to be merged.

@potiuk
Copy link
Member

potiuk commented Jul 18, 2022

Only static checks already fixed in main are failing. MErging.

@potiuk potiuk merged commit fd6f537 into apache:main Jul 18, 2022
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 18, 2022

Awesome work, congrats on your first merged pull request!

@ecodina ecodina deleted the default-email-error branch July 19, 2022 06:23
@ephraimbuddy ephraimbuddy added the type:bug-fix Changelog: Bug Fixes label Aug 14, 2022
@ephraimbuddy ephraimbuddy added this to the Airflow 2.3.4 milestone Aug 15, 2022
ephraimbuddy pushed a commit that referenced this pull request Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:bug-fix Changelog: Bug Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Send default email if file "html_content_template" not found
4 participants