Truncated money request preview

[esh-g]

Details

Fixed Issues

$ #29459
PROPOSAL: #29459 (comment)

Tests

1. Click on request money.
2. Enter any amount
3. Enter a long description (more than 4 lines)
4. Make sure it is truncated in the preview

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Click on request money.
2. Enter any amount
3. Enter a long description (more than 4 lines)
4. Make sure it is truncated in the preview

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android: Native
  • Android: mWeb Chrome
  • iOS: Native
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
  • MacOS: Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If 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
    • 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

Android: Native

Screen.Recording.2023-10-19.at.8.46.52.PM-1.mov

Android: mWeb Chrome

Screen.Recording.2023-10-19.at.8.54.37.PM-1.mov

iOS: Native

Screen.Recording.2023-10-24.at.4.45.32.PM.mov

iOS: mWeb Safari

Screen.Recording.2023-10-19.at.9.03.27.PM-1.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-24.at.4.00.44.PM.mov

MacOS: Desktop

Screen.Recording.2023-10-24.at.4.13.21.PM.mov

[melvin-bot]

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

[esh-g]

@situchan All the videos added... Hoping this can be a quick one

[esh-g]

gentle bump @situchan

[situchan]

Not sure if this is bug or expected. text is scrollable inside preview
I think we should prevent this for platform consistency as not happening on mobile.
cc: @Expensify/design

Screen.Recording.2023-10-26.at.4.37.07.PM.mov

[shawnborton]

Wow, interesting. @JmillsExpensify or @trjExpensify do you have any context here?

I think there definitely shouldn't be a scrollable area, so not sure how that happened. I would think we just truncate this one after 2-3 lines max, and ideally this component behaves the same as other preview components.

[esh-g]

@situchan I investigated this and apparently, this is an issue in react-native-web itself as mentioned here: necolas/react-native-web#13 (comment)

But I have a solution to this:
Instead of using numberOfLines prop to limit the text, we can set the maxHeight of the View to numberOfLines * lineHeight
which can look something like this:

<View style={[styles.flex1, truncatedContainerStyle]}> {/* Change here */}
    {!isCurrentUserManager && props.shouldShowPendingConversionMessage && (
        <Text style={[styles.textLabel, styles.colorMuted]}>{props.translate('iou.pendingConversionMessage')}</Text>
    )}
    {shouldShowDescription && <Text style={[styles.colorMuted]}>{description}</Text>}
</View>

where truncatedContainerStyle looks like this:

const truncatedContainerStyle = StyleUtils.combineStyles([
    StyleUtils.getMaximumHeight(3 * variables.fontSizeNormalHeight),
    styles.overflowHidden,
]);

same can be done for the merchant.

[dannymcclain]

I think there definitely shouldn't be a scrollable area, so not sure how that happened. I would think we just truncate this one after 2-3 lines max, and ideally this component behaves the same as other preview components.

Agree with Shawn here. Truncate after 2-3 lines (I'd kinda like to see both to see how they feel) with an "..." at the end to let users know there's more once they tap into it.

[situchan]

we can set the maxHeight of the View to numberOfLines * lineHeight

@esh-g Did you test that approach on all platforms?

[esh-g]

@situchan Yes, I did test on iOS, mWeb and desktop/chrome....

[situchan]

@esh-g what you linked is very old article. can you think of alternative solution, not setting maxHeight?

[esh-g]

@situchan I don't think there is an alternative...

• We cannot use the onTextLayout prop on web to get the number of lines.
• The current numberOfLines prop on web, translates to -webkit-line-clamp which cannot prevent scroll (even if overflow hidden is added).

The other option we have is to limit the number of characters in the IOU preview., which can be done easily...

[situchan]

@esh-g ok, please push changes and update screenshots accordingly with scrolling tested. Make sure to test various text length which fill 1-2 lines, 3 lines, 3+ lines

[esh-g]

Okay @situchan Just a note that there are no ellipsis with this approach, I hope that's fine?

[situchan]

Okay @situchan Just a note that there are no ellipsis with this approach, I hope that's fine?

No, ellipsis should show

[esh-g]

@situchan Then I think it's better we go for a preview with a fixed number of characters instead... because that will be predictable to add the ellipsis and I don't see any downside with that approach either...

[esh-g]

Gentle bump @situchan

[situchan]

@situchan Then I think it's better we go for a preview with a fixed number of characters instead... because that will be predictable to add the ellipsis and I don't see any downside with that approach either...

Nope, we should not truncate characters as width / font width will vary depending on devices.

[trjExpensify]

Wow, interesting. @JmillsExpensify or @trjExpensify do you have any context here?

I think there definitely shouldn't be a scrollable area, so not sure how that happened. I would think we just truncate this one after 2-3 lines max, and ideally this component behaves the same as other preview components.

Sorry I'm late here, I was out for a few days. I don't have context on this one, but agree it shouldn't be scrollable and we should truncate. 👍

[esh-g]

@situchan I wish there was a solution to that but seeing that even react-native-web was not able to come up with a solution to the scroll problem, I think the variation in the number of lines would be at most 1-2 lines...

But still if we want the current approach with the ellipsis, then we would have to add the ellipsis to the next line like in the following image:

This is achieved by adding a state var called subtitleHeight that is set in the onLayout callback in description or merchant Text, then checking if subtitleHeight > 3 * variables.fontSizeNormalHeight and displaying ellipsis if it is...

cc @Expensify/design (to decide with the ellipsis on the next line...)

[trjExpensify]

I'm not a huge fan of adding a whole line to the preview just for the ellipsis, what do you think @dannymcclain?

[dannymcclain]

@trjExpensify yeah I'm not a fan of that either. If we can't reliably truncate based on lines I think I'd rather do it based on character count like was suggested here (I think?). I realize that might give us less control over the number of lines that show up but we could probably choose a character count that we're pretty confident wouldn't span to 3 lines. And it would likely look a LOT cleaner. What do you think?

[trjExpensify]

Yeah, are you suggesting we have an ellipsis still to "signal" the truncation (which I think is important) but after X characters such that it's contained to two lines. I agree that's better than:

1. no ellipsis to signal the text is truncated
2. an ellipsis on its own line

[dannymcclain]

@trjExpensify Yeah that's exactly what I'm thinking. I also think the ellipsis is pretty important, so trying to find the nicest way to still include it feels like our best option here.

[esh-g]

So do we agree to go ahead with a character limit? If yes, then what is the amount of characters we are thinking?

cc @trjExpensify @dannymcclain

[esh-g]

@shawnborton Do you mean cutting out the description so that only first 2 lines are visible? We already discussed that and the problem was that there would be no ellipsis in the text..

[shawnborton]

I thought we could use the baked in ellipsizeMode? https://reactnative.dev/docs/text#ellipsizemode

[esh-g]

@shawnborton Yes we can use that on native but it is broken for react-native-web. If you have more than one line, it allows the user to scroll on web. This is the reason we decided to cap characters instead of lines..

[shawnborton]

Ah got it, thanks for clarifying!

[esh-g]

btw, I updated it to 83 because the lodash truncate function also counts the 3 ellipsis as characters so, if we had set it to 80, we would only get 77 characters.

[esh-g]

Does the change look good? @situchan

[situchan]

Looks good. Please also test with various width of characters including emojis.

[esh-g]

@situchan Seems like we can fit a bit more emojis than text... but is this something we should change? Because I wouldn't say it is realistic to use only emojis and there is no way to strictly enforce the 2 line limit for different characters...

[esh-g]

bump @situchan

[situchan]

I will complete review by tomorrow

[esh-g]

bump @situchan

[situchan]

83 is the best value?

3 lines on mobile:

[situchan]

If that's fine, I will go ahead given that there's no perfect solution to be responsive to all platforms.

[situchan]

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 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(theme.componentBG)
• If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
• If the PR modifies the form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label so the design team can review the changes.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
• 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[situchan]

@esh-g I don't see scroll issue in other places of the app where numberOfLines is set.
i.e. share code page

App/src/components/QRShare/index.js

Line 58 in d5f5856

numberOfLines={2}

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.4.22-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.4.22-0 🚀

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

[esh-g]

@esh-g I don't see scroll issue in other places of the app where numberOfLines is set. i.e. share code page

App/src/components/QRShare/index.js

Line 58 in d5f5856

numberOfLines={2}

It definitely is very strange behaviour for react-native-web maybe because the component was already scrollable in case of the money request action, it could not block any scroll events so we were able to scroll in the money request description but not here...

[OSBotify]

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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