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

Updated recipients.csv to accept both lang #245

Merged
merged 7 commits into from
Oct 3, 2023
Merged

Updated recipients.csv to accept both lang #245

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7f83f22
Updated recipients.csv to accept both lang
jzbahrai Sep 20, 2023
8d62ea9
add a further test
jzbahrai Sep 25, 2023
78bb2ec
fix
jzbahrai Sep 26, 2023
cd36941
tester
jzbahrai Sep 26, 2023
3c7453e
fixes
jzbahrai Sep 27, 2023
b0b1110
add comment and simplify code
jzbahrai Sep 27, 2023
d650f61
Merge branch 'main' into task/fix-upload
jzbahrai Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 65 additions & 11 deletions notifications_utils/recipients.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,38 @@
region_code = os.getenv("PHONE_REGION_CODE", "US")

first_column_headings = {
"email": ["email address"],
"sms": ["phone number"],
"en": {
"email": ["email address"],
"sms": ["phone number"],
# For backwards compatibility
"letter": [
"address line 1",
"address line 2",
"address line 3",
"address line 4",
"address line 5",
"address line 6",
"postcode",
],
},
"fr": {
"email": ["adresse courriel"],
"sms": ["numéro de téléphone"],
# For backwards compatibility
"letter": [
"address line 1",
"address line 2",
"address line 3",
"address line 4",
"address line 5",
"address line 6",
"postcode",
],
},
"email": ["email address"], # left this for backwards compatibility
"sms": ["phone number"], # left this for backwards compatibility
"email_both": ["email address", "adresse courriel"],
"sms_both": ["phone number", "numéro de téléphone"],
"letter": [
"address line 1",
"address line 2",
Expand Down Expand Up @@ -60,7 +90,9 @@ def __init__(
remaining_messages=sys.maxsize,
international_sms=False,
max_rows=50000,
user_language="en",
):
self.user_language = user_language
self.file_data = strip_whitespace(file_data, extra_characters=",")
self.template_type = template_type
self.placeholders = placeholders
Expand Down Expand Up @@ -114,7 +146,10 @@ def template_type(self):
@template_type.setter
def template_type(self, value):
self._template_type = value
self.recipient_column_headers = first_column_headings[self.template_type]
self.recipient_column_headers = first_column_headings[self.user_language][self.template_type] # type: ignore
self.recipient_column_headers_lang_check = (
first_column_headings.get("email_both") if self.template_type == "email" else first_column_headings.get("sms_both")
)

@property
def has_errors(self):
Expand Down Expand Up @@ -263,11 +298,31 @@ def column_headers_as_column_keys(self):

@property
def missing_column_headers(self):
return set(
key
for key in self.placeholders
if (Columns.make_key(key) not in self.column_headers_as_column_keys and not self.is_optional_address_column(key))
)
"""
Missing headers must return the following in each case:

Eg 1: file: []
placeholders: [phone number, name]
missing: [phone number, name]

Eg 2: file: [adresse courriel]
placeholders: [email address]
missing: []

"""
result = set()
for key in self.placeholders:
# If the key has a different heading due to language, then we need to check that the column_headers
# in the file have either the same or other language. This is only for email address / phone number
if key in self.recipient_column_headers_lang_check: # type: ignore
Copy link
Member

Choose a reason for hiding this comment

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

So do we allow FR column headers when the request is in EN and vice versa? What exactly is the intersection method doing here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yes we allow FR heading and EN request and vice versa.

The intersection says - if the headings that english/french are not in column headers of the file:
Add that header to the result - we know that it is "missing"

if not set(map(Columns.make_key, self.recipient_column_headers_lang_check)).intersection( # type: ignore
set(self.column_headers_as_column_keys)
):
result.add(key)
continue
elif Columns.make_key(key) not in self.column_headers_as_column_keys and not self.is_optional_address_column(key):
result.add(key)
return result

@property
def duplicate_recipient_column_headers(self):
Expand All @@ -290,13 +345,12 @@ def is_optional_address_column(self, key):

@property
def has_recipient_columns(self):
return (
return set([list(self.column_headers_as_column_keys)[0]]).issubset(
Copy link
Member

Choose a reason for hiding this comment

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

What does this do? Should we have a comment here maybe?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

set(
Columns.make_key(recipient_column)
for recipient_column in self.recipient_column_headers
for recipient_column in self.recipient_column_headers_lang_check # type: ignore
if not self.is_optional_address_column(recipient_column)
)
<= self.column_headers_as_column_keys
)

def _get_error_for_field(self, key, value): # noqa: C901
Expand Down
Loading