Fix pdf blinks when open it by bernhardoj · Pull Request #42333 · Expensify/App

bernhardoj · 2024-05-17T04:38:27Z

Details

The blink happens because we change the component tree when the pdf loads completes which will recreate the pdf component again. This PR fix it.

Fixed Issues

$ #42103
PROPOSAL: #42103 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisite: send a pdf attachment

Open the chat with the pdf attachment
Press the pdf preview to open the attachment
Verify the pdf doesn't blink

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-05-17.at.12.37.49.mov

Android: mWeb Chrome

Screen.Recording.2024-05-17.at.12.34.02.mov

iOS: Native

Screen.Recording.2024-05-17.at.12.32.22.mov

iOS: mWeb Safari

Screen.Recording.2024-05-17.at.12.30.50.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-17.at.12.29.54.mov

MacOS: Desktop

Screen.Recording.2024-05-17.at.12.30.14.mov

melvin-bot · 2024-05-17T04:38:31Z

@mananjadhav 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 · 2024-05-17T05:19:30Z

@mananjadhav I tested a multi-page PDF and I can't scroll it on Android, basically this PR will reraise #20867 again. #20867 is the one that causes our issue here. The root cause is explained on the proposal there, but in short, it's because our Pressable component when disabled doesn't really disable the Pressable, but just pass an undefined event handler to it.

App/src/components/Pressable/GenericPressable/BaseGenericPressable.tsx

Lines 139 to 143 in e8ae3c5

    
           onPress={!isDisabled ? singleExecution(onPressHandler) : undefined} 
        
           onLongPress={!isDisabled && onLongPress ? onLongPressHandler : undefined} 
        
           onKeyDown={!isDisabled ? onKeyDown : undefined} 
        
           onPressIn={!isDisabled ? onPressIn : undefined} 
        
           onPressOut={!isDisabled ? onPressOut : undefined}

I think to solve both issues, we should have a new prop for Pressable called something like, fullDisabled and use it to set the disabled props of BaseGenericPressable. What do you think?

mananjadhav · 2024-05-19T17:19:49Z

when disabled doesn't really disable the Pressable, but just pass an undefined event handler to it.

@bernhardoj I don't completely follow what you mean? You mean in our PR or the props in general? I am not sure if we really need fullDisabled. Can you rephrase what you mean? May be we can then come up with an alternative.

cc - @blimpich

bernhardoj · 2024-05-20T08:56:22Z

@mananjadhav that's how the disabled props of our custom Pressable currently works as shown in this code.

App/src/components/Pressable/GenericPressable/BaseGenericPressable.tsx

Lines 139 to 143 in e8ae3c5

    
           onPress={!isDisabled ? singleExecution(onPressHandler) : undefined} 
        
           onLongPress={!isDisabled && onLongPress ? onLongPressHandler : undefined} 
        
           onKeyDown={!isDisabled ? onKeyDown : undefined} 
        
           onPressIn={!isDisabled ? onPressIn : undefined} 
        
           onPressOut={!isDisabled ? onPressOut : undefined}

There is no disabled={disabled}. We are just passing an undefined callback, so the pressable responder is still working. The only way to disable the responder is by setting the RN Pressable disabled to true.

mananjadhav · 2024-05-20T18:20:54Z

and what happens if we actually add disabled: true in here.

App/src/components/Pressable/GenericPressable/index.native.tsx

Lines 9 to 12 in e8ae3c5

    
           focusable 
        
           accessible 
        
           accessibilityHint={props.accessibilityHint ?? props.accessibilityLabel} 
        
           // eslint-disable-next-line react/jsx-props-no-spreading

bernhardoj · 2024-05-21T02:43:58Z

It will still be the same since we take out the disabled props from the ...rest props.

App/src/components/Pressable/GenericPressable/BaseGenericPressable.tsx

Lines 22 to 38 in e8ae3c5

    
           disabled, 
        
           style, 
        
           disabledStyle = {}, 
        
           hoverStyle = {}, 
        
           focusStyle = {}, 
        
           pressStyle = {}, 
        
           screenReaderActiveStyle = {}, 
        
           shouldUseHapticsOnLongPress = true, 
        
           shouldUseHapticsOnPress = false, 
        
           nextFocusRef, 
        
           keyboardShortcut, 
        
           shouldUseAutoHitSlop = false, 
        
           enableInScreenReaderStates = CONST.SCREEN_READER_STATES.ALL, 
        
           onPressIn, 
        
           onPressOut, 
        
           accessible = true, 
        
           ...rest

mananjadhav · 2024-05-21T04:23:20Z

Okay I am okay having a fullDisabled prop. @blimpich Any thoughts?

blimpich · 2024-05-21T17:10:10Z

Fine by me 👍

mananjadhav · 2024-05-21T22:51:00Z

@bernhardoj Can we work on the fix?

bernhardoj · 2024-05-22T02:47:26Z

@mananjadhav updated

mananjadhav · 2024-05-22T16:44:46Z

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

android-pdf-blink.mov

Android: mWeb Chrome

mweb-chrome-pdf-blink.mov

iOS: Native

ios-pdf-blink.mov

iOS: mWeb Safari

mweb-safari-pdf-blink.mov

MacOS: Chrome / Safari

web-pdf-blink.mov

MacOS: Desktop

desktop-pdf-blink.mov

blimpich

LGTM! Waiting on merge freeze to end to merge.

OSBotify · 2024-05-23T23:52:45Z

✋ 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 · 2024-05-27T14:25:56Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.4.76-0 🚀

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

OSBotify · 2024-05-29T09:18:37Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.76-7 🚀

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

hannojg · 2024-06-25T09:58:04Z

I don't understand why we manually disable the on* events manually. If we'd just pass along the disabled prop, the gesture responder would be deactivate and none of the callbacks would fire 🤔
That seems way simpler than turning off everything manually + adding additional props such as "fullDisabled" ?

bernhardoj · 2024-06-25T10:30:35Z

@hannojg I don't have full context on why we do that, but one thing that I can guess is that if we use disabled prop of the Pressable, Tooltip wrapped on a Pressable won't work anymore because the onMouse* event is now disabled which the Tooltip rely on.

fix pdf blinks

3181213

bernhardoj requested a review from a team as a code owner May 17, 2024 04:38

melvin-bot Bot removed the request for review from a team May 17, 2024 04:38

melvin-bot Bot requested a review from mananjadhav May 17, 2024 04:38

mananjadhav mentioned this pull request May 19, 2024

[HOLD for payment 2024-06-05] [$250] Chat - PDF file blinks when open it #42103

Closed

1 of 6 tasks

add fullDisabled prop to disable the pressable responder

c62bd40

mananjadhav approved these changes May 22, 2024

View reviewed changes

melvin-bot Bot requested a review from blimpich May 22, 2024 16:47

blimpich approved these changes May 22, 2024

View reviewed changes

chiragsalian merged commit d2e6445 into Expensify:main May 23, 2024

github-actions Bot mentioned this pull request May 27, 2024

Deploy Checklist: New Expensify 2024-05-27 #42636

Closed

69 tasks done

Conversation

bernhardoj commented May 17, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented May 17, 2024

Uh oh!

bernhardoj commented May 17, 2024

Uh oh!

mananjadhav commented May 19, 2024

Uh oh!

bernhardoj commented May 20, 2024

Uh oh!

mananjadhav commented May 20, 2024

Uh oh!

bernhardoj commented May 21, 2024

Uh oh!

mananjadhav commented May 21, 2024

Uh oh!

blimpich commented May 21, 2024

Uh oh!

mananjadhav commented May 21, 2024

Uh oh!

bernhardoj commented May 22, 2024

Uh oh!

mananjadhav commented May 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

blimpich left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented May 23, 2024

Uh oh!

OSBotify commented May 27, 2024

Uh oh!

OSBotify commented May 29, 2024

Uh oh!

hannojg commented Jun 25, 2024

Uh oh!

bernhardoj commented Jun 25, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

mananjadhav commented May 22, 2024 •

edited

Loading