Fix: Private personal details are not fetched when navigating by direct link #22906

tienifr · 2023-07-14T17:31:11Z

Details

Navigating to sub-pages under Personal details page by direct link does not fetch private_personalDetails data. This PR fixes that.

Fixed Issues

$ #22606
PROPOSAL: #22606 (comment)

Tests

Sign in with any account
Go to Settings > Profiles > Personal details > Legal name
Copy the URL of this Legal name page
Add a legal name (if not yet)
Sign out
Go to Legal name page from the URL in step 3
Sign in again
Verify that it navigates to Legal name page and displays your legal name correctly
Repeat step 2 - 8 with Date of birth and Home address page

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Sign in with any account
Go to Settings > Profiles > Personal details > Legal name
Copy the URL of this Legal name page
Add a legal name (if not yet)
Sign out
Go to Legal name page from the URL in step 3
Sign in again
Verify that it navigates to Legal name page and displays your legal name correctly
Repeat step 2 - 8 with Date of birth and Home address page

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

22606-web.mp4

Mobile Web - Chrome

22606-mweb-chrome.mp4

Mobile Web - Safari

22606-mweb-safari.1.mp4

Desktop

22606-desktop.mp4

iOS

22606-ios-1.mp4

Android

22606-android.mp4

melvin-bot · 2023-07-18T08:15:24Z

@Santhosh-Sellavel 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]

Santhosh-Sellavel · 2023-07-18T12:57:11Z

Cc: @allroundexperts yours

allroundexperts · 2023-07-18T22:21:35Z

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 / Chrome
- iOS / native
- iOS / 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(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 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

Web

Screen.Recording.2023-07-25.at.12.39.25.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-25.at.12.50.07.AM.mov

Mobile Web - Safari

Screen.Recording.2023-07-25.at.12.47.32.AM.mov

Desktop

Screen.Recording.2023-07-25.at.12.44.53.AM.mov

iOS

Screen.Recording.2023-07-25.at.12.56.16.AM.mov

Android

Screen.Recording.2023-07-25.at.12.58.22.AM.mov

tienifr · 2023-07-20T02:36:48Z

@allroundexperts any updates?

allroundexperts · 2023-07-20T14:30:11Z

@allroundexperts any updates?

Still on it. The changed files are a little more than what I expected. That's taking me some time!

allroundexperts · 2023-07-22T22:02:56Z

src/components/withPrivatePersonalDetails.js

+class PrivatePersonalDetailsProvider extends React.Component {
+    componentDidMount() {
+        if (this.props.network.isOffline || !isAuthenticated(this.props.session)) {
+            return;
+        }
+
+        PersonalDetails.openPersonalDetailsPage();
+    }
+
+    componentDidUpdate(prevProps) {
+        // Only open personal detail page if the network is online, and the state is transitioning from unauthenticated to authenticated
+        if (this.props.network.isOffline || !isAuthenticated(this.props.session) || isAuthenticated(prevProps.session)) {
+            return;
+        }
+        PersonalDetails.openPersonalDetailsPage();
+    }
+
+    render() {
+        return <PrivatePersonalDetailsContext.Provider value={this.props}>{this.props.children}</PrivatePersonalDetailsContext.Provider>;
+    }
+}


No more class components please.

allroundexperts · 2023-07-22T22:05:45Z

src/components/withPrivatePersonalDetails.js

+export default function withPrivatePersonalDetails(WrappedComponent) {
+    const WithPrivatePersonalDetails = forwardRef((props, ref) => (
+        <PrivatePersonalDetailsContext.Consumer>
+            {(privatePersonalDetailsProps) => (
+                <WrappedComponent
+                    // eslint-disable-next-line react/jsx-props-no-spreading
+                    {...privatePersonalDetailsProps}
+                    // eslint-disable-next-line react/jsx-props-no-spreading
+                    {...props}
+                    ref={ref}
+                />
+            )}
+        </PrivatePersonalDetailsContext.Consumer>
+    ));


Instead of wrapping this in a Consumer, lets just use the hook (src/hooks/usePrivatePersonalDetails.js) that you created.

src/libs/actions/PersonalDetails.js

allroundexperts · 2023-07-22T22:15:14Z

src/components/withPrivatePersonalDetails.js

I think this whole Context approach does not make sense here. We just need to initialise the API call to read personal details here along with openApp call. I think this will do what we want.

allroundexperts · 2023-07-22T22:16:00Z

src/pages/settings/Profile/PersonalDetails/AddressPage.js

-        },
-    }),
-)(AddressPage);
+export default compose(withLocalize, withPrivatePersonalDetails)(AddressPage);


Why not just use Onyx? Let's not re-invent the wheel here please.

allroundexperts · 2023-07-22T22:17:09Z

src/pages/settings/Profile/PersonalDetails/AddressPage.js

+    const [addressStreet1, setAddressStreet1] = useState('');
+    const [addressStreet2, setAddressStreet2] = useState('');
+    const [addressCity, setAddressCity] = useState('');
+    const [addressState, setAddressState] = useState('');
+    const [addressZip, setAddressZip] = useState('');
+    const [addressCountry, setAddressCountry] = useState('');
+
+    useEffect(() => {
+        const {address} = privatePersonalDetails;
+        if (!address) {
+            return;
+        }
+        const [street1, street2] = (address.street || '\n').split('\n');
+        setAddressStreet1(street1);
+        setAddressStreet2(street2);
+        setAddressCity(address.city);
+        setAddressState(address.state);
+        setAddressZip(address.zip);
+        setAddressCountry(address.country);
+    }, [privatePersonalDetails, privatePersonalDetails.address]);


Why is this needed?

allroundexperts · 2023-07-22T22:17:57Z

src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js

+    const [dob, setDob] = useState(privatePersonalDetails.dob || '');
+
+    useEffect(() => {
+        setDob(privatePersonalDetails.dob);
+    }, [privatePersonalDetails.dob]);


Not needed.

allroundexperts · 2023-07-22T22:18:16Z

src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js

-        },
-    }),
-)(DateOfBirthPage);
+export default compose(withLocalize, withPrivatePersonalDetails)(DateOfBirthPage);


Same as previous file.

allroundexperts · 2023-07-22T22:18:42Z

src/pages/settings/Profile/PersonalDetails/LegalNamePage.js

+    useEffect(() => {
+        setLegalFirstName(lodashGet(privatePersonalDetails, 'legalFirstName', ''));
+        setLegalLastName(lodashGet(privatePersonalDetails, 'legalLastName', ''));
+    }, [privatePersonalDetails, privatePersonalDetails.legalFirstName, privatePersonalDetails.legalLastName]);


Not needed.

allroundexperts · 2023-07-22T22:19:44Z

src/pages/settings/Profile/PersonalDetails/privatePersonalDetailsPropTypes.js

Doesn't make sense to use a HoC when we've shifted to functional components. I think this PR could have been much simpler.

tienifr · 2023-07-24T10:23:17Z

@allroundexperts Can you please help check again? I though we have several files using React class component so I try to create the HOC. Sorry for this inconvenience.

allroundexperts · 2023-07-24T15:31:04Z

src/hooks/usePrivatePersonalDetails.js

Are we using similar pattern elsewhere? I think it would be better to add PersonalDetails.openPersonalDetailsPage call along with the OpenApp call.

hmmm not yet, but I don't think fetching personalDetails along with OpenApp is a good idea. Firstly, we may not access personalDetail page, so fetching personalDetails at first is unnecessary. Secondly, we have many places that use openPage like PersonalDetails.openPublicProfilePage(accountID) and it's not executed along with OpenApp

Hm... You do have a valid point. Can you think of a way so that we just have to rely on onyx for getting data inside the component instead of using this hook?

We're still using data from onyx inside the component. we just use the hook to fetch data if needed and don't worry about the performance because we have the logic to prevent fetching data again if it's already in onyx

Thinking about this again, I think this approach is fine actually. We won't have to repeat the usage of useEffect on every page where we need this data.

allroundexperts · 2023-07-24T19:16:41Z

src/pages/settings/Profile/PersonalDetails/AddressPage.js

@@ -118,7 +118,10 @@ function AddressPage(props) {
    }, []);

    return (
-        <ScreenWrapper includeSafeAreaPaddingBottom={false}>
+        <PersonalDetailsScreenWrapper
+            privatePersonalDetails={props.privatePersonalDetails}


I think this is not really needed. You can just use Onyx to get that data inside PersonalDetailsScreenWrapper component.

That being said, I think its not much and should be fine as it is.

src/components/NewDatePicker/index.js

allroundexperts

Looks good. Tests well as well!

dangrous · 2023-07-25T14:38:06Z

Hi! Can I get a quick summary of why we decided to go with a new component instead of a hook? I can definitely be convinced, but the hook seemed cleaner to me when it was proposed. Thanks!

allroundexperts · 2023-07-25T14:39:23Z

Hi! Can I get a quick summary of why we decided to go with a new component instead of a hook? I can definitely be convinced, but the hook seemed cleaner to me when it was proposed. Thanks!

@dangrous We're still using the hook in the component.

dangrous · 2023-07-25T15:38:37Z

Right but I don't think the new component (PersonalDetailsScreenWrapper) was part of the proposal, unless I'm mistaken?

allroundexperts · 2023-07-25T15:40:21Z

Right but I don't think the new component (PersonalDetailsScreenWrapper) was part of the proposal, unless I'm mistaken?

It wasn't. Its just an optimisation that prevents us from repeating the Loader and using the hook in each individual personal details screen.

dangrous · 2023-07-25T17:27:47Z

Hm yeah, I get the idea behind it but it doesn't seem like a pattern we've really used before. I might prefer just replicating the loader and hook in each component; I realize that is a bit of duplicated code but I think it might be cleaner overall. Happy to open the discussion to Slack though if y'all want more opinions!

allroundexperts · 2023-07-25T17:43:30Z

@tienifr What do you think?

tienifr · 2023-07-25T17:58:13Z

I agree with @dangrous. Although the loading check is duplicated, that's what we've been doing across the App like here, here or here, etc. It looks clean and easy to understand. IMO, we should not create a separate ScreenWrapper just for PersonalDetails. Happy to hear your point to proceed then.

allroundexperts · 2023-07-25T18:02:07Z

Nops. I'm good. Lets revert that!

This reverts commit d452118 Signed-off-by: tienifr <[email protected]>

dangrous

Two quick updates, looks great though!

src/pages/settings/Profile/PersonalDetails/LegalNamePage.js

src/libs/actions/PersonalDetails.js

tienifr · 2023-07-25T19:39:40Z

Thanks, I've updated @dangrous.

dangrous

Nice!

dangrous

Nice!

OSBotify · 2023-07-25T19:54:30Z

✋ 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 · 2023-07-26T16:10:19Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.46-0 🚀

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

OSBotify · 2023-07-27T22:08:19Z

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.47-0 🚀

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

OSBotify · 2023-07-27T22:39:05Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

OSBotify · 2023-07-31T18:36:48Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

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

tienifr added 8 commits July 14, 2023 17:31

refactor: private personal details prop types

b6f562c

usePrivatePersonalDetails hook

17ee08a

isLoading private personal details

eed1ecc

pass context value

0078199

modify onyx key

f418f98

apply HOC in affected pages

d786e80

Merge branch 'main' into fix/22606

6dc0046

fix lint

edc1cfe

tienifr changed the title ~~Fix: Private personal details are not fetched on navigating by direct link~~ Fix: Private personal details are not fetched when navigating by direct link Jul 14, 2023

tienifr added 5 commits July 15, 2023 01:05

added prop types for HOC

755701d

add session prop

1df7bff

add shouldComponentUpdate in

4e0bc85

refactor

b3a8c30

fix lint

f17ca65

tienifr marked this pull request as ready for review July 18, 2023 08:15

tienifr requested a review from a team as a code owner July 18, 2023 08:15

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team July 18, 2023 08:15

tienifr mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-08-03] [$1000] Opening legal name from link and login does not display saved legal name #22606

Closed

6 tasks

dangrous requested review from allroundexperts and removed request for Santhosh-Sellavel July 18, 2023 19:01

allroundexperts suggested changes Jul 22, 2023

View reviewed changes

fix: 22606 use hook to fetch private personal detail data

5bd9c3a

allroundexperts reviewed Jul 24, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

allroundexperts reviewed Jul 24, 2023

View reviewed changes

src/components/NewDatePicker/index.js Show resolved Hide resolved

allroundexperts approved these changes Jul 24, 2023

View reviewed changes

melvin-bot bot requested a review from dangrous July 24, 2023 20:43

Revert "add wrapper component"

7df5cf8

This reverts commit d452118 Signed-off-by: tienifr <[email protected]>

allroundexperts approved these changes Jul 25, 2023

View reviewed changes

dangrous requested changes Jul 25, 2023

View reviewed changes

src/pages/settings/Profile/PersonalDetails/LegalNamePage.js Outdated Show resolved Hide resolved

src/libs/actions/PersonalDetails.js Outdated Show resolved Hide resolved

fix comment and add shouldEnableMaxHeight

60ed833

dangrous approved these changes Jul 25, 2023

View reviewed changes

dangrous merged commit abfbefa into Expensify:main Jul 25, 2023

OSBotify mentioned this pull request Jul 26, 2023

Deploy Checklist: New Expensify 2023-07-26 #23657

Closed

43 tasks

OSBotify mentioned this pull request Jul 27, 2023

Deploy Checklist: New Expensify 2023-07-27 #23765

Closed

79 tasks

mkhutornyi mentioned this pull request Oct 6, 2023

[$500] [HOLD for payment 2023-09-27] Android - Infinite loading after opening personal details page #27560

Closed

6 tasks

Fix: Private personal details are not fetched when navigating by direct link #22906

Fix: Private personal details are not fetched when navigating by direct link #22906

Conversation

tienifr commented Jul 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 18, 2023

Santhosh-Sellavel commented Jul 18, 2023

allroundexperts commented Jul 18, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

tienifr commented Jul 20, 2023 • edited Loading

allroundexperts commented Jul 20, 2023

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

Choose a reason for hiding this comment

tienifr commented Jul 24, 2023

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

This comment was marked as outdated.

allroundexperts left a comment

Choose a reason for hiding this comment

dangrous commented Jul 25, 2023

allroundexperts commented Jul 25, 2023

dangrous commented Jul 25, 2023

allroundexperts commented Jul 25, 2023

dangrous commented Jul 25, 2023

allroundexperts commented Jul 25, 2023

tienifr commented Jul 25, 2023 • edited Loading

allroundexperts commented Jul 25, 2023

dangrous left a comment

Choose a reason for hiding this comment

tienifr commented Jul 25, 2023

dangrous left a comment

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 31, 2023

tienifr commented Jul 14, 2023 •

edited

Loading

allroundexperts commented Jul 18, 2023 •

edited

Loading

tienifr commented Jul 20, 2023 •

edited

Loading

tienifr commented Jul 25, 2023 •

edited

Loading