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 selection list focus #34196

Merged
merged 21 commits into from
Feb 15, 2024

Conversation

abzokhattab
Copy link
Contributor

@abzokhattab abzokhattab commented Jan 9, 2024

Details

Fixed Issues

$ #29080
PROPOSAL: #29080 (comment)

Tests

  • Verify that no errors appear in the JS console

  • Acceptance criteria

  1. If there are selected items and the text input changes, focus on the first item.
  2. When the text input is cleared/empty, remove focus completely

Test:

  1. Open the app
  2. Open settings->profile->timezone
  3. Select any timezone from the visible timezones when scrolled to the top eg: type as and selectAfrica/Asmara
  4. Search any term in search (eg: tr) and observe that focus is changed to the first value as it normally does for all other similar UI

Besides the previous test, all other tests should abide the previous requirements criteria

  • Profile -> Pronouns
  • Workspace -> Members
  • Workspace -> Members -> Invite
  • Workspace -> Settings -> currency

Offline tests

  • Acceptance criteria
  1. If there are selected items and the text input changes, focus on the first item.
  2. When the text input is cleared/empty, remove focus completely

Test:

  1. Open the app
  2. Open settings->profile->timezone
  3. Select any timezone from the visible timezones when scrolled to the top eg: type as and selectAfrica/Asmara
  4. Search any term in search (eg: tr) and observe that focus is changed to the first value as it normally does for all other similar UI

Besides the previous test, all other tests should abide the previous requirements criteria

  • Profile -> Pronouns
  • Workspace -> Members
  • Workspace -> Members -> Invite
  • Workspace -> Settings -> currency

QA Steps

  • Verify that no errors appear in the JS console

  • Acceptance criteria

  1. If there are selected items and the text input changes, focus on the first item.
  2. When the text input is cleared/empty, remove focus completely

Test:

  1. Open the app
  2. Open settings->profile->timezone
  3. Select any timezone from the visible timezones when scrolled to the top eg: type as and selectAfrica/Asmara
  4. Search any term in search (eg: tr) and observe that focus is changed to the first value as it normally does for all other similar UI

Besides the previous test, all other tests should abide the previous requirements criteria

  • Profile -> Pronouns
  • Workspace -> Members
  • Workspace -> Members -> Invite
  • Workspace -> Settings -> currency

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

Android: Native
Untitled2.mov
Android: mWeb Chrome
Screen.Recording.2023-10-26.at.2.41.17.PM.mov
iOS: Native
Screen.Recording.2023-10-26.at.4.06.31.PM.mov
iOS: mWeb Safari
Untitled.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-10.at.12.51.43.AM.mov
Screen.Recording.2024-01-10.at.12.37.04.AM.mov
MacOS: Desktop
Screen.Recording.2024-01-10.at.12.53.31.AM.mov
Screen.Recording.2024-01-10.at.12.54.13.AM.mov

@abzokhattab abzokhattab requested a review from a team as a code owner January 9, 2024 22:46
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team January 9, 2024 22:46
Copy link

melvin-bot bot commented Jan 9, 2024

@fedirjh Please 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]

@abzokhattab
Copy link
Contributor Author

@fedirjh i added the sorting function .. let me know if you think any regression could occur here.

@fedirjh
Copy link
Contributor

fedirjh commented Jan 14, 2024

@abzokhattab Could you please merge main? I couldn't test on android.

@abzokhattab
Copy link
Contributor Author

@fedirjh done

@fedirjh
Copy link
Contributor

fedirjh commented Jan 16, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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

Android: Native
CleanShot.2024-01-16.at.21.02.06.mp4
Android: mWeb Chrome
CleanShot.2024-01-16.at.17.43.46.mp4
iOS: Native
CleanShot.2024-01-16.at.15.57.35.mp4
CleanShot.2024-01-16.at.16.13.32.mp4
iOS: mWeb Safari
CleanShot.2024-01-24.at.06.26.12.mp4
MacOS: Chrome / Safari
CleanShot.2024-01-15.at.12.12.41.mp4
MacOS: Desktop
CleanShot.2024-01-17.at.16.16.40.mp4

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Jan 17, 2024

i have migrated the new changes to typescript as the file on main was changed to ts.

please check this comment and let me know if we should cover the selection focus as well #29080 (comment)

@abzokhattab
Copy link
Contributor Author

the typescript migration was reverted :D so i merged from main again.

@fedirjh
Copy link
Contributor

fedirjh commented Jan 24, 2024

@abzokhattab I checked your comment, and it seems that the issue with android was fixed. However, I got this bug on web; when you use the keyboard navigation arrow keys to navigate between the list items, as seen in the video, the last item can't be selected, I think this is due to the sorting method; can we move the sorting to flattenedSections ?

CleanShot.2024-01-24.at.07.09.21.mp4

@fedirjh
Copy link
Contributor

fedirjh commented Jan 25, 2024

cc @abzokhattab Could you please merge main? Can we please move this forward ?

@abzokhattab
Copy link
Contributor Author

okay working on it now

@abzokhattab
Copy link
Contributor Author

bump @fedirjh

@fedirjh
Copy link
Contributor

fedirjh commented Jan 31, 2024

@abzokhattab Let's resolve conflicts. Let's remove/update and make sure that the other bug is fixed as well.

@abzokhattab
Copy link
Contributor Author

@abzokhattab Let's resolve conflicts. Let's remove/update and make sure that the other bug is fixed as well.

the PR i mentioned was reverted here so we can discard the last comment.

@abzokhattab
Copy link
Contributor Author

thanks @fedirjh, all threads are now resolved. let me know if you have any other comment

@fedirjh
Copy link
Contributor

fedirjh commented Feb 6, 2024

@abzokhattab Could you please also update the testing steps to reflect the correct behaviour? Thank you.

@abzokhattab
Copy link
Contributor Author

done

@abzokhattab
Copy link
Contributor Author

is there any other comments @fedirjh ?

@fedirjh
Copy link
Contributor

fedirjh commented Feb 12, 2024

@abzokhattab Could you please merge main?

@abzokhattab
Copy link
Contributor Author

done

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.

Co-authored-by: Monil Bhavsar <monilbhavsar25@gmail.com>
Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Thanks!

@MonilBhavsar MonilBhavsar merged commit abe77e9 into Expensify:main Feb 15, 2024
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/MonilBhavsar in version: 1.4.42-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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.

6 participants