fix: blank space for corrupt files preview by abdel-h66 · Pull Request #29692 · Expensify/App

abdel-h66 · 2023-10-16T16:59:57Z

Details

Fixed Issues

$ #27292
PROPOSAL: #27292 (comment)

Tests

Verify that no errors appear in the JS console

Open any chat
Add the following PDF as an attachment (https://github.com/Expensify/App/files/12919474/QA.Expensify.Issue.27292.pdf)
Verify that Failed to load PDF file. message appears after uploading a corrupt PDF file

QA Expensify-corrupt.pdf

Offline tests

QA Steps

Verify that no errors appear in the JS console

Open any chat
Add the following PDF as an attachment (https://github.com/Expensify/App/files/12919474/QA.Expensify.Issue.27292.pdf)
Verify that Failed to load PDF file. message appears after uploading a corrupt PDF file

PR Author Checklist

Screenshots/Videos

Android: Native

android-native.mp4

Android: mWeb Chrome

android-chrome.mp4

iOS: Native

ios-native.mp4

iOS: mWeb Safari

ios-safari.mp4

MacOS: Chrome / Safari

web-chrome.mp4

MacOS: Desktop

desktop-native.mp4

melvin-bot · 2023-10-16T17:04:04Z

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

eVoloshchak · 2023-10-16T18:16:54Z

@abdel-h66, change tests to

Open any chat
Add the following PDF as an attachment (https://github.com/Expensify/App/files/12919474/QA.Expensify.Issue.27292.pdf)
Verify that Failed to load PDF file. message appears after uploading a corrupt PDF file

eVoloshchak · 2023-10-16T18:10:13Z

Suggested change

isAttachmentModal

isUsedInAttachmentModal

eVoloshchak · 2023-10-16T18:15:24Z

We can simplify this and forego the need for the new PDFPreviewError component

Instead of passing isAttachmentModal prop, we'll just pass errorLabelStyles

errorLabelStyles={isUsedInAttachmentModal && [styles.textLabel, styles.textLarge]}

And then in PDFView.index/index.native.js, we use those styles directly

error={<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

eVoloshchak · 2023-10-16T18:17:46Z

One more thing, when you hover over the error message, the text background is the wrong color

abdel-h66 · 2023-10-17T07:37:18Z

Do you think the background should have a color ? or none at all :) ?

eVoloshchak · 2023-10-17T07:50:31Z

Do you think the background should have a color ? or none at all :) ?

The text shouldn't have a separate background color, it should look like this when the message is hovered over

Screen.Recording.2023-10-17.at.09.49.23.mov

abdel-h66 · 2023-10-17T18:52:57Z

Removed this one here, it's only used in the touched component on desktop, and does not really add anything. This was the one causing the weird background on hover.

abdel-h66 · 2023-10-17T18:54:06Z

I had to add cusrorAuto, because I'm not sure if you have noticed, but the text is still clickable to download the PDF, since the PDF is not corrupt, it's just the preview that is corrupt, I was even thinking that we might another way to do this.

eVoloshchak · 2023-10-17T19:47:26Z

Suggested change

errorLabelStyles: PropTypes.arrayOf(PropTypes.object),

errorLabelStyles: stylePropTypes,

in both files errorLabelStyles prop type needs a comment explaining what it's used for

eVoloshchak · 2023-10-17T19:47:53Z

Suggested change

errorLabelStyles={isUsedInAttachmentModal ? [styles.textLabel, styles.textLarge] : []}

errorLabelStyles={isUsedInAttachmentModal && [styles.textLabel, styles.textLarge]}

This will send a boolean down. Id rather limit the leakage here. What do you think. ?

I think it's fine as long as we have a defaultProps, it'll be replaced with []

eVoloshchak · 2023-10-17T19:48:36Z

Suggested change

errorLabelStyles: PropTypes.arrayOf(PropTypes.object),

errorLabelStyles: stylePropTypes,

eVoloshchak

pull the latest main
there is a crash when you try to send an attachment

Screen.Recording.2023-10-18.at.10.22.37.mov

abdel-h66 · 2023-10-18T10:51:04Z

I have fixed the above issue, it was due to style not being passed down in the correct type. Codebases with no typing are a little tricky to work with 😞

pdf-ios-native.mp4

pdf-web-chrome.mp4

abdel-h66 · 2023-10-18T10:52:28Z

I also noticed that on main, deleting an attachment will cause a crash. I confirmed that the issue happens on staging as well.

eVoloshchak · 2023-10-18T12:44:40Z

Shouldn't we add cursor.cursorAuto only if isUsedInAttachmentModal=true?

Yes we could, I was thinking maybe we can omit the whole Text change thing, and stick with only the small size text for both cases. that will remove so much overhead. what do you think. ?

I don't think it's that much overhead, ideally, we should retain the current design

eVoloshchak · 2023-10-18T12:44:53Z

Suggested change

error={<Text style={[...errorLabelStyles, cursor.cursorAuto]}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

error={<Text style={[...this.props.errorLabelStyles, cursor.cursorAuto]}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

I have the errorLabelStyles defined at line 275 🤔

Is in necessary? I think we can just use this.props.errorLabelStyles directly

error={<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

From the proptype, PropTypes.oneOfType([PropTypes.object, PropTypes.arrayOf(PropTypes.object), PropTypes.func]) . I know in our case we are passing an array, but there will be no linter errors if a single object is passed down. I will just keep this as a guard.

This will work correctly even if we pass styles as a single object
The previous crash was due to nested arrays, it won't happen if we pass a single object

Sure, it should be up-to-date now.

eVoloshchak · 2023-10-18T12:45:09Z

Suggested change

<Text style={errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>

<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>

eVoloshchak · 2023-10-18T12:46:31Z

Suggested change

/** Array of styles for error label */

/** Styles for the error label */

eVoloshchak · 2023-10-19T12:15:07Z

Suggested change

/** Array of styles for error label */

/** Styles for the error label */

Same thing here

eVoloshchak · 2023-10-19T12:15:34Z

Linter error

eVoloshchak · 2023-10-19T12:15:59Z

Suggested change

error={<Text style={errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

error={<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

eVoloshchak · 2023-10-19T16:53:28Z

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(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 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 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-10-23.at.12.36.56.mov

Mobile Web - Chrome

screen-20231023-123514.mp4

Mobile Web - Safari

Screen.Recording.2023-10-23.at.12.36.19.mov

Desktop

Screen.Recording.2023-10-23.at.12.38.21.mov

iOS

Screen.Recording.2023-10-23.at.12.31.41.mov

Android

screen-20231023-123359.mp4

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

eVoloshchak · 2023-10-19T17:30:45Z

Bug on native platforms (iOS and Android)
PDF preview flashes white for a moment before displaying the error

Screen.Recording.2023-10-19.at.19.24.33.mov

abdel-h66 · 2023-10-19T17:36:10Z

Could not replicate this one, I could see the loading after the upload. But not on this screen.

eVoloshchak · 2023-10-19T17:51:38Z

Could not replicate this one

It's 100% reproducible for me, both iOS and Android

screen-20231019-194906.mp4

I could see the loading after the upload. But not on this screen.

Are you experiencing this issue?

abdel-h66 · 2023-10-20T07:51:09Z

Yes I only experience the loading animation that you mentioned in the issue. I think the flashing could be due to the background we removed, I believe now that the background was added there to cover up on this one.

eVoloshchak · 2023-10-20T10:23:39Z

Yup, flashing is caused by removal of backgroundColor from imageModalPDF styles
I think this can be resolved by passing styles to AttachmentViewPdf from AttachmentView

style={isUsedInAttachmentModal ? styles.imageModalPDF : styles.flex1}

I did some testing and it seems to resolve the issue, but please verify this is working and doesn't introduce new regressions

abdel-h66 · 2023-10-22T11:10:52Z

Your solution seems to be good, here are some screen recordings after the change.

iOS native

https://github.com/Expensify/App/assets/144037189/e2cb4a7a-102a-4839-8703-eb807f5ead9c

macOS chrome

macos-chrome.mp4

eVoloshchak · 2023-10-23T09:30:40Z

@abdel-h66, this introduces a bug on iOS/Android
Full-screen loading spinner when you enter a chat with a corrupt PDF or after you upload a corrupt PDF

Screen.Recording.2023-10-23.at.11.14.25.mov

abdel-h66 · 2023-10-23T09:43:48Z

That looks like an existing behavior, I could see that on main as well. not sure if we can address it here.

eVoloshchak

LGTM

OSBotify · 2023-10-23T18:15:17Z

✋ 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-10-24T01:59:56Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.90-0 🚀

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

OSBotify · 2023-10-25T16:36:50Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.90-2 🚀

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

OSBotify · 2023-10-25T17:01:38Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:43:39Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch 2 times, most recently from c33a90e to 1e386eb Compare October 16, 2023 17:02

abdel-h66 marked this pull request as ready for review October 16, 2023 17:03

abdel-h66 requested a review from a team as a code owner October 16, 2023 17:04

melvin-bot Bot requested review from eVoloshchak and removed request for a team October 16, 2023 17:04

eVoloshchak suggested changes Oct 16, 2023

View reviewed changes

abdel-h66 commented Oct 17, 2023

View reviewed changes

eVoloshchak suggested changes Oct 17, 2023

View reviewed changes

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch from 50e2a9f to 79c2469 Compare October 18, 2023 08:03

eVoloshchak suggested changes Oct 18, 2023

View reviewed changes

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch from 79c2469 to 485dc49 Compare October 18, 2023 10:51

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch 2 times, most recently from 8201199 to 37bf809 Compare October 18, 2023 11:13

eVoloshchak suggested changes Oct 18, 2023

View reviewed changes

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch from 37bf809 to ffb2272 Compare October 19, 2023 08:16

eVoloshchak suggested changes Oct 19, 2023

View reviewed changes

fix: invisible fail to load message

1f0cdd1

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch from ffb2272 to 1f0cdd1 Compare October 19, 2023 15:17

remove: styles validation

1d74b7c

abdel-h66 force-pushed the fix-blank-space-for-corrupt-files-preview branch from 29ed892 to 1d74b7c Compare October 19, 2023 16:37

eVoloshchak reviewed Oct 19, 2023

View reviewed changes

Comment thread src/components/Attachments/AttachmentView/propTypes.js Outdated

fix: typo

578bfa4

Co-authored-by: Eugene Voloshchak <copyreading@gmail.com>

fix: display background not modal to fix flickering

09a3b17

eVoloshchak approved these changes Oct 23, 2023

View reviewed changes

melvin-bot Bot requested a review from joelbettner October 23, 2023 10:41

joelbettner approved these changes Oct 23, 2023

View reviewed changes

joelbettner merged commit 6c54369 into Expensify:main Oct 23, 2023

OSBotify mentioned this pull request Oct 24, 2023

Deploy Checklist: New Expensify 2023-10-24 #30224

Closed

43 tasks

melvin-bot Bot mentioned this pull request Oct 25, 2023

[HOLD for payment 2023-11-01] [$500] Chat - Blank space appears with no preview or error message when corrupted file is sent #27292

Closed

6 tasks

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

0xmiroslav mentioned this pull request Nov 16, 2023

Migrate index.native.js to function component #24615

Merged

58 tasks

	errorLabelStyles: PropTypes.arrayOf(PropTypes.object),
	errorLabelStyles: stylePropTypes,

	errorLabelStyles={isUsedInAttachmentModal ? [styles.textLabel, styles.textLarge] : []}
	errorLabelStyles={isUsedInAttachmentModal && [styles.textLabel, styles.textLarge]}

	error={<Text style={[...errorLabelStyles, cursor.cursorAuto]}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}
	error={<Text style={[...this.props.errorLabelStyles, cursor.cursorAuto]}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

	<Text style={errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>
	<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>

	/** Array of styles for error label */
	/** Styles for the error label */

	error={<Text style={errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}
	error={<Text style={this.props.errorLabelStyles}>{this.props.translate('attachmentView.failedToLoadPDF')}</Text>}

Conversation

abdel-h66 commented Oct 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Oct 16, 2023

Uh oh!

eVoloshchak commented Oct 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eVoloshchak Oct 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eVoloshchak commented Oct 16, 2023

Uh oh!

abdel-h66 commented Oct 17, 2023

Uh oh!

eVoloshchak commented Oct 17, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

abdel-h66 commented Oct 18, 2023

Uh oh!

abdel-h66 commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abdel-h66 commented Oct 16, 2023 •

edited

Loading

eVoloshchak Oct 16, 2023 •

edited

Loading

abdel-h66 commented Oct 18, 2023 •

edited

Loading

eVoloshchak commented Oct 19, 2023 •

edited

Loading

abdel-h66 commented Oct 22, 2023 •

edited

Loading