feat: Email made translatable #7416

codedsun · 2020-11-05T16:53:08Z

Fixes #7405

Short description of what this resolves:

Changes proposed in this pull request:

Checklist

I have read the Contribution & Best practices Guide and my PR follows them.
My branch is up-to-date with the Upstream development branch.
The unit tests pass locally with my changes
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

All the functions created/modified in this PR contain relevant docstrings.

codecov · 2020-11-05T17:03:59Z

Codecov Report

Merging #7416 (0a5b601) into development (f0cf6a2) will increase coverage by 0.01%.
The diff coverage is 68.75%.

@@               Coverage Diff               @@
##           development    #7416      +/-   ##
===============================================
+ Coverage        65.28%   65.29%   +0.01%     
===============================================
  Files              265      265              
  Lines            13205    13212       +7     
===============================================
+ Hits              8621     8627       +6     
- Misses            4584     4585       +1

Impacted Files	Coverage Δ
app/api/helpers/system_mails.py	`100.00% <ø> (ø)`
app/api/auth.py	`24.15% <50.00%> (+0.32%)`	⬆️
app/api/users.py	`31.66% <75.00%> (+0.38%)`	⬆️
app/instance.py	`87.76% <80.00%> (-0.28%)`	⬇️
config.py	`89.02% <100.00%> (+0.13%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f0cf6a2...a76ee91. Read the comment docs.

iamareebjamal · 2020-11-06T21:05:47Z

app/api/auth.py

+            send_email(
+                to=user,
+                action=PASSWORD_RESET_AND_VERIFY,
+                html=render_template('email/password_reset_and_verify', **context),


pass context as keyword arguments

.html missing

iamareebjamal · 2020-11-06T21:05:54Z

app/api/auth.py

+            send_email(
+                to=user,
+                action=PASSWORD_RESET,
+                html=render_template('email/password_reset', **context),


pass context as keyword arguments

.html missing

iamareebjamal · 2020-11-06T21:06:31Z

app/api/users.py

+            to=user,
+            action=USER_REGISTER,
+            subject=MAILS[USER_REGISTER]['subject'].format(app_name=settings['app_name']),
+            html=render_template('email/user_register.html', **context),


pass context as keyword arguments

iamareebjamal · 2020-11-06T21:06:42Z

app/api/auth.py

+                subject=MAILS[PASSWORD_CHANGE]['subject'].format(
+                    app_name=get_settings()['app_name']
+                ),
+                html=render_template('email/password_change'),


.html missing

iamareebjamal · 2020-11-06T21:07:28Z

app/templates/email/password_reset.html

@@ -0,0 +1,3 @@
+Please use the following link to reset your password.
+<br/><a href='{link}' target='_blank'>{{ link }}</a>


Suggested change

 <a href='{link}' target='_blank'>{{ link }}</a>

 {{ link }}

iamareebjamal · 2020-11-06T21:07:53Z

app/templates/email/password_reset_and_verify.html

@@ -0,0 +1,2 @@
+Please use the following link to reset your password and verify your account.
+<br> <a href='{link}' target='_blank'> {{ link }} </a>


Suggested change

 <a href='{link}' target='_blank'> {{ link }} </a>

 {{ link }}

codedsun · 2020-11-07T10:14:42Z

@iamareebjamal - mo file created.

iamareebjamal · 2020-11-07T10:16:18Z

app/templates/email/ticket_purchased.html

+{{ _('Hello') }},
+<br/><br/>{{ _('Thank you for your ticket order for') }} {{ order.event.name }}.
+<br/><br/>{{ _('This is your order confirmation. You can download your tickets at') }} : {{ order_view_url }}
+<br/><br/>{{ _('Order Summary') }}:
 <br/>Order: {{ order.invoice_number }}
 <br/>Name: {{ order.user.full_name }}


_() missing here

iamareebjamal · 2020-11-07T10:16:56Z

app/templates/email/ticket_purchased_attendee.html

-<br/><br/>Ticket Summary:
+{{ _('Hello') }},
+<br/><br/>{{ _('This is a confirmation mail of your tickets for the event') }} {{ order.event.name }}. {{ _('You can download your tickets at') }}: {{ order_view_url }}
+<br/><br/>{{ _('Ticket Summary') }}:
 <br/>Name: {{ attendees.0.user.full_name }}


_() missing here

iamareebjamal · 2020-11-07T10:17:32Z

app/templates/email/user_register.html

@@ -0,0 +1,7 @@
+{{ _('Hello') }},
+<br/><br/>{{ _('Your account has been created on') }} {{ settings.app_name }}. {{ _('Congratulations! ') }}


Suggested change

 {{ _('Your account has been created on') }} {{ settings.app_name }}. {{ _('Congratulations! ') }}

 {{ _('Your account has been created on') }} {{ settings.app_name }}. {{ _('Congratulations!') }}

iamareebjamal · 2020-11-07T10:18:12Z

app/templates/email/user_register.html

@@ -0,0 +1,7 @@
+{{ _('Hello') }},
+<br/><br/>{{ _('Your account has been created on') }} {{ settings.app_name }}. {{ _('Congratulations! ') }}
+<br/><br/>{{ _('Your login is: {{ email }} ')}}


email should be out of _()

iamareebjamal · 2020-11-07T10:18:23Z

app/templates/email/user_register.html

+<br/><br/>{{ _('Your login is: {{ email }} ')}}
+<br/><br/>{{ _('Please visit the following link to verify your email:') }} {{ link }}
+<br/><br/>{{ _('Thank You') }},
+<br/><br/>{{ settings.app_name }} Team


_() missing here

codedsun · 2020-11-07T11:10:45Z

@iamareebjamal - While passing context as keyword argument in send_email function , the jinja html template doesn't recognize values and give error object not found. What should be done?

iamareebjamal · 2020-11-07T11:54:28Z

You don't pass context as kwarg, you pass contents of context as kwargs

iamareebjamal · 2020-11-07T11:55:27Z

app/api/users.py

+            action=USER_REGISTER,
+            subject=MAILS[USER_REGISTER]['subject'].format(app_name=settings['app_name']),
+            html=render_template('email/user_register.html', context=context),
+            attachments=None,


If attachments is None, then this is not needed

iamareebjamal · 2020-11-07T11:56:24Z

config.py

@@ -49,6 +49,7 @@ class Config:
    FLASK_ADMIN_SWATCH = 'lumen'

    VERSION = VERSION_NAME
+    LANGUAGES = ['en', 'de', 'fr']


Add all languages present in the translations folder

babel.cfg

iamareebjamal · 2020-11-07T11:57:10Z

messages.pot

@@ -0,0 +1,125 @@
+# Translations template for PROJECT.


Delete this file

iamareebjamal

Add required dependencies in requirements

codedsun · 2020-11-07T17:05:10Z

@iamareebjamal - Done the changes, performed the testing

iamareebjamal · 2020-11-07T20:32:22Z

requirements/common.txt

@@ -62,6 +62,7 @@ pyyaml==5.3.1
 sendgrid==6.4.7
 marshmallow==2.15.2
 WeasyPrint==52.1
+Flask-Babel=2.0.0


wrong syntax

iamareebjamal · 2020-11-07T20:33:14Z

Please add a screenshot of the mail you received and fix the build

requirements/common.txt

iamareebjamal · 2020-11-08T10:11:04Z

Disable https://google.github.io/pytype/errors.html#mro-error on app/instance.py", line 243, in get_locale

iamareebjamal · 2020-11-08T10:19:40Z

Please also write the command to extract to pot, merge to po, and generating mo files because I'll need that for testing

codedsun · 2020-11-08T10:27:16Z

Extracting to pot
pybabel extract -F babel.cfg -k _l -o app/translations/messages.pot .

Updating po
pybabel update -i app/translations/messages.pot -d app/translations

Generating mo
pybabel compile -d app/translations

codedsun · 2020-11-08T11:44:12Z

@iamareebjamal - Done!

iamareebjamal · 2020-11-08T11:49:08Z

How did you test the translation was happening?

codedsun · 2020-11-08T11:51:08Z

How did you test the translation was happening?

As you sugggested, In the de folder I changed the msgStr of Ticket purchased string Thank you for your ticket order for to Suneet Srivastava

i changed my browser display language in firefox to German (De), the website was translated to german now.
I logged in and purchased a ticket. Now in the mails table I gave you the exact text of the message here.
#7416 (comment)

iamareebjamal · 2020-11-08T11:54:15Z

OK. Thank you

iamareebjamal · 2020-11-08T12:00:35Z

app/templates/email/ticket_purchased_attendee.html

-    <br/>Quantity: {{ attendee | length }}
+{% for i, attendee in attendees | groupby('ticket_id') %}
+    <br/>{{ _('Ticket') }}: {{ attendee.0.ticket.name }}
+    <br/>{ _('Quantity') }}: {{ attendee | length }}


auto-label bot added the feature label Nov 5, 2020

codedsun changed the title ~~feat: Revamp user registration mail~~ feat: Email made translatable Nov 6, 2020

iamareebjamal reviewed Nov 6, 2020

View reviewed changes

codedsun force-pushed the translatable branch from 93eb0e6 to b27beca Compare November 7, 2020 10:01

iamareebjamal reviewed Nov 7, 2020

View reviewed changes

codedsun force-pushed the translatable branch from 2e094bf to 4180fec Compare November 7, 2020 11:12

iamareebjamal reviewed Nov 7, 2020

View reviewed changes

babel.cfg Show resolved Hide resolved

iamareebjamal reviewed Nov 7, 2020

View reviewed changes

messages.pot Outdated

@@ -0,0 +1,125 @@

# Translations template for PROJECT.

Copy link

Member

iamareebjamal Nov 7, 2020

Choose a reason for hiding this comment

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

Delete this file

iamareebjamal requested changes Nov 7, 2020

View reviewed changes

codedsun force-pushed the translatable branch from 4180fec to f1727ee Compare November 7, 2020 17:01

iamareebjamal reviewed Nov 7, 2020

View reviewed changes

requirements/common.txt Outdated Show resolved Hide resolved

codedsun force-pushed the translatable branch from cbea6c2 to 9d5e642 Compare November 8, 2020 06:46

codedsun force-pushed the translatable branch 2 times, most recently from d166be8 to 78c06ad Compare November 8, 2020 11:32

Suneet Srivastava and others added 13 commits November 8, 2020 17:23

feat: Revamp user registration mail

106357e

feat: Revamp password change mails

b2d6fe5

feat: Babel configured

6d629e1

feat: Added babel.cfg and extracted text for translations

8f7fabd

feat: messages.po file updated with new translations

b0f3a99

feat: Updated messages.mo for translations

59d5e1d

fix: Extract translation text changes in email templates

861d191

feat: Translations updated

a6ecf1b

chore: Added babel in requirements

aabc72d

fix: Dredd test for reset-password

e265c6b

fix: mro error for getLocale in instance

2d52153

fix

f80a49c

fix

7014786

iamareebjamal reviewed Nov 8, 2020

View reviewed changes

fix

d4ce99b

iamareebjamal force-pushed the translatable branch from 78c06ad to d4ce99b Compare November 8, 2020 12:01

iamareebjamal added 3 commits November 8, 2020 17:40

fix

0a5b601

fix

a76ee91

f

a689760

iamareebjamal approved these changes Nov 8, 2020

View reviewed changes

iamareebjamal merged commit 84d4f54 into fossasia:development Nov 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Email made translatable #7416

feat: Email made translatable #7416

codedsun commented Nov 5, 2020

codecov bot commented Nov 5, 2020 •

edited

Loading

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

iamareebjamal Nov 6, 2020

codedsun commented Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

codedsun commented Nov 7, 2020 •

edited

Loading

iamareebjamal commented Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal Nov 7, 2020

iamareebjamal left a comment

codedsun commented Nov 7, 2020 •

edited

Loading

iamareebjamal Nov 7, 2020

iamareebjamal commented Nov 7, 2020

iamareebjamal commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

codedsun commented Nov 8, 2020

codedsun commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

codedsun commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

iamareebjamal Nov 8, 2020

		@@ -0,0 +1,3 @@
		Please use the following link to reset your password.
		<br/><a href='{link}' target='_blank'>{{ link }}</a>

	<br/><a href='{link}' target='_blank'>{{ link }}</a>
	<br/>{{ link }}

		@@ -0,0 +1,2 @@
		Please use the following link to reset your password and verify your account.
		<br> <a href='{link}' target='_blank'> {{ link }} </a>

	<br> <a href='{link}' target='_blank'> {{ link }} </a>
	<br>{{ link }}

		@@ -0,0 +1,7 @@
		{{ _('Hello') }},
		<br/><br/>{{ _('Your account has been created on') }} {{ settings.app_name }}. {{ _('Congratulations! ') }}

feat: Email made translatable #7416

feat: Email made translatable #7416

Conversation

codedsun commented Nov 5, 2020

Short description of what this resolves:

Changes proposed in this pull request:

Checklist

codecov bot commented Nov 5, 2020 • edited Loading

Codecov Report

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

codedsun commented Nov 7, 2020

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

codedsun commented Nov 7, 2020 • edited Loading

iamareebjamal commented Nov 7, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iamareebjamal left a comment

Choose a reason for hiding this comment

codedsun commented Nov 7, 2020 • edited Loading

Choose a reason for hiding this comment

iamareebjamal commented Nov 7, 2020

iamareebjamal commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

codedsun commented Nov 8, 2020

codedsun commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

codedsun commented Nov 8, 2020

iamareebjamal commented Nov 8, 2020

Choose a reason for hiding this comment

codecov bot commented Nov 5, 2020 •

edited

Loading

codedsun commented Nov 7, 2020 •

edited

Loading

codedsun commented Nov 7, 2020 •

edited

Loading