Fix receipt image blink when opening it the first time

[bernhardoj]

Details

The receipt image blinks when we open it the first time because the size is not ready yet and we scale it really big.

Fixed Issues

$ #33625
PROPOSAL: #33625 (comment)

Tests

Same as QA Steps

• Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

1. Create a new scan request to any user
2. Press the IOU preview twice to open the transaction thread
3. Press the receipt image to open the image preview
4. Verify the image shows without any blink

• 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

Android: Native

Screen.Recording.2024-01-03.at.13.09.13.mov

Android: mWeb Chrome

Screen.Recording.2024-01-03.at.13.11.56.mov

iOS: Native

Screen.Recording.2024-01-03.at.13.10.20.mov

iOS: mWeb Safari

Screen.Recording.2024-01-03.at.13.11.43.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-03.at.13.15.13.mov

MacOS: Desktop

Screen.Recording.2024-01-03.at.13.15.35.mov

[melvin-bot]

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

[bernhardoj]

@Ollyws please review when you get the chance 🙇

[Ollyws]

@bernhardoj I still seem to be getting a brief translucent flash on Android. Is this also occuring for you?

Screen.Recording.2024-01-08.at.16.26.04.mov

[bernhardoj]

Hmm, somehow after this PR is merged, the image onLoad is called thrice. First with a smaller size and the second (and third) one with a bigger size. If I tried reverting it locally, everything back to normal

Here is the size comparison before and after the above-linked PR.

Before (no issue):

After (has issue):

(the number after the content size object is the zoom scale)

If we try to calculate the width/height * zoom scale, we actually get a size that fits the screen. The problem here is that the scale size is animated but the image size is not.

So, when we get the new image size, the image is still scaled with the previous zoom scale for a brief moment. In our case, when the image size becomes {height: 5148, width: 2376}, it is still scaled with 0.22031172000665591 instead of 0.14028395846577663.

To overcome this new behavior, I'm thinking of a new solution:
First, we will create a new debounced function of setImageLoaded state (in Lightbox.js).

const debouncedSetImageLoaded = useDebounce(
    useCallback((loaded) => {
        console.log('load ended')
        setImageLoaded(loaded)
    }, []),
    500,
    { maxWait: 1000 }
)

Then, in onLoadEnd, instead of calling setImageLoaded, we call debouncedSetImageLoaded. Next, we apply the opacity style directly to the Image component. If isImageLoaded is false, we set the opacity to 0.

{opacity: isImageLoaded ? 1 : 0}

And we can remove the opacity style from MultiGestureCanvas. With this solution, the image will be shown when the last onLoadEnd callback is called. I use maxWait in case there is a bug where the onLoadEnd is called infinitely.

It works fine so far on my end, can you please test this and let me know whether we should proceed with this new solution or not?

Why do I debounce the onLoadEnd and not onLoad?
The 2nd onLoad will be called only after the image gets the size from the 1st onLoad. So, even if we debounce onLoad, it will be called 3 times. But from my testing, the blink is gone even though the onLoad is called 3 times and maybe it is because each size update is delayed.

[bernhardoj]

@Ollyws let me know your thoughts for the above finding!

[bernhardoj]

@Ollyws bump

[Ollyws]

@bernhardoj Hmmm..debouncing seems like a bit of a work-around, are there any other solutions?

[bernhardoj]

@Ollyws I'm afraid there is nothing much we can do as this is most likely the issue with expo-image which is actually already out of scope from the initial issue.

[Ollyws]

@bernhardoj Ok I suppose we have no choice but to go with the debounce solution then.

[bernhardoj]

do you have any idea what is causing that extra render?

I have no idea.

Ok I suppose we have no choice but to go with the debounce solution then.

Will update it tomorrow.

[bernhardoj]

@Ollyws updated. Please check

[Ollyws]

Thanks for the changes.
It does seem to take significantly longer to load using the debounce:

original.mov

debounced.mov

Is there any way we could improve that?

[bernhardoj]

Yes, that's expected if we use debounce. The image will be delayed at least 500ms (debounce wait time) or a maximum of 1s (max wait). So far, 500ms is a safe value to prevent the multiple onLoad with different sizes being called.

One idea to improve it is to have a ref called hasCache.

const hasCache = useRef(!!cachedDimensions.get(source))

This will indicate whether the image size has been cached or not. If not yet, we will debounce it, otherwise we won't debounce it.

onLoadEnd={() => {
    if (!hasCache.current) {
        debouncedSetImageLoaded(true)
        return;
    }
    setImageLoaded(true)
}}

What do you think?

[Ollyws]

Sounds good to me!

[bernhardoj]

Updated. Please check

[Ollyws]

@marcochavezf Could I get your opinion on this solution.
Another PR changed the behaviour here so we had to go for a different approach using debounce, which introduces a delay on the initial load of the image.
Is this acceptable do you think?

[Ollyws]

It also seems to be causing the perf-tests to fail...

[bernhardoj]

The reassure is unrelated. It fails on the search page. Happens on main.

[Ollyws]

Friendly bump on #33860 (comment) @marcochavezf

[Ollyws]

Still a bit stuck on this one, to be honest I'm not sure the delay on the initial image load is acceptable. Any other ideas @bernhardoj ?

[bernhardoj]

The second issue doesn't seems reproducible anymore on latest main for me. Can you check that too? You can log the contentSize here

App/src/components/Lightbox/index.tsx

Lines 111 to 117 in 668df99

	const updateContentSize = useCallback(
	({nativeEvent: {width, height}}: ImageOnLoadEvent) => {
	if (contentSize !== undefined) {
	return;
	}
	setContentSize({width: width * PixelRatio.get(), height: height * PixelRatio.get()});

[bernhardoj]

@Ollyws bump

[Ollyws]

@bernhardoj Looks like it, I'm only getting two calls here, one where the contentSize is undefined and another with the correct dimensions. Does this mean your original solution will work?

[bernhardoj]

Let me recheck

[bernhardoj]

@Ollyws yes, I retested a few times and the original solution still work.

Please check.

[Ollyws]

Looks good thanks! I'll just do a little more testing and hopefully we'll be good to go.

[Ollyws]

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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

05_MacOS_Chrome.mp4

MacOS: Chrome / Safari

06_MacOS_Desktop.mp4

MacOS: Desktop

iOS_Web.mp4

[Ollyws]

LGTM.

[marcochavezf]

LGTM, thanks guys!

[OSBotify]

🚀 Deployed to staging by https://github.com/marcochavezf in version: 1.4.48-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.48-0 🚀

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