refactor: move methods to personalDetailsUtils, remove unused one #34657

koko57 · 2024-01-17T16:16:52Z

Details

Fixed Issues

$ #31312
PROPOSAL: #31312 (comment)

Tests

Go to Settings -> Wallet -> Enable Wallet - verify that Legal First Name and Legal Last Name in the Additional Details step are displayed in the inputs correctly.
Go to Settings -> Profile -> Display Name -> change your display name - verify that it works correctly.

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Go to Settings -> Wallet -> Enable Wallet - verify that Legal First Name and Legal Last Name in the Additional Details step are displayed in the inputs correctly.
Go to Settings -> Profile -> Display Name -> change your display name - verify that it works correctly.

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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(themeColors.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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…thods-pt3

melvin-bot · 2024-01-19T10:26:50Z

@situchan 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]

…thods-pt3

koko57 · 2024-01-23T10:13:21Z

@situchan friendly bump 🙂

…thods-pt3

situchan · 2024-01-26T22:53:56Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan · 2024-01-28T18:22:06Z

src/libs/PersonalDetailsUtils.ts

+ *
+ * @param login - user's login
+ * @param passedPersonalDetails - details object with firstName and lastName
+ * @returns - The effective display name


This is not needed in TS if params are self-explanatory

Suggested change

*

* @param login - user's login

* @param passedPersonalDetails - details object with firstName and lastName

* @returns - The effective display name

@situchan but other methods in this file also have params listed

https://github.com/Expensify/App/blob/main/contributingGuides/TS_STYLE.md#jsdoc

@situchan should I remove the params from other methods' docs as well? wdyt?

not a big deal

Let’s remove it from this method though, yeah?

situchan · 2024-01-28T18:23:15Z

src/libs/PersonalDetailsUtils.ts

+ *
+ * @param login - user's login
+ * @param displayName - user display name
+ * @param firstName
+ * @param lastName


Same here

Suggested change

*

* @param login - user's login

* @param displayName - user display name

* @param firstName

* @param lastName

situchan · 2024-01-28T18:34:50Z

- 2. Go to Settings -> Personal Details -> change your display name - verify that it works correctly.
+ 2. Go to Settings -> Profile -> Display name > change your display name - verify that it works correctly.

…thods-pt3

puneetlath

Looks good to me other than the things that @situchan already pointed out.

…thods-pt3

koko57 · 2024-01-30T09:15:49Z

@situchan @puneetlath done!

…thods-pt3

puneetlath · 2024-02-01T20:53:15Z

@koko57 looks like the performance tests are failing.

…thods-pt3

koko57 · 2024-02-05T08:50:25Z

@puneetlath fixed!

OSBotify · 2024-02-05T15:26:01Z

✋ 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-02-05T23:09:13Z

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-02-05T23:30:58Z

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-02-07T09:51:22Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

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

refactor: move methods to personalDetailsUtils, remove unused one

fad567c

koko57 mentioned this pull request Jan 17, 2024

[HOLD for payment 2024-02-14] [HOLD for payment 2024-01-18] Consolidate GetDislplayName methods #31312

Closed

koko57 added 2 commits January 19, 2024 09:55

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

ab8dcab

…thods-pt3

fix: run prettier

dc76940

koko57 marked this pull request as ready for review January 19, 2024 10:26

koko57 requested a review from a team as a code owner January 19, 2024 10:26

melvin-bot bot removed the request for review from a team January 19, 2024 10:26

melvin-bot bot requested a review from situchan January 19, 2024 10:26

koko57 added 2 commits January 22, 2024 11:13

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

23647c7

…thods-pt3

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

84fb28a

…thods-pt3

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

066bd29

…thods-pt3

situchan reviewed Jan 28, 2024

View reviewed changes

situchan approved these changes Jan 29, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath January 29, 2024 09:01

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

205f9ee

…thods-pt3

puneetlath requested changes Jan 29, 2024

View reviewed changes

koko57 added 2 commits January 30, 2024 09:14

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

93d8f75

…thods-pt3

fix: remove params

b0970b6

koko57 added 2 commits January 31, 2024 12:19

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

c0b1426

…thods-pt3

fix: resolve conflicts

c8e9dc1

koko57 requested a review from puneetlath February 1, 2024 11:44

puneetlath approved these changes Feb 1, 2024

View reviewed changes

Merge branch 'main' into refactor/31312-consolidate-getdisplayname-me…

6fee255

…thods-pt3

puneetlath approved these changes Feb 5, 2024

View reviewed changes

puneetlath merged commit f0ad2ac into Expensify:main Feb 5, 2024
15 checks passed

github-actions bot mentioned this pull request Feb 5, 2024

Deploy Checklist: New Expensify 2024-02-05 #35857

Closed

66 tasks

izarutskaya mentioned this pull request Feb 7, 2024

[$500] FN/LN in Wallet pg don't update immediately if display name changed, update after logout/login #36001

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: move methods to personalDetailsUtils, remove unused one #34657

refactor: move methods to personalDetailsUtils, remove unused one #34657

koko57 commented Jan 17, 2024 •

edited

Loading

melvin-bot bot commented Jan 19, 2024

koko57 commented Jan 23, 2024

situchan commented Jan 26, 2024 •

edited

Loading

situchan Jan 28, 2024

koko57 Jan 29, 2024

situchan Jan 29, 2024

koko57 Jan 29, 2024 •

edited

Loading

situchan Jan 29, 2024

puneetlath Jan 29, 2024

situchan Jan 28, 2024

situchan commented Jan 28, 2024 •

edited

Loading

puneetlath left a comment

koko57 commented Jan 30, 2024

puneetlath commented Feb 1, 2024

koko57 commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 7, 2024

refactor: move methods to personalDetailsUtils, remove unused one #34657

refactor: move methods to personalDetailsUtils, remove unused one #34657

Conversation

koko57 commented Jan 17, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 19, 2024

koko57 commented Jan 23, 2024

situchan commented Jan 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

situchan Jan 28, 2024

Choose a reason for hiding this comment

koko57 Jan 29, 2024

Choose a reason for hiding this comment

situchan Jan 29, 2024

Choose a reason for hiding this comment

koko57 Jan 29, 2024 • edited Loading

Choose a reason for hiding this comment

situchan Jan 29, 2024

Choose a reason for hiding this comment

puneetlath Jan 29, 2024

Choose a reason for hiding this comment

situchan Jan 28, 2024

Choose a reason for hiding this comment

situchan commented Jan 28, 2024 • edited Loading

puneetlath left a comment

Choose a reason for hiding this comment

koko57 commented Jan 30, 2024

puneetlath commented Feb 1, 2024

koko57 commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 7, 2024

koko57 commented Jan 17, 2024 •

edited

Loading

situchan commented Jan 26, 2024 •

edited

Loading

koko57 Jan 29, 2024 •

edited

Loading

situchan commented Jan 28, 2024 •

edited

Loading