Setup MailHog in Docker to send test notifications #146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SerpentBytes
added
category: back end
humphd
previously approved these changes
Feb 7, 2023
There was a problem hiding this comment.
One suggestion, looks great otherwise.
cc @sirinoks, we should add some docs about how to use this new test email server in development. It's really cool, you can go to http://localhost:8025 and you have a GMail like UI that shows you the emails you've sent. There is also an API you can use in testing, which @td will probably document when he writes tests.
.env.example
Outdated
| @@ -11,3 +11,7 @@ PORT=8080 | |||
|
|
|||
| # One of: trace, debug, info, warn, error, fatal, silent | |||
| LOG_LEVEL=debug | |||
|
|
|||
| # Nodemailer config | |||
| NODEMAILER_USER="[email protected]" | |||
There was a problem hiding this comment.
Let's rename this to NOTIFICATIONS_EMAIL_USER. The nodemailer bit is an internal detail that admins of the system won't care about. Add a comment above it that indicates what it's for.
There was a problem hiding this comment.
@humphd resolved in latest commit.
* Add nodemailer env var * Add mailhog smtf port * setup malhog * Add alternative dev transport to use for testing * update typo in mailhog env var * remove quotes from mailhog setup in docker-compose * improve nodemailer module * Update nodemail user variable name * replace NODEMAILER_USER with NOTIFICATIONS_EMAIL_USER
Genne23v
approved these changes
Feb 7, 2023
humphd
approved these changes
Feb 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR resolves #126 by setting up MailHog in Docker to test sending notification emails in the development environment.
Steps to Test
cp .env.example .envnpm run dockernpm run setupnpm run buildnpm run devlocalhost:8025:Additional Information
There are currently no tests implemented to check whether we are able to send notifications successfully. I intend on implementing tests for notifications in a follow-up PR.