Skip to content

Ensure multiple waypoints are visible on smaller screens#26604

Closed
ZhenjaHorbach wants to merge 5 commits into
Expensify:mainfrom
ZhenjaHorbach:fix/distance-request-preview-title-for-sbe
Closed

Ensure multiple waypoints are visible on smaller screens#26604
ZhenjaHorbach wants to merge 5 commits into
Expensify:mainfrom
ZhenjaHorbach:fix/distance-request-preview-title-for-sbe

Conversation

@ZhenjaHorbach

@ZhenjaHorbach ZhenjaHorbach commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

Details

Fixed Issues

$ #26595
PROPOSAL: N/A

Tests

1.Open app on small screen (height = +- 400px )
2.Go to a workspace chat
3.Click the "+" button next to the text composer
4.Click "Request money"
5.Click "Distance"
6.Should show 2 stops
7.Click Add stope
8.Should be an animation of the transition of the list elements to the end

  • Verify that no errors appear in the JS console

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 / 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
Screen.Recording.2023-09-03.at.17.09.30.mov
Screen.Recording.2023-09-03.at.17.05.56.mov
Mobile Web - Chrome
Screen.Recording.2023-09-03.at.17.20.13.mov
Mobile Web - Safari
Screen.Recording.2023-09-03.at.17.27.41.mov
Desktop
Screen.Recording.2023-09-03.at.17.14.00.mov
iOS
Android

@ZhenjaHorbach ZhenjaHorbach requested a review from a team as a code owner September 3, 2023 12:34
@github-actions

github-actions Bot commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


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


1 out of 2 committers have signed the CLA.
@ZhenjaHorbach
❌ @HORBAY02
HORBAY02 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request

@melvin-bot melvin-bot Bot removed the request for review from a team September 3, 2023 12:34
@melvin-bot

melvin-bot Bot commented Sep 3, 2023

Copy link
Copy Markdown

@marcochavezf 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 marcochavezf September 3, 2023 12:34
@mountiny mountiny changed the title Fix distance request preview title for sbe Ensure multiple waypoints are visible on smaller screens Sep 3, 2023
@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach Can you make sure to remove the unverified commits?

@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach Can you please force push just with verified commits?

@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

You also need to sign the CLA as a first time contributor, simple comment the sentence its asking you to post

@ZhenjaHorbach ZhenjaHorbach force-pushed the fix/distance-request-preview-title-for-sbe branch from bc1c085 to 9fd1f42 Compare September 3, 2023 14:29
@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach Amazing, can you please update the tests to be a nubered list? than also fill out the chekclist and include videos from all the platfroms

@fedirjh Could you start your review here in parallel, please? thanks!

@Expensify Expensify deleted a comment from ZhenjaHorbach Sep 3, 2023
@Expensify Expensify deleted a comment from ZhenjaHorbach Sep 3, 2023
@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach can you post the sentence without anything else in there

@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach Lint is failing as well

Comment thread src/components/DistanceRequest.js Outdated
}

scrollViewRef.current.scrollToEnd({animated: true});
}, [haveWaypointsChanged])

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We have a lint error here.

@ZhenjaHorbach I have an alternative suggestion: instead of using a hook to scroll, I will comment on another line.

Comment thread src/components/DistanceRequest.js Outdated
@@ -170,6 +180,7 @@ function DistanceRequest({iou, iouType, report, transaction, mapboxAccessToken})
onContentSizeChange={(width, height) => setScrollContentHeight(height)}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Instead of using a hook for scrolling, we can utilize this callback to scroll when the content size changes and the number of waypoints increases:

onContentSizeChange={(width, height) => {
    if (scrollContentHeight < height && numberOfWaypoints > numberOfPreviousWaypoints){
        scrollViewRef.current.scrollToEnd({animated: true});
    }
    setScrollContentHeight(height)
}}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actually, we can just compare the height and remove the extra changes of numberOfPreviousWaypoints.

@ZhenjaHorbach ZhenjaHorbach Sep 3, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I totally agree about remove useEffect.
Good idea

But what about the height
I think it's better to compare the number of stops, because for example when opening the stop details
The height will reset and scroll will occur, which we do not need

More precisely, I believe that the change in the number of stops is much more predictable than the height

@fedirjh fedirjh Sep 3, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

cc @ZhenjaHorbach In case you missed my last comment, what do you think of just comparing the height?

Edit: Just missed your comment, I agree with your point 👍🏼

@fedirjh

fedirjh commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

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
CleanShot.2023-09-03.at.16.04.27-converted.mp4
Mobile Web - Chrome
CleanShot.2023-09-03.at.16.41.29-converted.mp4
CleanShot.2023-09-03.at.16.42.48.mp4
Mobile Web - Safari
CleanShot.2023-09-03.at.16.29.59.mp4
CleanShot.2023-09-03.at.16.32.20.mp4
Desktop
CleanShot.2023-09-03.at.16.13.47.mp4
iOS
CleanShot.2023-09-03.at.16.27.21.mp4
Android
CleanShot.2023-09-03.at.16.57.02.mp4

@parasharrajat

Copy link
Copy Markdown
Member

Looks like commits are messed up a little. The easiest solution would be to squash them into one commit if you can't update the previous commits.

Screenshot 2023-09-03 at 8 59 51 PM

@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

@ZhenjaHorbach can you fix the commutes please? If you prefer to make s new pr lets do it

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor Author

@ZhenjaHorbach can you fix the commutes please? If you prefer to make s new pr lets do it

I'm just thinking about it
But yes, since the first commit was made from a different email
I can't think of a smooth option
So I will probably create a new PR

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor Author

@ZhenjaHorbach can you fix the commutes please? If you prefer to make s new pr lets do it
#26610
@mountiny can we make a reviewer @fedirjh ?
To not bother others?

@mountiny

mountiny commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

Closing in favour of #26610

@mountiny mountiny closed this Sep 3, 2023
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