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

fix/14954: "Email" title is displayed on the detail page instead of "Phone number" after creating a chat with an invalid number #15122

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Feb 14, 2023

Details

When the user type in the phone number on the new chat search, the isValidPhone filter is using the original text that was typed in. However, the isSMSLogin condition that was used to select "Email" or "Phone number" label is using the phone number with added country code. This inconsistency is the root cause of the issue

Fixed Issues

$ #14954
$ #14954 (comment)

Tests

  1. Click on :green-plus-button: > New chat
  2. Enter an invalid phone number and press enter key
  3. Verify that there are no options displayed
  4. Enter a valid phone number and press enter key
  5. Verify that the contact title in the detail page should be "Phone number"
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Click on :green-plus-button: > New chat
  2. Enter an invalid phone number and press enter key
  3. Verify that there are no options displayed
  4. Enter a valid phone number and press enter key
  5. Verify that the contact title in the detail page should be "Phone number"
  • 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 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 correct English and 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
    • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web1.mp4
Mobile Web - Chrome
329848214_5873611802745971_4442965487294022836_n.mp4
Mobile Web - Safari
Screen.Recording.2023-02-14.at.12.07.13.mp4
Desktop
Screen.Recording.2023-02-14.at.12.14.18.mp4
iOS
Screen.Recording.2023-02-14.at.12.23.32.mp4
Android
Screen.Recording.2023-02-14.at.12.54.17.mp4

@tienifr tienifr marked this pull request as ready for review February 14, 2023 05:39
@tienifr tienifr requested a review from a team as a code owner February 14, 2023 05:39
@melvin-bot melvin-bot bot requested review from cead22 and mananjadhav and removed request for a team February 14, 2023 05:39
@MelvinBot
Copy link

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

@mananjadhav
Copy link
Collaborator

I've reviewed the PR. I'll test on all platforms tonight.

@cead22
Copy link
Contributor

cead22 commented Feb 15, 2023

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

Can you share how this was done? Does your test cover all the flows that call getOptions? If not, can you test them all please?

@tienifr
Copy link
Contributor Author

tienifr commented Feb 16, 2023

@cead22 the getOptions function is being used in 3 places: getSearchOptions in SearchPage, getNewChatOptions in NewChatPage, getMemberInviteOptions in WorkspaceInvitePage. I just tested and saw that it works correctly in all places

@mananjadhav
Copy link
Collaborator

@robertjchen I was wondering if we could get the regression test suite from the QA team here so that we can ensure we cover everything? I am a bit concerned as getOptions is used at multiple places and moving the code shouldn't impact any other search operation?

@tienifr Are you fine that we run the regression test suite to ensure things are working as expected for other areas.

@tienifr
Copy link
Contributor Author

tienifr commented Feb 16, 2023

I agree with @mananjadhav that we should run the regression test period to ensure that it works correctly in all places. However, I think we should do it in the regression test period after this PR is merged, since we've already had a QA process there before deploying to production

I also test all places that I mentioned here
and this is the result:

Screen.Recording.2023-02-16.at.14.53.54.mp4

cc @cead22

@robertjchen
Copy link
Contributor

@mananjadhav Thanks for pointing this out- additional testing with such refactors are always good!

However, I'm not 100% familiar with the regression test suite from the QA team? My understanding is the same as @tienifr , where the usual QA process also includes a regression test. Is there an example where we've employed more in-depth regression testing for other PRs- would love to know about this myself 🙏

@mananjadhav
Copy link
Collaborator

@robertjchen We had done that here. @roryabraham Had shared the list of test rail cases maintained internally for the component my PR was touching and then we tested each test rail case. I hope this helps.

@robertjchen
Copy link
Contributor

Got it- agreed that it would be great! I might have to defer to @roryabraham on the process behind employing the same testing here, as I'm not sure if this involves granting access or finding QA resources.

@cead22
Copy link
Contributor

cead22 commented Feb 16, 2023

These are the tests I see we have for the chat switcher

image

And here are the steps for each

image

image

image

image

image

image

@cead22
Copy link
Contributor

cead22 commented Feb 16, 2023

Code looks good. @mananjadhav please fill out the reviewer checklist when you get a chance

@mananjadhav
Copy link
Collaborator

Thanks @cead22. Testing this out. @tienifr Can you also test the given regression suite?

@tienifr
Copy link
Contributor Author

tienifr commented Feb 17, 2023

  1. Chat switcher
Screen.Recording.2023-02-17.at.16.06.26.1.mp4
  1. New chat/New group search
Screen.Recording.2023-02-17.at.16.29.20.mp4
  1. Request/Send/Split bill
Screen.Recording.2023-02-17.at.16.30.45.mp4
  1. Arrow navigation
Screen.Recording.2023-02-17.at.16.38.12.1.mp4
  1. Navigate to Concierge link
Screen.Recording.2023-02-17.at.16.49.27.mp4
  1. Navigate to IOU link
Screen.Recording.2023-02-17.at.16.59.38.mp4

@tienifr
Copy link
Contributor Author

tienifr commented Feb 17, 2023

@mananjadhav Can u help review my tests? Thanks

@mananjadhav
Copy link
Collaborator

mananjadhav commented Feb 17, 2023

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 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 correct English and 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 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.

Screenshots/Videos

Web
web-email-title-correct.mov
Mobile Web - Chrome
mweb-chrome-email-title-correct.mov
Mobile Web - Safari
mweb-safari-email-title-correct.mov
Desktop
desktop-email-title-correct.mov
iOS
ios-email-title-correct.mov
Android
android-email-title-correct.mov

Thanks for the patience here @tienifr. Took a bit longer to test. I also had a app crash unrelated to the PR. @cead22 All yours.

@cead22
Copy link
Contributor

cead22 commented Feb 17, 2023

Thanks! @mananjadhav your desktop video doesn't show the full test, so I created a new one

Oh0dYbh3YV.mp4

@cead22 cead22 merged commit 7805b90 into Expensify:main Feb 17, 2023
@mananjadhav
Copy link
Collaborator

thanks for the help here @cead22. Looks like I stopped capturing early.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cead22 in version: 1.2.75-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/melvin-bot[bot] in version: 1.2.75-0 🚀

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

@deetergp
Copy link
Contributor

Just a heads up that the code to append country codes should also have been applied go Loginutils.getHeaderMessage. Not doing so led to this issue being created.

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.

7 participants