fix: task background image getting cropped #36261

aswin-s · 2024-02-09T16:25:04Z

Details

This PR fixes an issue where the animated background image was getting clipped on a cancelled task report.

Fixed Issues

$ #33922
PROPOSAL: #33922 (comment)

Tests

Create a new task.
Navigate to task report and cancel the task
After cancellation navigate to task report again.
Verify that the image in report background is not clipped at the top
Verify that the background image is not clipped on below report types as well.

Regular Chat report
Workspace Report
Money Report
Money Request
Thread View
Task Report
Verify that no errors appear in the JS console

Offline tests

Navigate to a cancelled task report
Verify that the image in report background is not clipped at the top
Verify that the background image is not clipped on below report types as well.

Regular Chat report
Workspace Report
Money Report
Money Request
Thread View
Task Report

QA Steps

Create a new task.
Navigate to task report and cancel the task
After cancellation navigate to task report again.
Verify that the image in report background is not clipped at the top
Verify that the background image is not clipped on below report types as well.

Regular Chat report
Workspace Report
Money Report
Money Request
Thread View
Task Report
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_out.mp4

Android: mWeb Chrome

android-web_out.mp4

iOS: Native

ios_out.mp4

iOS: mWeb Safari

ios-web_out.mp4

MacOS: Chrome / Safari

web_out.mp4

MacOS: Desktop

desktop_out.mp4

melvin-bot · 2024-02-09T17:50:02Z

@aimane-chnaif 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]

aimane-chnaif · 2024-02-11T14:27:50Z

src/pages/home/report/AnimatedEmptyStateBackground.tsx

@@ -12,7 +12,7 @@ function AnimatedEmptyStateBackground() {
    const StyleUtils = useStyleUtils();
    const {windowWidth, isSmallScreenWidth} = useWindowDimensions();
    const illustrations = useThemeIllustrations();
-    const IMAGE_OFFSET_X = windowWidth / 2;
+    const IMAGE_OFFSET_X = 0;


Please make sure that this doesn't cause regression - #35172

ok I confirmed that this causes regression. x sensor doesn't work.
You should test with physical device. Test in android

Fixed the horizontal sensor shift. Tested on physical device.

sensor.mp4

aimane-chnaif · 2024-02-12T07:35:14Z

src/pages/home/report/AnimatedEmptyStateBackground.tsx

-            transform: [{translateX: withSpring(-IMAGE_OFFSET_X - xOffset.value)}, {translateY: withSpring(yOffset.value)}],
+            // On Android, scroll view sub views gets clipped beyond container bounds. Set the top position so that image wouldn't get clipped
+            top: IMAGE_OFFSET_Y,
+            transform: [{translateX: withSpring(xOffset.value)}, {translateY: withSpring(yOffset.value)}, {scale: 1.15}],


I am worried about this change.
Please compare this branch vs staging on all platforms. There should be no 1px difference

Especially, test sensor

Here is video testing sensors on physical iOS device.

ios_out.mp4

There should be no 1px difference

I've added a top offset top: IMAGE_OFFSET_Y, to prevent the image from getting clipped while tilting on Android devices. This actually pushes the image down by 40px. If you think we don't need to fix it (as this is the experience on prod at the moment), I'll leave it same as before.

Also the earlier implementation stretched out the image to 200% and then positioned the image back in view by translating the image by setting negative IMAGE_OFFSET_X. This caused issues on web while resizing. Instead in current implementation, I'm keeping image width at 100% but then scale it 15% to account for the additional span required while tilting the device.

Staging This Branch

@staszekscp what do you think about this change? Since you recently worked on this file.
Also, we're trying to fix regression caused by your PR

I think the regression was caused by this line, so I would look there for a fix. I've added it, because I wanted to move the background image a bit upwards following designers' suggestion.

I suppose that the cropped image problem can be rather related to wrong container size, not the animation itself. The animation moves the image outside of container boundaries, and as a result it gets cropped.

Thanks for the feedback.
@aswin-s let's not touch animation logic if possible

@aimane-chnaif I don't see a way without modifying the animation logic. As we need to remove the '200%' width set for background image to fix the issue on web. In fact the core logic of the animation is still the same, all I have changed is using scale to position the image instead of setting 200% width and then positioning using negative margin.

We may also try generating adhoc build for this branch for extensive testing on native devices.

aimane-chnaif

Still look for solution without changing animation values

aswin-s · 2024-02-28T10:58:24Z

Still look for solution without changing animation values

@aimane-chnaif Reason the image looks cropped is because of the width:200% style applied to the background image. This was not an issue with SVG images, as the shape will get resized accordingly. But since we migrated to PNG images from SVG the original styles and animation values will not work as such. That's why we need to modify the animation values. Using scale instead of width will allow us to zoom the image from centre of image rather than from edge.

Also note that the issue is not limited to Task page but all reports. Have a look at the attached video where I have explained this visually.

Screen.Recording.2024-02-28.at.4_out.mp4

I've tested the current version on multiple resolutions and devices and couldn't find any issues.

aimane-chnaif · 2024-03-18T03:54:20Z

@aswin-s please merge main. I will retest and see if any issues with that approach.

aswin-s · 2024-03-18T04:55:31Z

@aimane-chnaif merged main

aimane-chnaif · 2024-03-19T13:44:35Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

android1.mp4

android2.mp4

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif · 2024-03-19T13:45:10Z

@deetergp can you please generate adhoc build?

aimane-chnaif · 2024-03-19T14:25:28Z

@aswin-s tested on this branch but still reproducible to me

aimane-chnaif · 2024-03-19T14:38:41Z

Can we also fix this?

bug.mp4

aswin-s · 2024-03-19T14:56:43Z

@aimane-chnaif Fixed both issues. I've clamped translateY value so that the image vertical offset wouldn't go beyond the specified bounds.

fix_out.mp4

Typescript checks seems to be failing. But it is unrelated to current PR.

aimane-chnaif · 2024-03-19T15:16:49Z

Typescript checks seems to be failing. But it is unrelated to current PR.

@aswin-s please merge main. It's fixed now

aswin-s · 2024-03-19T15:31:46Z

@aimane-chnaif Done!

aimane-chnaif · 2024-03-19T16:50:43Z

src/pages/home/report/ReportActionItem.tsx

@@ -668,7 +668,7 @@ function ReportActionItem({
            const isReversedTransaction = ReportActionsUtils.isReversedTransaction(parentReportAction);
            if (ReportActionsUtils.isDeletedParentAction(parentReportAction) || isReversedTransaction) {
                return (
-                    <View style={[StyleUtils.getReportWelcomeContainerStyle(isSmallScreenWidth, true), styles.justifyContentEnd]}>
+                    <View>


Please add test case for this change

aimane-chnaif

Please add test cases and test all affected pages where AnimatedEmptyStateBackground is used:

reversed/deleted transaction
task view
deleted task view
money report view
money request view
normal chat
thread

Tip: search for all usages of <AnimatedEmptyStateBackground

This PR cannot be simply approved without testing above on all platforms

aimane-chnaif · 2024-03-20T23:59:15Z

@aswin-s bump ^

aswin-s · 2024-03-22T15:41:58Z

@aimane-chnaif Sorry for the hold up. I had to take time and retest all the scenarios on all the platforms.
I've tested below report types on all platforms and everything looks good. I've updated the testcases as well.

Regular chats
Threads
Archived Chats
Workspace Chats
Money Requests
Failed Receipts
Task Reports ( New, Active & Deleted )

aimane-chnaif · 2024-03-22T15:47:39Z

@deetergp all yours

melvin-bot · 2024-03-22T21:41:14Z

@deetergp looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-03-22T21:46:48Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

aswin-s added 5 commits February 7, 2024 07:55

fix: animated background getting cropped on android

9ff4961

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

8122391

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

cd340a8

fix: action item taking extra space

e623767

fix: clean lint

eaa7e04

aswin-s marked this pull request as ready for review February 9, 2024 17:49

aswin-s requested a review from a team as a code owner February 9, 2024 17:49

melvin-bot bot requested review from aimane-chnaif and removed request for a team February 9, 2024 17:50

aimane-chnaif reviewed Feb 11, 2024

View reviewed changes

fix: background image horizontal shift on sensor value change

e6e18f6

aswin-s requested a review from aimane-chnaif February 12, 2024 00:23

refactor: move image offset values outside of component

977512b

aimane-chnaif reviewed Feb 12, 2024

View reviewed changes

aswin-s added 3 commits February 13, 2024 07:42

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

deee8d4

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

1a076af

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

5ab88ef

aswin-s requested a review from aimane-chnaif February 16, 2024 06:17

aimane-chnaif suggested changes Feb 27, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

310d81f

aswin-s added 2 commits March 19, 2024 20:01

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

c0f2995

fix: extra space among report action items

e7902fe

fix: clamp translateY value

4cb39ce

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

d9fec75

aimane-chnaif reviewed Mar 19, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into fix/issue-33922

33bcc45

aimane-chnaif approved these changes Mar 22, 2024

View reviewed changes

deetergp approved these changes Mar 22, 2024

View reviewed changes

deetergp merged commit 570a001 into Expensify:main Mar 22, 2024
16 checks passed

melvin-bot bot added the Emergency label Mar 22, 2024

deetergp removed the Emergency label Mar 22, 2024

aimane-chnaif mentioned this pull request Mar 27, 2024

[C+ Checklist Needs Completion] [$500] Android - Task - Background image in task report appears cropped after cancelling the task #33922

Closed

6 tasks

github-actions bot mentioned this pull request Mar 27, 2024

Deploy Checklist: New Expensify 2024-03-27 #39033

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: task background image getting cropped #36261

fix: task background image getting cropped #36261

aswin-s commented Feb 9, 2024 •

edited

Loading

melvin-bot bot commented Feb 9, 2024

aimane-chnaif Feb 11, 2024

aimane-chnaif Feb 11, 2024

aswin-s Feb 12, 2024

aimane-chnaif Feb 12, 2024

aimane-chnaif Feb 12, 2024

aswin-s Feb 13, 2024

aswin-s Feb 13, 2024

aimane-chnaif Feb 14, 2024

staszekscp Feb 14, 2024

aimane-chnaif Feb 14, 2024

aswin-s Feb 16, 2024

aimane-chnaif left a comment

aswin-s commented Feb 28, 2024

aimane-chnaif commented Mar 18, 2024

aswin-s commented Mar 18, 2024 •

edited

Loading

aimane-chnaif commented Mar 19, 2024 •

edited

Loading

aimane-chnaif commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aswin-s commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aswin-s commented Mar 19, 2024

aimane-chnaif Mar 19, 2024

aimane-chnaif left a comment

aimane-chnaif commented Mar 20, 2024

aswin-s commented Mar 22, 2024

aimane-chnaif commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

OSBotify commented Mar 22, 2024

fix: task background image getting cropped #36261

fix: task background image getting cropped #36261

Conversation

aswin-s commented Feb 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

aswin-s commented Feb 28, 2024

aimane-chnaif commented Mar 18, 2024

aswin-s commented Mar 18, 2024 • edited Loading

aimane-chnaif commented Mar 19, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aswin-s commented Mar 19, 2024

aimane-chnaif commented Mar 19, 2024

aswin-s commented Mar 19, 2024

Choose a reason for hiding this comment

aimane-chnaif left a comment

Choose a reason for hiding this comment

aimane-chnaif commented Mar 20, 2024

aswin-s commented Mar 22, 2024

aimane-chnaif commented Mar 22, 2024

melvin-bot bot commented Mar 22, 2024

OSBotify commented Mar 22, 2024

aswin-s commented Feb 9, 2024 •

edited

Loading

aswin-s commented Mar 18, 2024 •

edited

Loading

aimane-chnaif commented Mar 19, 2024 •

edited

Loading