Feat SES event-based email sendouts #1530

tchalvak · 2023-09-25T02:26:50Z

Purpose of PR:

--- Sending out emails via AWS SES via the conduit of EventBridge

Email generated and sent (locally, but hooked into the AWS account eventbridge for testing purposes).
It goes from: php code -> NMail php class -> send method -> aws-php-sdk -> eventbridge -> lambda -> SES
And then in to the magic of the email system.

End Result in my gmail:

Before

We were using a system based on exim4 on the server, and also relying on a phpmailer library in php that became deprecated and then removed.

After

Now we hook right in to SES via events. We could probably eventually use SES templates and other such things.

For Non-Hotfixes:

Attached Screenshot of my change:

Things that make review take longer:

(remove lines that do not apply to this PR)

Changing more than 20 files (much harder to review)
Changing more than 5 files (a bit harder to review)
Changes to critical code (login, dashboard, etc)
No comments on changed files (unknown)
Tests do not pass (will get pushed back)

Things that make review faster and easier:

(check box with an x where it applies)

I attached a screenshot of the changed part of the app working
I added tests
This feature is requested specifically by a user
This will fix a bug

Preview results in my branch at the url:

Add aws access to send through SES? You probably don't want to do that, so just review the tests and check that the new ones make sense, and if you're ambitious, run the unit tests yourself locally via:
:/src/ninjawars$ ./vendor/bin/phpunit-watcher watch /src/ninjawars/deploy/lib/events/PutEventTest.php
You can run a signup at https://localhost:8765/signup , but of course that'll stop at the attempt to send an event to aws which will fail if you don't have it hooked in to an aws account.

This commit fixes the style issues introduced in 6276d1c according to the output from PHP CS Fixer. Details: #1530

This commit fixes the style issues introduced in 1feb906 according to the output from PHP CS Fixer. Details: #1530

This commit fixes the style issues introduced in 9465868 according to the output from PHP CS Fixer. Details: #1530

a future note that to get expected overriding, have to use the initial array as the second entry in the plus operator + chain, strangely.

This commit fixes the style issues introduced in 1501583 according to the output from PHP CS Fixer. Details: #1530

tchalvak · 2023-09-27T00:18:40Z

@Beagle Feel like giving a PR review? : D

tchalvak · 2023-10-01T17:07:35Z

Ah, need to run with some of this functionality, but do check through @Beagle and give review and I’ll follow up.

Beagle · 2023-10-04T19:45:30Z

deploy/lib/events/PutEvent.php

+    list($email, $display) = is_array($email_complex) ?
+        [array_key_first($email_complex), reset($email_complex)] :
+        [$email_complex, null];
+    $sanitized_email = filter_var($email, FILTER_SANITIZE_EMAIL);


Double check this against valid email addresses that have special characters. As an example, ' is a valid email character so you should be able to send to seamus.o'[email protected]

Beagle · 2023-10-04T19:46:42Z

deploy/lib/events/PutEvent.php

+}
+
+/**
+ * Email config validation, which should perhaps eventually be moved away from event lib


What is config? Saying "validateEmailIncomingConfig provides email config validation" is not a useful comment. Perhaps: "This validates email header information includes from, to, subject, etc"

Beagle · 2023-10-04T19:48:10Z

deploy/lib/events/PutEvent.php

+    return null;
+}
+
+function generateEmailEvent(array $config): array


"Returns a dictionary with the keys and data required to submit an event to the event bus"

Beagle · 2023-10-04T19:49:54Z

deploy/lib/extensions/Nmail.class.php

@@ -79,47 +96,23 @@ public function setReplyTo($email_or_array)
     *
     * @return boolean whether the mail function accepted the inputs.
     */
-    public function send()
+    public function send($debug_override = false)


document the intention of debug_override

Beagle · 2023-10-04T19:51:28Z

Super nice. A great bridgehead into getting an EDA in place. Nice job!

tchalvak and others added 20 commits September 24, 2023 18:50

Add aws-sdk-php via composer.

71ebcc0

Operational PutEvent procedural file.

ec089ab

Functions for email event sendout.

5b4dda2

Add eventCheck prototyping check file.

ca621cd

Events tested a bit and prototype sending out through to gmail inbox.

6276d1c

style: format code with PHP CS Fixer

b7c72bb

This commit fixes the style issues introduced in 6276d1c according to the output from PHP CS Fixer. Details: #1530

Add SES request process doc.

ca1a1af

SES prod process doc.

0d6950b

Initial tests passing, controller not yet.

654b69a

Start to handle array to/from addresses.

1feb906

style: format code with PHP CS Fixer

22391eb

This commit fixes the style issues introduced in 1feb906 according to the output from PHP CS Fixer. Details: #1530

Improved email array support... ...skipping proper name for now.

0448835

Abstract complex address formatting.

731ae79

More base email formatting.

9465868

style: format code with PHP CS Fixer

c054a20

This commit fixes the style issues introduced in 9465868 according to the output from PHP CS Fixer. Details: #1530

Update data array merge so it overwrites correctly,

1501583

a future note that to get expected overriding, have to use the initial array as the second entry in the plus operator + chain, strangely.

style: format code with PHP CS Fixer

9be3665

This commit fixes the style issues introduced in 1501583 according to the output from PHP CS Fixer. Details: #1530

Minor email template changes.

5d98263

Email template updates.

34d4863

Minor email template footer tweak.

de3ea8c

tchalvak requested a review from Beagle September 27, 2023 00:14

tchalvak added the Important label Sep 27, 2023

tchalvak mentioned this pull request Sep 27, 2023

feat: Mail exploration #1198

Closed

8 tasks

tchalvak merged commit 8517fd9 into master Oct 1, 2023
9 checks passed

tchalvak deleted the feat/email branch October 1, 2023 17:07

Beagle reviewed Oct 4, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat SES event-based email sendouts #1530

Feat SES event-based email sendouts #1530

tchalvak commented Sep 25, 2023 •

edited

Loading

tchalvak commented Sep 27, 2023

tchalvak commented Oct 1, 2023

Beagle Oct 4, 2023

Beagle Oct 4, 2023

Beagle Oct 4, 2023

Beagle Oct 4, 2023

Beagle commented Oct 4, 2023

Feat SES event-based email sendouts #1530

Feat SES event-based email sendouts #1530

Conversation

tchalvak commented Sep 25, 2023 • edited Loading

Purpose of PR:

Before

After

For Non-Hotfixes:

Attached Screenshot of my change:

Things that make review take longer:

Things that make review faster and easier:

Preview results in my branch at the url:

tchalvak commented Sep 27, 2023

tchalvak commented Oct 1, 2023

Beagle Oct 4, 2023

Choose a reason for hiding this comment

Beagle Oct 4, 2023

Choose a reason for hiding this comment

Beagle Oct 4, 2023

Choose a reason for hiding this comment

Beagle Oct 4, 2023

Choose a reason for hiding this comment

Beagle commented Oct 4, 2023

tchalvak commented Sep 25, 2023 •

edited

Loading