feat: Add constants.humanName to allow countries to have custom full name format #7812

Siyasanga · 2024-10-22T08:25:44Z

In order to allow countries to define their own full name format, we are adding a constants.humanName into the client.csv translations, which will then be used everywhere where we are displaying system users and citizen's name in the systems.

Addresses #6830

ocrvs-bot · 2024-10-22T08:32:38Z

Your environment is deployed to https://ocrvs-6830-human-name-constant.opencrvs.dev

packages/client/src/i18n/messages/constants.ts

Zangetsu101 · 2024-10-22T11:01:46Z

packages/client/src/views/SysAdmin/Team/user/UserList.tsx

+                intl.formatMessage(constantsMessages.humanName, {
+                  firstName: user.name[0].firstNames,
+                  middleName: user.name[0].middleName,
+                  lastName: user.name[0].familyName
+                })) ||


It would be better to have a utility function similar to the createNamesMap, something like this:

function internationalizedName(name: HumanName[], locale: Locale): { firstName: string middleName: string lastName: string }

It would try to find the name in the given locale, falling back to 'en' in case it does not find it

I think this is where I was getting confused. It looks like the translations are passed through from IntlProvider and also pulled from country-config, now passing the locale implies that we have access to all different translations and dynamically changes languages. Do you know where I can get this?

You can just pass in intl.locale to the function. As for how to resolve that, take a look at the current implementation of the createNamesMap function, it should give you an idea.

Do we really support names in multiple languages 🤔 If not, then I'd aim to simplify as much as we can. IMO best would be a component like

<HumanName name={user.name} />

component that could use the useIntl hook. Passing the intl object as a function parameter feels like a little upside down

Hi @rikukissa on the system user we only support one language, English and on the Birth and Death forms it looks like we only ask First names and Surname. Does this confirm that we don't support name in multiple languages for Birth, Marriage and Death as well?

Yes, I think that's a safe assumption

Siyasanga · 2024-10-24T04:55:21Z

Thank for the feedback guys @rikukissa @Zangetsu101, I ended up going with the utility function approach because I needed just the localised name in some instances instead of the React.Node component. Please let me know if you have feedback

Zangetsu101 · 2024-10-24T12:31:39Z

I think we can go with this approach. Removing multiple spaces using regex is better as we would have to handle quite a few edge cases otherwise

tahmidrahman-dsi · 2024-11-07T12:28:32Z

@Siyasanga is this PR still work in progress or ready for review?

Siyasanga · 2024-11-07T12:41:34Z

@Siyasanga is this PR still work in progress or ready for review?

Thanks @tahmidrahman-dsi yes it's ready for review

To allow countries to have custom ordering for full names #6830

To ensure that we get the format from the country-config #6830

To make the name more usable we had to extract the name formatting logic into it's own function. #6830

#6830

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

#6830

naftis · 2024-11-11T12:43:09Z

I think this PR might have broken the E2E's? @Siyasanga

…name format (#7812) * Add humanName to constants.ts To allow countries to have custom ordering for full names #6830 * Use constants.humanName on the UserList.tsx comp To ensure that we get the format from the country-config #6830 * Create a utility function getLocalisedname() To make the name more usable we had to extract the name formatting logic into it's own function. #6830 * Use getLocalisedName on the UserList component #6830 * Use getLocalisedName on the UserAudit comp Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830 * refactor: use getLocalisedName() @ InProgress.tsx We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830 * Refactor the work queues to use getLocalisedName() We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830 * Record changes in the CHANGELOG for this PR #6830

…om full name format (#7812)" This reverts commit 9d98010.

Siyasanga self-assigned this Oct 22, 2024

This comment has been minimized.

Sign in to view

Siyasanga added the 🚧 work in progress label Oct 22, 2024

Siyasanga added this to the v1.7.0 milestone Oct 22, 2024

Siyasanga marked this pull request as draft October 22, 2024 08:43

Zangetsu101 requested changes Oct 22, 2024

View reviewed changes

Siyasanga force-pushed the ocrvs-6830-human-name-constant branch from 46b6c1d to d1e6f6a Compare October 24, 2024 08:20

Siyasanga force-pushed the ocrvs-6830-human-name-constant branch from c23ce35 to 41e9d75 Compare October 30, 2024 11:37

Siyasanga requested review from Zangetsu101 and rikukissa October 30, 2024 11:37

Siyasanga added 💅 Waiting For Review and removed 🚧 work in progress labels Oct 30, 2024

Siyasanga linked an issue Oct 30, 2024 that may be closed by this pull request

As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

Open

6 tasks

Siyasanga force-pushed the ocrvs-6830-human-name-constant branch from 720bc5f to d826a03 Compare October 30, 2024 11:52

Siyasanga force-pushed the ocrvs-6830-human-name-constant branch from d826a03 to 5d122ce Compare November 7, 2024 12:40

Siyasanga temporarily deployed to ocrvs-6830-human-name-constant November 7, 2024 12:40 — with GitHub Actions Inactive

Siyasanga marked this pull request as ready for review November 7, 2024 12:41

Zangetsu101 approved these changes Nov 11, 2024

View reviewed changes

Siyasanga added 7 commits November 11, 2024 13:29

Add humanName to constants.ts

7ce52b9

To allow countries to have custom ordering for full names #6830

Use constants.humanName on the UserList.tsx comp

65ee7df

To ensure that we get the format from the country-config #6830

Create a utility function getLocalisedname()

02908a7

To make the name more usable we had to extract the name formatting logic into it's own function. #6830

Use getLocalisedName on the UserList component

5a30712

#6830

Use getLocalisedName on the UserAudit comp

2498c23

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

refactor: use getLocalisedName() @ InProgress.tsx

7189e4e

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

Refactor the work queues to use getLocalisedName()

a68ae62

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

Record changes in the CHANGELOG for this PR

1a13fc2

#6830

Siyasanga force-pushed the ocrvs-6830-human-name-constant branch from 5d122ce to 1a13fc2 Compare November 11, 2024 11:29

Siyasanga enabled auto-merge (squash) November 11, 2024 11:32

Siyasanga merged commit 9d98010 into develop Nov 11, 2024
59 of 60 checks passed

Zangetsu101 added a commit that referenced this pull request Nov 12, 2024

Revert "feat: Add constants.humanName to allow countries to have cust…

b7082b0

…om full name format (#7812)" This reverts commit 9d98010.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add constants.humanName to allow countries to have custom full name format #7812

feat: Add constants.humanName to allow countries to have custom full name format #7812

Siyasanga commented Oct 22, 2024 •

edited

Loading

This comment has been minimized.

ocrvs-bot commented Oct 22, 2024

Zangetsu101 Oct 22, 2024

Siyasanga Oct 22, 2024

Zangetsu101 Oct 23, 2024

rikukissa Oct 23, 2024 •

edited

Loading

Siyasanga Oct 23, 2024 •

edited

Loading

rikukissa Oct 23, 2024

Siyasanga commented Oct 24, 2024

Zangetsu101 commented Oct 24, 2024

tahmidrahman-dsi commented Nov 7, 2024

Siyasanga commented Nov 7, 2024

naftis commented Nov 11, 2024

feat: Add constants.humanName to allow countries to have custom full name format #7812

feat: Add constants.humanName to allow countries to have custom full name format #7812

Conversation

Siyasanga commented Oct 22, 2024 • edited Loading

This comment has been minimized.

ocrvs-bot commented Oct 22, 2024

Zangetsu101 Oct 22, 2024

Choose a reason for hiding this comment

Siyasanga Oct 22, 2024

Choose a reason for hiding this comment

Zangetsu101 Oct 23, 2024

Choose a reason for hiding this comment

rikukissa Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Siyasanga Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

rikukissa Oct 23, 2024

Choose a reason for hiding this comment

Siyasanga commented Oct 24, 2024

Zangetsu101 commented Oct 24, 2024

tahmidrahman-dsi commented Nov 7, 2024

Siyasanga commented Nov 7, 2024

naftis commented Nov 11, 2024

Siyasanga commented Oct 22, 2024 •

edited

Loading

rikukissa Oct 23, 2024 •

edited

Loading

Siyasanga Oct 23, 2024 •

edited

Loading