Skip to content
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

Jump to bottom

Email notification #433

Merged
merged 33 commits into from
Mar 16, 2020
Merged

Email notification #433

merged 33 commits into from
Mar 16, 2020

Conversation

Stezido
Copy link
Contributor

@Stezido Stezido commented Feb 12, 2020 •
edited by daniel-arnauer
Loading

Description

  • Trubudget should offer a possibility to send email notifications.
  • The email notification shall only contain the link to the notifications page since the rest of the information can be seen there. It is not important that the notification contains more detailed information.
  • A User shall be able to subscribe or unsubscribe to email notifications via Trubudget.
  • It shall not be possible to select certain email notifications that are sent to a user.

Solution

As shown in the architecture section below, a script shall filter every transaction. The script saves the transactions with a timestamp locally as files in a notification folder.
An external process watches the notification folder and sends the user's ids via http request to the email service.
The email service creates one http server which handle:

  1. GetEmail of user
  2. Sending notifications to external smtp server
  3. un-/subscribing with email via frontend

Via env variables the email service can connect to the external SMTP-Server which actually sends the emails.
The frontend handles a user's email address in a user profile, available when clicking on the profile picture.

Architecture

image

Todo

Email-Service

Hook/ filterScript

  • Save filtered transactions with timestamp as files in local folder
  • Spawn an external process which handle reading of notification files, sending of ids to email service and deleting of files succesfully sent.
  • Delete notification files which cannot be sent for a longer time (default 24 hours)
  • Check error messages: do not throw error if create stream transaction is checked
  • Rewrite send Notification process in javascript

Frontend

  • Create e2e-tests
  • User-Profile should be own container since there are to many props in navbar container
  • Clicking on User image to open user profile is not obvious - create settings icon for it

Documentation

Closes #419
Closes #65

@Stezido Stezido self-assigned this Feb 12, 2020
@openkfwCI
Copy link

openkfwCI commented Feb 12, 2020 •
edited
Loading

Warnings
⚠️ It looks like an ID was added. Please make sure it is not a secret.

Generated by 🚫 dangerJS against 99b4abe

@openkfwCI
Copy link

openkfwCI commented Feb 12, 2020 •
edited
Loading

NotesTime
✅Note for Reviewer: E2E tests on remote server succeededMon, 16 Mar 2020 13:04:31 +0000

Generated by E2E-Test

mathiashoeld
mathiashoeld suggested changes Mar 10, 2020
View reviewed changes
Copy link
Contributor

@mathiashoeld mathiashoeld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

important: please change all occurrences of "email" to "email address" where appropriate

@Stezido Stezido force-pushed the email-notification branch from 4cbef60 to 586a683 Compare March 11, 2020 17:39
@mathiashoeld mathiashoeld force-pushed the email-notification branch 4 times, most recently from 5b3424f to 56dd935 Compare March 16, 2020 11:33
Stezido added 18 commits March 16, 2020 12:38
@Stezido @mathiashoeld
Create email-service
5ca9a0e 
The email-service starts two servers when executed
Server started:
	- TCP Server (TCP Command Listener)
            All relevant hooks should be handled (currently only sendNotifications)
	- HTTP Server (express)
            All requests which modify the email database are handled
@Stezido @mathiashoeld
bc: Create mutlichain hook
ac71519 
On walletnotifynew, a mutlichain runtimeparamter, a script called 'filterScript' (written in go) is executed
This script checks each transaction if it's a notification_created event.
If so a notification is send via tcp to the email-service.
To configure te email-service connection following env vars are used:
    - EMAIL_HOST
    - EMAIL_PORT
@Stezido @mathiashoeld
ui: Create user-profile
19a51ee 
Only show email if service available
Implement un-/subscribe to the email notification
@Stezido @mathiashoeld
bc: Write notification transactions into JSON files, filename is a un…
0af71d0 
…ixtimestamp
@Stezido @mathiashoeld
Create watcher which reads/sends notificaiton from files
0fa4888
@Stezido @mathiashoeld
Merge tcp/http server to one http server, add pino logger, adjust res…
57c3077 
…ponse format
@Stezido @mathiashoeld
Bc spawns child process to check/send notifications every 5 seconds
269c21f 
Create directory "notifications" if not exist (done by sendData as well as filterScript)
Clean up windows binary files
Prepared docker-compose file including email service and email database
@Stezido @mathiashoeld
Add documentation and postman collection
130ab32
@Stezido @mathiashoeld
bc: Only execute filterScript if Email host/port are set
baf22da
@Stezido @mathiashoeld
Delete notification files after certain time (default 24 hours)
fb792da
@Stezido @mathiashoeld
Handle create stream transactions, improve logging
5c486a9
@Stezido @mathiashoeld
Create own go project for filterScript
ff1a1b8 
Rename filterScript to multichain-feed
Structure go code to be able to easily exand the multichain-feed with other hooks/sideEffects
@Stezido @mathiashoeld
Rewrite notification watcher in js, WIP missing logs
7957339
@Stezido @mathiashoeld
Adjust docker-compose in frontend folder
e3cc475
@Stezido @mathiashoeld
multichain-feed: Removed log when parsing transaction fails
45223ff
@Stezido @mathiashoeld
email-service: Add debug logs, adjust docker-compose file
85df013
@Stezido @mathiashoeld
Rewrite send Notifcation in js
00451b5 
Restructure filesystem
improve logging
@Stezido @mathiashoeld
Adjust paths, delete files after succesfully send a notification
0ec0b42
Stezido and others added 15 commits March 16, 2020 12:38
@Stezido @mathiashoeld
email-service: Type all variables, remove joi validator
d7a1216
@Stezido @mathiashoeld
Use jwt tokens to verify user
e039a29
@Stezido @mathiashoeld
Fix auth token of notification watcher
fba77a5
@Stezido @mathiashoeld
doc: adjust env vars and email notification architecture image
1f5462a
@Stezido @mathiashoeld
Move Userprfile into own container, add regex check for email
bce2fe9
@Stezido @mathiashoeld
Change status code to 401 for auth error
768401d
@Stezido @mathiashoeld
email-notification: Add JWT-section
24c5762
@Stezido @mathiashoeld
Add user.update endpoint
053d1dc
@Stezido @mathiashoeld
Update email-service postman collection
bae912a
@Stezido @mathiashoeld
bc: Add EMAIL_SERVICE env variable to en/disable email-service
44ac8b9
@Stezido @mathiashoeld
email-service: Change email varible name to emailAddress
b63862f
@Stezido @mathiashoeld
Resolve requested review changes
d43c6e5
@Stezido @mathiashoeld
Update postman collection/environment
83728e1
@Stezido @mathiashoeld
Update CHANGELOG.md
19eaa62
@mathiashoeld
Add e2e tests
99b4abe 
Add e2e tests for the following cases:
* Email service is available
* Email service is not available
@mathiashoeld mathiashoeld merged commit c984bc6 into master Mar 16, 2020
@mathiashoeld mathiashoeld deleted the email-notification branch March 16, 2020 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mathiashoeld mathiashoeld

Assignees

@Stezido Stezido

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Email notification implementation email notifications
3 participants
@Stezido @openkfwCI @mathiashoeld