feat: emails #10

typeWolffo · 2024-07-23T00:17:44Z

No description provided.

mikoscz · 2024-07-23T08:35:24Z

examples/common_nestjs_remix/apps/api/src/auth/__tests__/auth.service.spec.ts

@@ -11,6 +11,12 @@ import { omit } from "lodash";
 import hashPassword from "src/common/helpers/hashPassword";
 import { truncateAllTables } from "test/helpers/test-helpers";

+jest.mock("../../common/emails/emails.service", () => ({


I would suggest to create EmailTestingAdapter which would get all messages and save them to array/object and provides methods like getAllEmail/lastEmail etc. this way we can easily check in tests what emails were sent and assert them.

If we have EmailTestingAdapter, you don't need to mock it, inject it in the test application as an adapter, then use DI to work with it.

mikoscz · 2024-07-23T08:42:20Z

examples/common_nestjs_remix/apps/api/src/common/emails/email.config.ts

+import { ConfigService } from "@nestjs/config";
+
+@Injectable()
+export class EmailConfig {


Personally I would create another adapter like LocalAdapter which has the mailhog values hardcoded and inject config directly to the nodemailer, and then use .env with EMAIL_ADAPTER=mailhog, in prod environments smtp auth is not always the case, sometimes it is just service account. This way we can add/remove adapters without changing configuration or if we want to test something from the local we could easily use real one.

mikoscz · 2024-07-29T11:32:54Z

examples/common_nestjs_remix/apps/api/src/common/configuration/email.ts

+  SMTP_PORT: Type.Number(),
+  SMTP_USER: Type.String(),
+  SMTP_PASSWORD: Type.String(),
+  USE_MAILHOG: Type.Boolean(),


Do we still use this one?

yup, in smtp adapter.

referring to previous comment

in prod environments smtp auth is not always the case, sometimes it is just service account

then we just need to create a new adapter?

We should require environments based on what we want to use, eg I am going with local one I don't need to setup aws.

so it works like that - it checks what adapter we have specified in env EMAIL_ADAPTER and dynamically instantiate the adapter using moduleRef.create() in emails-adapter.factory. If the value in env for the specified adapter is missing - it returns an error

but I may not understand something 😅

mikoscz · 2024-07-29T11:36:33Z

examples/common_nestjs_remix/apps/api/src/common/emails/email.interface.ts

@@ -0,0 +1,7 @@
+export interface Email {


With this interface it is possible to pas an Email without both text and html. Can we make it that we need at least one?

When I specify email with only text, the html property has string | undefined should be undefined same other way around. Could we go with something simpler?

type Email = { to: string; from: string; subject: string; } & ( | { html: string; text?: never } | { text: string; html?: never } | { text: string; html: string } );

mikoscz · 2024-07-29T11:41:11Z

examples/common_nestjs_remix/apps/api/src/common/emails/factory/email-adapters.factory.ts

+  createAdapter(): EmailAdapter {
+    const adapterType = this.configService.get<AdapterType>("EMAIL_ADAPTER");
+
+    return match(adapterType)


What advantage do we get with ts-pattern?

It compares config from .env and returns the corresponding adapter. In addition, it handles errors on bad config

mikoscz · 2024-07-29T11:41:45Z

examples/common_nestjs_remix/apps/api/test/helpers/test-email.adapter.ts

+    this.sentEmails.push(finalEmail);
+  }
+
+  setEmailOverride(override: Partial<Email>): void {


What is the practical use of this override?

For tests only - to overwrite react emails with custom content. When unused it sends email from template.

I don't think this is a good idea. Adapter is only responsible for sending part so ok. there is an email I need to send it somehow. But in this case it is changing the Email that is not the part of the job. So whenever I set something I am basically testing the mock not the implementation.

@mikoscz ok so I removed that and simplified test to only check the "inbox" length

mikoscz · 2024-07-29T11:41:58Z

examples/common_nestjs_remix/package.json

@@ -7,6 +7,7 @@
    "lint": "turbo lint",
    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
    "generate:client": "pnpm run --filter=web generate:client",
+    "generate:emails": "pnpm run --filter=email-templates build",


Do we need that?

mikoscz · 2024-07-29T11:45:43Z

examples/common_nestjs_remix/packages/email-templates/plugin.mjs

@@ -0,0 +1,98 @@
+import path from "path";


If this one works probably we don't need the exports in index

index is generated by this plugin

mikoscz

I didn't check at runtime, but do I need to specify all the environments for AWS if I want to use just the local adapter?

typeWolffo · 2024-07-31T08:49:04Z

I didn't check at runtime, but do I need to specify all the environments for AWS if I want to use just the local adapter?

previously yes, but this has now been fixed

typeWolffo requested a review from mikoscz July 23, 2024 00:17

typeWolffo self-assigned this Jul 23, 2024

typeWolffo requested a review from k1eu July 23, 2024 00:17

typeWolffo force-pushed the jw/emails branch from 8a27854 to d50bd70 Compare July 23, 2024 00:25

mikoscz reviewed Jul 23, 2024

View reviewed changes

typeWolffo requested a review from mikoscz July 23, 2024 11:17

typeWolffo force-pushed the jw/emails branch from 63d4e0a to 2680c26 Compare July 23, 2024 11:21

typeWolffo added 9 commits July 24, 2024 11:28

feat: add email functionality

b32de93

feat: integrate email module into auth module

e279bc3

feat: add nodemailer adapter and email configuration

c9e7c42

feat: add email adapter factory and local adapter

7f50fd2

feat: add EmailTestingAdapter for testing email functionality

48e42c6

refactor: update email adapter type and configuration schema

c65b1ba

feat: add sas email adapter

46a9c29

feat: add react email templates

90cd7ce

feat: react emails package

c2a380a

typeWolffo force-pushed the jw/emails branch from fd11d07 to c2a380a Compare July 24, 2024 15:10

refactor: update AST parsing for email templates

8621ad8

typeWolffo force-pushed the jw/emails branch from 00e5e8d to 8621ad8 Compare July 24, 2024 15:51

mikoscz reviewed Jul 29, 2024

View reviewed changes

mikoscz requested changes Jul 29, 2024

View reviewed changes

typeWolffo added 3 commits July 30, 2024 13:10

feat: implement email adapter changes

5731c84

refactor: update email interface and AuthService tests

0e6fe0f

test: refactor AuthService tests to use EmailTestingAdapter

7f031e5

typeWolffo added 7 commits July 30, 2024 15:07

feat: add and use EmailAdapter in tests

8d1dcdc

feat: update EmailAdapterFactory to dynamically create email adapter

50282dc

feat: add config validation for email and database

7e9485e

feat: refactor email configuration to use configValidator

5c6fc6b

feat: create configValidator for validating configuration

086c024

feat: add config validation for jwt

c17047e

feat: update turbo.json for build and lint tasks

40be8e9

typeWolffo requested a review from mikoscz July 31, 2024 08:49

typeWolffo added 2 commits July 31, 2024 10:50

chore: add clean option to tsup configuration

af86c98

chore: update package.json scripts

fc3696c

typeWolffo force-pushed the jw/emails branch from 4165d90 to 234fdf8 Compare August 1, 2024 13:59

refactor: update email interface and email sending test

31bafb8

typeWolffo force-pushed the jw/emails branch from 234fdf8 to 31bafb8 Compare August 1, 2024 14:11

mikoscz approved these changes Aug 1, 2024

View reviewed changes

typeWolffo merged commit 2636bc1 into main Aug 1, 2024

typeWolffo deleted the jw/emails branch August 1, 2024 14:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: emails #10

feat: emails #10

typeWolffo commented Jul 23, 2024

mikoscz Jul 23, 2024

typeWolffo Jul 23, 2024

mikoscz Jul 29, 2024

mikoscz Jul 23, 2024

mikoscz Jul 29, 2024

typeWolffo Jul 31, 2024

typeWolffo Jul 31, 2024

mikoscz Aug 1, 2024

typeWolffo Aug 1, 2024 •

edited

Loading

typeWolffo Aug 1, 2024

mikoscz Jul 29, 2024

typeWolffo Jul 31, 2024

mikoscz Aug 1, 2024 •

edited

Loading

mikoscz Jul 29, 2024

typeWolffo Jul 31, 2024

mikoscz Jul 29, 2024

typeWolffo Jul 31, 2024

mikoscz Aug 1, 2024

typeWolffo Aug 1, 2024

mikoscz Jul 29, 2024

typeWolffo Aug 1, 2024

mikoscz Jul 29, 2024

typeWolffo Jul 31, 2024

mikoscz left a comment

typeWolffo commented Jul 31, 2024

feat: emails #10

feat: emails #10

Conversation

typeWolffo commented Jul 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typeWolffo Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikoscz Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikoscz left a comment

Choose a reason for hiding this comment

typeWolffo commented Jul 31, 2024

typeWolffo Aug 1, 2024 •

edited

Loading

mikoscz Aug 1, 2024 •

edited

Loading