Update picker to avoid showing svg images on android #27834

rmm-fl · 2023-09-20T07:22:52Z

Details

Upstream PR for patch

react-native-image-picker/react-native-image-picker#2145

Fixed Issues

$ #26768
PROPOSAL: #26768 (comment)

Tests (Android Only)

Download any svg file (sample)
Open App
Go to Settings > Profile
Change profile picture
Verify you cannot select the downloaded svg image

Verify that no errors appear in the JS console

Offline tests (Android only)

Download any svg file (sample)
Open App
Go to Settings > Profile
Change profile picture
Verify you cannot select the downloaded svg image

QA Steps (Android only)

Download any svg file (sample)
Open App
Go to Settings > Profile
Change profile picture
Verify you cannot select the downloaded svg image

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 / Chrome
- iOS / native
- iOS / 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 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari.mp4

Desktop

desktop.mp4

iOS

ios-native.mp4

Android

android-native.mp4

melvin-bot · 2023-09-20T10:19:23Z

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

s77rt

Instead of writing the new feature as a patch (androidAllowedMimeTypes). We should just directly patch the native code i.e. just call libraryIntent.putExtra(Intent.EXTRA_MIME_TYPES, mimeTypesHere);

s77rt · 2023-09-20T14:12:34Z

The tests steps are not correct, we should specify that svg images should not be pickable (not shown in the picker)

rmm-fl · 2023-09-20T14:19:49Z

The tests steps are not correct, we should specify that svg images should not be pickable (not shown in the picker)

Updated the steps to include that.

We should just directly patch the native code i.e. just call libraryIntent.putExtra(Intent.EXTRA_MIME_TYPES, mimeTypesHere);

@s77rt - Sure, would you prefer it to be toggleable via a boolean like excludeSvgImages ? Or should it be done unconditionally ?

s77rt · 2023-09-20T14:38:25Z

It should be done unconditionally, there won't be any cases where we'd want this to be controllable

rmm-fl · 2023-09-20T15:38:24Z

@s77rt Updated the PR - Please take a look, Thanks!

s77rt · 2023-09-20T17:54:14Z

patches/react-native-image-picker+5.1.0.patch

+    // Generated by merging from lists of image mimetypes supported on Android, and list of IANA media-types:
+    //   https://android.googlesource.com/platform/external/mime-support/+/main/mime.types#636
+    //   https://www.iana.org/assignments/media-types/media-types.xhtml#image


Can we just use the Android one to be sure we are not adding something that was not added before

I believe the android list is not really exhaustive list (this was the limited info I was able to find), because it doesn't contain image formats like avif & heif (default for camera app on some new android phones). Also previously it was image/* which I believe covers all the formats. We should instead worry about missing any format, which I believe shouldn't be the case as any widespread new format should probably be registered by IANA and we are using their list here.

s77rt · 2023-09-20T19:23:40Z

Please update the test steps:

Tests (Android Only)

Download any svg file (sample)
Open App
Go to Settings > Profile
Change profile picture
Verify you cannot select the downloaded svg image

rmm-fl · 2023-09-20T19:27:29Z

@s77rt - updated the steps!

s77rt · 2023-09-20T19:32:15Z

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 / Chrome
- iOS / native
- iOS / 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Before: (the white squares are svg files)

After:

s77rt · 2023-09-20T19:54:42Z

patches/react-native-image-picker+5.1.0.patch

+    // Avoid image picker to show svg images on Android, to get the behaviour to be same as on iOS.
+    // Since, we can't exclude an image format, we instead allowlist all the possible image formats,
+    // excluding the 'image/svg+xml' mime type.


Just some comments clarification:

Prevent svg images from being selected as they are not supported (Image component does not support them) and also because iOS does not allow them to be selected (for consistency).

Since, we can't exclude a mime type, we instead allow all image mime types except 'image/svg+xml'. Image mime types are generated by merging the Android image mime type support and the IANA media-types lists.

Updated the PR

OSBotify · 2023-09-21T03:21:35Z

✋ 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-09-22T14:00:47Z

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

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

OSBotify · 2023-09-25T09:35:38Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:07:42Z

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

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

OSBotify · 2023-09-28T18:50:03Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

roryabraham · 2024-02-07T06:57:26Z

Heads up, we should not be adding any new patches without also creating an upstream PR with the same change.

Julesssss · 2024-02-07T08:57:45Z

Reminder: I need to raise an upstream PR

Julesssss · 2024-02-07T11:07:39Z

Asked a clarifying question here.

s77rt · 2024-02-07T15:26:03Z

We didn't raise an upstream PR because there was already a similar open PR react-native-image-picker/react-native-image-picker#2145 and it was not moving forward.

Will look into this asap

rmm-fl mentioned this pull request Sep 20, 2023

[HOLD for payment 2023-10-02] [$1000] Profile - Unable to upload .svg file as profile photo #26768

Closed

6 tasks

rmm-fl marked this pull request as ready for review September 20, 2023 10:19

rmm-fl requested a review from a team as a code owner September 20, 2023 10:19

melvin-bot bot requested review from s77rt and removed request for a team September 20, 2023 10:19

rmm-fl force-pushed the i-26768-alt branch from 4119c12 to ede1380 Compare September 20, 2023 11:34

s77rt suggested changes Sep 20, 2023

View reviewed changes

rmm-fl force-pushed the i-26768-alt branch from ede1380 to 5a25596 Compare September 20, 2023 15:37

s77rt reviewed Sep 20, 2023

View reviewed changes

s77rt suggested changes Sep 20, 2023

View reviewed changes

Update picker to avoid showing svg images on android

fd7c592

rmm-fl force-pushed the i-26768-alt branch from 5a25596 to fd7c592 Compare September 20, 2023 20:02

s77rt approved these changes Sep 20, 2023

View reviewed changes

melvin-bot bot requested a review from Julesssss September 20, 2023 20:33

Julesssss assigned rmm-fl Sep 21, 2023

Julesssss approved these changes Sep 21, 2023

View reviewed changes

Julesssss merged commit 89141ac into Expensify:main Sep 21, 2023
13 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update picker to avoid showing svg images on android #27834

Update picker to avoid showing svg images on android #27834

rmm-fl commented Sep 20, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Sep 20, 2023

s77rt left a comment

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023 •

edited

Loading

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023

s77rt Sep 20, 2023

rmm-fl Sep 20, 2023 •

edited

Loading

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023

s77rt commented Sep 20, 2023 •

edited

Loading

s77rt Sep 20, 2023

rmm-fl Sep 20, 2023

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

roryabraham commented Feb 7, 2024

Julesssss commented Feb 7, 2024

Julesssss commented Feb 7, 2024

s77rt commented Feb 7, 2024

Update picker to avoid showing svg images on android #27834

Update picker to avoid showing svg images on android #27834

Conversation

rmm-fl commented Sep 20, 2023 • edited by github-actions bot Loading

Details

Upstream PR for patch

Fixed Issues

Tests (Android Only)

Offline tests (Android only)

QA Steps (Android only)

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 20, 2023

s77rt left a comment

Choose a reason for hiding this comment

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023 • edited Loading

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023

s77rt Sep 20, 2023

Choose a reason for hiding this comment

rmm-fl Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

s77rt commented Sep 20, 2023

rmm-fl commented Sep 20, 2023

s77rt commented Sep 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt Sep 20, 2023

Choose a reason for hiding this comment

rmm-fl Sep 20, 2023

Choose a reason for hiding this comment

OSBotify commented Sep 21, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

roryabraham commented Feb 7, 2024

Julesssss commented Feb 7, 2024

Julesssss commented Feb 7, 2024

s77rt commented Feb 7, 2024

rmm-fl commented Sep 20, 2023 •

edited by github-actions bot

Loading

rmm-fl commented Sep 20, 2023 •

edited

Loading

rmm-fl Sep 20, 2023 •

edited

Loading

s77rt commented Sep 20, 2023 •

edited

Loading