Skip to content

[ENG-11254] Improve local dev with mailhog configuration #11749

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

Open
Ostap-Zherebetskyi wants to merge 4 commits into
base: feature/pbs-26-9
Choose a base branch
from
Open

[ENG-11254] Improve local dev with mailhog configuration #11749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92aadda
Refactor Notification.send method to remove protocol_type parameter a…
Ostap-Zherebetskyi May 21, 2026
d485113
Set LOCAL_MODE to True for local-ci
Ostap-Zherebetskyi May 21, 2026
7e3d7f5
Add warning log for email sending in LOCAL_MODE without MailHog
Ostap-Zherebetskyi May 21, 2026
4ecf7e3
Apply CR suggestions
cslzchen May 21, 2026
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
16 changes: 11 additions & 5 deletions osf/models/notification.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from django.utils import timezone

from api.base import settings as api_settings
from website import settings as osf_settings
from osf import email, features


Expand All @@ -21,7 +22,6 @@ class Notification(models.Model):

def send(
self,
protocol_type='email',
destination_address=None,
email_context=None,
save=True,
Expand All @@ -36,22 +36,28 @@ def send(
f"\ncontext={self.event_context}"
f"\nemail_context={email_context}"
)
if protocol_type == 'email' and waffle.switch_is_active(features.ENABLE_MAILHOG):

if waffle.switch_is_active(features.ENABLE_MAILHOG):
email.send_email_over_smtp(
recipient_address,
self.subscription.notification_type,
self.event_context,
email_context
)
elif protocol_type == 'email':

if not osf_settings.LOCAL_MODE:
email.send_email_with_send_grid(
recipient_address,
self.subscription.notification_type,
self.event_context,
email_context
)
else:
raise NotImplementedError(f'protocol `{protocol_type}` is not supported.')

if osf_settings.LOCAL_MODE and not waffle.switch_is_active(features.ENABLE_MAILHOG):
logging.warning(
'Both ENABLE_MAILHOG and LOCAL_MODE are disabled. Emails will not be sent to MailHog or real email addresses. '
'Turn on ENABLE_MAILHOG to send emails to MailHog for testing, or turn on LOCAL_MODE to send emails with SendGrid.'
)

if save:
self.mark_sent()
Expand Down
1 change: 1 addition & 0 deletions website/settings/local-ci.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
DEV_MODE = True
DEBUG_MODE = True # Sets app to debug mode, turns off template caching, etc.
SECURE_MODE = not DEBUG_MODE # Disable osf secure cookie
LOCAL_MODE = True # Local development environment, used to toggle certain features on/off

PROTOCOL = 'https://' if SECURE_MODE else 'http://'
DOMAIN = PROTOCOL + 'localhost:5000/'
Expand Down