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

[WIP] Clean up BaseOptionsSelector #37353

Closed
wants to merge 25 commits into from

Conversation

roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Feb 27, 2024

Details

Lots of simplifications:

  • use useArrowKeyFocusManager hook instead of ArrowKeyFocusManager component, simplify lots of that code
  • Remove platform-specific code that breaks our style guide. Instead rely on useActiveElementRole and useAutoFocusInput
  • Remove duplicate KeyboardShortcut-handling code, consolidate on useKeyboardShortcut
  • Remove unnecessary state variables, along with functions to generate them and useEffects to manage them. Simplify this substantially using useMemo. This also should come with some performance benefits to eliminate unnecessary extra renders and data mapping.
  • Use usePrevious utility instead of ad-hoc version of the same thing with useRef+useEffect

Fixed Issues

$ #37335
$ #37294
$ #37267
$ #37256
$ #37239
$ #37238
$ #37346

Tests / QA steps

Retest the following issues:

Offline tests

QA Steps

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Verified #37256 is fixed:

web.mov
MacOS: Desktop

@roryabraham roryabraham self-assigned this Feb 27, 2024
@Pujan92
Copy link
Contributor

Pujan92 commented Feb 28, 2024

adjustedSectionIndex part is not required inside the scrollToIndex function, it is removed here for the wrong scrolling location. Reproducing that issue again here.

@roryabraham
Copy link
Contributor Author

Going to close this as we're reverting the PR that changed this from a class component to a functional component, and we'll let the contributor who did that integrate these changes in their second try, when we're not so rushed.

The main thing I'm aware of that's not working on this branch is the pagination functionality, but I'm not sure why.

@roryabraham roryabraham deleted the Rory-BaseOptionsSelectorImprovements branch February 28, 2024 21:39
@roryabraham roryabraham restored the Rory-BaseOptionsSelectorImprovements branch February 28, 2024 21:57
@roryabraham
Copy link
Contributor Author

Actually I'm going to reopen this without the intention of having it merged to reflect further comments on the code.

@roryabraham roryabraham reopened this Feb 28, 2024
@roryabraham roryabraham deleted the Rory-BaseOptionsSelectorImprovements branch February 28, 2024 22:16
@dragnoir
Copy link
Contributor

reverting the PR

Can you pls mention where this is happening? PR!!

@Piotrfj
Copy link
Contributor

Piotrfj commented Feb 29, 2024

Update: re-refactoring is ready to be tested, it fixes all the regression issues I was aware of. Please test it (especially the tags, because I could not yet replicate the scenario on my site).
The fix is based on the @roryabraham solution, so special thanks for him!
Link to PR: #37494

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