clear callbacks when closing the account #26119

b4s36t4 · 2023-08-28T19:54:44Z

Details

Clears all callbacks when we're closing the account.

Fixed Issues

$ #25793
PROPOSAL: #25793 (comment)

Tests

Verify that no errors appear in the JS console

Open settings -> Security -> close the account
Observe user should be re-directed to Sign-in screen.
Move the app to background (2-3 open and close the app try not to open the app from recents)
Now try to login using new email address (no account) , user should able to login in any-case.
Repeat the same steps with maigclink as well.

Offline tests

NA - No login possible when offline

QA Steps

Same as above

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

Web

web.mp4

Mobile Web - Chrome

https://drive.google.com/file/d/1UH_kQ4dPMtVSNK8ZFtk4R-SwffetPMES/view?usp=sharing

Mobile Web - Safari

Kapture.2023-08-30.at.15.07.12.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

melvin-bot · 2023-08-28T19:54:48Z

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

jjcoffee · 2023-08-30T09:06:33Z

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

chrome-desktop-2023-08-30_13.49.14.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-08-30_11.57.13.mp4

Desktop

mac-desktop-2023-08-30_11.59.52.mp4

iOS

ios-native-2023-08-30_11.51.34.mp4

Android

android-native-2023-08-30_14.23.24.mp4

jjcoffee · 2023-08-30T09:08:07Z

@b4s36t4 Reviewing now - just noticed that you're missing mWeb screenshots for Chrome & Safari, can you add them?

b4s36t4 · 2023-08-30T09:08:59Z

Hey @jjcoffee sorry forget them. Will add and ping you soon.

jjcoffee · 2023-08-30T09:11:08Z

@b4s36t4 Could you also tweak the test steps to match the issue, so step 4 should be to login with a new email address (that doesn't have an account). I know the error was happening in normal login case too, but it's easier to test the fix if we just follow the original issue, I think! Offline tests should also be N/A since we can't login whilst offline 😄

b4s36t4 · 2023-08-30T10:13:07Z

@jjcoffee Updated the things you suggested. Sorry to wait you up though :). Thanks.

jjcoffee · 2023-08-30T12:57:18Z

src/libs/actions/User.js

@@ -70,6 +71,8 @@ function closeAccount(message) {
            ],
        },
    );
+    // Clear all the listeners/callback that are registered while logged-in


Little nitpick here; I think the comment could explain why we need to do this cleanup - otherwise it won't make sense for future readers of the code and we could just leave out the comment altogether.

So shall I remove the comment? or update the comment?

Are these comment good enough?!

@b4s36t4 That would be a tiny bit too long 😅 Just a sentence to explain why we're running cleanup actions will do.

Sure, sorry I'm a bit weak in commenting :)

@jjcoffee This works right?

src/libs/actions/User.js

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

b4s36t4 · 2023-08-30T13:35:05Z

Thanks a lot @jjcoffee :) committed the suggested change. Really sorry.

jjcoffee

LGTM!

(Note: there's a merge freeze at the moment so there may be a delay getting this merged.)

OSBotify · 2023-09-11T17:57:41Z

✋ 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-09-12T00:16:25Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.3.68-0 🚀

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

OSBotify · 2023-09-13T08:42:52Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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

clear callbacks when closing the account

0e4c49c

b4s36t4 requested a review from a team as a code owner August 28, 2023 19:54

melvin-bot bot removed the request for review from a team August 28, 2023 19:54

melvin-bot bot requested a review from jjcoffee August 28, 2023 19:54

b4s36t4 mentioned this pull request Aug 28, 2023

[HOLD for payment 2023-09-20] [$500] Log in - Unable to login after Closing an account #25793

Closed

6 tasks

jjcoffee reviewed Aug 30, 2023

View reviewed changes

added comment

c9d29eb

jjcoffee reviewed Aug 30, 2023

View reviewed changes

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

Update src/libs/actions/User.js

4e70228

Co-authored-by: Joel Davies <joeld.dev@gmail.com>

jjcoffee approved these changes Aug 30, 2023

View reviewed changes

melvin-bot bot requested a review from jasperhuangg August 30, 2023 13:36

jasperhuangg approved these changes Aug 31, 2023

View reviewed changes

jasperhuangg changed the title ~~clear callbacks when closing the account~~ [HOLD merge freeze] clear callbacks when closing the account Aug 31, 2023

jasperhuangg changed the title ~~[HOLD merge freeze] clear callbacks when closing the account~~ clear callbacks when closing the account Sep 11, 2023

jasperhuangg merged commit 7b828c1 into Expensify:main Sep 11, 2023

b4s36t4 deleted the fix/clear-callbacks-on-close branch September 11, 2023 17:54

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

clear callbacks when closing the account #26119

clear callbacks when closing the account #26119

b4s36t4 commented Aug 28, 2023 •

edited

Loading

melvin-bot bot commented Aug 28, 2023

jjcoffee commented Aug 30, 2023 •

edited

Loading

jjcoffee commented Aug 30, 2023

b4s36t4 commented Aug 30, 2023

jjcoffee commented Aug 30, 2023 •

edited

Loading

b4s36t4 commented Aug 30, 2023

jjcoffee Aug 30, 2023

b4s36t4 Aug 30, 2023

b4s36t4 Aug 30, 2023

jjcoffee Aug 30, 2023

b4s36t4 Aug 30, 2023

b4s36t4 Aug 30, 2023

b4s36t4 commented Aug 30, 2023

jjcoffee left a comment

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

clear callbacks when closing the account #26119

clear callbacks when closing the account #26119

Conversation

b4s36t4 commented Aug 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 28, 2023

jjcoffee commented Aug 30, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Aug 30, 2023

b4s36t4 commented Aug 30, 2023

jjcoffee commented Aug 30, 2023 • edited Loading

b4s36t4 commented Aug 30, 2023

jjcoffee Aug 30, 2023

Choose a reason for hiding this comment

b4s36t4 Aug 30, 2023

Choose a reason for hiding this comment

b4s36t4 Aug 30, 2023

Choose a reason for hiding this comment

jjcoffee Aug 30, 2023

Choose a reason for hiding this comment

b4s36t4 Aug 30, 2023

Choose a reason for hiding this comment

b4s36t4 Aug 30, 2023

Choose a reason for hiding this comment

b4s36t4 commented Aug 30, 2023

jjcoffee left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

OSBotify commented Sep 13, 2023

b4s36t4 commented Aug 28, 2023 •

edited

Loading

jjcoffee commented Aug 30, 2023 •

edited

Loading

jjcoffee commented Aug 30, 2023 •

edited

Loading