update document-picker package to support the file protocol #31499

b4s36t4 · 2023-11-17T18:45:44Z

Details

Updates the react-native-document-picker to solve the issue with Android file download local files.

Fixed Issues

$ #29788
PROPOSAL: #29788 (comment)

Tests

Verify that no errors appear in the JS console

Important

Be on Low network if possible
File name should not have space when choosing from document picker

Click on FAB -> Request Money -> Manual
Enter Amount and click Next
Click three-dot menu (at top) -> Add Receipt
Choose option to update receipt from documents (choose from documents)
File name should not have space when choosing from document picker
Complete the Money Request
Now Quickly try to open the money-request and download the upload reciept.

Offline tests

Same as above.

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

ios.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2023-11-17T18:45:49Z

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

situchan · 2023-11-19T15:38:35Z

src/libs/fileDownload/FileUtils.js

@@ -181,7 +182,7 @@ const readFileAsync = (path, fileName, onSuccess, onFailure = () => {}) =>
                return res.blob();
            })
            .then((blob) => {
-                const file = new File([blob], cleanFileName(fileName), {type: blob.type});
+                const file = new File([blob], cleanFileName(fileName), {type: blob.type || type});


What's this change for? blob doesn't return type in updated version?

I tested and confirmed that type isn't returned in old version as well.
So what exactly does this change fix?

For only the files which does have Space in their name, as you told upload failing for files which does have space init, after some digging type is the issue for the files which does have the space.

Nice! But I said it's out of scope as it already happens on main and has different root cause.
Let's just fix crash here.

oh, ok then. Fine. Will update the code to just have the fix.

situchan

update version to latest (9.0.1)

…ssue

b4s36t4 · 2023-11-21T21:13:43Z

@situchan Updated the code to according to your changes. Please check!

situchan · 2023-11-25T23:20:31Z

@b4s36t4 performance tests failing. Please pull main

situchan · 2023-11-26T10:20:13Z

Still failing. I don't see any other recent PRs failing that test.

b4s36t4 · 2023-11-26T10:27:04Z

I'm checking, but I don't see any change in my that's causing the issue.

b4s36t4 · 2023-11-26T11:21:24Z

@situchan can you check if these tests are working fine on local in main branch?

b4s36t4 · 2023-11-26T11:22:40Z

The error is coming from navigatesToChat this translation key which we're checking for the components to have as part of accessbility hints, but None of the component (in src folder) is containing this particular string. Maybe somebody removed the or changes the strings.

b4s36t4 · 2023-11-26T19:14:37Z

@situchan Fixed.

situchan · 2023-11-28T15:10:21Z

@b4s36t4 please add one more test condition - File name should not have space when choosing from document picker

situchan · 2023-11-28T15:12:05Z

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

The change doesn't affect non-native platforms (web/desktop/mWeb)

Android: Native

android.mov

Android: mWeb Chrome

iOS: Native

ios.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

situchan · 2023-11-28T15:13:35Z

@marcochavezf I think we should create new GH to fix file name with space issue (#29788 (comment))

situchan

marcochavezf

Thanks guys, LGTM

marcochavezf · 2023-11-28T17:02:12Z

@marcochavezf I think we should create new GH to fix file name with space issue (#29788 (comment))

Ah for this issue ^, what's the exact problem? I tried to upload for scan a file with a space in the name but I didn't have the error:

situchan · 2023-11-28T17:03:27Z

@marcochavezf I think we should create new GH to fix file name with space issue (#29788 (comment))

Ah for this issue ^, what's the exact problem? I tried to upload for scan a file with a space in the name but I didn't have the error:

That only happens on android.

b4s36t4 · 2023-11-28T17:15:44Z

With android, if the filename have a space in the name, it's not returning the type of the file which we're trying to get using fetch maybe we could use fetch from fs or some-other way. Or else we can simply have the type in ONYX so that if fetch not able to fetch type we manually provide type.

Tested and it's working fine as well.

b4s36t4 · 2023-11-28T17:16:53Z

@situchan @marcochavezf Updated the test condition.

marcochavezf · 2023-11-28T19:13:29Z

@situchan @marcochavezf Updated the test condition.

@b4s36t4 ah sorry which test condition?

situchan · 2023-11-28T19:14:45Z

@situchan @marcochavezf Updated the test condition.

@b4s36t4 ah sorry which test condition?

#31499 (comment) for QA team to test properly as it will fail with spaced name on android

marcochavezf · 2023-11-28T19:29:02Z

Snyk checks are failing, asking how to proceed here

situchan · 2023-11-29T06:46:34Z

Snyk checks are failing, asking how to proceed here

It's known - https://expensify.slack.com/archives/C01GTK53T8Q/p1700498232891239

marcochavezf · 2023-11-29T18:08:48Z

Ok, given that we're just updating a package library to fix a bug it should be fine, thanks guys!

OSBotify · 2023-11-29T18:14:14Z

✋ 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-12-01T12:44:17Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.6-2 🚀

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

update document-picker package to support the file protocol

9a14d7c

b4s36t4 requested a review from a team as a code owner November 17, 2023 18:45

melvin-bot bot requested review from situchan and removed request for a team November 17, 2023 18:45

b4s36t4 mentioned this pull request Nov 17, 2023

[HOLD for payment 2023-12-08] [$1000] IOU - Tapping download on manual money request receipt app crashes #29788

Closed

6 tasks

situchan reviewed Nov 19, 2023

View reviewed changes

situchan suggested changes Nov 19, 2023

View reviewed changes

b4s36t4 added 3 commits November 22, 2023 02:34

upgrade to latest

1aa20bb

Merge branch 'main' of github.com:Expensify/App into fix/attachment-i…

ec42737

…ssue

Revert changes related to type & update package to latest

3362228

Merge branch 'Expensify:main' into fix/attachment-issue

825c58b

revert back v9 to document picker

5e44b8b

situchan approved these changes Nov 28, 2023

View reviewed changes

melvin-bot bot requested a review from marcochavezf November 28, 2023 15:14

marcochavezf approved these changes Nov 28, 2023

View reviewed changes

marcochavezf merged commit ff18fdd into Expensify:main Nov 29, 2023
17 checks passed

github-actions bot mentioned this pull request Nov 30, 2023

Deploy Checklist: New Expensify 2023-11-30 #32266

Closed

42 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update document-picker package to support the file protocol #31499

update document-picker package to support the file protocol #31499

b4s36t4 commented Nov 17, 2023 •

edited

Loading

melvin-bot bot commented Nov 17, 2023

situchan Nov 19, 2023

situchan Nov 19, 2023

b4s36t4 Nov 19, 2023

situchan Nov 19, 2023

b4s36t4 Nov 19, 2023

situchan left a comment

b4s36t4 commented Nov 21, 2023

situchan commented Nov 25, 2023

situchan commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

situchan commented Nov 28, 2023

situchan commented Nov 28, 2023

situchan commented Nov 28, 2023

situchan left a comment

marcochavezf left a comment

marcochavezf commented Nov 28, 2023

situchan commented Nov 28, 2023

b4s36t4 commented Nov 28, 2023

b4s36t4 commented Nov 28, 2023

marcochavezf commented Nov 28, 2023

situchan commented Nov 28, 2023

marcochavezf commented Nov 28, 2023

situchan commented Nov 29, 2023

marcochavezf commented Nov 29, 2023

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

update document-picker package to support the file protocol #31499

update document-picker package to support the file protocol #31499

Conversation

b4s36t4 commented Nov 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 17, 2023

situchan Nov 19, 2023

Choose a reason for hiding this comment

situchan Nov 19, 2023

Choose a reason for hiding this comment

b4s36t4 Nov 19, 2023

Choose a reason for hiding this comment

situchan Nov 19, 2023

Choose a reason for hiding this comment

b4s36t4 Nov 19, 2023

Choose a reason for hiding this comment

situchan left a comment

Choose a reason for hiding this comment

b4s36t4 commented Nov 21, 2023

situchan commented Nov 25, 2023

situchan commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

b4s36t4 commented Nov 26, 2023

situchan commented Nov 28, 2023

situchan commented Nov 28, 2023

Reviewer Checklist

Screenshots/Videos

situchan commented Nov 28, 2023

situchan left a comment

Choose a reason for hiding this comment

marcochavezf left a comment

Choose a reason for hiding this comment

marcochavezf commented Nov 28, 2023

situchan commented Nov 28, 2023

b4s36t4 commented Nov 28, 2023

b4s36t4 commented Nov 28, 2023

marcochavezf commented Nov 28, 2023

situchan commented Nov 28, 2023

marcochavezf commented Nov 28, 2023

situchan commented Nov 29, 2023

marcochavezf commented Nov 29, 2023

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

b4s36t4 commented Nov 17, 2023 •

edited

Loading