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

Adjust IOUPreview height based on description availability #18774

Conversation

huzaifa-99
Copy link
Contributor

@huzaifa-99 huzaifa-99 commented May 11, 2023

Details

Fixed Issues

$ #18770
PROPOSAL: #18770 (comment)

Tests

  1. Create an IOU request (to any user) without a comment/description
  2. Notice the height of the message
  3. Now create another IOU request (to the same user) without a comment/description
  4. Verify the height of the new message (it should be less than the preview due to no comment/description)
  • Verify that no errors appear in the JS console

Offline tests

  1. Create an IOU request (to any user) without a comment/description
  2. Notice the height of the message
  3. Now create another IOU request (to the same user) without a comment/description
  4. Verify the height of the new message (it should be less than the preview due to no comment/description)

QA Steps

  1. Create an IOU request (to any user) without a comment/description
  2. Notice the height of the message
  3. Now create another IOU request (to the same user) without a comment/description
  4. Verify the height of the new message (it should be less than the preview due to no comment/description)
  • 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
    • 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 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

Safari

1-1 Chat

Screenshot 2023-05-12 at 12 58 07 AM

3+ user chat
Screenshot 2023-05-12 at 1 01 04 AM
Screenshot 2023-05-12 at 1 00 43 AM

Chrome

1-1 Chat
Screenshot 2023-05-12 at 12 54 56 AM

3+ user chat
Screenshot 2023-05-12 at 12 48 59 AM
Screenshot 2023-05-12 at 12 52 23 AM

Mobile Web - Chrome

1-1 Chat

Screenshot 2023-05-12 011152

3+ User chat
Screenshot 2023-05-12 010907

Screenshot 2023-05-12 011006

Mobile Web - Safari

1-1 Chat

image

3+ User chat
Screenshot 2023-05-12 at 1 09 49 AM
Screenshot 2023-05-12 at 1 06 00 AM

Desktop

1-1 Chat
image

3+ User chat
image
image

iOS

1-1 Chat
image

3+ User chat
image
image

Android

1-1 Chat

3a

3+ User chat
1a
2a

@huzaifa-99 huzaifa-99 requested a review from a team as a code owner May 11, 2023 13:24
@melvin-bot melvin-bot bot requested review from aimane-chnaif and Julesssss and removed request for a team May 11, 2023 13:24
@melvin-bot
Copy link

melvin-bot bot commented May 11, 2023

@Julesssss @aimane-chnaif One of you needs to 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]

@@ -143,6 +143,7 @@ const IOUPreview = (props) => {
const sessionEmail = lodashGet(props.session, 'email', null);
const managerEmail = props.iouReport.managerEmail || '';
const ownerEmail = props.iouReport.ownerEmail || '';
const requestDescription = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''));
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const requestDescription = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''));
const comment = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', '')).trim();

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -240,7 +241,7 @@ const IOUPreview = (props) => {
<Text style={[styles.textLabel, styles.colorMuted]}>{props.translate('iou.pendingConversionMessage')}</Text>
)}

<Text style={[styles.colorMuted]}>{Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''))}</Text>
{requestDescription ? <Text style={[styles.colorMuted]}>{requestDescription}</Text> : ''}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{requestDescription ? <Text style={[styles.colorMuted]}>{requestDescription}</Text> : ''}
{!_.isEmpty(comment) && <Text style={[styles.colorMuted]}>{comment}</Text>}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -240,7 +241,7 @@ const IOUPreview = (props) => {
<Text style={[styles.textLabel, styles.colorMuted]}>{props.translate('iou.pendingConversionMessage')}</Text>
)}

<Text style={[styles.colorMuted]}>{Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''))}</Text>
{_.isEmpty(comment) ? <Text style={[styles.colorMuted]}>{comment}</Text> : ''}
Copy link
Contributor

Choose a reason for hiding this comment

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

why ''? it should be null. also condition is wrong
This was my suggestion:

Suggested change
{_.isEmpty(comment) ? <Text style={[styles.colorMuted]}>{comment}</Text> : ''}
{!_.isEmpty(comment) && <Text style={[styles.colorMuted]}>{comment}</Text>}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apologies, this is fixed now

@@ -143,6 +143,7 @@ const IOUPreview = (props) => {
const sessionEmail = lodashGet(props.session, 'email', null);
const managerEmail = props.iouReport.managerEmail || '';
const ownerEmail = props.iouReport.ownerEmail || '';
const comment = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''));
Copy link
Contributor

Choose a reason for hiding this comment

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

trim value:

Suggested change
const comment = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', ''));
const comment = Str.htmlDecode(lodashGet(props.action, 'originalMessage.comment', '')).trim();

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huzaifa-99 huzaifa-99 requested a review from aimane-chnaif May 11, 2023 14:09
Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Looking good! Would you mind just adding another test?

Test Bill Split

  • Create a Bill Split with 3+ users
  • An IOUPreview should display within the group chat
  • // Same as the other test, no space should appear

@trjExpensify
Copy link
Contributor

Let's give @shawnborton an opp to review this as well.

@huzaifa-99
Copy link
Contributor Author

@Julesssss sure, will add those tests as well

@shawnborton
Copy link
Contributor

Looks good to me. Where are we addressing the other IOU preview card changes, like getting rid of the avatars and adding a right caret in the top right?

@trjExpensify
Copy link
Contributor

Actually, good point. That was done here. Why does the OP tests have avatars still? 🤔

@Julesssss
Copy link
Contributor

Good point Tom. @huzaifa-99 is this PR branching from the latest main commit? Or at least one from within the last 8 hours?

@huzaifa-99
Copy link
Contributor Author

@Julesssss its actually a little before the last 8 hours. I probably forgot to pull. Adding fresh tests...

Apologies guys.

@Julesssss
Copy link
Contributor

No worries, thank you!

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented May 11, 2023

Was testing with main and Splitting bill creates an empty chat like this (an unrelated bug).

image

Should I ignore this in the tests? @Julesssss

@aimane-chnaif
Copy link
Contributor

Was testing with main and Splitting bill creates an empty chat like this (an unrelated bug).

image

Should I ignore this in the tests? @Julesssss

This happens on main so out of scope.. I reported here - https://expensify.slack.com/archives/C049HHMV9SM/p1683816514449429
But sure it should be fixed urgently

@huzaifa-99
Copy link
Contributor Author

Thank you @aimane-chnaif. Will ignore the bug in tests

@huzaifa-99
Copy link
Contributor Author

Apparently, some other flows related to spill bill have some issues.

When i spilt bill in a group with 3+ members, it creates a new chat with this error
image

I think this is also unrelated but just wanted to highlight this

@huzaifa-99
Copy link
Contributor Author

Updated the test in PR Desc, I was getting this and this error but ignored them as unrelated to the current fix/scope.

I have added screenshots since the mentioned errors were a bit annoying but I can add videos if thats preferred.

cc: @Julesssss @aimane-chnaif

@huzaifa-99 huzaifa-99 requested a review from Julesssss May 11, 2023 22:06
@Julesssss
Copy link
Contributor

Please raise that bug in expensify-bugs to claim the bug bounty. Agree it's a separate issue.

@huzaifa-99
Copy link
Contributor Author

Thank you @Julesssss. I just tried with latest HEAD and this issue is not there anymore

@aimane-chnaif
Copy link
Contributor

@huzaifa-99 please merge main again

@huzaifa-99
Copy link
Contributor Author

@aimane-chnaif done!

@aimane-chnaif
Copy link
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 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 web
Mobile Web - Chrome mchrome
Mobile Web - Safari

msafari

Desktop desktop
iOS

ios

Android android

aimane-chnaif
aimane-chnaif previously approved these changes May 12, 2023
Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

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

@Julesssss LGTM 🎉

@trjExpensify
Copy link
Contributor

@huzaifa-99 could you fix the conflicts please?

@huzaifa-99
Copy link
Contributor Author

@trjExpensify Thanks for the ping. Fixed merge conflicts!

@@ -282,4 +283,4 @@ export default compose(
key: ONYXKEYS.WALLET_TERMS,
},
}),
)(IOUPreview);
)(IOUPreview);
Copy link
Contributor

Choose a reason for hiding this comment

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

@huzaifa-99 can you add an empty line at the end of the file please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@luacmartins Thanks for pointing out. Fixed

@huzaifa-99 huzaifa-99 requested a review from luacmartins May 14, 2023 13:21
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thank you @huzaifa-99

@luacmartins luacmartins merged commit 6377858 into Expensify:main May 14, 2023
@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.

@huzaifa-99
Copy link
Contributor Author

Pleasure to contribute guys. Thank you all!

@mountiny
Copy link
Contributor

Thank you! @huzaifa-99 Hope to see many more PRs from you 🚀

@huzaifa-99
Copy link
Contributor Author

Thanks @mountiny. I plan to contribute more, already have proposals underway.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.14-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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.

8 participants