Add email service #123

ttoino · 2023-02-23T22:38:55Z

Closes #82.

Adds a new EmailService with a method send, which receives an instance of EmailBuilder.
Two builders were implemented: SimpleEmailBuilder, which receives all properties directly, and TemplateEmailBuilder, which generates the subject, content and attachments from the given data using mustache templates.

Each different template email should be a subclass of TemplateEmailBuilder, here's an example:

data class ExampleContext(
    val title: String,
    val todos: List<String>
)

class ExampleEmailBuilder : TemplateEmailBuilder<ExampleContext>("example")

<!-- .../resources/templates/email/example.mustache -->
---
subject: Example: {{title}}
attachments:
    - {{title}}.txt :: classpath:application.properties
inline:
    - image :: classpath:image.png
---

# {{title}}

{{#todos}}
- {{.}}
{{/todos}}

![Image](cid:image)

service.send(
    ExampleEmailBuilder()
        .data(ExampleContext("Grocery list", listOf("Potatoes", "Tomatoes", "Cheese")))
        .to("[email protected]")
)

This sends an email that looks something like this:

Review checklist

Contains enough appropriate tests
Behavior is as expected
Clean, well structured code

codecov-commenter · 2023-03-04T01:34:52Z

Codecov Report

Patch coverage: 16.66% and project coverage change: -11.07 ⚠️

Comparison is base (2a423b6) 88.49% compared to head (33dc731) 77.43%.

Additional details and impacted files

@@              Coverage Diff               @@
##             develop     #123       +/-   ##
==============================================
- Coverage      88.49%   77.43%   -11.07%     
- Complexity       345      355       +10     
==============================================
  Files             61       67        +6     
  Lines            791      935      +144     
  Branches          65       76       +11     
==============================================
+ Hits             700      724       +24     
- Misses            57      177      +120     
  Partials          34       34

Impacted Files	Coverage Δ
.../pt/up/fe/ni/website/backend/BackendApplication.kt	`50.00% <ø> (ø)`
...up/fe/ni/website/backend/email/BaseEmailBuilder.kt	`0.00% <0.00%> (ø)`
.../fe/ni/website/backend/email/SimpleEmailBuilder.kt	`0.00% <0.00%> (ø)`
...e/ni/website/backend/email/TemplateEmailBuilder.kt	`0.00% <0.00%> (ø)`
...t/up/fe/ni/website/backend/service/EmailService.kt	`37.50% <37.50%> (ø)`
.../fe/ni/website/backend/config/email/EmailConfig.kt	`100.00% <100.00%> (ø)`
...site/backend/config/email/EmailConfigProperties.kt	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

ttoino · 2023-03-04T01:48:13Z

I'm marking as ready for review, but a few things are still missing:

Support for images and other embedded resources like styles
Default email layout and styles - Supported, design not finalized
Some kind of testing (not sure what to do here)
~~Maybe~~ markdown support
Documentation - in the wiki

github-actions · 2023-03-17T15:51:36Z

Check the documentation preview: https://64148c8507396b40a734ad10--niaefeup-backend-docs.netlify.app

github-actions · 2023-03-18T19:47:38Z

Check the documentation preview: https://64161557a5113f2455baeb87--niaefeup-backend-docs.netlify.app

BrunoRosendo

What a great PR 🎉 Tremendous job! I left minor/cosmetic suggestions

One thing I don't like is having email as a top-level package, I think we already have enough of them. What do you think of storing the builders under service/email/? together with EmailService?

src/main/kotlin/pt/up/fe/ni/website/backend/config/email/EmailConfigProperties.kt

src/main/kotlin/pt/up/fe/ni/website/backend/email/BaseEmailBuilder.kt

BrunoRosendo · 2023-03-19T17:34:49Z

src/main/kotlin/pt/up/fe/ni/website/backend/email/BaseEmailBuilder.kt

+import pt.up.fe.ni.website.backend.config.email.EmailConfigProperties
+import pt.up.fe.ni.website.backend.model.Account
+
+abstract class BaseEmailBuilder : EmailBuilder {


Testing the builders should be trivial with unit tests (testing validation, whether emails are added in the right places, etc.)

One can also mock the java mail library and verify if the methods are being called with the correct arguments

src/main/kotlin/pt/up/fe/ni/website/backend/email/SimpleEmailBuilder.kt

src/main/kotlin/pt/up/fe/ni/website/backend/email/TemplateEmailBuilder.kt

src/main/resources/email/style.css

src/main/kotlin/pt/up/fe/ni/website/backend/service/EmailService.kt

BrunoRosendo · 2023-03-19T18:06:55Z

src/main/kotlin/pt/up/fe/ni/website/backend/email/TemplateEmailBuilder.kt

+        this.data = data
+    }
+
+    override fun build(helper: MimeMessageHelper, emailConfigProperties: EmailConfigProperties) {


this function is a bit verbose, I'd consider splitting it into more methods if possible

BrunoRosendo · 2023-03-19T18:10:11Z

src/main/resources/application.properties

+spring.mail.host=
+spring.mail.port=
+spring.mail.username=
+spring.mail.password=


Will we need to configure this in prod? It'd be nice to have some example in the wiki if so

You're right, I'll add a section on how to configure it

Where is it? I may be legally blind

Could you try to add this @rubuy-74 ? (Meant to comment under the open conversation, about adding instructions to the wiki)

src/main/resources/templates/email/layout.html.mustache

github-actions · 2023-03-23T16:30:22Z

Check the documentation preview: https://641c7e9b8ddee704dad18da7--niaefeup-backend-docs.netlify.app

BrunoRosendo · 2023-04-02T01:09:40Z

Have you decided something about the tests?

github-actions · 2023-06-28T16:05:02Z

Check the documentation preview: https://649c5a2becd22626c57b25e2--niaefeup-backend-docs.netlify.app

src/main/kotlin/pt/up/fe/ni/website/backend/email/SimpleEmailBuilder.kt

github-actions · 2024-11-28T17:04:31Z

Check the documentation preview: https://6748a29cc73b7330bd8b3797--niaefeup-backend-docs.netlify.app

github-actions · 2025-01-24T17:29:03Z

Check the documentation preview: https://6793cddd62e627d5c653cc1b--niaefeup-backend-docs.netlify.app

MRita443

It's looking good so far. Shouldn't we add tests for SimpleEmailBuilder and TemplateEmailBuildertoo?

MRita443 · 2025-01-24T17:40:54Z

src/main/resources/application.properties

+spring.mail.host=
+spring.mail.port=
+spring.mail.username=
+spring.mail.password=


Could you try to add this @rubuy-74 ? (Meant to comment under the open conversation, about adding instructions to the wiki)

MRita443 · 2025-01-24T17:41:26Z

src/test/kotlin/pt/up/fe/ni/website/backend/email/BaseEmailBuilderTest.kt

+class BaseEmailBuilderImpl(
+    override val emailConfigProperties: EmailConfigProperties
+) : BaseEmailBuilder() {
+    fun getToEmails(): Set<String> = to
+    fun getCcEmails(): Set<String> = cc
+    fun getBccEmails(): Set<String> = bcc
+    fun getFromEmail(): String? = from
+    fun getName(): String? = fromPersonal
+}


Why is this needed?

rubuy-74 · 2025-01-26T16:13:36Z

Don't forget to add instructions for testing on the wiki.

…iaefeup-backend into feature/email-service

BrunoRosendo

I like the changes from the last time I saw it. Good job with the tests!

One thing that would be great to improve is the size of the PRs. We didn't use to do this in NI but it's much easier to do small and incremental PRs, even if the feature or issue isn't fully closed. This should help make the reviews quicker and avoid having stale CRs for months at a time

PS: you need to fix the lint, it seems

BrunoRosendo

approve to unblock, but look at the comments

This comment was marked as resolved.

Sign in to view

ttoino force-pushed the feature/email-service branch 2 times, most recently from 78a6476 to c1c29c2 Compare February 25, 2023 11:53

ttoino marked this pull request as ready for review March 4, 2023 01:43

jamcunha self-requested a review March 19, 2023 14:00

BrunoRosendo requested changes Mar 19, 2023

View reviewed changes

BrunoRosendo reviewed Mar 19, 2023

View reviewed changes

src/main/resources/templates/email/layout.html.mustache Show resolved Hide resolved

ttoino mentioned this pull request Mar 20, 2023

email: Implement layout and style #140

Open

bdmendes self-requested a review March 29, 2023 15:22

ttoino added 9 commits June 28, 2023 16:58

Add email service

59fb90c

Add template email builder

ec5e79a

Add more properties to email config

213ef50

Implement email attachments

445a092

Add default empty email credentials

a1a75b2

Use markdown for email templates and add support for inline files

0604abc

Add html layout and style support for emails

65d97f7

Move attachment support to SimpleEmailBuilder, add inline support to it

8c9a313

Use beans in email builders

33dc731

ttoino force-pushed the feature/email-service branch from 744c69c to 33dc731 Compare June 28, 2023 15:58

bdmendes reviewed Jul 3, 2023

View reviewed changes

src/main/kotlin/pt/up/fe/ni/website/backend/email/SimpleEmailBuilder.kt Outdated Show resolved Hide resolved

pedrosilva17 and others added 3 commits August 18, 2024 19:20

progress in tests (temporary changes)

9737590

Fix tests

d9435bf

Create new tests

024dae6

fix: linter issues

efd4b4e

MRita443 requested review from MRita443 and removed request for jamcunha December 4, 2024 16:46

Merge branch 'develop' into feature/email-service

4ccc546

MRita443 requested a review from BrunoRosendo January 24, 2025 17:22

MRita443 requested changes Jan 24, 2025

View reviewed changes

rubuy-74 and others added 4 commits January 26, 2025 16:51

feat:TemplateEmailBuilder tests

b70fd52

feat:SimpleEmailBuilder tests

4b0505b

Merge branch 'feature/email-service' of github.com:NIAEFEUP/website-n…

1ea1473

…iaefeup-backend into feature/email-service

Merge branch 'develop' into feature/email-service

5b79ed5

rubuy-74 requested a review from MRita443 January 28, 2025 15:31

BrunoRosendo reviewed Feb 3, 2025

View reviewed changes

BrunoRosendo approved these changes Feb 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add email service #123

Add email service #123

ttoino commented Feb 23, 2023 •

edited

Loading

This comment was marked as resolved.

codecov-commenter commented Mar 4, 2023 •

edited by codecov bot

Loading

ttoino commented Mar 4, 2023 •

edited

Loading

github-actions bot commented Mar 17, 2023

github-actions bot commented Mar 18, 2023

BrunoRosendo left a comment

BrunoRosendo Mar 19, 2023

DoStini Sep 1, 2023

BrunoRosendo Mar 19, 2023

BrunoRosendo Mar 19, 2023 •

edited

Loading

ttoino Mar 20, 2023

BrunoRosendo Apr 1, 2023

MRita443 Jan 24, 2025 •

edited

Loading

github-actions bot commented Mar 23, 2023

BrunoRosendo commented Apr 2, 2023

github-actions bot commented Jun 28, 2023

github-actions bot commented Nov 28, 2024

github-actions bot commented Jan 24, 2025

MRita443 left a comment

MRita443 Jan 24, 2025 •

edited

Loading

MRita443 Jan 24, 2025

rubuy-74 commented Jan 26, 2025 •

edited

Loading

BrunoRosendo left a comment •

edited

Loading

BrunoRosendo left a comment

Add email service #123

Are you sure you want to change the base?

Add email service #123

Conversation

ttoino commented Feb 23, 2023 • edited Loading

Review checklist

This comment was marked as resolved.

codecov-commenter commented Mar 4, 2023 • edited by codecov bot Loading

Codecov Report

ttoino commented Mar 4, 2023 • edited Loading

github-actions bot commented Mar 17, 2023

github-actions bot commented Mar 18, 2023

BrunoRosendo left a comment

Choose a reason for hiding this comment

BrunoRosendo Mar 19, 2023

Choose a reason for hiding this comment

DoStini Sep 1, 2023

Choose a reason for hiding this comment

BrunoRosendo Mar 19, 2023

Choose a reason for hiding this comment

BrunoRosendo Mar 19, 2023 • edited Loading

Choose a reason for hiding this comment

ttoino Mar 20, 2023

Choose a reason for hiding this comment

BrunoRosendo Apr 1, 2023

Choose a reason for hiding this comment

MRita443 Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Mar 23, 2023

BrunoRosendo commented Apr 2, 2023

github-actions bot commented Jun 28, 2023

github-actions bot commented Nov 28, 2024

github-actions bot commented Jan 24, 2025

MRita443 left a comment

Choose a reason for hiding this comment

MRita443 Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

MRita443 Jan 24, 2025

Choose a reason for hiding this comment

rubuy-74 commented Jan 26, 2025 • edited Loading

BrunoRosendo left a comment • edited Loading

Choose a reason for hiding this comment

BrunoRosendo left a comment

Choose a reason for hiding this comment

ttoino commented Feb 23, 2023 •

edited

Loading

codecov-commenter commented Mar 4, 2023 •

edited by codecov bot

Loading

ttoino commented Mar 4, 2023 •

edited

Loading

BrunoRosendo Mar 19, 2023 •

edited

Loading

MRita443 Jan 24, 2025 •

edited

Loading

MRita443 Jan 24, 2025 •

edited

Loading

rubuy-74 commented Jan 26, 2025 •

edited

Loading

BrunoRosendo left a comment •

edited

Loading