fix: Scan - No error pop-up and scan expense with corrupted PDF can be submitted via QAB by Krishna2323 · Pull Request #44778 · Expensify/App

Krishna2323 · 2024-07-03T16:17:36Z

Details

Fixed Issues

$ #43645
PROPOSAL: #43645 (comment)

Tests

Go to workspace chat.
Go to + > Submit expense > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan page
Submit a manual request in the workspace chat.
Go to FAB > Submit expense under QAB > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan page

Verify that no errors appear in the JS console

Offline tests

Go to workspace chat.
Go to + > Submit expense > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan page
Submit a manual request in the workspace chat.
Go to FAB > Submit expense under QAB > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan page

QA Steps

Go to workspace chat.
Go to + > Submit expense > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan page
Submit a manual request in the workspace chat.
Go to FAB > Submit expense under QAB > Scan.
Upload a corrupted PDF.
Verify error pop-up shows on Scan page
Upload a protected PDF
Verify error pop-up shows on Scan 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-07-03T16:17:41Z

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

suneox · 2024-07-06T08:51:58Z

@Krishna2323 How about your update? And could you please try to add new props into PDFThumbnail to prevent rendering instead of handling it at screen?

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

Krishna2323 · 2024-07-06T23:29:45Z

@suneox, PR is ready.

And could you please try to add new props into PDFThumbnail to prevent rendering instead of handling it at screen?

We already have enabled prop for that but the PDF wasn't rendered again when selecting corrupt PDF again and because of that nothing happens when selecting PDF second time.

suneox · 2024-07-07T13:53:20Z

+                            // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
+                            previewSourceURL={pdfFile?.uri ?? ''}


We don’t need to disable eslint for that case because an empty previewSourceURL is invalid. Instead, I suggest checking the condition before rendering ST like {pdfFile.uri && (< PDFThumbnail ....

updated. we don't need to check for pdfFile.uri as we are already checking for pdfFile before rendering.

suneox · 2024-07-07T14:01:23Z

+            <View style={{height: 0, overflow: 'hidden', width: 0, opacity: 0}}>
+                {pdfFile && (
+                    <View style={{height: 1, width: 1}}>
+                        <PDFThumbnail


Suggested change

<View style={{height: 0, overflow: 'hidden', width: 0, opacity: 0}}>

{pdfFile && (

<View style={{height: 1, width: 1}}>

<PDFThumbnail

{pdfFile && (

<PDFThumbnail

invisible

Can we create a new prop, such as invisible, and handle the style inside PDFThumbnail instead of handling it at the screen level?

We already have enabled prop for that but the PDF wasn't rendered again when selecting corrupt PDF again and because of that nothing happens when selecting PDF second time.

suneox · 2024-07-07T14:04:22Z

+    const PDFThumbnailView = pdfFile ? (
+        <View style={{position: 'absolute', opacity: 0, width: 1, height: 1}}>
+            <PDFThumbnail
+                // eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
+                previewSourceURL={pdfFile.uri ?? ''}


Same IOURequestStepScan/index.native.tsx mentioned above, handle the invisible style inside PDFThumbnail and prevent disabling TypeScript.

suneox · 2024-07-07T14:12:12Z

+                            }}
+                            onPassword={() => {
+                                setPdfFile(null);
+                                Alert.alert(translate('attachmentPicker.attachmentError'), translate('attachmentPicker.protectedPDFNotSupported'));


At MoneyRequestConfirmationListFooter.tsx we show error by confirmation modal

App/src/components/MoneyRequestConfirmationListFooter.tsx

Lines 657 to 665 in c5eafd3

<ConfirmModal

title={translate('attachmentPicker.attachmentError')}

onConfirm={navigateBack}

onCancel={navigateBack}

isVisible={isAttachmentInvalid}

prompt={invalidAttachmentPrompt}

confirmText={translate('common.close')}

shouldShowCancelButton={false}

/>

So we have to update Alert to ConfirmModal

@suneox, for native we use alert to show all file related issues.

App/src/pages/iou/request/step/IOURequestStepScan/index.native.tsx

Lines 165 to 186 in 29e8df5

const validateReceipt = (file: FileObject) => {

const {fileExtension} = FileUtils.splitExtensionFromFileName(file?.name ?? '');

if (

!CONST.API_ATTACHMENT_VALIDATIONS.ALLOWED_RECEIPT_EXTENSIONS.includes(

fileExtension.toLowerCase() as TupleToUnion<typeof CONST.API_ATTACHMENT_VALIDATIONS.ALLOWED_RECEIPT_EXTENSIONS>,

)

) {

Alert.alert(translate('attachmentPicker.wrongFileType'), translate('attachmentPicker.notAllowedExtension'));

return false;

}

if ((file?.size ?? 0) > CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE) {

Alert.alert(translate('attachmentPicker.attachmentTooLarge'), translate('attachmentPicker.sizeExceeded'));

return false;

}

if ((file?.size ?? 0) < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) {

Alert.alert(translate('attachmentPicker.attachmentTooSmall'), translate('attachmentPicker.sizeNotMet'));

return false;

}

return true;

};

Agreed, just make it consistent with other places on IOURequestStepScan/native

@suneox, you mean to make it consistent with Alert.alert for native, right? If so, then it's already consistent.

Yes, we can using Alert for native in this case

suneox · 2024-07-07T14:12:47Z

+                            }}
+                            onLoadError={() => {
+                                setPdfFile(null);
+                                Alert.alert(translate('attachmentPicker.attachmentError'), translate('attachmentPicker.errorWhileSelectingCorruptedAttachment'));


We have to update Alert to ConfirmModal

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

Krishna2323 · 2024-07-10T01:42:26Z

@suneox, ready for another review.

suneox · 2024-07-10T14:09:40Z

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

Screen.Recording.2024-07-10.at.21.44.38.mov

Android: mWeb Chrome

Screen.Recording.2024-07-10.at.21.41.17.mov

iOS: Native

Screen.Recording.2024-07-10.at.21.14.55.mov

iOS: mWeb Safari

Screen.Recording.2024-07-10.at.21.26.12.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-10.at.21.29.20.mov

MacOS: Desktop

Screen.Recording.2024-07-10.at.21.22.15.mov

suneox

Testing passed on all platforms and the requested changes have been updated. LGTM

grgia

A few questions for clarity + clean up

grgia · 2024-07-12T08:44:12Z

+                    style={{height: 1, width: 1, opacity: 0, position: 'absolute'}}
+                    previewSourceURL={pdfFile?.uri ?? ''}
+                    onLoadSuccess={() => {
+                        setPdfFile(null);


Why do we call this with null here?

for some reason PDF isn't re-rendering on android native when file is changed to another file so we need to set it to null first.

grgia · 2024-07-12T08:45:50Z

            if (!isFileValid) {
                return;
            }
+            if (Str.isPDF(file.name ?? '') && !isPdfValidated) {


could you explain the check for a not validated pdf here?

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

shawnborton · 2024-07-15T07:11:33Z

Screenshots look good to me.

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

Krishna2323 · 2024-07-17T18:03:11Z

@grgia bump

OSBotify · 2024-07-22T16:11:28Z

✋ 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-07-23T08:35:38Z

🚀 Deployed to staging by https://github.com/grgia in version: 9.0.11-0 🚀

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

OSBotify · 2024-07-24T00:15:56Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-25T03:14:09Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

OSBotify · 2024-07-26T05:13:10Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

Krishna2323 added 6 commits June 13, 2024 20:59

feat: corrupt pdf detection on scan page.

0caf904

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

Merge branch 'Expensify:main' into krishna2323/test/43645

2a76f6d

add pdf validation for native.

4cbf8e2

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

Merge branch 'Expensify:main' into krishna2323/test/43645

a26c5b6

corrupt pdf alert fix for android.

80fa7bb

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

Merge branch 'Expensify:main' into krishna2323/test/43645

65c1537

Krishna2323 requested a review from a team as a code owner July 3, 2024 16:17

melvin-bot Bot removed the request for review from a team July 3, 2024 16:17

melvin-bot Bot requested a review from suneox July 3, 2024 16:17

Krishna2323 changed the title ~~Krishna2323/issue/43645~~ fix: Scan - No error pop-up and scan expense with corrupted PDF can be submitted via QAB Jul 3, 2024

Krishna2323 marked this pull request as draft July 3, 2024 16:18

Krishna2323 added 6 commits July 6, 2024 17:05

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

3f1fafa

minor updated.

2a7cbe9

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

cleanup.

458c75d

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

minor fix.

85e166e

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

minor update/

e4eb9a2

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

refactor.

29ad495

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

Krishna2323 mentioned this pull request Jul 6, 2024

[On Hold #44778] Submit Expense - Inconsistent Error Messages for Password Protected PDFs on Mweb and Android #44091

Closed

2 of 6 tasks

Krishna2323 added 2 commits July 7, 2024 03:22

fix rendering issue.

881dba7

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

minor update.

33b3912

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

Krishna2323 marked this pull request as ready for review July 6, 2024 23:31

suneox reviewed Jul 7, 2024

View reviewed changes

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

1a5c19b

minor updates.

f36966d

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

suneox approved these changes Jul 10, 2024

View reviewed changes

melvin-bot Bot requested a review from grgia July 10, 2024 14:53

grgia requested changes Jul 12, 2024

View reviewed changes

Krishna2323 added 2 commits July 15, 2024 12:19

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

1a71c50

add invisible pdf styling.

24b07d5

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

Krishna2323 requested a review from a team as a code owner July 15, 2024 06:58

add comment.

ace0862

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

add comment.

105356b

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

grgia reviewed Jul 15, 2024

View reviewed changes

Comment thread src/pages/iou/request/step/IOURequestStepScan/index.native.tsx

minor fix.

8d553b0

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

grgia approved these changes Jul 22, 2024

View reviewed changes

grgia merged commit 637796d into Expensify:main Jul 22, 2024

github-actions Bot mentioned this pull request Jul 23, 2024

Deploy Checklist: New Expensify 2024-07-23 #45991

Closed

95 tasks done

melvin-bot Bot mentioned this pull request Jul 25, 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 done

		// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
		previewSourceURL={pdfFile?.uri ?? ''}

	<ConfirmModal
	title={translate('attachmentPicker.attachmentError')}
	onConfirm={navigateBack}
	onCancel={navigateBack}
	isVisible={isAttachmentInvalid}
	prompt={invalidAttachmentPrompt}
	confirmText={translate('common.close')}
	shouldShowCancelButton={false}
	/>

	const validateReceipt = (file: FileObject) => {
	const {fileExtension} = FileUtils.splitExtensionFromFileName(file?.name ?? '');
	if (
	!CONST.API_ATTACHMENT_VALIDATIONS.ALLOWED_RECEIPT_EXTENSIONS.includes(
	fileExtension.toLowerCase() as TupleToUnion<typeof CONST.API_ATTACHMENT_VALIDATIONS.ALLOWED_RECEIPT_EXTENSIONS>,
	)
	) {
	Alert.alert(translate('attachmentPicker.wrongFileType'), translate('attachmentPicker.notAllowedExtension'));
	return false;
	}

	if ((file?.size ?? 0) > CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE) {
	Alert.alert(translate('attachmentPicker.attachmentTooLarge'), translate('attachmentPicker.sizeExceeded'));
	return false;
	}

	if ((file?.size ?? 0) < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) {
	Alert.alert(translate('attachmentPicker.attachmentTooSmall'), translate('attachmentPicker.sizeNotMet'));
	return false;
	}
	return true;
	};

Conversation

Krishna2323 commented Jul 3, 2024 • 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 Jul 3, 2024

Uh oh!

suneox commented Jul 6, 2024

Uh oh!

Krishna2323 commented Jul 6, 2024

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!

Krishna2323 Jul 10, 2024 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Krishna2323 commented Jul 10, 2024

Uh oh!

suneox commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

suneox left a comment

Choose a reason for hiding this comment

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

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!

Uh oh!

shawnborton commented Jul 15, 2024

Uh oh!

Uh oh!

Krishna2323 commented Jul 17, 2024

Uh oh!

OSBotify commented Jul 22, 2024

Uh oh!

OSBotify commented Jul 23, 2024

Uh oh!

OSBotify commented Jul 24, 2024

Uh oh!

OSBotify commented Jul 25, 2024

Uh oh!

OSBotify commented Jul 26, 2024

Uh oh!

Reviewers

Krishna2323 commented Jul 3, 2024 •

edited

Loading

Krishna2323 Jul 10, 2024 •

edited

Loading

suneox commented Jul 10, 2024 •

edited

Loading