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

UI MoneyRequestHeader Polish #18775

Merged
merged 12 commits into from
May 16, 2023
Merged

Conversation

s77rt
Copy link
Contributor

@s77rt s77rt commented May 11, 2023

Details

  1. Set flex 1 to Views so the workspace name does not overflow.
  2. Adjusted subscript avatar position, background color and border radius (more info in comment).
  3. Adjusted MoneyRequestHeader bottom padding to meet the design mockup (20px).
  4. The <ReportActionItemCreated /> (welcome message, avatars and bg art) will be rendered only if the report is a chat report.
  5. Reduced section titles heights

Fixed Issues

$ #18773

Tests

Same as #18537 but request money from a workspace/user with a very long name

  1. Verify name does not overflow and shows ellipsis instead
  2. Verify there is no welcome message and that the background is blank

web

  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

same as Tests ^

  • 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

web

Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

{isExpenseReport ? (
<SubscriptAvatar
backgroundColor={themeColors.highlightBG}
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 is taken from MoneyRequestHeader

@s77rt s77rt marked this pull request as ready for review May 12, 2023 00:10
@s77rt s77rt requested a review from a team as a code owner May 12, 2023 00:10
@melvin-bot melvin-bot bot requested review from 0xmiros and Julesssss and removed request for a team May 12, 2023 00:10
@melvin-bot
Copy link

melvin-bot bot commented May 12, 2023

@Julesssss @0xmiroslav 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]

Julesssss
Julesssss previously approved these changes May 12, 2023
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. I'm going to cc Shawn for a final design review.

@Julesssss
Copy link
Contributor

I kicked off an automated builds run here. Once complete, I'll share the links with Shawn for review.

@0xmiros
Copy link
Contributor

0xmiros commented May 12, 2023

I will review and checklist in a few hrs

@rushatgabhane
Copy link
Member

@Julesssss
Copy link
Contributor

Forgot to add the label, re-running now.

@0xmiros
Copy link
Contributor

0xmiros commented May 12, 2023

Also, please pull from main

@s77rt
Copy link
Contributor Author

s77rt commented May 12, 2023

@0xmiroslav

Also, please pull from main

This is based on main and there are no conflicts. Are you facing any issue here?

@0xmiros
Copy link
Contributor

0xmiros commented May 12, 2023

This is based on main and there are no conflicts. Are you facing any issue here?

No issue but just for safety (207 commits behind is not small diff). PR itself is fine but after merge, might conflict with another PR as I've seen a few cases recently.
If you don't, I can pull main locally and test.

@s77rt
Copy link
Contributor Author

s77rt commented May 12, 2023

Key notes:

  1. Added iconAdditionalStyles prop to Avatar to pass styles and avoid the double border radius. Previously there was 3 border radius values (20px for default avatar, 4px inner, 6px outer). Now we only have one which is 6px.
  2. We can now pass imageStyles=null to clear the preset styles. This is needed to remove the 20px border radius and unset the unnecessary width and height for the subscript avatar.
  3. StyleUtils.getAvatarBorderWidth will now return an object instead of a number.
  4. Removed the extra View in SubscriptAvatar. Will be using the existing containerStyles prop.

I think the rest is self-explanatory.


Here are the results:
Screenshot from 2023-05-12 19-15-52
Screenshot from 2023-05-12 19-03-14

cc @shawnborton

[CONST.AVATAR_SIZE.SMALL_SUBSCRIPT]: 2,
[CONST.AVATAR_SIZE.SMALL_SUBSCRIPT]: 1,
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 was based on the removed border width from secondAvatarSubscriptCompact.

@shawnborton
Copy link
Contributor

Looks good to me!

@0xmiros
Copy link
Contributor

0xmiros commented May 12, 2023

@s77rt is this ready for review?

@s77rt
Copy link
Contributor Author

s77rt commented May 12, 2023

@0xmiroslav Yes. There are still 2 other enhancements but we may move those to a follow up PR. You can review this one as is.

@luacmartins
Copy link
Contributor

@s77rt can you address @mountiny's comment above please?

@0xmiros
Copy link
Contributor

0xmiros commented May 16, 2023

Let's merge main into this branch and see if that still happens

@luacmartins
Copy link
Contributor

I don't think we should merge it with failing tests.

@mountiny
Copy link
Contributor

yeah we cannot merge this as then all PRs would be failing.

@0xmiros
Copy link
Contributor

0xmiros commented May 16, 2023

I don't think we should merge it with failing tests.

Oh I meant to pull main since this branch is 445 commits behind

@s77rt
Copy link
Contributor Author

s77rt commented May 16, 2023

Sorry I thought the failing test was the old unread indicator one, it's another one. Fix is on the way.

@s77rt s77rt dismissed stale reviews from 0xmiros, mountiny, luacmartins, and Julesssss via ff1d770 May 16, 2023 17:16
@s77rt
Copy link
Contributor Author

s77rt commented May 16, 2023

Ok we should be good to go 🚀

@luacmartins luacmartins merged commit bd6743c into Expensify:main May 16, 2023
OSBotify pushed a commit that referenced this pull request May 16, 2023
UI MoneyRequestHeader Polish

(cherry picked from commit bd6743c)
OSBotify added a commit that referenced this pull request May 16, 2023
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/luacmartins in version: 1.3.14-11 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@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 ✅

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

</View>
<Tooltip text={props.secondaryTooltip}>
<Avatar
imageStyles={null}
Copy link
Member

Choose a reason for hiding this comment

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

Hi this PR caused #19905

More details - #19905 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @rushatgabhane We didn't test with a real image indeed. Nice catch!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants