fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible. #40607

Krishna2323 · 2024-04-19T19:32:15Z

Details

Fixed Issues

$ #39356
PROPOSAL: #39356 (comment)

Tests

Open FAB mentu > submit expense > scan
Upload corrupt pdf attached below > Select any participant
Verify alert modal is shown with title Attachment error
Verify the background has a placeholder with receipt slash component on confirmation page

Verify that no errors appear in the JS console

Offline tests

Open FAB mentu > submit expense > scan
Upload corrupt pdf attached below > Select any participant
Verify alert modal is shown with title Attachment error
Verify the background has a placeholder with receipt slash component on confirmation page

QA Steps

Open FAB mentu > submit expense > scan
Upload corrupt pdf attached below > Select any participant
Verify alert modal is shown with title Attachment error
Verify the background has a placeholder with receipt slash component on confirmation page

Verify that no errors appear in the JS console

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_app.mp4

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

melvin-bot · 2024-04-19T19:32:20Z

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

Krishna2323 · 2024-04-19T20:51:53Z

@jayeshmangwani, when selecting a corrupt pdf file on native devices we don't get error and empty white background is shown. I'm looking for a solution for that.

jayeshmangwani · 2024-04-22T06:22:53Z

@Krishna2323 When you push the changes for native devices, please ping me.

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

Krishna2323 · 2024-04-22T13:08:45Z

@jayeshmangwani, I have updated the code for native devices, can you pls check and let me know, I haven't updated the recordings for native yet.

Demo for for native devices:

scan_corrupt_pdf_error_native.mp4

jayeshmangwani · 2024-04-22T16:15:32Z

@Expensify/design Please confirm the styling of the Failed to load PDF file. text?

shawnborton · 2024-04-22T16:36:10Z

I would think instead of showing text like we are, we'd show our default fallback receipt view, something like this that @dannymcclain had suggested previously:

Though I think I would change out the icon to use some kind of broken image icon, something like this but in our brand style:

dannymcclain · 2024-04-22T19:27:38Z

@shawnborton I thought in a different issue we had settled on not allowing someone to upload a corrupted image/PDF? We show the standard modal that says "Error uploading attachment..." This was the mock for that:

Am I misremembering something?

shawnborton · 2024-04-22T19:28:53Z

You are definitely right. So yeah, that begs the question, how did we trigger this particular "Failed to load PDF" scenario?

jayeshmangwani · 2024-04-22T19:41:59Z

@shawnborton @dannymcclain To reproduce this issue, I am following this steps:

Go to workspace chat > + > Split Expense > Scan > Upload a corrupt pdf

corrupted-pdf.mov

Corrupt pdf

corrupted.pdf

Krishna2323 · 2024-04-22T19:47:02Z

@dannymcclain @shawnborton, Yep, you're correct here. I worked on preventing corrupted images from being uploaded, but that was specifically for images. There might be another GitHub issue addressing prevention of corrupt PDFs from being uploaded. PR.

Krishna2323 · 2024-04-22T19:49:34Z

Here is the issue for preventing corrupted pdf's from being uploaded.

shawnborton · 2024-04-22T19:50:35Z

Yeah, I feel like a much better solution is to prevent a corrupted PDF from being uploaded in the first place.

jayeshmangwani · 2024-04-25T14:22:26Z

@hayata-suenaga @shawnborton If we are going to prevent a corrupted PDF from being uploaded, then we can close this PR and close/hold the issue in favor of #34032

shawnborton · 2024-04-25T14:43:41Z

That's where my head is at... it seems like we won't ever be able to get to this scenario once we prevent corrupted images/files from being uploaded.

trjExpensify · 2024-04-27T11:26:07Z

it seems like we won't ever be able to get to this scenario once we prevent corrupted images/files from being uploaded.

I don't think we know the image/file is corrupt purely on the client, so isn't it possible you'll run into this when uploading a corrupt file offline?

shawnborton · 2024-04-29T12:39:37Z

Hmm good question, who can confirm that?

If that's the case, I like doing something like my suggestion here.

dannymcclain · 2024-04-29T13:25:09Z

If that's the case, I like doing something like my suggestion #40607 (comment).

Yeah I agree. @shawnborton do you think any of these icons would work for that? (Receipt Slash and Document Slash are already in the system—Image Slash is one that I just made based off of the Image icon and Receipt Slash icon.)

shawnborton · 2024-04-29T13:28:14Z

Yeah I think any of these would be great! I think I like doing something super generic in case this is a pattern we'd repeat not only for PDF-specific receipts but for all receipts in general that are corrupt. So that being said, I lean towards the first option?

dannymcclain · 2024-04-29T13:39:22Z

Yeah first option makes sense to me—that way we could use it for any file type of receipt that borked.

hayata-suenaga · 2024-04-30T16:35:46Z

I don't think we know the image/file is corrupt purely on the client, so isn't it possible you'll run into this when uploading a corrupt file offline?

I'm not familiar with how we're handling the PDF upload on the client side, but we try to display a preview of the PDF before the user attempts to send it. If the PDF is corrupted, we know that when we try to display the preview.

@Krishna2323, could you confirm that you seem to be working on the issue to prevent the corrupt PDF from being uploaded?

Regardless, I think it's a good idea to still implement the fallback view if the attachment is corrupted though.

Krishna2323 · 2024-05-01T13:49:27Z

@hayata-suenaga, I've worked on preventing corrupt images from being uploaded, and it seems to be functioning well across all platforms. As for the PDF issue, it's slated to be addressed in this issue. The proposal selected to resolve the problem doesn't appear to offer a straightforward solution for detecting corrupt PDFs across all platforms. Therefore, I agree with your suggestion to proceed with implementing the fallback view. Additionally, I've noticed that some PDFs preview correctly on the confirmation list but then display an error message stating that the PDF can't be loaded.

You can try with this pdf:
Bug6460367_1713968986208.class-9-maths-chapter-10-solutions-2024-02-08_22_17_00.194.pdf

This works fine until we submit the request and go to details page but as soon as we refresh it shows Failed to load PDF file.

Krishna2323 · 2024-05-06T05:40:43Z

Ok, so I guess, we agree on showing fallback for corrupted files, will start implementing the changes today and update.

jayeshmangwani · 2024-05-14T13:38:09Z

src/components/PDFThumbnail/index.native.tsx

    const sizeStyles = [styles.w100, styles.h100];
+    const [hasError, setHasError] = useState(false);


hasError variable name doesn't look good here. Instead we can use something like failedToLoad @hayata-suenaga @Krishna2323

failedToLoad sounds good 😄

jayeshmangwani · 2024-05-14T14:29:12Z

src/components/PDFThumbnail/index.native.tsx

-            <View style={[sizeStyles, styles.alignItemsCenter, styles.justifyContentCenter]}>
-                {enabled && (
+            <View style={[sizeStyles, !hasError && styles.alignItemsCenter, styles.justifyContentCenter]}>
+                {enabled && !hasError && (


Is there any reason you added different conditions when rendering the PDF component and thumbnail?

Why are we checking the hasError in native only and not other platforms?

App/src/components/PDFThumbnail/index.native.tsx

Line 22 in 31caba2

{enabled && !hasError && (

App/src/components/PDFThumbnail/index.tsx

Line 57 in 31caba2

{enabled && thumbnail}

I think I forgot to add that condition, now updated.

jayeshmangwani · 2024-05-14T14:37:12Z

src/components/PDFThumbnail/index.native.tsx

+                            fill={theme.icon}
+                        />
+                    </View>
+                )}


The lines of code below are common in both files; we can create a common file for this.

<View style={[styles.justifyContentCenter, styles.pdfErrorPlaceholder, styles.alignItemsCenter]}> <Icon src={Expensicons.ReceiptSlash} width={variables.receiptPlaceholderIconWidth} height={variables.receiptPlaceholderIconHeight} fill={theme.icon} /> </View>

jayeshmangwani · 2024-05-14T14:42:03Z

src/components/PDFThumbnail/index.native.tsx


    return (
        <View style={[style, styles.overflowHidden]}>
-            <View style={[sizeStyles, styles.alignItemsCenter, styles.justifyContentCenter]}>
-                {enabled && (
+            <View style={[sizeStyles, !hasError && styles.alignItemsCenter, styles.justifyContentCenter]}>


Why conditional alignItemsCenter styling here

The component is used in other places as well, and if I recall correctly, applying alignItemsCenter by default was causing styling issues in other places.

jayeshmangwani · 2024-05-14T14:51:03Z

src/components/PDFThumbnail/index.tsx

-        <View style={[style, styles.overflowHidden]}>
-            <View style={[styles.w100, styles.h100, styles.alignItemsCenter, styles.justifyContentCenter]}>{enabled && thumbnail}</View>
+        <View style={[style, styles.h100, styles.overflowHidden]}>
+            <View style={[styles.w100, styles.h100, !hasError && styles.alignItemsCenter, !hasError && styles.justifyContentCenter]}>


Why are conditional alignItemsCenter and justifyContentCenter styling passed here?

Instead of checking hasError twice for both stylings, please merge them.

- !hasError && styles.alignItemsCenter, !hasError && styles.justifyContentCenter + !hasError && {...styles.alignItemsCenter, ...styles.justifyContentCenter}

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

jayeshmangwani · 2024-05-19T21:27:40Z

src/components/PDFThumbnail/index.tsx

-            <View style={[styles.w100, styles.h100, styles.alignItemsCenter, styles.justifyContentCenter]}>{enabled && thumbnail}</View>
+        <View style={[style, styles.h100, styles.overflowHidden]}>
+            <View style={[styles.w100, styles.h100, !failedToLoad && {...styles.alignItemsCenter, ...styles.justifyContentCenter}]}>
+                {enabled && failedToLoad && thumbnail}


These conditionals contradict each other. Why should we show a thumbnail when the failedToLoad condition is true??

thats incorrect, updated now. Thanks for the catch.

jayeshmangwani · 2024-05-19T21:31:38Z

src/components/PDFThumbnail/index.tsx

    );

    return (
-        <View style={[style, styles.overflowHidden]}>
-            <View style={[styles.w100, styles.h100, styles.alignItemsCenter, styles.justifyContentCenter]}>{enabled && thumbnail}</View>
+        <View style={[style, styles.h100, styles.overflowHidden]}>


Here, we Added the styles.h100 parent View Component; why is this change necessary? It was not to the parent View Component before our changes. We don't want to add any visual regression from the PR, so we wanted to make sure it is needed here

I found a bug when adding styles.h100 directly, added a condition now.

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

jayeshmangwani · 2024-05-20T12:19:36Z

@Krishna2323 Please Update Tests Section something like this:

1. Open App > Press FAB Menu > Submit expense > Select the Scan tab
2. Upload corrupt pdf(attached below) > Select any participant
3. Verify That We can see the Attachment error Modal, and in the background, we can see the [Receipt Slash Image](https://github.com/Expensify/App/pull/40607#issuecomment-2082744344)

Below the Tests Section, attach the corrupt pdf file for testing. Also, can you help me understand how I can test these steps? I can test the following:

4. Verify transactions preview also shows receipt slash component
5. Click on transactions preview and verify receipt slash component is also displayed on transaction preview
6. Open transaction details page and verify receipt slash component in place of receipt place holder

jayeshmangwani · 2024-05-20T12:19:55Z

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

Android: mWeb Chrome

mWeb-chrome.mov

iOS: Native

iOS.mov

iOS: mWeb Safari

mWeb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

jayeshmangwani

Added a comment for updating the Tests section, code changes LGTM

All yours @hayata-suenaga

hayata-suenaga

the code change looks good to me. I'm putting HOLD as we have merge freeze put in place. I'll let you know when we lift the merge freeze.

jayeshmangwani · 2024-05-28T15:24:45Z

@hayata-suenaga I think we are good to merge this PR; I can see a few PRs merged recently

hayata-suenaga · 2024-05-28T18:13:48Z

The merge freeze is being gradually being lifted with the urgent PRs being merged first

I don't think this PR needs to be merged urgently, so let's wait until we have complete merge freeze lift 😄

Krishna2323 · 2024-06-03T19:52:47Z

@hayata-suenaga, friendly bump to merge this, if we can.

OSBotify · 2024-06-05T06:36:39Z

✋ 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-06-11T23:31:16Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible.

df364c5

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

Krishna2323 requested a review from a team as a code owner April 19, 2024 19:32

melvin-bot bot requested review from jayeshmangwani and removed request for a team April 19, 2024 19:32

Merge branch 'Expensify:main' into krishna2323/issue/39356

1b4bf57

Krishna2323 added 2 commits April 22, 2024 18:35

fix: show corrupted pdf alert for native devices.

1e046d8

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

spacing improvement.

2288b18

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

Merge branch 'Expensify:main' into krishna2323/issue/39356

24577f1

jayeshmangwani reviewed May 14, 2024

View reviewed changes

Krishna2323 added 3 commits May 17, 2024 11:45

Merge branch 'Expensify:main' into krishna2323/issue/39356

601eb77

minor updates and refactoring.

075868d

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

add PDFThumbnailError component.

dc778d7

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

jayeshmangwani reviewed May 19, 2024

View reviewed changes

fix styling issues.

1f93a1e

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>

jayeshmangwani approved these changes May 20, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga May 20, 2024 12:21

hayata-suenaga changed the title ~~fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible.~~ [HOLD Merge freeze] fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible. May 20, 2024

hayata-suenaga approved these changes May 20, 2024

View reviewed changes

Merge branch 'Expensify:main' into krishna2323/issue/39356

16cb64f

tienifr mentioned this pull request Jun 3, 2024

fix Password-protected PDF not handled correctly #42572

Merged

50 tasks

Merge branch 'Expensify:main' into krishna2323/issue/39356

364acd6

hayata-suenaga changed the title ~~[HOLD Merge freeze] fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible.~~ fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible. Jun 5, 2024

hayata-suenaga merged commit b56ac33 into Expensify:main Jun 5, 2024
15 checks passed

github-actions bot mentioned this pull request Jun 6, 2024

Deploy Checklist: New Expensify 2024-06-06 #43168

Closed

melvin-bot bot mentioned this pull request Jun 11, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] [$250] IOU Scan - In dark mode, the damaged PDF - file is barely visible #39356

Closed

6 tasks

Krishna2323 mentioned this pull request Jun 13, 2024

[HOLD for payment 2024-08-01] [$250] Scan - No error pop-up and scan expense with corrupted PDF can be submitted via QAB #43645

Closed

6 tasks

		const sizeStyles = [styles.w100, styles.h100];
		const [hasError, setHasError] = useState(false);

fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible. #40607

fix: IOU Scan - In dark mode, the damaged PDF - file is barely visible. #40607

Conversation

Krishna2323 commented Apr 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 19, 2024

Krishna2323 commented Apr 19, 2024

jayeshmangwani commented Apr 22, 2024

Krishna2323 commented Apr 22, 2024

jayeshmangwani commented Apr 22, 2024

shawnborton commented Apr 22, 2024

dannymcclain commented Apr 22, 2024

shawnborton commented Apr 22, 2024

jayeshmangwani commented Apr 22, 2024

Krishna2323 commented Apr 22, 2024

Krishna2323 commented Apr 22, 2024

shawnborton commented Apr 22, 2024

jayeshmangwani commented Apr 25, 2024

shawnborton commented Apr 25, 2024

trjExpensify commented Apr 27, 2024

shawnborton commented Apr 29, 2024

dannymcclain commented Apr 29, 2024

shawnborton commented Apr 29, 2024

dannymcclain commented Apr 29, 2024

hayata-suenaga commented Apr 30, 2024

Krishna2323 commented May 1, 2024

Krishna2323 commented May 6, 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

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

jayeshmangwani commented May 20, 2024

jayeshmangwani commented May 20, 2024

Reviewer Checklist

Screenshots/Videos

jayeshmangwani left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

jayeshmangwani commented May 28, 2024

hayata-suenaga commented May 28, 2024

Krishna2323 commented Jun 3, 2024

OSBotify commented Jun 5, 2024

OSBotify commented Jun 11, 2024

Krishna2323 commented Apr 19, 2024 •

edited

Loading