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

style search result can scroll to bottom #27619

Merged

Conversation

suneox
Copy link
Contributor

@suneox suneox commented Sep 17, 2023

Details

Fixed Issues

$ #27365
PROPOSAL: #27365 (comment)

Tests

  1. Start document
  2. Open help site
  3. Click on the find icon then type "other" and submit a search
  4. Scroll to the bottom of the search result

Offline tests

QA Steps

  1. Login and then open Settings.
  2. Open help.
  3. Tap on the search icon.
  4. Type in the search field "other" and then tab search icon to submit,
  5. When the search list shows up try to scroll down
  6. Verify user can scroll to the bottom of the search page

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 Screenshot 2023-09-17 at 21 36 21
Mobile Web - Chrome

screenshot-1694961257860

Mobile Web - Safari

IMG_0225

Desktop
iOS
Android

@github-actions
Copy link
Contributor

github-actions bot commented Sep 17, 2023

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

@suneox suneox force-pushed the fix/27365-help-search-can-not-scroll-to-bottom branch 2 times, most recently from e728b9e to f6d1851 Compare September 17, 2023 14:52
@suneox
Copy link
Contributor Author

suneox commented Sep 17, 2023

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

@suneox suneox force-pushed the fix/27365-help-search-can-not-scroll-to-bottom branch from f6d1851 to f6d4fb0 Compare September 17, 2023 15:10
@suneox suneox marked this pull request as ready for review September 18, 2023 01:16
@suneox suneox requested a review from a team as a code owner September 18, 2023 01:16
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team September 18, 2023 01:16
@melvin-bot
Copy link

melvin-bot bot commented Sep 18, 2023

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

@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 2023

Hi, @suneox, do you have time to look at this request change?
image

@suneox suneox force-pushed the fix/27365-help-search-can-not-scroll-to-bottom branch from f6d4fb0 to 25c8852 Compare September 19, 2023 00:54
@suneox
Copy link
Contributor Author

suneox commented Sep 19, 2023

Hi, @suneox, do you have time to look at this request change? image

Sure I just updated with comment browser support in the code, thank you for your suggestion

@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 2023

@suneox, Let's add QA steps that are somewhat similar to the Action Performed in the issue, and here are some reference suggestions on how to write them: 🙂
image

@suneox
Copy link
Contributor Author

suneox commented Sep 19, 2023

@ntdiary I have updated the QA step this PR is the first time with Expensify I have missed info :) Thank you for your reminder! And what environment QA can test? because on staging the help site visit from the setting page is the same production https://help.expensify.com/

@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 2023

@ntdiary I have updated the QA step this PR is the first time with Expensify I have missed info :) Thank you for your reminder! And what environment QA can test? because on staging the help site visit from the setting page is the same production https://help.expensify.com/

@suneox, don't worry about this, our help site is hosted on GitHub Pages, it should be automatically updated when merged.
Additionally, there are two comments that need to be addressed. : )

@suneox
Copy link
Contributor Author

suneox commented Sep 19, 2023

@suneox, don't worry about this, our help site is hosted on GitHub Pages, it should be automatically updated when merged. Additionally, there are two comments that need to be addressed. : )

@ntdiary I have updated the code and updated QA Step.
How can I resolve two comments on your mention?
In my view, I don't see and do not receive notification of your comment in this picture so it's your draft comment?

docs/_sass/_search-bar.scss Outdated Show resolved Hide resolved
docs/_sass/_search-bar.scss Outdated Show resolved Hide resolved
@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 2023

In my view, I don't see and do not receive notification of your comment #27619 (comment) so it's your draft comment?

@suneox, ah, my bad, I forgot to submit these requests. 😅

@suneox suneox force-pushed the fix/27365-help-search-can-not-scroll-to-bottom branch from 25c8852 to 2c0109b Compare September 19, 2023 03:48
@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 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
27619-web.mp4
Mobile Web - Chrome
27619-mobile-chrome.mp4
Mobile Web - Safari
27619-mobile-safari.mp4
Desktop N/A
iOS N/A
Android N/A

Copy link
Contributor

@ntdiary ntdiary left a comment

Choose a reason for hiding this comment

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

LGTM! : )

@melvin-bot melvin-bot bot requested a review from tgolen September 19, 2023 04:12
@ntdiary
Copy link
Contributor

ntdiary commented Sep 19, 2023

@suneox, by the way, why are you using force push? It may mess up the review history. In the future, it's fine to just commit directly or resolve conflicts with merge. : )
image

@suneox
Copy link
Contributor Author

suneox commented Sep 19, 2023

@suneox, by the way, why are you using force push? It may mess up the review history. In the future, it's fine to just commit directly or resolve conflicts with merge. : )

image

I've rebased from upstream remote so need force push, sorry about that. I'll aware for next time. Thanks your reminder!

@suneox
Copy link
Contributor Author

suneox commented Sep 20, 2023

Hi @ntdiary @tgolen have we got any blocker or feedback for this PR?
This is my first PR so I don't know how long PR can merge after getting approval.

@ntdiary
Copy link
Contributor

ntdiary commented Sep 20, 2023

Don't worry, we just need to wait for @tgolen to merge it when they have time. : )

@tgolen tgolen merged commit b03a594 into Expensify:main Sep 21, 2023
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/tgolen in version: 1.3.73-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.74-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 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