Migrate deprecated pronouns by gijoe0295 · Pull Request #39522 · Expensify/App

gijoe0295 · 2024-04-03T17:22:32Z

Details

Deprecated pronouns are still being stored in the database. This PR migrates those by calling UpdatePronouns API with the new pronouns format.

Deprecated	English	Spanish
He/him	He / Him / His	Él
She/her	She / Her / Hers	Ella
They/them	They / Them / Theirs	Ellos
Ze/hir	Ze / Hir	Ze / Hir
Call me by my name	Call me by my name	Llámame por mi nombre
Self-select	Select your pronouns	Selecciona tus pronombres

Fixed Issues

$ #38969
PROPOSAL: #38969 (comment)

Tests

Open DevTools and manually change your pronouns to a deprecated value in Onyx

Onyx.merge('personalDetailsList', { your_account_id: { pronouns: 'He/him' } })

Refresh the page
Go to Profile Settings page
Verify Pronouns shows the corresponding new pronouns (He / Him / His in this case)
Verify UpdatePronouns API is triggered to set the correct pronouns
Repeat all steps above with other deprecated values and any custom values
Change language
Verify pronouns is changed accordingly

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

NA

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: mWeb Chrome

Screen.Recording.2024-04-04.at.02.07.28-source.mov

iOS: mWeb Safari

Screen.Recording.2024-04-04.at.02.00.36-source.mov

MacOS: Chrome / Safari

Untitled.mov

custom.mov

melvin-bot · 2024-04-03T18:48:45Z

@ntdiary Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

gijoe0295 · 2024-04-03T18:54:09Z

@ntdiary Some notes before reviewing:

~~Deprecated values will show as is in other places such as profile page (not profile settings page), details page... It will only be updated when user opens profile settings page.~~ If user had deprecated pronouns, it would get updated on open App.
There was a Self-selected option which allowed user to use their own custom pronouns. As we don't have its alternative in the new pronouns list and don't allow custom pronouns no more, I think we should treat it as empty pronouns (i.e. they haven't selected a pronouns).

ntdiary · 2024-04-04T14:27:35Z

-        const pronounsKey = currentUserPersonalDetails?.pronouns?.replace(CONST.PRONOUNS.PREFIX, '') ?? '';
+        const pronounsKey = PersonalDetailsUtils.getPronounsKey(currentUserPersonalDetails);
+        if (PersonalDetailsUtils.isDeprecatedPronouns(currentUserPersonalDetails)) {
+            PersonalDetails.updatePronouns(pronounsKey ? `${CONST.PRONOUNS.PREFIX}${pronounsKey}` : '', false);


I like going with solution 2, and I would like to recommend to use an Onyx migration instead of using the profile page to correct the pronouns.

I guess what you mean by "onyx migration" here is:
create a file like PronounsMigration.ts in the src/libs/migrations directory to handle mapping or even calling the updatePronouns API, instead of calling the API only when the user visits the ProfilePage? 🤔

cc @tgolen

Ah yes. Thanks. I didn't understand that requirement previously.

Yeah, that's what I meant. Sorry for not being clear! The migration would still make the API request to fix the pronoun on the server.

gijoe0295 · 2024-04-04T16:00:17Z

@ntdiary Updated with the Onyx migration approach.

tgolen · 2024-04-04T17:01:25Z

 });

-function updatePronouns(pronouns: string) {
+function updatePronouns(pronouns: string, navigate = true) {


I'd much rather have the navigation happen outside of this method. Is that possible without too much work? I don't like it when the action files do the redirecting because it makes them much more difficult to reuse like you are having to deal with here. It should be handled in the calling code.

Yes agree! I moved the navigation out.

tgolen · 2024-04-04T17:07:35Z

+            }
+
+            const pronouns = currentUserPersonalDetails.pronouns?.replace(CONST.PRONOUNS.PREFIX, '') ?? '';
+            const isDeprecatedPronouns = !!pronouns && !pronouns.startsWith(CONST.PRONOUNS.PREFIX);


I don't quite get why a pronoun starting with __predefined_ would mean it's deprecated. Can you explain why that is the case in a code comment, please?

Yes this condition is not 100% correct. I changed it to check whether the pronouns is in the latest PRONOUNS_LIST.

tgolen · 2024-04-04T17:07:37Z

+            const pronounsKey = Object.entries(CONST.DEPRECATED_PRONOUNS_LIST).find((deprecated) => deprecated[1] === pronouns)?.[0] ?? '';
+            PersonalDetails.updatePronouns(pronounsKey ? `${CONST.PRONOUNS.PREFIX}${pronounsKey}` : '', false);


I'm kind of confused about what this code is doing. Can you explain it with a code comment, or change the code to be a little more explanatory?

Added comments.

tgolen

Love it. Those changes are great. Thank you!

ntdiary · 2024-04-05T10:39:39Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

39522-android-native.mp4

Android: mWeb Chrome

39522-android-chrome.mp4

iOS: Native

N/A

iOS: mWeb Safari

39522-ios-safari.mp4

MacOS: Chrome / Safari

39522-web.mp4

MacOS: Desktop

39522-desktop.mp4

ntdiary

Note: this migration only occurs when we launch the app that has logged with an account. If we launch the app first and then login, the migration won't occur. :)

gijoe0295 · 2024-04-05T13:27:52Z

Hmm I'm not sure why perf-test is failing here but working fine locally.

ntdiary · 2024-04-05T14:35:57Z

Hmm I'm not sure why perf-test is failing here but working fine locally.

I don't think the perf-tests failure is caused by this PR. It seems that the perf-tests is still not very stable.

tgolen · 2024-04-10T13:37:00Z

I've tried re-running the performance tests, and it's still failing. It looks like the tests completed:

Test Suites: 16 passed, 16 total

but the process fails a little later on because of:

Auto-merging tests/unit/NetworkTest.ts
Auto-merging tests/unit/OptionsListUtilsTest.ts
Auto-merging tests/utils/LHNTestUtils.tsx
Auto-merging wdyr.ts
Automatic merge failed; fix conflicts and then commit the result.

@gijoe0295 Could you please double-check that you've updated from main and there are no conflicts in these files? It looks like the last time this was updated with main was from 5 days ago, so maybe something snuck in.

gijoe0295 · 2024-04-10T14:14:17Z

@tgolen Thanks for reminding me. I've merged main and all checks passed. Can you try again?

tgolen · 2024-04-10T15:20:14Z

Looks like that worked! Thanks

OSBotify · 2024-04-10T15:27:10Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-04-10T17:46:24Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2024-04-10T17:55:17Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2024-04-10T19:34:31Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.62-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-04-18T04:32:15Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.62-17 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

eh2077 · 2025-01-28T15:50:51Z


    const updatePronouns = (selectedPronouns: PronounEntry) => {
        PersonalDetails.updatePronouns(selectedPronouns.keyForList === currentPronounsKey ? '' : selectedPronouns?.value ?? '');
+        Navigation.goBack();


This caused

[HOLD for payment 2025-01-28] [$250] Web - Profile - App takes user back two steps when double clicking on a pronoun #54819

We should introduce a ref called isOptionSelected that will be true when we select an option, which will prevent the option from being selected multiple times.

gijoe0295 added 5 commits April 4, 2024 00:07

Migrate deprecated pronouns

15575a6

not goBack on updatePronouns

2177c7e

Handle self-select pronouns

dc0e5b9

Handle empty pronouns

380e29c

Handle custom pronouns

1dece95

gijoe0295 marked this pull request as ready for review April 3, 2024 18:48

gijoe0295 requested a review from a team as a code owner April 3, 2024 18:48

melvin-bot Bot removed the request for review from a team April 3, 2024 18:48

melvin-bot Bot requested a review from ntdiary April 3, 2024 18:48

ntdiary reviewed Apr 4, 2024

View reviewed changes

gijoe0295 added 3 commits April 4, 2024 22:18

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/38969

3824407

Use migrateOnyx approach

3df0e56

modify comment

1302b98

tgolen requested changes Apr 4, 2024

View reviewed changes

add explanatory comment

72a5702

tgolen approved these changes Apr 4, 2024

View reviewed changes

ntdiary approved these changes Apr 5, 2024

View reviewed changes

melvin-bot Bot requested a review from tgolen April 5, 2024 12:10

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/38969

134c04d

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/38969

ff56073

tgolen approved these changes Apr 10, 2024

View reviewed changes

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/38969

60633bb

tgolen merged commit 458de57 into Expensify:main Apr 10, 2024

github-actions Bot mentioned this pull request Apr 10, 2024

Deploy Checklist: New Expensify 2024-04-10 #40026

Closed

melvin-bot Bot mentioned this pull request Apr 18, 2024

[HOLD for payment 2024-04-25] [$500] MISSING_TRANSLATION is shown in pronoun field even without any pronouns set #38969

Closed

1 of 6 tasks

eh2077 reviewed Jan 28, 2025

View reviewed changes

		const pronounsKey = Object.entries(CONST.DEPRECATED_PRONOUNS_LIST).find((deprecated) => deprecated[1] === pronouns)?.[0] ?? '';
		PersonalDetails.updatePronouns(pronounsKey ? `${CONST.PRONOUNS.PREFIX}${pronounsKey}` : '', false);

Conversation

gijoe0295 commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Apr 3, 2024

Uh oh!

gijoe0295 commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gijoe0295 commented Apr 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgolen left a comment

Choose a reason for hiding this comment

Uh oh!

ntdiary commented Apr 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ntdiary left a comment

Choose a reason for hiding this comment

Uh oh!

gijoe0295 commented Apr 5, 2024

Uh oh!

ntdiary commented Apr 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tgolen commented Apr 10, 2024

Uh oh!

gijoe0295 commented Apr 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tgolen commented Apr 10, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

OSBotify commented Apr 10, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gijoe0295 commented Apr 3, 2024 •

edited

Loading

gijoe0295 commented Apr 3, 2024 •

edited

Loading

ntdiary commented Apr 5, 2024 •

edited

Loading

ntdiary commented Apr 5, 2024 •

edited

Loading

gijoe0295 commented Apr 10, 2024 •

edited

Loading