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

fix: EReceipt icon via props no state #35499

Merged
merged 5 commits into from
Feb 9, 2024
Merged

Conversation

dragnoir
Copy link
Contributor

@dragnoir dragnoir commented Jan 31, 2024

Details

Fixed Issues

$ #34316
PROPOSAL: #34316 (comment)

Tests

  1. Go to the workspace chat with an EReceipt transaction.
  2. Click on the preview.
  3. Go back and forth between the main chat, expense report and expense details page.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to the workspace chat with an EReceipt transaction.
  2. Click on the preview.
  3. Go back and forth between the main chat, expense report and expense details page.
  • 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 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.

Screenshots/Videos

ReportActionItemImages > ReportActionItemImage > EReceiptThumbnail

  • numberOfShownImages = 3

image

  • numberOfShownImages = 2

image

  • numberOfShownImages = 1

image

image

MoneyRequestView> ReportActionItemImage > EReceiptThumbnail

image

AttachmentView > EReceipt > EReceiptThumbnail

image

Mobile (android - Pixel 7):

image

image

Safari: iPad:

image

Screenshots/Videos

Android: Native
20240204_171146_Trim.mp4
Android: mWeb Chrome
20240204_232456_Trim.mp4
iOS: Native
20240204_231019_Trim.mp4
iOS: mWeb Safari
20240204_231212_Trim.mp4
MacOS: Chrome / Safari
20240204_223138.mp4
MacOS: Desktop
20240204_223533_Trim.mp4

@dragnoir dragnoir requested a review from a team as a code owner January 31, 2024 17:54
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team January 31, 2024 17:54
Copy link

melvin-bot bot commented Jan 31, 2024

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

@dragnoir
Copy link
Contributor Author

@jjcoffee any idea why the Perf test failed with this error?
Error: Render count difference exceeded the allowed deviation of 0. Current difference: 6.5

@jjcoffee
Copy link
Contributor

jjcoffee commented Feb 1, 2024

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-native-2024-02-02_12.05.29.mp4
Android: mWeb Chrome
android-chrome-2024-02-02_12.01.07.mp4
iOS: Native
ios-native-2024-02-02_11.21.34.mp4
iOS: mWeb Safari
ios-safari-2024-02-02_11.26.41.mp4
MacOS: Chrome / Safari
desktop-chrome-2024-02-02_11.37.34.mp4
MacOS: Desktop
desktop-app-2024-02-02_11.53.59.mp4

@jjcoffee

This comment was marked as resolved.

@jjcoffee

This comment was marked as resolved.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 2, 2024

@jjcoffee

Please can you make sure to fill out the screenshots section as it is in the template, i.e. you need to keep these dropdowns and fill them with a video from each relevant platform.

Ok will doit ASAP, can I keep the old screenshots as it is and andd the missing part from the template?

@jjcoffee
Copy link
Contributor

jjcoffee commented Feb 2, 2024

Ok will doit ASAP, can I keep the old screenshots as it is and andd the missing part from the template?

Sure, just make sure to add videos too as they're required in this case to demonstrate that the fix works.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 4, 2024

@jjcoffee

  • Videos posted as template require
  • Merged with main
  • Conflicts solved
  • Test passed

@jjcoffee

This comment was marked as resolved.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 5, 2024

@jjcoffee I was thinking also about it. In my code, I have not changed anything on the design. I just removed the lagging effect. What do you think we need to change on storybook?

@jjcoffee
Copy link
Contributor

jjcoffee commented Feb 5, 2024

@dragnoir If you run npm run storybook you will see that the sizes are not correct.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 5, 2024

@jjcoffee the sizes on storybook are the same as on the code, no difference

image

image

image

screenshots from storybook are exactly as on the website #34316 (comment)

@jjcoffee

This comment was marked as resolved.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 5, 2024

Thank you for the details. I will fix it tomorrow.

@jjcoffee
Copy link
Contributor

jjcoffee commented Feb 7, 2024

@dragnoir Friendly bump on this!

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 9, 2024

Will be done by the end of the day.

@dragnoir
Copy link
Contributor Author

dragnoir commented Feb 9, 2024

@jjcoffee update added to storybook

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the fix!

@melvin-bot melvin-bot bot requested a review from luacmartins February 9, 2024 13:44
@luacmartins luacmartins merged commit 2017a3a into Expensify:main Feb 9, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 9, 2024

✋ 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/luacmartins in version: 1.4.40-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

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