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: [Search v1] Search page scroll is not smooth #42170

Merged
merged 8 commits into from
May 27, 2024

Conversation

charles-liang
Copy link
Contributor

@charles-liang charles-liang commented May 14, 2024

@eh2077

Details

#41581 [$250] [Search v1] Search page scroll is not smooth

Fixed Issues

$ #41581 (comment)
PROPOSAL: #41581 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open the search page, Profile > Troubleshoot > New Search Page
  2. Scroll through the list of results
  3. Notice that the items flicker and on mobile the list jumps around
  • 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

Android: Native
untitled.webm
Android: mWeb Chrome
android.mov
iOS: Native
ios-native.mov
iOS: mWeb Safari
ios.mov
MacOS: Chrome / Safari
2024-05-14.01.13.09.2.mov
2024-05-14.01.13.46.mov
MacOS: Desktop
desktop.mov
desktop.mov

@charles-liang charles-liang requested a review from a team as a code owner May 14, 2024 20:16
@melvin-bot melvin-bot bot requested review from eh2077 and removed request for a team May 14, 2024 20:16
Copy link

melvin-bot bot commented May 14, 2024

@eh2077 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]

Copy link
Contributor

github-actions bot commented May 14, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@charles-liang
Copy link
Contributor Author

@eh2077
I compiled to Android native and iOS native, but I don't know how to switch the .env file.
I tried hardcoding isDeveloping to open the test menu, entered the Search Page, but couldn't load the data.
Can you tell me how I should test on these two platforms, or if it's not necessary to test right now?

@charles-liang
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@charles-liang
Copy link
Contributor Author

@bot

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

recheck

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

@eh2077 I compiled to Android native and iOS native, but I don't know how to switch the .env file. I tried hardcoding isDeveloping to open the test menu, entered the Search Page, but couldn't load the data. Can you tell me how I should test on these two platforms, or if it's not necessary to test right now?

@charles-liang Do you mean trying to open the search page on native Apps? If so, I think you can just follow the first reproduction step from the original issue

Open the search page, Profile > Troubleshoot > New Search Page

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

@charles-liang Can you handle the conflicts?

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

@charles-liang And don’t worry if CI workflows are not running automatically. It needs help from @luacmartins to trigger it because it's your first PR and it's a little bit special.

You can run lint, prettier and typecheck locally before pushing.

@charles-liang
Copy link
Contributor Author

charles-liang commented May 15, 2024

@eh2077 I compiled to Android native and iOS native, but I don't know how to switch the .env file. I tried hardcoding isDeveloping to open the test menu, entered the Search Page, but couldn't load the data. Can you tell me how I should test on these two platforms, or if it's not necessary to test right now?

@charles-liang Do you mean trying to open the search page on native Apps? If so, I think you can just follow the first reproduction step from the original issue

Open the search page, Profile > Troubleshoot > New Search Page

I mean i run it in iOS
And android native will use production env and cannot enter in search page because it only open in dev or staging
I don't know how to change it in the script.

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

I don't think it's necessary to edit .env file. Can you follow

to run native apps?

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

@charles-liang When opening a PR, please merge your branch to the main branch` as stated here

@eh2077
Copy link
Contributor

eh2077 commented May 15, 2024

I mean i run it in iOS And android native will use production env and cannot enter in search page because it only open in dev or staging I don't know how to change it in the script.

I think the issue you encountered here is because you're not working on the main branch which contains default settings of dev env.

@charles-liang charles-liang changed the base branch from staging to main May 15, 2024 16:09
@charles-liang
Copy link
Contributor Author

@eh2077 I have completed the iOS and Android native screenshots. The conflicts have also been resolved and merged into the main branch. Thank you for tutoring me.

Comment on lines +74 to +94
windowSize={111}
updateCellsBatchingPeriod={200}
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you explain the rationale for choosing these values?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The windowSize is set to 111 because each page can contain a maximum of 500 items, and this size is sufficiently large to ensure that the entire page will not be recycled.

The choice of 200 for updateCellsBatchingPeriod is because 200ms out of 1000ms allows it to be slightly larger, preventing continuous loading while not causing too much delay.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use different values for desktop and mobile devices? As their screens size are different

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Recycling of cells is only necessary in cases such as phones with low memory. I tested in iPhone 14 pro is very smooth and not need recycling.

why I set it to 111. This size ensures that in both portrait mode and landscape mode, is large enough not to be recycled.

Copy link
Contributor

Choose a reason for hiding this comment

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

can we leave a comment explaining that please?

src/components/SelectionList/TransactionListItem.tsx Outdated Show resolved Hide resolved
Comment on lines 361 to 366
rightHandSideComponent={
rightHandSideComponent &&
(typeof rightHandSideComponent === 'function'
? rightHandSideComponent({} as TItem) // Example usage of the function, replace with actual item
: rightHandSideComponent)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's from the original code, and then when the GitHub Action runs typecheck, it throws a type error.

@eh2077
Copy link
Contributor

eh2077 commented May 19, 2024

I'll continue testing when the site is full recovered.

@eh2077
Copy link
Contributor

eh2077 commented May 20, 2024

@charles-liang I'm checkout this branch locally and still can't open search page.

image

@charles-liang
Copy link
Contributor Author

Can you open the Chrome Developer Tools' Network tab to check the server response speed? I thought the network was slow because I am in China and there is a firewall.

@eh2077
Copy link
Contributor

eh2077 commented May 20, 2024

I also tested on the main branch and it was same - loading. But the staging env is working. So, I'm going to revisit this after the merging freeze.

@trjExpensify
Copy link
Contributor

@eh2077 can you open the console and head to the Network tab before you go to search page. Then look for the Search command and check if you're getting errors. I wonder if you're running into something I did recently with a 501 for an invalid tax percentage.

@eh2077
Copy link
Contributor

eh2077 commented May 20, 2024

@trjExpensify Oh, sorry I forgot to attach the screenshot of request. Yeah, the backend returned invalid data though the HTTP code is 200.

image

cc @charles-liang

@charles-liang
Copy link
Contributor Author

So? what do I need to do? I feel like it's not an issue with my code.

@eh2077
Copy link
Contributor

eh2077 commented May 20, 2024

So? what do I need to do? I feel like it's not an issue with my code.

@charles-liang In this case, I think you can just wait until I'm able to re-test it and then provide feedback. Thanks.

@trjExpensify Should we pull in another internal engineer (since @luacmartins is OOO) to take a look at the API issue, or should we just wait a little while?

@luacmartins
Copy link
Contributor

@eh2077 @charles-liang the pagination API is only in staging and we have a merge freeze in place. We'll need to wait a bit longer to get that deployed to production. Meanwhile, you should be able to test this using the staging API. Let me know if you still have issues with that.

@charles-liang
Copy link
Contributor Author

@charles-liang please avoid force-pushing changes to the branch as that makes it a bit harder to review the code

@luacmartins

Should I rebase my branch onto the main branch and then make changes? Or should I merge the latest code from the main branch into my branch?

My approach is to rebase my branch onto the main branch and I can remember the specific changes I need to make. Then, I would force-push my branch in the end. This way, when comparing with the latest main branch, the diff will be very clean.

@eh2077@luacmartins Got it. I will pay attention to it in the future.

updateCellsBatchingPeriod?: number;

/**
* The number passed here is a measurement unit where 1 is equivalent to your viewport height. The default value is 21 (10 viewports above, 10 below, and one in between).
Copy link
Contributor

Choose a reason for hiding this comment

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

The default value is 5 right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This comment was copied from the original documentation. It is correct. The default value of 5 was used in the previous project.

src/components/SelectionList/types.ts Outdated Show resolved Hide resolved
src/components/Search.tsx Outdated Show resolved Hide resolved
src/components/SelectionList/TransactionListItem.tsx Outdated Show resolved Hide resolved
@eh2077
Copy link
Contributor

eh2077 commented May 27, 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
0-android.mp4
Android: mWeb Chrome
0-mobile-chrome.mp4
iOS: Native
0-ios.mp4
iOS: mWeb Safari
0-mobile-safari.mp4
MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop
0-desktop.mp4

@eh2077
Copy link
Contributor

eh2077 commented May 27, 2024

@luacmartins This PR overall looks good to me and tested well. Just defer one comment (about fixing type error from main) to you. Kindly help to trigger the workflow to see if CI is green, thanks!

@luacmartins
Copy link
Contributor

Running workflow now.

@luacmartins
Copy link
Contributor

@eh2077 seems like typecheck is passing.

@luacmartins luacmartins requested a review from eh2077 May 27, 2024 16:49
<Icon
src={Expensicons.ArrowRightLong}
width={variables.iconSizeXXSmall}
height={variables.iconSizeXXSmall}
fill={theme.icon}
/>
<View style={[styles.flex1, styles.mw50]}>{userCell(transactionItem.to)}</View>
<View style={[styles.mw50]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

We need the styles.flex1 here otherwise the text overflows. I won't block on this though, since it's a simple change we can do in a follow up and it's more important to get this optimization out and resolve conflicts on ongoing PRs.

Screenshot 2024-05-27 at 12 25 26 PM

@melvin-bot melvin-bot bot requested a review from luacmartins May 27, 2024 18:31
@puneetlath puneetlath merged commit a1cb473 into Expensify:main May 27, 2024
18 of 19 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/puneetlath in version: 1.4.77-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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.

None yet

6 participants