You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "vchiapaikeo (via GitHub)" <gi...@apache.org> on 2023/12/14 16:50:57 UTC
[PR] Add TemplatedSmtpNotifier [airflow]
vchiapaikeo opened a new pull request, #36226:
URL: https://github.com/apache/airflow/pull/36226
<!--
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:
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
closes: https://github.com/apache/airflow/issues/35381
Creating a TemplatedSmtpNotifier class that simplifies sending emails based on the discussion in https://github.com/apache/airflow/issues/35381. This class simply extends from the SmtpNotifier and defaults a number of the required arguments (like email_from, subject, and html_content). The latter two variables are pulled from airflow/settings.py.
On the template itself, I was initially thinking of having at least three distinct templates following https://github.com/apache/airflow/issues/35381#issuecomment-1792108885 but it's simple to add a condition to detect whether we are sending an SLA miss or a failure/success/retry email so I decided on using a single template. Happy to change that approach if the community thinks having distinct templates are cleaner.
Will work on tests after the approach is generally agreed upon.
## Examples
on_failure_callback / on_success_callback / on_retry_callback -
<img width="1032" alt="Screenshot 2023-12-14 at 11 41 37 AM" src="https://github.com/apache/airflow/assets/9200263/a36c8a17-edb0-447f-b521-32f07e3edee7">
sla_miss_callback -
<img width="1017" alt="Screenshot 2023-12-14 at 11 42 05 AM" src="https://github.com/apache/airflow/assets/9200263/71686fdb-1de9-44c6-af4b-4c060407f641">
<!-- 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.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 [newsfragments](https://github.com/apache/airflow/tree/main/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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1430312108
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
We can decide on major release if we have confidence its nececery
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #36226:
URL: https://github.com/apache/airflow/pull/36226#issuecomment-1963854193
This is backward compatibility issue that should be fixed (it was not caught because the settings import was a local import and that's why it passed compatibility checks. Will make a PR fixing it in a moment.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "vchiapaikeo (via GitHub)" <gi...@apache.org>.
vchiapaikeo commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1429356248
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
This introduces a potential breaking change for any uses of SmtpNotifier that rely on positional arguments. Thoughts? Alternatively, we could just keep it as is and require that users pass it like was done before.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "hussein-awala (via GitHub)" <gi...@apache.org>.
hussein-awala commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1430376298
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
I don't see any need for this change; we can add only the newly added parameters after the `*` with a TODO comment for this change in the next major release.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "vchiapaikeo (via GitHub)" <gi...@apache.org>.
vchiapaikeo commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1430486041
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
Ack @hussein-awala - I can revert. The one newly added parameter is `template` so that one parameter will come after the `*`. And will get the TODO comment in there for the next major release.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "stephenatgithub (via GitHub)" <gi...@apache.org>.
stephenatgithub commented on PR #36226:
URL: https://github.com/apache/airflow/pull/36226#issuecomment-1963759865
Please notice that [chicken-egg provider](https://github.com/apache/airflow/blob/main/dev/README_RELEASE_PROVIDER_PACKAGES.md#chicken-egg-providers) is encountered.
apache-airflow-providers-smtp 1.6.0 does not work with airflow 2.8.1
because modified code in [airflow/settings.py](airflow/settings.py) is not yet released in airflow 2.8.1
I manually downgraded apache-airflow-providers-smtp to 1.5.0 and it worked fine with airflow 2.8.1 now
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #36226:
URL: https://github.com/apache/airflow/pull/36226#issuecomment-1963894082
Fix in https://github.com/apache/airflow/pull/37701
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add TemplatedSmtpNotifier [airflow]
Posted by "vchiapaikeo (via GitHub)" <gi...@apache.org>.
vchiapaikeo commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1428161896
##########
airflow/providers/smtp/notifications/templated_smtp.py:
##########
@@ -0,0 +1,51 @@
+# 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.
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Iterable
+
+from airflow.configuration import conf
+from airflow.providers.smtp.notifications.smtp import SmtpNotifier
+from airflow.settings import SMTP_DEFAULT_TEMPLATED_HTML_CONTENT_PATH, SMTP_DEFAULT_TEMPLATED_SUBJECT
+
+# Read once and cache - is this desirable? If users edit local settings, their changes will not take effect
+# On the other hand, if we put this in the constructor, then we need to read from disk on each instantiation
+SMTP_DEFAULT_TEMPLATED_HTML_CONTENT = Path(SMTP_DEFAULT_TEMPLATED_HTML_CONTENT_PATH).read_text()
+
+
+class TemplatedSmtpNotifier(SmtpNotifier):
Review Comment:
@hussein-awala , @potiuk - what do you think about @eladkal 's idea? Asking because you both suggested something slightly different in https://github.com/apache/airflow/issues/35381#issuecomment-1791741821 and https://github.com/apache/airflow/issues/35381#issuecomment-1792108885
I'm fine either way.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #36226:
URL: https://github.com/apache/airflow/pull/36226
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add TemplatedSmtpNotifier [airflow]
Posted by "vchiapaikeo (via GitHub)" <gi...@apache.org>.
vchiapaikeo commented on PR #36226:
URL: https://github.com/apache/airflow/pull/36226#issuecomment-1856403567
cc @eladkal , @potiuk , @BasPH, @hussein-awala - would love to hear what you think when you have a moment
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add TemplatedSmtpNotifier [airflow]
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1427829595
##########
airflow/providers/smtp/notifications/templated_smtp.py:
##########
@@ -0,0 +1,51 @@
+# 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.
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Iterable
+
+from airflow.configuration import conf
+from airflow.providers.smtp.notifications.smtp import SmtpNotifier
+from airflow.settings import SMTP_DEFAULT_TEMPLATED_HTML_CONTENT_PATH, SMTP_DEFAULT_TEMPLATED_SUBJECT
+
+# Read once and cache - is this desirable? If users edit local settings, their changes will not take effect
+# On the other hand, if we put this in the constructor, then we need to read from disk on each instantiation
+SMTP_DEFAULT_TEMPLATED_HTML_CONTENT = Path(SMTP_DEFAULT_TEMPLATED_HTML_CONTENT_PATH).read_text()
+
+
+class TemplatedSmtpNotifier(SmtpNotifier):
Review Comment:
I really like the idea of templates!
However I think we should try to keep the current user API.
meaning that users should still use `SmtpNotifier`.
Thus when users do:
`MyOperator(on_success_callable=SmtpNotifier(to='myemail@myemail.com),...)`
It will use the default template of success unless user overrides it
`MyOperator(on_success_callable=SmtpNotifier(to='myemail@myemail.com), template='my_template.html'...)`
Similarly if user does:
`MyOperator(on_failure_callable=SmtpNotifier(to='myemail@myemail.com),...)`
It will use the default template of failure unless user overrides it
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "vchiapaikeo (via GitHub)" <gi...@apache.org>.
vchiapaikeo commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1430491018
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
This unfortunately means users will have to continue providing the `from_email` argument until then but that is not too much of a hassle IMO.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #36226:
URL: https://github.com/apache/airflow/pull/36226#discussion_r1430362935
##########
airflow/providers/smtp/notifications/smtp.py:
##########
@@ -47,31 +50,41 @@ class SmtpNotifier(BaseNotifier):
def __init__(
self,
- from_email: str | None,
+ *,
Review Comment:
Yeah. let's treat it as breaking change (however this one is most cases will be either super-easy to fix or will not break as people will already use keyword parameters.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Modify SmtpNotifier to accept template with defaults [airflow]
Posted by "stephenatgithub (via GitHub)" <gi...@apache.org>.
stephenatgithub commented on PR #36226:
URL: https://github.com/apache/airflow/pull/36226#issuecomment-1965722792
Wow... really quick responses and immediate actions. Thank you everyone in this airflow community.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org