Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use new API command LogOut #9602

Merged
merged 14 commits into from
Jul 8, 2022
Merged

Use new API command LogOut #9602

merged 14 commits into from
Jul 8, 2022

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Jun 28, 2022

Tracking issue: https://github.com/Expensify/Expensify/issues/212810

Details

Holding on https://github.com/Expensify/Web-Expensify/pull/34150 getting to production :D

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/213650

Tests

  1. Checkout branch from https://github.com/Expensify/Web-Expensify/pull/34150 or main if that PR has been merged already
  2. Log out of any account that's currently logged in
  3. Check the number of logins in your logins table with select COUNT(*) from logins where accountID = <account-ID>;
  4. Log in with that account you're checking
  5. Check the number of logins, verify it's one more than what you saw in step 3
  6. Log out of your account
  7. Check the number of logins, verify it's back to what you saw in step 3
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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
  • 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 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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 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 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.

QA Steps

I believe you'll need ring1 to access login table, unless ring3 has access 😅

  1. Log out of any account that's currently logged in
  2. Check the number of logins in your logins table with select COUNT(*) from logins where accountID = <account-ID>;
  3. Log in with that account you're checking
  4. Check the number of logins, verify it's one more than what you saw in step 3
  5. Log out of your account
  6. Check the number of logins, verify it's back to what you saw in step 3
  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

Screen.Recording.2022-06-29.at.3.17.10.PM.mov

@Beamanator Beamanator self-assigned this Jun 28, 2022
@Beamanator Beamanator changed the title [HOLD Web-E#Use new API endpoint LogOut [HOLD Web-E#34150] Use new API endpoint LogOut Jun 28, 2022
@Beamanator Beamanator changed the title [HOLD Web-E#34150] Use new API endpoint LogOut [HOLD Web-E#34150] Use new API command LogOut Jun 29, 2022
@Beamanator Beamanator changed the title [HOLD Web-E#34150] Use new API command LogOut [HOLD Web-E#34150] Use new API command LogOut Jun 29, 2022
@Beamanator Beamanator added the InternalQA This pull request required internal QA label Jun 29, 2022
@Beamanator Beamanator marked this pull request as ready for review June 29, 2022 13:25
@Beamanator Beamanator requested a review from a team as a code owner June 29, 2022 13:25
@melvin-bot melvin-bot bot requested review from techievivek and removed request for a team June 29, 2022 13:25
@Beamanator Beamanator changed the title [HOLD Web-E#34150] Use new API command LogOut Use new API command LogOut Jun 29, 2022
@Beamanator
Copy link
Contributor Author

No longer on hold!

@Beamanator Beamanator closed this Jun 29, 2022
@Beamanator Beamanator reopened this Jun 30, 2022
@Beamanator
Copy link
Contributor Author

Beamanator commented Jun 30, 2022

Uhhh I guess the Control + Enter shortcut is now "Closing" the PR / Issue - I didn't mean to close this!

Update: Didn't close that time so 🤷

techievivek
techievivek previously approved these changes Jul 1, 2022
Copy link
Contributor

@techievivek techievivek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Just wanted to understand the usage of Timing.clearData();. And does it matter if we place it above in a block of code or at the bottom?

@Beamanator
Copy link
Contributor Author

Hmm good question I'll see if I can figure out who knows the most about that :D

@Beamanator
Copy link
Contributor Author

Good point @techievivek I think it's better to keep clearing the timer at the bottom, after the API call. updated

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be on HOLD until the linked PR is on production? No LogOut command will exist until it is.

];
API.write('LogOut', {
// Send current authToken because we will immediately clear it once triggering this command
authToken: NetworkStore.getAuthToken(),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAB, maybe kind of rare that this would happen - but feels like something that API should deal with by caching the authToken before setting optimisticData.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I definitely think it's rare, but it's necessary for this case (took me a while to debug & figure out this was the cause of some annoying issues)

I like the idea of the API caching the authToken before setting optimisticData, but maybe only if there's other instances where that's needed? Like in other Authenticate refactors 'n such.

src/libs/actions/Session/index.js Outdated Show resolved Hide resolved
src/libs/actions/Session/index.js Outdated Show resolved Hide resolved
@Beamanator Beamanator changed the title Use new API command LogOut [HOLD Web-Expensify#34150] Use new API command LogOut Jul 1, 2022
@Beamanator
Copy link
Contributor Author

Dunno how I got so many merge commits 🤫 but should be ready for another review now haha

marcaaron
marcaaron previously approved these changes Jul 5, 2022
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

src/libs/actions/Session/index.js Outdated Show resolved Hide resolved
@Beamanator Beamanator changed the title [HOLD Web-Expensify#34150] Use new API command LogOut Use new API command LogOut Jul 8, 2022
@Beamanator Beamanator merged commit f42331e into main Jul 8, 2022
@Beamanator Beamanator deleted the beaman-refactorApiDeleteLogin branch July 8, 2022 06:23
@melvin-bot
Copy link

melvin-bot bot commented Jul 8, 2022

Triggered auto assignment to @Julesssss (InternalQA), see https://stackoverflow.com/c/expensify/questions/5042 for more details.

@melvin-bot melvin-bot bot added the Emergency label Jul 8, 2022
@melvin-bot
Copy link

melvin-bot bot commented Jul 8, 2022

@Beamanator looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@Beamanator
Copy link
Contributor Author

Beamanator commented Jul 8, 2022

Related Web-E PR is on Production since yesterday 👍

Oh just noticed the latest tests haven't finished or something??

Nevermind, the tests on the last commit passed so idk what the problem was & why Emergency was added 🤷 Maybe because I merged right after taking off HOLD.

Anway, this is not actually an emergency 😅

@OSBotify
Copy link
Contributor

OSBotify commented Jul 8, 2022

🚀 Deployed to staging by @Beamanator in version: 1.1.82-5 🚀

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

@Beamanator
Copy link
Contributor Author

Used User.getLoginList() in OldDot to check the number of logins for myself (had to hard refresh between logins & logouts) and pass! 👍

After logging in in NewDot:

Screen Shot 2022-07-12 at 5 04 23 PM

After logging out of NewDot:

Screen Shot 2022-07-12 at 5 06 02 PM

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @roryabraham in version: 1.1.82-5 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
InternalQA This pull request required internal QA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants