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

Remove unused code for setPassword() action #8680

Merged
merged 3 commits into from
Apr 20, 2022

Conversation

marcaaron
Copy link
Contributor

@marcaaron marcaaron commented Apr 18, 2022

cc @roryabraham since you reviewed #6587 and I'm trying to reference that PR to make sure this one is correct.

Details

The code running inside this catch() block seems like it will never run. This particular (maybe all) API command methods will only catch if:

  • There are unhandled throws in the .then()
  • They "run out of retries" and get rejected

Since the only logic performed is a call to createTemporaryLogin() and the throw inside that method is handled by it's own catch() the logic here won't ever run.

Code was added in this PR and I didn't catch it (no pun intended)

Fixed Issues

$ #8678

Tests

  1. Sign up for new account
  2. Get validate email
  3. Visit link and break validate code in url
  4. Enter valid password and submit
  5. Verify the message appears above the submit button about the validate code being expired

2022-04-18_10-33-35

  • Verify that no errors appear in the JS console

PR Review Checklist

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

This is not really easy to QA on native since you need to manually break the validate code. But we can repeat the steps above for:

  • Web

  • mobile web

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

return;
}
setPassword(password, validateCode, accountID);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just removing this because I don't think it's clear to have a single method responsible for setting a password or changing one and this can be left up to the view to decide.

@marcaaron marcaaron self-assigned this Apr 18, 2022
@marcaaron marcaaron marked this pull request as ready for review April 18, 2022 20:57
@marcaaron marcaaron requested a review from a team as a code owner April 18, 2022 20:57
@melvin-bot melvin-bot bot requested review from marcochavezf and removed request for a team April 18, 2022 20:58
const login = lodashGet(response, 'data.email', null);
Onyx.merge(ONYXKEYS.ACCOUNT, {accountExists: true, validateCodeExpired: true, error: null});

// The login might not be set if the user hits a url in a new session. We set it here to ensure calls to resendValidationLink() will succeed.
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 actually don't really get what this comment is saying even though I asked for it to be added when a contributor added this 😅

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 think it cannot run... and could not run when the code was added...

Original state of file when this was added...

https://github.com/akshayasalvi/App/blob/6180d9ecb90cbfb50562e047783a1813c5021ddd/src/libs/actions/Session/index.js#L215-L217

@marcaaron
Copy link
Contributor Author

cc @chiragsalian on this too just to check me. I read some older comments of yours in this thread #5150 (comment) and wanted to be sure that there isn't another way that catch() block can handle a response that I'm not seeing.

@chiragsalian
Copy link
Contributor

and wanted to be sure that there isn't another way that catch() block can handle a response that I'm not seeing.

Umm are you asking if there is some incoming response flow that would require a catch block? If so i feel like in the past an "incorrect validate code" or "email not found" would trigger the catch block. But i just tested this and it doesn't seem to be the case as its going to .then just fine. There is one case catch block would still be used and that would be offline connection, its steps,

  1. Go to http://localhost:8080/setpassword/12/FGVGEKKUB
  2. Turn off ngrok
  3. Enter a password in newdot, click "set password"

Since the request is a failure it should go to the catch block. Not sure if this is something we would want to account for though.

@marcaaron
Copy link
Contributor Author

@chiragsalian Oh wow, thanks for testing 🙇 That is consistent with my expectations then. Yes, I think if you are offline it's possible for the request to eventually fail and throw (but we are not really handling this case anywhere yet AFAIK).

@marcaaron marcaaron mentioned this pull request Apr 19, 2022
89 tasks
</View>
<View>
<FormAlertWithSubmitButton
buttonText={buttonText}
Copy link
Contributor

@marcochavezf marcochavezf Apr 19, 2022

Choose a reason for hiding this comment

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

NAB: the console log is throwing a warning message saying that onFixTheErrorsLinkPressed property is required. I think we could add something like onFixTheErrorsLinkPressed={() => {}} here :)

Screen Shot 2022-04-19 at 11 23 51

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice catch! It's a blocker for me so I'll fix it.

marcochavezf
marcochavezf previously approved these changes Apr 19, 2022
Copy link
Contributor

@marcochavezf marcochavezf left a comment

Choose a reason for hiding this comment

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

LGTM

@marcaaron marcaaron merged commit b8cbc1b into main Apr 20, 2022
@marcaaron marcaaron deleted the marcaaron-fixSetPasswordLogic branch April 20, 2022 20:00
@melvin-bot
Copy link

melvin-bot bot commented Apr 20, 2022

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by @marcaaron in version: 1.1.57-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @chiragsalian in version: 1.1.57-17 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants