Allow searching for phone numbers with parenthesis, spaces and dashes in them #15594

narefyev91 · 2023-03-01T15:40:04Z

Details

The main issue here that search mechanism is not understand formatted phones. We need to catch when user typing/inserting phone number and prepare it in correct format to make searching mechanism working fine

We will use already existing regExp - which working fine and covers all our needs from CONST folder.
Also to make it working in any other places we need to apply changes for getOptions function instead of fixing this issue around different places.
getOptions function has more that 41 variable with name searchValue inside itself - and to make less changes in the whole function i suggest to rename prop from searchValue to searchInputValue and inside getOptions define a variable searchValue and assign formatted value if needed. Also to not break existing functionality (like this one

 const login = (Str.isValidPhone(searchValue) && !searchValue.includes('+'))
        ? `+${countryCodeByIP}${searchValue}`
        : searchValue;

we will remove any characters which are not numbers but will allow to have +

Fixed Issues

$ #15491
$ #15491 (comment)

Tests

Open search
Type phone/paste phone number in this formats (xxx) xxx-xxxx / (xxx)xxx-xxxx / +x(xxx)xxx-xxxx / +x (xxx) xxx-xxxx
Verify that search return correct result

Verify that no errors appear in the JS console

Offline tests

This feature doesn't change or is impacted by offline mode.

QA Steps

Same as above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

android-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

… in them

MelvinBot · 2023-03-01T15:40:12Z

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

puneetlath · 2023-03-01T16:05:51Z

I think it's close but not quite there.

It accepts (972)658-5619

But not +1(972)658-5619

And not +1 (972) 658-5619

It should accept all of those.

narefyev91 · 2023-03-01T16:22:26Z

@puneetlath done

src/CONST.js

puneetlath · 2023-03-02T02:05:59Z

@sobitneupane can you please give this a review and run it through the reviewer checklist? Thanks!

sobitneupane · 2023-03-02T12:32:04Z

@puneetlath What are the formats to be accepted? I have list few based on above discussions:

(972)658-5619
+1(972)658-5619
+1 (972) 658-5619

Other countries might have different formats. Should we allow special characters ( , ) - and space in all positions?

puneetlath · 2023-03-02T16:28:57Z

Good question. I think definitely those three that you listed. Are there known phone number formats that this doesn't support?

sobitneupane · 2023-03-02T17:03:08Z

@puneetlath

I have done some internet surfing. I am not sure how much it makes sense in real world.

Source: https://blog.insycle.com/phone-number-formatting-crm

001-212-456-7890
191-212-456-7890

Source: https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers

France: +49 AAAA BBBBBB
NewZeland: +64-MM-BBB-BBBB
India +91-AAAAA BBBBB

These are few. Each country has different format.

narefyev91 · 2023-03-02T17:06:57Z

@sobitneupane @puneetlath im my view it will be overkill if we will try to write function to identify phone number around the world

puneetlath · 2023-03-02T17:31:46Z

Yeah maybe in the future it would be good to check the formatting based on the country code being used. But for now I think this is a good starting point.

puneetlath

Mostly looks good to me. Just one comment.

src/CONST.js

puneetlath

Ok sweet. Looks good to me. @sobitneupane over to you!

sobitneupane

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

sobitneupane · 2023-03-02T18:31:10Z

Video Comparison with and without special characters

Without Special characters	With Special Characters
Screen.Recording.2023-03-03.at.00.02.45.mov	Screen.Recording.2023-03-03.at.00.00.47.mov

With Special Characters, contact is shown only after whole input is entered.

cc: @puneetlath

sobitneupane

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.

sobitneupane · 2023-03-02T18:37:24Z

@narefyev91 Can you please add other formats to be tested on Tests section in PR body?

narefyev91 · 2023-03-03T07:21:12Z

@narefyev91 Can you please add other formats to be tested on Tests section in PR body?

Added

puneetlath · 2023-03-06T16:36:39Z

With Special Characters, contact is shown only after whole input is entered.

I think that's ok since it's not really a valid phone number until that point anyways.

OSBotify · 2023-03-06T16:42:35Z

✋ 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-03-07T18:12:03Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.2.80-0 🚀

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

OSBotify · 2023-03-09T03:33:10Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.2.80-2 🚀

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

narefyev91 added 2 commits March 1, 2023 16:56

Allow searching for phone numbers with parenthesis, spaces and dashes…

a94568b

… in them

migrate to global solution

70b1d52

narefyev91 requested a review from a team as a code owner March 1, 2023 15:40

melvin-bot bot requested review from puneetlath and sobitneupane and removed request for a team March 1, 2023 15:40

change reg exp

67ea1a5

puneetlath reviewed Mar 1, 2023

View reviewed changes

src/CONST.js Outdated Show resolved Hide resolved

narefyev91 requested review from puneetlath and removed request for sobitneupane March 2, 2023 12:05

puneetlath requested a review from sobitneupane March 2, 2023 16:29

puneetlath requested changes Mar 2, 2023

View reviewed changes

src/CONST.js Outdated Show resolved Hide resolved

src/CONST.js Outdated Show resolved Hide resolved

remove unused regexp

33e17d0

puneetlath requested changes Mar 2, 2023

View reviewed changes

src/CONST.js Outdated Show resolved Hide resolved

change namings for regexp

8690bd7

puneetlath approved these changes Mar 2, 2023

View reviewed changes

sobitneupane reviewed Mar 2, 2023

View reviewed changes

sobitneupane approved these changes Mar 2, 2023

View reviewed changes

puneetlath merged commit ace7d0a into Expensify:main Mar 6, 2023

OSBotify mentioned this pull request Mar 7, 2023

Deploy Checklist: New Expensify 2023-03-07 #15717

Closed

18 tasks

MelvinBot mentioned this pull request Mar 9, 2023

[HOLD for payment 2023-03-16] Allow searching for phone numbers with parenthesis, spaces and dashes in them #15491

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow searching for phone numbers with parenthesis, spaces and dashes in them #15594

Allow searching for phone numbers with parenthesis, spaces and dashes in them #15594

narefyev91 commented Mar 1, 2023 •

edited

Loading

MelvinBot commented Mar 1, 2023

puneetlath commented Mar 1, 2023

narefyev91 commented Mar 1, 2023

puneetlath commented Mar 2, 2023

sobitneupane commented Mar 2, 2023 •

edited

Loading

puneetlath commented Mar 2, 2023

sobitneupane commented Mar 2, 2023

narefyev91 commented Mar 2, 2023

puneetlath commented Mar 2, 2023

puneetlath left a comment

puneetlath left a comment

sobitneupane left a comment

sobitneupane commented Mar 2, 2023

sobitneupane left a comment

sobitneupane commented Mar 2, 2023

narefyev91 commented Mar 3, 2023

puneetlath commented Mar 6, 2023

OSBotify commented Mar 6, 2023

OSBotify commented Mar 7, 2023

OSBotify commented Mar 9, 2023

Allow searching for phone numbers with parenthesis, spaces and dashes in them #15594

Allow searching for phone numbers with parenthesis, spaces and dashes in them #15594

Conversation

narefyev91 commented Mar 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 1, 2023

puneetlath commented Mar 1, 2023

narefyev91 commented Mar 1, 2023

puneetlath commented Mar 2, 2023

sobitneupane commented Mar 2, 2023 • edited Loading

puneetlath commented Mar 2, 2023

sobitneupane commented Mar 2, 2023

narefyev91 commented Mar 2, 2023

puneetlath commented Mar 2, 2023

puneetlath left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

sobitneupane left a comment

Choose a reason for hiding this comment

Screenshots/Videos

sobitneupane commented Mar 2, 2023

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

sobitneupane commented Mar 2, 2023

narefyev91 commented Mar 3, 2023

puneetlath commented Mar 6, 2023

OSBotify commented Mar 6, 2023

OSBotify commented Mar 7, 2023

OSBotify commented Mar 9, 2023

narefyev91 commented Mar 1, 2023 •

edited

Loading

sobitneupane commented Mar 2, 2023 •

edited

Loading