Refactor CloseAccountPage to functional component #19328

bondydaa · 2023-05-19T23:23:16Z

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

Verify that no errors appear in the JS console

Logged in and closed an account and ensured it closed properly

Logged in and went to the close account page and added a message and submitted the form and ensured the message showed up in the logs:

2023-05-22T21:18:48.854700+00:00 expensidev2004 php-fpm: gNqtRg /api.php wickford@dog.com !ecash1.3.16-7! ?api? [hmmm] Account closed with parting message ~~ email: 'wickford@dog.com' message: 'fffffasdf'

Offline tests

Logged in, forced offline mode, went to the close account page and ensured I wasn't able to submit since this functionality requires network access.

QA Steps

Verify that no errors appear in the JS console

Log into an account you are able to close without major repercussions (ie: not an admin/owner of workspace)
Force offline mode and attempt to close the account, ensure you're not allowed to submit the form.
Go back online, attempt to close the account and ensure you're able to submit it properly
When you are redirected to the login/sign in page ensure the Green Dot Road message of Account closed successfully appears correctly:

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…lose-account

melvin-bot · 2023-05-22T21:52:50Z

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

bondydaa · 2023-05-22T21:53:51Z

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.

parasharrajat · 2023-05-23T12:09:46Z

PR is looking good. I will test this asap.

parasharrajat · 2023-05-23T18:57:57Z

When you are redirected to the login/sign in page ensure the Green Dot Road message of Account closed successfully appears correctly:

This is failing for me even on staging.

parasharrajat

Please fix the Lint issues.

parasharrajat · 2023-05-23T19:08:37Z

src/libs/actions/CloseAccount.js

-/**
- * Clear CloseAccount error message to hide modal
- */
-function clearError() {


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.

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.

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:

App/src/CONST.js

Line 730 in 63f314c

DEFAULT_CLOSE_ACCOUNT_DATA: {error: '', success: '', isLoading: false},

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.

I tried again and now this issue is not reproducible as you said.

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.

…lose-account

parasharrajat · 2023-05-26T22:06:22Z

src/pages/signin/LoginForm.js

@@ -22,7 +22,7 @@ import {withNetwork} from '../../components/OnyxProvider';
 import networkPropTypes from '../../components/networkPropTypes';
 import * as ErrorUtils from '../../libs/ErrorUtils';
 import DotIndicatorMessage from '../../components/DotIndicatorMessage';
-import * as CloseAccount from '../../libs/actions/CloseAccount';


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.

…lose-account

This reverts commit bd80ad9.

This reverts commit 270b71c.

This reverts commit df15ca0.

…too much

bondydaa · 2023-05-26T23:07:03Z

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

parasharrajat · 2023-05-31T19:25:45Z

src/pages/settings/Security/CloseAccountPage.js

-            isConfirmModalVisible: false,
-            reasonForLeaving: '',
+    useEffect(() => {
+        CloseAccount.setDefaultData();


What is the reason for setting the defaultData on the mount?

This should be just

useEffect(() => () => CloseAccount.clearError(), []);

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.

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.

parasharrajat · 2023-05-31T19:26:16Z

src/pages/settings/Security/CloseAccountPage.js

        };
-    }
+    });


Suggested change

});

}, []);

not sure this is needed per the docs https://react.dev/reference/react/useEffect it's optional so empty array is probably the default.

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

okay cool makes sense, thanks for that! updating now

chiragsalian · 2023-06-13T21:36:34Z

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.

chiragsalian · 2023-06-13T22:08:35Z

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.

bondydaa · 2023-06-27T16:20:18Z

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

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.

🎀 👀 🎀 C+ reviewed

parasharrajat · 2023-06-27T18:40:15Z

@chiragsalian All yours.

OSBotify · 2023-06-28T23:17:17Z

✋ 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-06-29T20:38:09Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.35-0 🚀

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

Julesssss · 2023-07-03T12:55:51Z

These two issues were raised during testing: #21951 & #21952 (dupe of #21833)

parasharrajat · 2023-07-03T13:30:14Z

Possibly unrelated to refactoring. It must be present before this refactor.

Julesssss · 2023-07-03T14:24:22Z

Yeah, none of them are holding the release. Moving forward 👍

OSBotify · 2023-07-03T14:36:00Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

OSBotify · 2023-07-03T15:18:35Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

sakluger · 2023-07-03T19:16:48Z

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?

parasharrajat · 2023-07-03T20:26:31Z

@sakluger No, it was present before this PR. I just tested it.

situchan · 2023-07-05T05:20:57Z

src/pages/settings/Security/CloseAccountPage.js

-                            confirmText={this.props.translate('common.yesContinue')}
-                            cancelText={this.props.translate('common.cancel')}
-                            shouldShowCancelButton
-                            danger


This prop is not moved correctly

Ops yes. I can create a follow up.

refactor to functional component

014d239

bondydaa self-assigned this May 19, 2023

bondydaa mentioned this pull request May 19, 2023

[HOLD for payment 2023-07-10] [$250] Migrate CloseAccountPage.js to function component #16298

Closed

1 task

bondydaa added 4 commits May 22, 2023 14:42

Merge branch 'main' of github.com:Expensify/App into bondy-refactor-c…

db0d53e

…lose-account

remove unused method

bd80ad9

dont use useCallback here as its most likely not needed

86c0b3f

clean up imports

df15ca0

bondydaa marked this pull request as ready for review May 22, 2023 21:52

bondydaa requested a review from a team as a code owner May 22, 2023 21:52

melvin-bot bot requested review from chiragsalian and parasharrajat and removed request for a team May 22, 2023 21:52

parasharrajat suggested changes May 23, 2023

View reviewed changes

parasharrajat reviewed May 23, 2023

View reviewed changes

bondydaa added 3 commits May 25, 2023 10:49

Merge branch 'main' of github.com:Expensify/App into bondy-refactor-c…

ac211e3

…lose-account

export default and clean up usage

270b71c

fix default error key as defined by Onyx::handleException in web-e

5d050a0

parasharrajat reviewed May 26, 2023

View reviewed changes

bondydaa added 5 commits May 26, 2023 16:06

Merge branch 'main' of github.com:Expensify/App into bondy-refactor-c…

ba1c8fb

…lose-account

Revert "remove unused method"

ecbef94

This reverts commit bd80ad9.

Revert "export default and clean up usage"

4779d8e

This reverts commit 270b71c.

Revert "clean up imports"

cce3f22

This reverts commit df15ca0.

copy functionality based on lifecycle methods to not change behavior …

e25a3b1

…too much

parasharrajat reviewed May 31, 2023

View reviewed changes

bondydaa added 5 commits June 27, 2023 09:51

initial fix of merge conflicts, doesnt include all changes yet though

7bcb7a9

apply changes from commit 38e49c3

d71f54b

pull in change from commit b2dda33

57a33a4

pull in changes from commit 1b36c75

3c806f1

pull in changes from commit 3b5e279

7bd01cb

bondydaa dismissed chiragsalian’s stale review via 7bd01cb June 27, 2023 16:18

pull in changes from commit 1e456f6

15f6982

parasharrajat approved these changes Jun 27, 2023

View reviewed changes

This comment was marked as off-topic.

Sign in to view

chiragsalian approved these changes Jun 28, 2023

View reviewed changes

chiragsalian merged commit 309279f into main Jun 28, 2023

chiragsalian deleted the bondy-refactor-close-account branch June 28, 2023 23:13

OSBotify mentioned this pull request Jun 29, 2023

Deploy Checklist: New Expensify 2023-06-29 #21911

Closed

51 tasks

lanitochka17 mentioned this pull request Jun 30, 2023

[HOLD for payment 2023-08-01] [$1000] Close account offline - Close account is enabled by ENTER and no close account text #21951

Closed

6 tasks

situchan reviewed Jul 5, 2023

View reviewed changes

This was referenced Jul 5, 2023

[HOLD for payment 2023-07-14] Web- A Green 'Yes, Continues' button is shown when closing an account. #22257

Closed

Fix: Modal type in close Account confirmation #22251

Merged

Refactor CloseAccountPage to functional component #19328

Refactor CloseAccountPage to functional component #19328

Conversation

bondydaa commented May 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 22, 2023

bondydaa commented May 22, 2023

parasharrajat commented May 23, 2023

parasharrajat commented May 23, 2023

parasharrajat left a 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

bondydaa commented May 26, 2023

parasharrajat May 31, 2023 • edited Loading

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

parasharrajat Jun 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chiragsalian commented Jun 13, 2023

chiragsalian commented Jun 13, 2023

bondydaa commented Jun 27, 2023

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

This comment was marked as off-topic.

parasharrajat commented Jun 27, 2023

OSBotify commented Jun 28, 2023

OSBotify commented Jun 29, 2023

Julesssss commented Jul 3, 2023

parasharrajat commented Jul 3, 2023

Julesssss commented Jul 3, 2023

OSBotify commented Jul 3, 2023

OSBotify commented Jul 3, 2023

sakluger commented Jul 3, 2023 • edited Loading

parasharrajat commented Jul 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bondydaa commented May 19, 2023 •

edited

Loading

parasharrajat May 31, 2023 •

edited

Loading

parasharrajat Jun 2, 2023 •

edited

Loading

sakluger commented Jul 3, 2023 •

edited

Loading