fix Password-protected PDF not handled correctly #42572

tienifr · 2024-05-24T08:05:16Z

Details

Fixed Issues

$ #42078
PROPOSAL: #42078 (comment)

Tests

Web/Desktop

FAB > Submit expense > Manual > add amount
Select workspace > add merchant > submit the expense
Go to IOU > add password-protected PDF as a recipient
During the expense submission process (FAB > Submit expense > add amount > choose workspace), when attempting to add a password-protected PDF, an error occurs stating "password-protected PDF is not supported." This error handling should also be applied when adding a password-protected PDF as the recipient in the IOU

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Screenshots/Videos

Android: Native

output.mp4

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

output.mp4

MacOS: Desktop

tienifr · 2024-05-24T08:22:55Z

I encountered an issue in native, still investigate it.

melvin-bot · 2024-05-29T18:38:22Z

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

tienifr · 2024-05-29T20:27:01Z

@Julesssss Can you help confirm the expected behavior when we add protected pdf as receipt during the expense submission process (FAB > Submit expense > add amount > choose workspace)? I think the behavior in this PR looks good. cc @dukenv0307 WDYT?

In latest main:

Screen.Recording.2024-05-30.at.03.21.05.mov

In this PR:

output.mp4

dukenv0307 · 2024-05-30T02:58:41Z

@tienifr IMO, 2 places should be consistent, the behavior in this PR looks good. Pls apply the same for expense submission. cc @Julesssss

Julesssss · 2024-05-30T09:46:16Z

I do agree, but let's leave this decision to the design team.

Julesssss · 2024-05-30T09:49:31Z

I commented here on the issue, let's go with the choice that the design team make 👍

dukenv0307 · 2024-06-03T09:34:10Z

@tienifr any updates?

Did you test with the corrupted pdf?

Seem like we need the extra lib pdf-lib to detect if it's the protected pdf on native. I also can't find a different solution without using the new lib but we discourage from introducing the new lib. You have any ideas @Julesssss ?

tienifr · 2024-06-03T11:15:51Z

@dukenv0307

Did you test with the corrupted pdf?

I think the corrupted pdf file will be handled in #40607, so we do not need to implement it in this PR

dukenv0307 · 2024-06-04T03:14:13Z

@tienifr Can you raise your issue about checking the protected pdf on Slack? We need to find the best way (without using new lib), if not we can consider using your solution. cc @Julesssss

tienifr · 2024-06-04T22:51:11Z

@dukenv0307 I am trying to investigate another solution today. If cannot, I will raise on slack.

Julesssss · 2024-06-05T11:22:01Z

Seem like we need the extra lib pdf-lib to detect if it's the protected pdf on native.

Oh, I thought we were already doing this? As shown in the capture videos here

github-actions · 2024-06-10T08:44:43Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/42572/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/42572/NewExpensify.dmg	https://42572.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

dukenv0307 · 2024-06-10T09:18:58Z

@tienifr Lint has failed. Can you update the steps to test on web/mweb/desktop only.

dukenv0307 · 2024-06-11T03:04:59Z

@tienifr bump

dukenv0307 · 2024-06-11T10:19:22Z

@tienifr Can we use async await for isPdfFilePasswordProtected. Promise looks messy to me

tienifr · 2024-06-11T10:21:23Z

@dukenv0307 It can lead to a lint error, indicating that we should not use async/await syntax.

dukenv0307 · 2024-06-11T10:25:06Z

I think we can disable no-async-await rule in this case, we did it in several places. Wdyt? @Julesssss

dukenv0307 · 2024-06-13T02:56:07Z

@Julesssss Can you help check the question above^? Thanks

Julesssss · 2024-06-13T11:07:41Z

I think we can disable no-async-await rule in this case, we did it in several places.

Ah, no. We only allow it in GH actions and tests.

If we can't think of any alternatives we'll have to stick with the promise 😞

dukenv0307 · 2024-06-14T15:26:17Z

src/libs/isPdfFilePasswordProtected/index.tsx

+        reader.onload = (event) => {
+            const arrayBuffer = event.target?.result;
+            if (!arrayBuffer) {
+                resolve(false);


Suggested change

resolve(false);

resolve(false);

return;

then remove the else block

dukenv0307 · 2024-06-14T15:26:25Z

src/libs/isPdfFilePasswordProtected/index.tsx

+                        },
+                        (error) => {
+                            if (error.name === 'PasswordException') {
+                                resolve(true);


same as above

dukenv0307 · 2024-06-14T15:31:18Z

It works well, just have some minor comments above^

tienifr · 2024-06-17T09:06:30Z

@dukenv0307 I fixed all your comments.

dukenv0307 · 2024-06-18T02:55:25Z

Thank you @tienifr. LGTM

Outdated

OSBotify · 2024-06-18T09:44:37Z

✋ 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-19T21:52:07Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:16:49Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-19T22:50:48Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.86-0 🚀

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

OSBotify · 2024-06-21T21:21:26Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.0-9 🚀

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

fix Password-protected PDF not handled correctly

af4debc

tienifr added 8 commits May 27, 2024 17:26

fix merge main

efde856

fix native issue

b71c857

fix merge main

b9335ed

fix use pdf lib

58d2aeb

fix validateReceipt function

cdedb54

fix lint

084f895

fix import issue

ab940b5

fix package lock file

7c135f3

tienifr marked this pull request as ready for review May 29, 2024 18:34

tienifr requested a review from a team as a code owner May 29, 2024 18:34

melvin-bot bot requested review from dukenv0307 and removed request for a team May 29, 2024 18:38

tienifr added 3 commits May 30, 2024 02:17

fix do not use react pdf in web

09d50db

fix typecheck

bd9e6c2

fix lint

ca0ca58

Julesssss added Design and removed Design labels May 30, 2024

Julesssss mentioned this pull request May 30, 2024

[HOLD for payment 2024-06-28] [$250] IOU - Password-protected PDF not handled correctly when added to IOU as recipient #42078

Closed

6 tasks

tienifr added 2 commits June 8, 2024 17:25

fix typecheck

166b3b2

fix lint

41b00c9

Julesssss added the Ready To Build label Jun 10, 2024

fix merge main

7c9961b

dukenv0307 reviewed Jun 14, 2024

View reviewed changes

tienifr added 2 commits June 17, 2024 14:51

fix merge main

9ad3602

fix comment

61666db

dukenv0307 approved these changes Jun 18, 2024

View reviewed changes

melvin-bot bot requested a review from Julesssss June 18, 2024 02:55

Julesssss approved these changes Jun 18, 2024

View reviewed changes

Julesssss merged commit f0f3b03 into Expensify:main Jun 18, 2024
17 checks passed

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

Deploy Checklist: New Expensify 2024-06-19 #44047

Closed

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix Password-protected PDF not handled correctly #42572

fix Password-protected PDF not handled correctly #42572

tienifr commented May 24, 2024 •

edited

Loading

tienifr commented May 24, 2024

melvin-bot bot commented May 29, 2024

tienifr commented May 29, 2024

dukenv0307 commented May 30, 2024

Julesssss commented May 30, 2024

Julesssss commented May 30, 2024

dukenv0307 commented Jun 3, 2024

tienifr commented Jun 3, 2024

dukenv0307 commented Jun 4, 2024

tienifr commented Jun 4, 2024

Julesssss commented Jun 5, 2024

github-actions bot commented Jun 10, 2024

dukenv0307 commented Jun 10, 2024

dukenv0307 commented Jun 11, 2024

dukenv0307 commented Jun 11, 2024

tienifr commented Jun 11, 2024

dukenv0307 commented Jun 11, 2024

dukenv0307 commented Jun 13, 2024

Julesssss commented Jun 13, 2024 •

edited

Loading

dukenv0307 Jun 14, 2024

dukenv0307 Jun 14, 2024

dukenv0307 commented Jun 14, 2024

tienifr commented Jun 17, 2024

dukenv0307 commented Jun 18, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

fix Password-protected PDF not handled correctly #42572

fix Password-protected PDF not handled correctly #42572

Conversation

tienifr commented May 24, 2024 • edited Loading

Details

Fixed Issues

Tests

Web/Desktop

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tienifr commented May 24, 2024

melvin-bot bot commented May 29, 2024

tienifr commented May 29, 2024

dukenv0307 commented May 30, 2024

Julesssss commented May 30, 2024

Julesssss commented May 30, 2024

dukenv0307 commented Jun 3, 2024

tienifr commented Jun 3, 2024

dukenv0307 commented Jun 4, 2024

tienifr commented Jun 4, 2024

Julesssss commented Jun 5, 2024

github-actions bot commented Jun 10, 2024

dukenv0307 commented Jun 10, 2024

dukenv0307 commented Jun 11, 2024

dukenv0307 commented Jun 11, 2024

tienifr commented Jun 11, 2024

dukenv0307 commented Jun 11, 2024

dukenv0307 commented Jun 13, 2024

Julesssss commented Jun 13, 2024 • edited Loading

dukenv0307 Jun 14, 2024

Choose a reason for hiding this comment

dukenv0307 Jun 14, 2024

Choose a reason for hiding this comment

dukenv0307 commented Jun 14, 2024

tienifr commented Jun 17, 2024

dukenv0307 commented Jun 18, 2024

OSBotify commented Jun 18, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 19, 2024

OSBotify commented Jun 21, 2024

tienifr commented May 24, 2024 •

edited

Loading

Julesssss commented Jun 13, 2024 •

edited

Loading