Fix image picker conversions by BrtqKr · Pull Request #46025 · Expensify/App

BrtqKr · 2024-07-23T15:08:25Z

Details

There has been a related PR that was seemingly fixing this issue, but at the same time was the cause of another bug related to HEIC files. It turns out that when using assetRepresentationMode: 'current' HEIC files were being given .jpg extension without being converted, so the solution was to convert them manually when detecting the magic bytes with heic signature. It's quite a weird workaround, but since jpg conversion for HEIC is a standard approach, the most reasonable solution was to fix the conversion.

Fixed Issues

$ #38478
PROPOSAL:

Tests

Normally I'd upload both files I've been using for the tests, but github does't accept .heic. The one with the squares from the recordings was .heic

On iOS

Go to any chat
Press "+"
Add attachment
Choose from gallery
Select 2 given files (one heic, the other one a standard jpg)
Verify that both are being sent and displayed as expected
Send a standard video in the same way
Verify that the viso is being sent and displayed correctly
Send a video exceeding the file size limit
Verify that the picker closes without delay, verify that the error is being displayed instantly

On other platforms

HEIC files are treated as file attachments, but they should be sent without any issues. Also, verify using the same steps that images of different formats are being uploaded with correct previews in the messages.

Verify that no errors appear in the JS console

Offline tests

Everything is related to the picker and the format of the images, so the offline behaviour shouldn't be relevant in this case.

QA Steps

Same as in standard tests, but please make sure that it's working for various types of media. The last time regression was related to .heic format - this time it's working, but it would be good to verify all available data types of the media picked.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-07-24.at.10.48.24.mov

Android: mWeb Chrome

Screen.Recording.2024-07-24.at.10.54.22.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-07-23.at.17.09.31.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-07-23.at.17.17.21.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-07-23.at.17.26.52.mov

Screen.Recording.2024-07-23.at.17.28.25.mov

MacOS: Desktop

Screen.Recording.2024-07-24.at.10.57.07.mov

melvin-bot · 2024-07-23T15:39:18Z

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

hoangzinh · 2024-07-25T10:16:47Z

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-08-05.at.18.33.16.android.mov

Android: mWeb Chrome

Screen.Recording.2024-08-05.at.18.27.48.android.chrome.mov

iOS: Native

Screen.Recording.2024-08-05.at.18.35.53.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-08-05.at.18.39.39.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-05.at.18.07.22.mov

MacOS: Desktop

Screen.Recording.2024-08-05.at.18.12.24.desktop.mov

hoangzinh

Sorry for late review. Overall, your approach looks good to me.

hoangzinh · 2024-07-26T00:39:45Z

src/components/AttachmentPicker/index.native.tsx

+                        const fileContent = await RNFS.read(targetAsset.uri, 12, 0, 'base64');
+                        const hexSignature = Array.from(decode(fileContent))
+                            .map((char) => char.charCodeAt(0).toString(16).padStart(2, '0'))
+                            .slice(0, 32)
+                            .join('')
+                            .toUpperCase();
+
+                        const isHEIC = hexSignature.startsWith(CONST.HEIC_SIGNATURE);


We can wrap those into a function, and then use it here. It helps code look leaner. What do you think?

hoangzinh · 2024-07-26T10:34:25Z

src/components/AttachmentPicker/index.native.tsx

@@ -1,11 +1,15 @@
+/* eslint-disable @lwc/lwc/no-async-await */


I think we're not allowed to use async/await atm. Can you convert your code to Promise?

hoangzinh · 2024-07-28T12:24:59Z

src/libs/fileDownload/FileUtils.ts

    });
 }

+function verifyFileFormat({fileUri, formatSignature}: {fileUri: string; formatSignature: string}) {


I'm unsure whether we can reuse this method to verify other format types (like pdf/jpeg...). If not, we can name this function more specifically to verify the HEIC file. What do you think?

we can reuse it, but we would need to pass a different magic bytes for each, for now I'd leave it this way. If we need it in the future we could define a map with signatures for each specific type

https://en.wikipedia.org/wiki/List_of_file_signatures

okay cool, then can we rename the const isHEIC below to a more common variable?

my miss, sorry for that. It's ready now

hoangzinh · 2024-07-30T11:03:23Z

Looks good. @BrtqKr what do you think if we explicitly add another "testing steps" for other platforms (except IOS)? I think it should be same with current, but don't include HEIC file

hoangzinh · 2024-07-30T11:17:43Z

It appears that it's broken somewhere after refactoring. The HEIC file is not shown after uploading. Can you check again? Thank you.

Screen.Recording.2024-07-30.at.18.16.34.mov

BrtqKr · 2024-07-31T08:22:26Z

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-07-31.at.10.09.34.mp4

It seems to be working as expected. Would mind sharing the file you've used in this recording?

hoangzinh · 2024-07-31T09:53:34Z

Yep, you can try this file https://drive.google.com/file/d/1BsY-7m9Igsecnrp98QgmqCf5lusLi1Zu/view?usp=sharing

…tible with other platforms

BrtqKr · 2024-08-02T14:50:37Z

@hoangzinh it wasn't a standard heic. According to the signature of the file you've provided, it was ftypmif1 - a multi-image format related to heic. I've added additional signatures for the related types, which should help in this scenario. Also, I've changed the implementation to use fetch for the purpose of compatibility. I think this should be enough.

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-02.at.16.49.30.mp4

hoangzinh · 2024-08-05T10:54:19Z

Great. Thanks @BrtqKr

hoangzinh

LGTM

…er-conversions

puneetlath · 2024-08-05T15:15:37Z

src/components/AttachmentPicker/index.native.tsx

+                    if (targetAsset?.type?.startsWith('image')) {
+                        FileUtils.verifyFileFormat({fileUri: targetAssetUri, formatSignatures: CONST.HEIC_SIGNATURES})
+                            .then((isHEIC) => {
+                                // react-native-image-picker incorrectly changes file extension without transcoding the HEIC file, so we are doing it manually if we detect HEIC signature


Do we plan to fix this upstream also?

I've sent a feature request to the repository. If they think this approach is ok, I'll send a PR react-native-image-picker/react-native-image-picker#2317

src/libs/fileDownload/FileUtils.ts

OSBotify · 2024-08-06T15:14:36Z

✋ 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-08-07T22:11:57Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.0.18-0 🚀

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

OSBotify · 2024-08-12T10:03:11Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.18-10 🚀

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

BrtqKr added 2 commits July 23, 2024 15:51

fix conversions wip

eba5fb3

cleanups, fix for video, type changes

7bf0fe9

BrtqKr marked this pull request as ready for review July 23, 2024 15:39

BrtqKr requested a review from a team as a code owner July 23, 2024 15:39

melvin-bot bot requested review from hoangzinh and removed request for a team July 23, 2024 15:39

hoangzinh reviewed Jul 26, 2024

View reviewed changes

generalize function, migrate from async await to then

ccfcbaa

BrtqKr requested a review from hoangzinh July 26, 2024 14:42

hoangzinh reviewed Jul 28, 2024

View reviewed changes

BrtqKr requested a review from hoangzinh July 29, 2024 07:46

rename variable

88cda03

add multi image format, move implementation to fetch to make it compa…

ab63c3e

…tible with other platforms

cleanup

591320e

hoangzinh approved these changes Aug 5, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath August 5, 2024 11:41

Merge remote-tracking branch 'origin/main' into brtqkr/fix-image-pick…

939022a

…er-conversions

puneetlath requested changes Aug 5, 2024

View reviewed changes

add description for verifyFileFormat

b8cef07

BrtqKr requested a review from puneetlath August 6, 2024 08:27

puneetlath approved these changes Aug 6, 2024

View reviewed changes

puneetlath merged commit 9854dd8 into Expensify:main Aug 6, 2024

Christinadobrzyn mentioned this pull request Aug 6, 2024

[HOLD for payment 2024-08-19] [$500] No feedback and delay when uploading a large attachment #38478

Closed

6 tasks

github-actions bot mentioned this pull request Aug 7, 2024

Deploy Checklist: New Expensify 2024-08-07 #47006

Closed

88 tasks

lanitochka17 mentioned this pull request Aug 8, 2024

[HOLD for payment 2024-09-09] [$250] Attachment - The corrupted file can be sent and played back #47086

Closed

6 tasks

BrtqKr mentioned this pull request Aug 9, 2024

[CP Staging] Fix receipt conversion #47139

Merged

50 tasks

Beamanator mentioned this pull request Aug 13, 2024

[Due for payment 2025-06-11] Unable to upload HEIF image as money request (Web) #47078

Closed

6 tasks

OlimpiaZurek mentioned this pull request Oct 2, 2024

[HOLD for payment 2024-10-17] The Heic format image showing as 2.5MB is uploading with size over 10MB #49999

Closed

6 tasks

		@@ -1,11 +1,15 @@
		/* eslint-disable @lwc/lwc/no-async-await */

Conversation

BrtqKr commented Jul 23, 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 23, 2024

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

hoangzinh left a comment

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!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

BrtqKr commented Jul 31, 2024

Uh oh!

hoangzinh commented Jul 31, 2024

Uh oh!

BrtqKr commented Aug 2, 2024

Uh oh!

hoangzinh commented Aug 5, 2024

Uh oh!

hoangzinh left a comment

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!

OSBotify commented Aug 6, 2024

Uh oh!

OSBotify commented Aug 7, 2024

Uh oh!

OSBotify commented Aug 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BrtqKr commented Jul 23, 2024 •

edited

Loading

hoangzinh commented Jul 25, 2024 •

edited

Loading

hoangzinh commented Jul 30, 2024 •

edited

Loading

hoangzinh commented Jul 30, 2024 •

edited

Loading