fix: 16528 upload gif image fluctuate #17454

tienifr · 2023-04-14T11:13:22Z

Details

Fixed Issues

$ #16528
PROPOSAL: #16528 (comment)

Tests

The image shouldn’t fluctuate while trying to preview the image

Open web chrome and open any chat and send a message
Click on profile icon and upload a gif image. Crop the image to full.
From the chat, click on your profile picture and preview it.
Verify the image shouldn’t fluctuate

The image shouldn’t be empty when preview the image

Open web chrome and open any chat and send a message
Click on profile icon and upload a large image.
From the chat, click on your profile picture and preview it.
Verify the image shouldn’t be empty

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

The image shouldn’t fluctuate while trying to preview the image

Open web chrome and open any chat and send a message
Click on profile icon and upload a gif image. Crop the image to full.
From the chat, click on your profile picture and preview it.
Verify the image shouldn’t fluctuate

The image shouldn’t be empty when preview the image

Open web chrome and open any chat and send a message
Click on profile icon and upload a large image.
From the chat, click on your profile picture and preview it.
Verify the image shouldn’t be empty

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-14.at.14.54.59.mp4

Mobile Web - Chrome

RPReplay_Final1681470972.mp4

Mobile Web - Safari

RPReplay_Final1681470324.mp4

Desktop

Screen.Recording.2023-04-14.at.18.21.37.mp4

iOS

Screen-Recording-2023-04-14-at-18.48.32.mp4

Android

MelvinBot · 2023-04-14T11:56:38Z

@danieldoglas @eVoloshchak 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]

tienifr · 2023-04-14T11:58:19Z

src/components/ImageView/index.js

@@ -35,7 +35,7 @@ class ImageView extends PureComponent {
        this.trackPointerPosition = this.trackPointerPosition.bind(this);

        this.state = {
-            isLoading: false,
+            isLoading: true,


I want to change this line because it can improve the performance a bit. isLoading is always set to true then false when image is loaded.

Yeah, I agree, it should be set to true initially

Is this ready for testing?

src/components/AttachmentModal.js

eVoloshchak · 2023-04-17T09:41:09Z

src/components/ImageView/index.js

@@ -35,7 +35,7 @@ class ImageView extends PureComponent {
        this.trackPointerPosition = this.trackPointerPosition.bind(this);

        this.state = {
-            isLoading: false,
+            isLoading: true,


Yeah, I agree, it should be set to true initially

eVoloshchak · 2023-04-17T09:42:22Z

src/styles/StyleUtils.js

@@ -196,14 +196,12 @@ function getZoomCursorStyle(isZoomed, isDragging) {
 * @param {Number} zoomScale
 * @param {Number} containerHeight
 * @param {Number} containerWidth
- * @return {Object}
+ * @param {Boolean} isLoading
+ * @return {Object | undefined}


According to our style guide:

Do not use type unions e.g. {(number|boolean)}.

Thanks @eVoloshchak . I know but I still see other place use type unions:

App/src/styles/StyleUtils.js

Line 396 in 74d5290

* @param {Number | null} height

.
I don't actually know the best way to do here. What is your thought?

Ok, I think it's acceptable in this case

src/pages/DetailsPage.js

eVoloshchak · 2023-04-17T11:52:06Z

src/styles/StyleUtils.js

@@ -196,14 +196,12 @@ function getZoomCursorStyle(isZoomed, isDragging) {
 * @param {Number} zoomScale
 * @param {Number} containerHeight
 * @param {Number} containerWidth
- * @return {Object}
+ * @param {Boolean} isLoading
+ * @return {Object | undefined}


Ok, I think it's acceptable in this case

eVoloshchak · 2023-04-17T11:52:17Z

src/styles/StyleUtils.js

@@ -196,14 +196,12 @@ function getZoomCursorStyle(isZoomed, isDragging) {
 * @param {Number} zoomScale
 * @param {Number} containerHeight
 * @param {Number} containerWidth
- * @return {Object}
+ * @param {Boolean} isLoading
+ * @return {Object | undefined}


Suggested change

* @return {Object | undefined}

* @returns {Object | null}

eVoloshchak · 2023-04-17T11:53:07Z

src/styles/StyleUtils.js

-            width: isZoomed ? '250%' : '100%',
-        };
+function getZoomSizingStyle(isZoomed, imgWidth, imgHeight, zoomScale, containerHeight, containerWidth, isLoading) {
+    if (isLoading || imgWidth === 0 || imgHeight === 0) {


Suggested change

if (isLoading || imgWidth === 0 || imgHeight === 0) {

// Hide image until finished loading to prevent showing preview with wrong dimensions

if (isLoading || imgWidth === 0 || imgHeight === 0) {

eVoloshchak · 2023-04-17T11:53:32Z

src/libs/actions/PersonalDetails.js

@@ -289,11 +289,13 @@ function updateAvatar(file) {
            [currentUserEmail]: {
                avatar: file.uri,
                avatarThumbnail: file.uri,
+                avatarFileName: file.name,


Suggested change

avatarFileName: file.name,

originalFileName: file.name,

eVoloshchak · 2023-04-17T11:53:37Z

src/libs/actions/PersonalDetails.js

                errorFields: {
                    avatar: null,
                },
                pendingFields: {
                    avatar: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
+                    avatarFileName: null,


Suggested change

avatarFileName: null,

originalFileName: null,

eVoloshchak · 2023-04-17T11:53:48Z

src/pages/DetailsPage.js

@@ -130,6 +130,7 @@ class DetailsPage extends React.PureComponent {
                                        headerTitle={isSMSLogin ? this.props.toLocalPhone(details.displayName) : details.displayName}
                                        source={ReportUtils.getFullSizeAvatar(details.avatar, details.login)}
                                        isAuthTokenRequired
+                                        originalFileName={details.avatarFileName}


Suggested change

originalFileName={details.avatarFileName}

originalFileName={details.originalFileName}

tienifr · 2023-04-17T15:36:49Z

@eVoloshchak Thanks for your review. I've updated my PR, but just one minor question. Why do you suggest change @returns {Object | null} instead of @returns {Object | undefined}? I agree with using @returns but I'm not sure we want to return null here 😆 😁

eVoloshchak · 2023-04-17T15:48:14Z

@eVoloshchak Thanks for your review. I've updated my PR, but just one minor question. Why do you suggest change @returns {Object | null} instead of @returns {Object | undefined}? I agree with using @returns but I'm not sure we want to return null here 😆 😁

It's just easier to read. If that causes problems - I'm perfectly fine with undefined

tienifr · 2023-04-18T02:27:05Z

@eVoloshchak ok thanks, any updates?

tienifr · 2023-04-18T07:44:48Z

@eVoloshchak Yes, it's ready for testing

eVoloshchak · 2023-04-18T11:21:07Z

src/styles/StyleUtils.js

+function getZoomSizingStyle(isZoomed, imgWidth, imgHeight, zoomScale, containerHeight, containerWidth, isLoading) {
+    // Hide image until finished loading to prevent showing preview with wrong dimensions
+    if (isLoading || imgWidth === 0 || imgHeight === 0) {
+        return undefined;


Suggested change

return undefined;

return null;

Or if we have to return undefined, change jsdoc to * @returns {Object | undefined}

@eVoloshchak I prefer using undefined. I tested all platforms with undefined and I believe it works well. And changing @returns {Object | undefined} is good. Thanks

tienifr · 2023-04-19T02:59:15Z

@eVoloshchak I think all comments are resolved, can you help test. Thanks

eVoloshchak

This is looking good, tests well on web/Desktop/mWeb
I've encountered a couple of problems in native apps
Android: I'm unable to upload gif as user avatar, get unhandled promise rejection
iOS: getting the following prop type warning when opening user's avatar from chat

Safari mobile: endless loading spinner if you view image after uploading

IMG_0027.MP4

tienifr · 2023-04-20T03:32:45Z

@eVoloshchak Do these bug happens on main?

tienifr · 2023-04-20T03:33:49Z

actually, we don't need to use the gif, the image is enough

eVoloshchak · 2023-04-20T16:52:20Z

@eVoloshchak Do these bug happens on main?

Can't reproduce the bug with an endless loading spinner in Safari, I think it was resolved in main.

But I can verify that propTypes warning is caused by this PR, it's not present in main.
This tests well for me, so when we sort the warning out, please upload the missing video for Android, merge main once again, and I'll be able to do the final review

eVoloshchak

@tienifr, there is still a propType warning on iOS when opening user's avatar from chat

And please add a screen recording for Android

tienifr · 2023-04-21T10:23:25Z

@eVoloshchak I've updated my PR to fix the console warning. Please help take a look

tienifr · 2023-04-21T10:25:23Z

@eVoloshchak I see the problem when I record the video for android. The endless loading spinner is shown when I open user's avatar from chat

tienifr · 2023-04-21T12:18:20Z

Screen.Recording.2023-04-21.at.19.16.14.mov

This bug still happens on main

eVoloshchak · 2023-04-21T13:02:27Z

This bug still happens on main

Can also reproduce this on main. Could you report this in slack, please?

eVoloshchak · 2023-04-21T13:02:52Z

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

Screen.Recording.2023-04-27.at.00.48.58.mov

Mobile Web - Chrome

Screen_Recording_20230426-212828_Chrome.mp4

Screen_Recording_20230426-212754_Chrome.mp4

Mobile Web - Safari

IMG_0040.MP4

Desktop

Screen.Recording.2023-04-27.at.00.49.51.mov

iOS

IMG_0043.MP4

Android

Screen_Recording_20230427-003613_New.Expensify.mp4

Screen_Recording_20230427-003929_New.Expensify.mp4

eVoloshchak · 2023-04-21T13:42:26Z

@tienifr, I'm still getting the bug with endless spinner in Safari after uploading a large image

Screen.Recording.2023-04-21.at.16.40.46.mov

Here's how it looks without this PR

Screen.Recording.2023-04-21.at.16.39.51.mov

tienifr · 2023-04-24T10:12:33Z

original-30F2EFCF-D0BA-46DE-8716-FCEC6B11D93F.mp4

@eVoloshchak I can't reproduce on physical device. Should we test on physical device?

tienifr · 2023-04-24T10:30:33Z

I reported the endless spinner bug on android: https://expensify.slack.com/archives/C049HHMV9SM/p1682331646153809

eVoloshchak · 2023-04-24T13:02:18Z

I can't reproduce on physical device. Should we test on physical device?

I can reproduce it on a physical device.
The key here is to open the image before it was uploaded (on your video it flashes grey at 0:18, meaning it was uploaded before you opened it). It's much easier to reproduce using the network link conditioner

tienifr · 2023-04-25T10:15:50Z

@eVoloshchak I found this issue happens even on main

Screen.Recording.2023-04-25.at.16.29.46.mp4

When I try to upload image on small screen, the api UpdateUserAvatar call too many times because the API is error => the image is still blob:http://localhost:8080/<<id>>

As usual, the uri blob:http://localhost:8080/<<id>> should render the image but in this commit:

2f8f93d#diff-5d4cb2a76afdf22bdefb20480e5a8267efdfb76629f06d2e9562be8ff7c0d618

We add isAuthTokenRequired in src/components/AttachmentView.js: <ImageView url={props.source} isAuthTokenRequired={props.isAuthTokenRequired} /> => isAuthTokenRequired is always true. When the uri is blob:http://localhost:8080/<<id>> the isAuthTokenRequired should be false

tienifr · 2023-04-25T10:17:34Z

@eVoloshchak What do you think? Should we handle it on other PR?

tienifr · 2023-04-25T12:28:19Z

Here is the bug report: https://expensify.slack.com/archives/C049HHMV9SM/p1682425619771099

eVoloshchak · 2023-04-25T15:10:42Z

Awesome job investigating this!
I think it should be handled as a separate issue, but it might be worth putting this on HOLD until we merge that PR, since an endless loading spinner is worse than an empty attachment we currently have.

@danieldoglas, could you chime in on this please?
We have an issue that got surfaced by this PR, should we

Fix it in a separate issue after merging this PR
Put this PR on hold, resolve the issue, then merge this PR
Fix this as a part of this PR

danieldoglas · 2023-04-25T18:42:23Z

Let's fix it as part of this PR, I'll increase the bounty for the original issue since we're fixing 2 bugs.

tienifr · 2023-04-26T13:58:34Z

@eVoloshchak I've updated my PR can you help review again? Thanks

eVoloshchak · 2023-04-26T18:33:16Z

@tienifr, awesome, the issue on mWeb is resolved
I did, however, encounter a similar issue on Android, I think it wasn't present before

Screen_Recording_20230426-213041_New.Expensify.mp4

tienifr · 2023-04-26T18:35:37Z

@eVoloshchak I think it's the bug on android that I reported before?

eVoloshchak · 2023-04-26T18:39:16Z

@eVoloshchak I think it's the bug on android that I reported before?

My bad, totally forgot about that, thanks for the reminder
Will finish the checklist in a couple of hours

eVoloshchak

LGTM!
cc: @danieldoglas

OSBotify · 2023-04-26T22:12:58Z

✋ 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 · 2023-04-27T05:36:25Z

🚀 Deployed to staging by https://github.com/danieldoglas in version: 1.3.7-0 🚀

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

OSBotify · 2023-04-28T07:51:52Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.7-3 🚀

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

tienifr added 2 commits April 14, 2023 15:09

fix: 16528 upload gif image fluctuate

8282225

fix: improve code

db6cfbf

tienifr marked this pull request as ready for review April 14, 2023 11:56

tienifr requested a review from a team as a code owner April 14, 2023 11:56

melvin-bot bot requested review from danieldoglas and eVoloshchak and removed request for a team April 14, 2023 11:56

tienifr commented Apr 14, 2023

View reviewed changes

tienifr mentioned this pull request Apr 14, 2023

[HOLD for payment 2023-05-05] [$2000] Uploading gif image seems to fluctuate the image while previewing it immediately after uploading #16528

Closed

6 tasks

eVoloshchak suggested changes Apr 17, 2023

View reviewed changes

fix: remove filename

b05be87

eVoloshchak suggested changes Apr 17, 2023

View reviewed changes

fix: change avatarFileName to originalFileName

ef16bed

eVoloshchak reviewed Apr 18, 2023

View reviewed changes

fix: change returns type

92b60d7

eVoloshchak reviewed Apr 19, 2023

View reviewed changes

fix: merge main

ed4470a

eVoloshchak reviewed Apr 21, 2023

View reviewed changes

fix: error type

40bc8b0

Merge branch 'main' into fix/16528-uploading-gif-image-fluctuate

2e06be8

tienifr added 2 commits April 26, 2023 20:51

fix: disable auth token for local image

63e7599

fix: merge main

19780e8

eVoloshchak approved these changes Apr 26, 2023

View reviewed changes

danieldoglas approved these changes Apr 26, 2023

View reviewed changes

danieldoglas merged commit 9ec7704 into Expensify:main Apr 26, 2023

OSBotify mentioned this pull request Apr 27, 2023

Deploy Checklist: New Expensify 2023-04-27 #18063

Closed

19 tasks

eVoloshchak mentioned this pull request May 9, 2023

Add feature to view Profile Picture in full screen #8483

Merged

88 tasks

eVoloshchak mentioned this pull request May 31, 2023

Fix: Attachment Carousel not displaying images from Concierge #19724

Merged

55 tasks

	if (isLoading \|\| imgWidth === 0 \|\| imgHeight === 0) {
	// Hide image until finished loading to prevent showing preview with wrong dimensions
	if (isLoading \|\| imgWidth === 0 \|\| imgHeight === 0) {

	originalFileName={details.avatarFileName}
	originalFileName={details.originalFileName}

fix: 16528 upload gif image fluctuate #17454

fix: 16528 upload gif image fluctuate #17454

Conversation

tienifr commented Apr 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 14, 2023

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr commented Apr 17, 2023

eVoloshchak commented Apr 17, 2023

tienifr commented Apr 18, 2023 • edited Loading

tienifr commented Apr 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr commented Apr 19, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

tienifr commented Apr 20, 2023

tienifr commented Apr 20, 2023

eVoloshchak commented Apr 20, 2023 • edited Loading

eVoloshchak left a comment

Choose a reason for hiding this comment

tienifr commented Apr 21, 2023

tienifr commented Apr 21, 2023

tienifr commented Apr 21, 2023

eVoloshchak commented Apr 21, 2023

eVoloshchak commented Apr 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak commented Apr 21, 2023

tienifr commented Apr 24, 2023

tienifr commented Apr 24, 2023

eVoloshchak commented Apr 24, 2023 • edited Loading

tienifr commented Apr 25, 2023

tienifr commented Apr 25, 2023

tienifr commented Apr 25, 2023

eVoloshchak commented Apr 25, 2023

danieldoglas commented Apr 25, 2023

tienifr commented Apr 26, 2023

eVoloshchak commented Apr 26, 2023

tienifr commented Apr 26, 2023 • edited Loading

eVoloshchak commented Apr 26, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 26, 2023

OSBotify commented Apr 27, 2023

OSBotify commented Apr 28, 2023

tienifr commented Apr 14, 2023 •

edited

Loading

tienifr commented Apr 18, 2023 •

edited

Loading

eVoloshchak commented Apr 20, 2023 •

edited

Loading

eVoloshchak commented Apr 21, 2023 •

edited

Loading

eVoloshchak commented Apr 24, 2023 •

edited

Loading

tienifr commented Apr 26, 2023 •

edited

Loading