Links in the email notifications are not working #26

sonytrinhcvn · 2020-03-04T02:56:05Z

We got this email when click Unsubscribe & Manage your setting
https://e.dev.ins.unee-t.com/?url=https%3A%2F%2Fcase.dev.ins.unee-t.com%2Fnotification-settings&id=ut_notification_message_new-64&email=trunghieu912003%40gmail.com

franck-boullier · 2020-03-04T02:59:06Z

@sonytrinhcvn can we add a list of:

all the emails that have problematic urls
all the URLs that are problematic in these emails.
This will help us test everything when we have implemented the fix.

franck-boullier · 2020-03-04T03:02:14Z

The code to generate the links in the emails is located in the folder
https://github.com/Unee-T-INS/frontend/tree/master/imports/email-templates.

There are several files that are using a variable ROOT_URL.
@sonytrinhcvn can you help me list these files in that GH issue please.

This variable ROOT_URL is defined as an environment variable in the files aws-env.[STAGE]

franck-boullier · 2020-03-04T03:06:47Z

The issue:

In the email, the links generated are something like
https://e.dev.ins.unee-t.com/?url=https%3A%2F%2Fcase.dev.ins.unee-t.com%2Fnotification-settings&id=ut_notification_message_new-64&email=trunghieu912003%40gmail.com
instead of
https://case.dev.ins.unee-t.com/notification-settings&id=ut_notification_message_new-64&email=trunghieu912003%40gmail.com

The code somehow:

includes an unnecessary prefix in the email: https://e.dev.ins.unee-t.com/?url=https%3A%2F%2F
replace / with %2F

We have 2 solutions to fix the issue:

Quick and dirty:

hard code the URLs instead of using variables.

Pros:

Fast

Cons:

This will make it harder/almost impossible t use automated deployment anymore

Proper fix:

Understand how we can remove the additional code

sonytrinhcvn · 2020-03-04T03:07:24Z

@sonytrinhcvn can we add a list of:

all the emails that have problematic urls

all the URLs that are problematic in these emails.
This will help us test everything when we have implemented the fix.

Here you are:

case-assignee-updated
case-new-message
case-updated
case-user-invited
new-case-assigned

sonytrinhcvn · 2020-03-04T03:12:05Z

The code to generate the links in the emails is located in the folder
https://github.com/Unee-T-INS/frontend/tree/master/imports/email-templates.

There are several files that are using a variable ROOT_URL.
@sonytrinhcvn can you help me list these files in that GH issue please.

This variable ROOT_URL is defined as an environment variable in the files aws-env.[STAGE]

We have some files:

case-assignee-updated
case-new-message
case-updated
case-user-invited
new-case-assigned
report-pdf-shared
unit-user-invited
helper
email-invite
logger

franck-boullier · 2020-03-04T03:12:55Z

More information:

When we redeploy the code, we can update the ROOT_URL~ in the file aws-env.[STAGE]`

Today this variable is built from other variables. This might cause some unexpected behavior.

The Test:

in the DEV environment: replace the current value
export ROOT_URL=https://case.$STAGE.$DOMAIN on

frontend/aws-env.dev

Line 38 in 8b5a6e0

export ROOT_URL=https://case.$STAGE.$DOMAIN

with
export ROOT_URL=https://case.dev.ins.unee-t.com
in the file https://github.com/Unee-T-INS/frontend/blob/master/aws-env.dev

Re-deploy
test:
- create a case
- invite someone
- check if links are working.

for more information, see #26 (comment)

franck-boullier · 2020-03-04T03:18:06Z

What was done:

Hotfix (c2a4d03) done to test hypothesis described in #26 (comment)

Next step:

Test what are the values for the links generated in the emails.
See if we have fixed the issue or improved the situation.

franck-boullier · 2020-03-04T03:28:37Z

More information:

The URLs are generated using code like
url: url.resolve(process.env.ROOT_URL, '/notification-settings')

`url.resolve`:

a built-in mechanism in Node JS.

From the documentation:

The url.resolve(from, to) is a builtin method of class URL that resolves a target URL relative to a base URL.
Syntax:

url.resolve(from, to);
Where,
from: (type:String) The base URL being resolved against.
to : (type:String) The “href” URL being resolved.

`process.env.`

Is also a built-in mechanism in Node JS.

The process.env global variable is injected by the Node at runtime for your application to use and it represents the state of the system environment your application is in when it starts. For example, if the system has a PATH variable set, this will be made accessible to you through process.env.PATH which you can use to check where binaries are located and make external calls to them if required.

sonytrinhcvn · 2020-03-04T03:59:04Z

Test 1:

Create a new policy
My relationship to the policy: The Insurance Agent
Create a new case
Assign this case to The Insurance Agent

Expect result

The person assigned to the case receives an email - PASSED
The email includes a link to the case - PASSED the link was [https://case.dev.ins.unee-t.com/invitation?code=AHfKzw8xtqrw74IhPjVsS1Ja]
The link to the case sends the user to that case in InsureChat - PASSED

The source code for this email is in the file https://github.com/Unee-T-INS/frontend/blob/master/imports/util/email-invite.js.
The code that is use could generate the url is

frontend/imports/util/email-invite.js

Line 52 in c2a4d03

    
           Please click on <a href=${url.resolve(process.env.ROOT_URL, `/invitation?code=${accessToken}`)}>this link</a> to get more information and join the discussion with ${invitorUsername || 'him'}.

sonytrinhcvn · 2020-03-04T04:10:28Z

Test 2:

Create a new policy
My relationship to the policy: The Insurance Agent
Create a new case
Assign this case to myself

Expect result

No email sent - PASSED

sonytrinhcvn · 2020-03-04T04:40:48Z

Test 3:

Create a new policy
My relationship to the policy: The Insurance Agent
Create a new case
Assign this case to someone else The Insurance Company
Enter the email address at the Insurance company

Expect result

The person assigned to the case receives an email
The email includes a link to the case - the link was []
The link to the case sends the user to that case in InsureChat

The source code for this email is in the file https://github.com/Unee-T-INS/frontend/blob/master/imports/email-templates/case-assignee-updated.js
The code that is used to generate the URL is

frontend/imports/email-templates/case-assignee-updated.js

Lines 8 to 12 in c2a4d03

    
           const optOutUrl = createEngagementLink({ 
        
             url: url.resolve(process.env.ROOT_URL, '/notification-settings'), 
        
             id: notificationId, 
        
             email: assignee.emails[0].address 
        
           })

sonytrinhcvn · 2020-03-04T04:47:59Z

More Information

In the script, https://github.com/Unee-T-INS/frontend/blob/master/imports/email-templates/components/helpers.js refer to a dependency https://github.com/unee-t/engagement this dependency has not been deployed to Unee-T INS

To do

Deploy unee-t/engagement in the Unee-T INS environment.
Test again

franck-boullier · 2020-03-04T11:47:02Z

More information:

Quickfix: remove the engagement URL to avoid relying on the engagement repo.
See unee-t@45c3f63 for the code that'll work without the engagement URLs.

* revert previous hotfix * replace `property` with `policy` * do NOT use the function `createEngagementLink` - see GH issue #26

franck-boullier · 2020-03-04T14:19:00Z

Quickfix described in #26 (comment) has been implemented as part of PR #27.

We need a long term solution when we:

correctly deploy the engagement codebase
re-activate the createEngagementLink function so we can better track user engagement on email sent.

To Do:

Test the quick fix.

franck-boullier · 2020-03-08T08:33:51Z

The issue has been fixed. See #29 for what we still need to do

franck-boullier changed the title ~~Fix email links~~ Links in the email notifications are not working Mar 4, 2020

franck-boullier self-assigned this Mar 4, 2020

franck-boullier added a commit that referenced this issue Mar 4, 2020

Hotfix for issue #26

c2a4d03

for more information, see #26 (comment)

franck-boullier pushed a commit that referenced this issue Mar 4, 2020

do NOT use the function createEngagementLink - see GH issue #26

c3c9df0

franck-boullier mentioned this issue Mar 4, 2020

Fix links in emails #27

Merged

franck-boullier added a commit that referenced this issue Mar 4, 2020

Fix links in emails (#27)

38fe751

* revert previous hotfix * replace `property` with `policy` * do NOT use the function `createEngagementLink` - see GH issue #26

franck-boullier closed this as completed Mar 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Links in the email notifications are not working #26

Links in the email notifications are not working #26

sonytrinhcvn commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

sonytrinhcvn commented Mar 4, 2020 •

edited

Loading

sonytrinhcvn commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020 •

edited

Loading

sonytrinhcvn commented Mar 4, 2020 •

edited

Loading

sonytrinhcvn commented Mar 4, 2020

sonytrinhcvn commented Mar 4, 2020

sonytrinhcvn commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 8, 2020

Links in the email notifications are not working #26

Links in the email notifications are not working #26

Comments

sonytrinhcvn commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

The issue:

Quick and dirty:

Pros:

Cons:

Proper fix:

sonytrinhcvn commented Mar 4, 2020 • edited Loading

sonytrinhcvn commented Mar 4, 2020

franck-boullier commented Mar 4, 2020

More information:

The Test:

franck-boullier commented Mar 4, 2020

What was done:

Next step:

franck-boullier commented Mar 4, 2020 • edited Loading

More information:

url.resolve:

process.env.

sonytrinhcvn commented Mar 4, 2020 • edited Loading

Test 1:

Expect result

sonytrinhcvn commented Mar 4, 2020

Test 2:

Expect result

sonytrinhcvn commented Mar 4, 2020

Test 3:

Expect result

sonytrinhcvn commented Mar 4, 2020

More Information

To do

franck-boullier commented Mar 4, 2020

More information:

franck-boullier commented Mar 4, 2020

To Do:

franck-boullier commented Mar 8, 2020

sonytrinhcvn commented Mar 4, 2020 •

edited

Loading

franck-boullier commented Mar 4, 2020 •

edited

Loading

`url.resolve`:

`process.env.`

sonytrinhcvn commented Mar 4, 2020 •

edited

Loading