Refactor CloseAccountPage to functional component#19328
Conversation
melvin-bot
Bot
requested review from
chiragsalian and
parasharrajat
and removed request for
a team
|
@parasharrajat @chiragsalian One of you needs to 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] |
|
okay publishing this for review. One thing that was curious to me locally which I would love for someone to confirm is whether or not you get the proper "account was successfully closed" message on the log in page after closing the account. I could see in the onyx data the the data was present but I think pusher was failing for me locally and so the GBR wouldn't show up until I refreshed the page. |
|
PR is looking good. I will test this asap. |
This is failing for me even on staging. |
parasharrajat
left a comment
parasharrajat
left a comment
There was a problem hiding this comment.
Please fix the Lint issues.
| /** | ||
| * Clear CloseAccount error message to hide modal | ||
| */ | ||
| function clearError() { |
There was a problem hiding this comment.
I think we should clear the errors as before because the next time I open the page, the loader is shown on the Close Account button.
Steps.
- Go to the close account page.
- press the close account button.
- See the errors on the page.
- Now, Close the page and reopen.
Might be unrelated to this change but exists.
There was a problem hiding this comment.
hmm you might be right, I noticed at one point in testing but then it went away after I'd reloaded and then I couldn't reproduce. Let me try again.
There was a problem hiding this comment.
Though don't think this method would actually stop the loader from showing since I think that is controlled by the isLoading key that's defined here:
Line 730 in 63f314c
There was a problem hiding this comment.
The more I noodle on this I think maybe we shouldn't be trying to address this here?
Really these props are all reacted-to by the Form component, this component is sort of just attempting to pass that data down along to it.
The only way to really solve it is to use the useEffect / lifecycle methods that were being used but those don't really make sense to add here since our component doesn't actually depend on them.
If we were to re-implement the lifecycle methods here we'd need useEffect which is just going to set some onyx data to the default because that's what the <Form> component will react to.
There was a problem hiding this comment.
I tried again and now this issue is not reproducible as you said.
There was a problem hiding this comment.
But I think that these errors are backend errors that we were clearing earlier. But I am not sure how to create a backend error so I can't test that.
| import networkPropTypes from '../../components/networkPropTypes'; | ||
| import * as ErrorUtils from '../../libs/ErrorUtils'; | ||
| import DotIndicatorMessage from '../../components/DotIndicatorMessage'; | ||
| import * as CloseAccount from '../../libs/actions/CloseAccount'; |
There was a problem hiding this comment.
This is intentional and a better pattern. We follow that all actions use default exports so that we can clearly see the action group. Let's just revert this. Thank you.
|
updated and reverted some of the broader changes and made this hopefully work more inline with how the class component was working. testing I still don't see the GBR "account closed successfully" but still 🙏 that's due to some weird pusher thing locally. I did figure out one way you could trigger an error is to submit an IOU from the account your trying to close and then pay it from the account you submitted to |
| isConfirmModalVisible: false, | ||
| reasonForLeaving: '', | ||
| useEffect(() => { | ||
| CloseAccount.setDefaultData(); |
There was a problem hiding this comment.
What is the reason for setting the defaultData on the mount?
This should be just
useEffect(() => () => CloseAccount.clearError(), []);
There was a problem hiding this comment.
It's similar to what we were doing previously (though I don't love that we were doing it previously) but mostly the react docs suggest you should typically do something in the first part and undo it in the 2nd part so figure this was more inline with the "react way" but I don't have a super strong opinion, I think either is fine.
There was a problem hiding this comment.
oh after looking again... it jogged my memory a little bit.
I did it this way since that's how it was working before but ideally what we'd do is hook this up to the component directly in the withOnyx and pass these as actual props.
Since we were trying to change a little as possible I figured better to follow what was happening then we can clean everything else up after we're done with the refactor.
Happy to change it still.
| CloseAccount.clearError(); | ||
| }; | ||
| } | ||
| }); |
There was a problem hiding this comment.
| }); | |
| }, []); |
There was a problem hiding this comment.
not sure this is needed per the docs https://react.dev/reference/react/useEffect it's optional so empty array is probably the default.
There was a problem hiding this comment.
No, it is not the case. we need to pass empty array [] if we want to mimic componentDidMount. The current hook will run after each render which is wrong. We want it to call after the initial render only. https://react.dev/reference/react/useEffect#examples-dependencies
There was a problem hiding this comment.
okay cool makes sense, thanks for that! updating now
|
I could but then i won't be able to merge the PR since i pushed commits. Then we would have to find another internal engineer to review/merge it (or maybe you could merge it). Either way, i hit up bondy about this last week and i believe he said the merge conflicts changes are a bit tricky so he would need some time for it. But with that said i would have expected it to be done by now. I see him online on slack everyday and according to his calendar he's working 50% this whole week except thursday. So @bondydaa, could you give us an ETA for this PR? Let's wait till tomorrow to hear back from him. If we don't we'll plan something else. |
|
I spoke to @bondydaa about this PR. He says his plate is pretty full and he won't be able to get to this PR this week. He says that there isn't much rush on this PR so he should be able to get to it next week. |
|
okay believe i've fixed the merge conflict and pulled in changes from the various PRs. i tried to label each commit I pulled in manually as a separate commit to hopefully make it more clear and easier to follow instead of a single big "fix merge conflicts". tested it and seems to still be working as expected so ready for another review now. |
parasharrajat
left a comment
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
This comment was marked as off-topic.
This comment was marked as off-topic.
|
@chiragsalian All yours. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.35-0 🚀
|
|
Possibly unrelated to refactoring. It must be present before this refactor. |
|
Yeah, none of them are holding the release. Moving forward 👍 |
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀
|
1 similar comment
|
🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀
|
|
Hey folks, we have a new report (#21951) that a user can trigger the form in Offline Mode with the Enter key on their keyboard. Is that a regression from this PR? |
|
@sakluger No, it was present before this PR. I just tested it. |
| confirmText={this.props.translate('common.yesContinue')} | ||
| cancelText={this.props.translate('common.cancel')} | ||
| shouldShowCancelButton | ||
| danger |
There was a problem hiding this comment.
This prop is not moved correctly
There was a problem hiding this comment.
Ops yes. I can create a follow up.
7 participants
Details
This refactors the CloseAccountPage into a functional component.
A few of the things in the existing component aren't necessary (ex: the lifecycle method) so I did not port those over.
Fixed Issues
$ #16298
PROPOSAL: GH_LINK_ISSUE(COMMENT)
Tests
Offline tests
QA Steps
Account closed successfullyappears correctly:PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android