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

[23543] Multi words zones now work while searching for timezones. #25569

Merged
merged 8 commits into from
Aug 29, 2023
Merged

[23543] Multi words zones now work while searching for timezones. #25569

merged 8 commits into from
Aug 29, 2023

Conversation

DanutGavrus
Copy link
Contributor

@DanutGavrus DanutGavrus commented Aug 21, 2023

Details

Improved search functionality on the select timezone page.

Fixed Issues

$ #23543
PROPOSAL: #23543 (comment)

Tests

Same as QA Steps.

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps.

QA Steps

  1. Go to Settings -> Profile -> Timezone;
  2. Uncheck the "Automatically determine your location." checkbox;
  3. Click on "Timezone";
  4. Input a multi word zone such as "New York", "Isle of Man", "East Indiana" in the search text;
  5. Verify that the correct result appears.
  • 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
timezone_search.mp4
Mobile Web - Chrome
android_chrome.mp4
Mobile Web - Safari
Desktop
iOS
Android
android_native.mp4

@DanutGavrus DanutGavrus requested a review from a team as a code owner August 21, 2023 09:59
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team August 21, 2023 09:59
@DanutGavrus
Copy link
Contributor Author

I need to add Screenshots/Videos, but I firstly wanted to agree on the desired functionality. This version works as follows:

  1. "Europe/Isle_of_Man":
    1.1. Works with: "Isle of Man", "Isl o M", "Eur Isl", "man of isle", " Isle Man ", "Europe/Isl", "Eur/Isl", "Isle_of", "Isle_of man";
    1.2. Does not work with: "IsleOfMan".

  2. "Asia/Calcutta"
    2.1. Works with: "cal".

  3. "US/East-Indiana"
    3.1. Works with: "US East", "East I"(shown at the end), "East In"(shown first now), "East-I".

  4. "GMT+0"
    4.1. Works with: "gmt", "GMT", "GMT+", "gmt 0";
    4.2. Does not work with: "gmt0".

The only downsides for now are that "IsleOfMan" dows not work, and that "East I" shows "US/East-Indiana" at the end of the list. I've tried some changes, but I seem to lose some other functionality by fixing these.

@fedirjh Would you say that it's ok as is, or would you want me to make some changes? If so, please tell me what changes. I'll come back with a potential fix & a list of any new downside. Thank you!

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Left a few comments about the code.

The only downsides for now are that "IsleOfMan" dows not work, and that "East I" shows "US/East-Indiana" at the end of the list. I've tried some changes, but I seem to lose some other functionality by fixing these.

@DanutGavrus Let's use the same regex in the linked proposal, I left a suggestion about normalizing the searchText and I think that will resolve those issues, just let's make sure to use the right regex .replace(/[^a-z0-9\+\-\/]/g, '') for the timezone names.

setTimezoneOptions(_.filter(allTimezones.current, (tz) => tz.text.toLowerCase().includes(searchText.trim().toLowerCase())));
setTimezoneOptions(_.filter(allTimezones.current, (tz) => {
let shouldShow = true;
searchText.toLowerCase().replace(/[^a-z0-9]/g, ' ').split(' ').forEach((word) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can sanitize the searchText before checking :

const searchWords = searchText.toLowerCase().replace(/[^a-z0-9\+\-\s+/]/g, '').split(/\s+/);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we keep the current regex, this won't be needed, otherwise, I'll update as suggested.

Comment on lines 68 to 70
if (tz.text.toLowerCase().replace(/[^a-z0-9]/g, ' ').indexOf(word) < 0) shouldShow = false;
})
return shouldShow;
Copy link
Contributor

Choose a reason for hiding this comment

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

We have a lint here.

Can't we use Array.prototype.every() instead of .forEach, I think this will simplify the code and make it more readable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Run npm run prettier, fixed several lint issues & used Array.prototype.every() instead of .forEach.

@DanutGavrus
Copy link
Contributor Author

DanutGavrus commented Aug 22, 2023

@fedirjh Based on the review comments, I think this will be the new regex(not the final code, just quickly testing the regex):

const searchWords = searchText.toLowerCase().replace(/[^a-z0-9\+\-\s+/]/g, '').split(/\s+/);
searchWords.forEach((word) => {
    if (tz.text.toLowerCase().replace(/[^a-z0-9\+\-\/]/g, '').indexOf(word) < 0) shouldShow = false;
})
.replace(/[^a-z0-9]/g, ' ') .replace(/[^a-z0-9\+\-\/]/g, '')
Europe/Isle_of_Man: Europe/Isle_of_Man:
"Eur/Isl" na
na "IsleOfMan"
Europe/San_Marino: Europe/San_Marino:
"San M"(shows result at the end of the list) "San M"(shows result at the end of the list)

If my comparison is right, we gain "IsleOfMan" for "Eur/Isl", and "the result is shown at the end of the list for some searches issue" persists. I think the last issue is not very big, inserting 1 more letter eventually shows the result at the top. What would you say?

@DanutGavrus
Copy link
Contributor Author

@fedirjh Isn't this regex:

const searchWords = searchText.toLowerCase().replace(/[^a-z0-9]/g, ' ').split(' ');
searchWords.forEach((word) => {
    if (tz.text.toLowerCase().replace(/[^a-z0-9]/g, ' ').indexOf(word) < 0) shouldShow = false;
})

Simpler, more future proof, and with almost the same functionality?

We don't exactly specify the special characters(+, -, /) here, maybe some new ones will appear in the future. Only diff in functionality is that "IsleOfMan" does not work and "Eur/Isl" does. Personally, I think I'd prefer this, but let me know which one you want to keep & I'll make a new commit. Thanks!

@DanutGavrus
Copy link
Contributor Author

@fedirjh Added Web recording for easier understanding of the current changes.

@fedirjh
Copy link
Contributor

fedirjh commented Aug 24, 2023

Hey @DanutGavrus, it appears that we've made updates to the Timezone list in this PR #24446. Some timezones, such as GMT +1 and GMT -1, were excluded from the new list. Considering this, I think it is safe to use the regex /[^a-z0-9]/g for filtering.

more future proof

I don't strongly agree with that. If we were to update the timezone list in the future to include timezones like GMT +/-, this regex would also need to be updated accordingly.

@DanutGavrus
Copy link
Contributor Author

@fedirjh Yes, that PR kind of simplified the timezones list.

If we were to update the timezone list in the future to include timezones like GMT +/-, this regex would also need to be updated accordingly.

It will still show the GMT -1 in the results, but it won't be the first option. When searching for "gmt -1", users will see:

GMT +1
GMT -1
GMT 1

If the priority issue is to be resolved, I do agree with you, it's not future proof enough. It will be capable to show the results, but will have small problems in prioritizing them, especially for those with special characters. Same is happening in the present, but it's simply resolved by entering one more letter, as seen now for "San M"(shown at the end) vs "San Ma"(shown at the top as it's the only result). This, IMO, can be considered intended.

Copy link
Contributor

@fedirjh fedirjh 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, left small improvement

Comment on lines 68 to 71
searchText
.toLowerCase()
.replace(/[^a-z0-9]/g, ' ')
.split(' '),
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
searchText
.toLowerCase()
.replace(/[^a-z0-9]/g, ' ')
.split(' '),
searchText.toLowerCase().match(/[a-z0-9]+/g) || []

This can be simplified, Can we move to a local const to avoid repeating the same normalization process multiple times within the filter loop?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yees, of course! Hope I got it right.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, It is still included in the filter loop, and should be moved outside the loop.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤦 Sorry about that... Should be ok now

@fedirjh
Copy link
Contributor

fedirjh commented Aug 24, 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 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 Screenshot 2023-08-24 at 10 49 21 AM
Mobile Web - Chrome Screenshot 2023-08-24 at 11 16 25 AM
Mobile Web - Safari Screenshot 2023-08-24 at 10 51 31 AM
Desktop Screenshot 2023-08-24 at 10 52 31 AM
iOS Screenshot 2023-08-24 at 11 05 37 AM
Android Screenshot 2023-08-24 at 11 28 04 AM

Copy link
Contributor

@fedirjh fedirjh 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 and tests well.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from bondydaa August 24, 2023 10:42
@bondydaa bondydaa merged commit ff5f960 into Expensify:main Aug 29, 2023
14 of 15 checks passed
@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 https://github.com/bondydaa in version: 1.3.59-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.60-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.60-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.60-3 🚀

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