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

Replace OptionsSelector with SelectionList - part 1 #38994

Conversation

filip-solecki
Copy link
Contributor

@filip-solecki filip-solecki commented Mar 26, 2024

Details

First part of migration OptionsSelector to SelectionList covers 4 pages. Remaining 3 will be covered in separate PR and OptionsSelector will be removed there as well.

Fixed Issues

$ #25125
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

BaseShareLogList:

  1. Log in to the app
  2. Go to Profile -> About -> Troubleshoot
  3. Enable Client side logging if disabled
  4. Click „View debug console”
  5. Click „Share log”
  6. Test all list’s functionalities

WorkspaceSwitcherPage

  1. Log in to the app
  2. Go to Home Page
  3. Click Logo in the left top corner
  4. Test all Workspace Switcher functionalities

TagPicker

  1. Log in to the app
  2. Click FAB icon
  3. Select Money Request
  4. Select an amount and go Next
  5. Select a Workspace as a user where to Request money and click Next
  6. Click on Show more
  7. Select Tag
  8. Search for a tag
  9. Verify that Search is working
  10. Select a Tag
  11. Verify that page is working properly and you can request a money

EditReportFieldDropdownPage

  1. Log in to the app
  2. On a Paid workspace, in Old dot, set report field of Dropdown type.
  3. Open ND and create an expense report on the above workspace.
  4. Open the expense report and make sure that canUseReportFields beta is enabled.
  5. Verify that created custom field show up.
  6. Click on it and test if everything works fine
  7. Make sure that the field gets saved successfully.
  8. Verify that selecting an already selected dropdown option again deselects it.

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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

WorkspaceSwitcher

Android: Native
WorkspaceSwitcher_ANDROID.mov
Android: mWeb Chrome
WorkspaceSwitcher_AND_CHROME.mov
iOS: Native
WorkspaceSwitcher_IOS.mp4
iOS: mWeb Safari
WorkspaceSwitcher_IOS_SAFARI.mp4
MacOS: Chrome / Safari
Workspace_Switcher_WEB.mov
MacOS: Desktop
WorkspaceSwithcer_DESKTOP.mov

ShareLog

Android: Native
ShareLog_ANDROID.mov
Android: mWeb Chrome
ShareLog_AND_CHROME.mov
iOS: Native
ShareLog_IOS.mp4
iOS: mWeb Safari
ShareLog_IOS_SAFARI.mp4
MacOS: Chrome / Safari
Share_log_WEB.mov
MacOS: Desktop
ShareLog_DESKTOP.mov

TagPicker

Android: Native
TagPicker_ANDROID.mov
Android: mWeb Chrome
TagPicker_AND_CHROME.mov
iOS: Native
TagPicker_IOS.mp4
iOS: mWeb Safari
TagPicker_IOS_SAFARI.mp4
MacOS: Chrome / Safari
TagPicker_WEB.mov
MacOS: Desktop
TagPicker_DESKTOP.mov

EditReportFieldDropdownPage

Android: Native
Dropdown_ANDROID.mov
Android: mWeb Chrome
Dropdown_AND_CHROME.mov
iOS: Native
Dropdown_IOS.mp4
iOS: mWeb Safari
Dropdown_IOS_SAFARI.mp4
MacOS: Chrome / Safari
EditReportFieldDropdownPage_WEB.mov
MacOS: Desktop
Dropdown_DESKTOP.mov
EDIT Added `isSelected` mark in `EditReportFieldDropdownPage`, as on the screenshot below:

Simulator Screenshot - iPhone 15 Plus - 2024-03-27 at 12 02 57

Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

Code looks good! We have to test these components thoroughly. Thanks for the extensive QA steps 🙌

src/components/SelectionList/BaseListItem.tsx Outdated Show resolved Hide resolved
src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved
@filip-solecki filip-solecki changed the title Replace OptionsSelector with SelectionList Replace OptionsSelector with SelectionList - part 1 Mar 27, 2024
@filip-solecki filip-solecki marked this pull request as ready for review March 27, 2024 11:13
@filip-solecki filip-solecki requested a review from a team as a code owner March 27, 2024 11:13
@melvin-bot melvin-bot bot removed the request for review from a team March 27, 2024 11:13
Copy link

melvin-bot bot commented Mar 27, 2024

@Santhosh-Sellavel 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]

@melvin-bot melvin-bot bot requested a review from Santhosh-Sellavel March 27, 2024 11:13
@filip-solecki
Copy link
Contributor Author

@Santhosh-Sellavel kind bump here :)

@s77rt
Copy link
Contributor

s77rt commented Mar 29, 2024

Taking this as C+ from @Santhosh-Sellavel. I will review

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

Partial review

src/components/SelectionList/BaseListItem.tsx Outdated Show resolved Hide resolved
src/pages/WorkspaceSwitcherPage.tsx Outdated Show resolved Hide resolved
src/pages/WorkspaceSwitcherPage.tsx Outdated Show resolved Hide resolved
src/pages/WorkspaceSwitcherPage.tsx Outdated Show resolved Hide resolved
src/components/SelectionList/BaseSelectionList.tsx Outdated Show resolved Hide resolved
@s77rt
Copy link
Contributor

s77rt commented Mar 30, 2024

On report dropdown the selected item should be highlighted

Screenshot 2024-03-29 at 11 15 17 PM

@s77rt
Copy link
Contributor

s77rt commented Mar 30, 2024

On report dropdown after pressing the arrow button many items are highlighted

Screenshot 2024-03-29 at 11 15 22 PM

@s77rt
Copy link
Contributor

s77rt commented Mar 31, 2024

On report dropdown searching for a selected option should appear as selected

Screen.Recording.2024-03-31.at.2.44.04.AM.mov

@s77rt
Copy link
Contributor

s77rt commented Mar 31, 2024

Group tooltips not showing everyone's tooltip
PR:
Screenshot 2024-03-31 at 8 31 53 PM

Staging:
Screenshot 2024-03-31 at 8 32 05 PM

@s77rt
Copy link
Contributor

s77rt commented Mar 31, 2024

If isLoadingNewOptions is true then we should not show the not found message (similar to OptionsSelector)
Screenshot 2024-03-31 at 8 41 25 PM

src/libs/OptionsListUtils.ts Outdated Show resolved Hide resolved
// @ts-expect-error TODO: remove this comment once OptionsSelector (https://github.com/Expensify/App/issues/25125) is migrated to TS
placeholder={translate('workspace.switcher.placeholder')}
ref={inputCallbackRef}
<SelectionList
Copy link
Contributor

Choose a reason for hiding this comment

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

There is still a everythingSection that is using OptionRow. Can we move it to the passed sections in SelectionList

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, it needs a huge refactor of the whole page, not sure if this is the right issue to do it. Btw. OptionRow is also used in some other components and I don't know of we want to remove it with OptionsSelector

src/components/SelectionList/types.ts Outdated Show resolved Hide resolved
src/components/SelectionList/types.ts Outdated Show resolved Hide resolved
@filip-solecki
Copy link
Contributor Author

On report dropdown the selected item should be highlighted

Screenshot 2024-03-29 at 11 15 17 PM

This behvior is consistent with staging, but I can change it if we want to

@filip-solecki
Copy link
Contributor Author

On report dropdown after pressing the arrow button many items are highlighted

Screenshot 2024-03-29 at 11 15 22 PM

This is global SelectionList issue, not sure if it should be covered by this PR

@filip-solecki
Copy link
Contributor Author

Group tooltips not showing everyone's tooltip PR: Screenshot 2024-03-31 at 8 31 53 PM

Staging: Screenshot 2024-03-31 at 8 32 05 PM

Is it supported somewhere in SelectionList? I can't find any place, so maybe it should be done as a follow-up to extend SelectionList possibilities

@filip-solecki
Copy link
Contributor Author

@s77rt All done! Left one thought

@filip-solecki
Copy link
Contributor Author

@s77rt Ready for re-review!

@s77rt
Copy link
Contributor

s77rt commented Apr 4, 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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 android
Android: mWeb Chrome mweb-chrome
iOS: Native ios
iOS: mWeb Safari mweb-safari
MacOS: Chrome / Safari web
MacOS: Desktop desktop

Copy link

melvin-bot bot commented Apr 4, 2024

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25125 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot bot requested a review from danieldoglas April 4, 2024 19:47
Copy link
Contributor

@danieldoglas danieldoglas left a comment

Choose a reason for hiding this comment

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

Lots of changes going on on this PR. I would recommend we do 1 page per PR next time. Thanks @s77rt for the tests.

@danieldoglas danieldoglas merged commit 707b8cd into Expensify:main Apr 5, 2024
17 of 18 checks passed
@danieldoglas
Copy link
Contributor

danieldoglas commented Apr 5, 2024

I think this PR introduced this error. It happens both on Share logs and when you click on the workspace switcher.
#39696 (review)

@danieldoglas
Copy link
Contributor

I'm reverting this PR so we can fix the error log that is happening before we merge it again. I recommend we do it step by step this time.

We've checked the [] Verify that no errors appear in the JS console item in the check list, but it was actually logging new errors.

@@ -81,6 +81,14 @@ function BaseListItem<TItem extends ListItem>({
</View>
</View>
)}
{!item.isSelected && item.brickRoadIndicator && (
Copy link
Contributor

Choose a reason for hiding this comment

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

                    {!item.isSelected && !!item.brickRoadIndicator && (


{/* If we are loading new options we will avoid showing any header message. This is mostly because one of the header messages says there are no options. */}
{/* This is misleading because we might be in the process of loading fresh options from the server. */}
{!isLoadingNewOptions && headerMessage && (
Copy link
Contributor

Choose a reason for hiding this comment

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

                        {!isLoadingNewOptions && !!headerMessage && (

Copy link
Contributor

@Ollyws Ollyws Jun 13, 2024

Choose a reason for hiding this comment

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

Adding !isLoadingNewOptions here caused infinite loading when it should have been displaying the user is already a member of workspace message (#42219) we fixed this in #42569

@s77rt
Copy link
Contributor

s77rt commented Apr 5, 2024

@danieldoglas Sorry I missed that. I added required change. cc @filip-solecki

@s77rt
Copy link
Contributor

s77rt commented Apr 5, 2024

As for the duplicated variable I don't think we could have prevented that as it's a post-merge error

@filip-solecki
Copy link
Contributor Author

I've prepared draft PR with fix, not sure if we should prepare these pages as separated PRs right now, we can do it with the rest of pages I think. I am checking new branch on all devices, I'll let you know @s77rt when it is ready for you!

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.61-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.4.61-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.61-8 🚀

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