[HOLD for payment 2023-03-01] [$1000] Allow avatar image uploads: gif on Android

[Beamanator]

Action Performed:

1. Upload .gif as avatar image on Android

Expected Result:

It should upload and convert to .jpeg (the conversion can happen on the front end if needed, but we already have conversion code on the backend that works for every type of image in web)

Actual Result:

1. Uploading GIF in Android throws console warning, isn't able to upload image

Note: Some investigation was done here, indicating this may be a problem with a library we use, RNImageManipulator

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~012d6d474213ddb534
• Upwork Job ID: 1621106096863707136
• Last Price Increase: 2023-02-10

[melvin-bot]

Triggered auto assignment to @anmurali (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~012d6d474213ddb534

[melvin-bot]

Current assignee @anmurali is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @mananjadhav (External)

[melvin-bot]

Current assignee @Beamanator is eligible for the External assigner, not assigning anyone new.

[s77rt]

Proposal

The two mentioned issues have different root causes.

RCA

The .bmp images failing on iOS is a bug in react-native-image-picker.
The bug is that we fail to detect .bmp files as images.

---

The .gif images failing on Android is due to the lack of support for animated images in react-native-image-manipulator.
This is a known limitation of using Fresco's BaseBitmapDataSubscriber (that's what the lib uses).

Fix

I have raised a PR for each issue.

• Changed the way we detect images in iOS react-native-image-picker/react-native-image-picker#2076
• Added support to animated images oguzhnatly/react-native-image-manipulator#3

[s77rt]

I have updated my proposal above to handle both issues.

[redstar504]

Proposal (Android GIF issue)

Modifying the upstream package with an additional dependency that decodes the entire GIF just to extract the first frame is not necessary. The existing decoder has an option built in that will capture the first frame as soon as it's available.

It is easy to implement, and saves memory that would be allocated to decoding and performing transformations on the entire animation. It can be accomplished by a simple change (in our existing react-native-image-manipulator fork):

diff --git a/android/src/main/java/com/reactnativeimagemanipulator/RNImageManipulatorModule.java b/android/src/main/java/com/reactnativeimagemanipulator/RNImageManipulatorModule.java
index 4b8ed8a..b404fa7 100644
--- a/android/src/main/java/com/reactnativeimagemanipulator/RNImageManipulatorModule.java
+++ b/android/src/main/java/com/reactnativeimagemanipulator/RNImageManipulatorModule.java
@@ -23,6 +23,7 @@ import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
+import com.facebook.imagepipeline.common.ImageDecodeOptions;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -53,6 +54,10 @@ public class RNImageManipulatorModule extends ReactContextBaseJavaModule {
         ImageRequestBuilder
             .newBuilderWithSource(Uri.parse(uriString))
             .setRotationOptions(RotationOptions.autoRotate())
+            .setImageDecodeOptions(
+                    ImageDecodeOptions.newBuilder()
+                            .setForceStaticImage(true)
+                            .build())
             .build();
     final DataSource<CloseableReference<CloseableImage>> dataSource
         = Fresco.getImagePipeline().fetchDecodedImage(imageRequest, getReactApplicationContext());

[MelvinBot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[MelvinBot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.2.75-0 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Upgrade RN image-manipulator package to allow Android GIF avatars #15121

If no regressions arise, payment will be issued on 2023-03-01. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[MelvinBot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@mananjadhav / @Beamanator] The PR that introduced the bug has been identified. Link to the PR:
  • Bug was in an external library, no PR regression to link
• [@mananjadhav / @Beamanator] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
  • Similar as above
• [@mananjadhav / @Beamanator] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
  • N/A
• [@redstar504] Propose regression test steps to ensure the same bug will not reach production again.
• [@trjExpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: https://github.com/Expensify/Expensify/issues/265438

[mananjadhav]

@Beamanator @trjExpensify @redstar504 I think we're good to use the QA steps in the PR for the regression test proposal?

[redstar504]

@mananjadhav Yes, I will paste them here for reference:

1. Add an animated GIF image to an Android simulator or device
2. Log in to the app, and navigate to the profile screen
3. Press on the current avatar to change it, and press "Upload photo"
4. Press "Choose from gallery" and select the GIF image on your device
5. Proceed to crop, rotate, and zoom the avatar as desired
6. Press "Save" to finish uploading the avatar
7. Observe that the avatar was uploaded successfully
8. Observe that the saved avatar is a static image that only contains the first frame of the animation

#15121

[mananjadhav]

Thanks @redstar504. Quick bump @Beamanator @trjExpensify

[Beamanator]

Those test steps look great! I'd say one thing to change is: don't mention the particular environment that the tests will be run in please 🙏

[redstar504]

@Beamanator Good catch. Edited.

[trjExpensify]

Do we want to test this specific file format on Android-only with every regression test? I.e why not across all platforms? Also, we don't have any file type specifics for avatar uploads in our regression suite atm, should we couple this with the most common? I.e JPEG, PNG, GIF, SVG?

@Beamanator reference being somewhat similar to this "other" regression test case for attachment uploads.

[Beamanator]

@trjExpensify Ooh good points! I think it's fair to make sure all of those types work across all platforms to prevent any bugs leaking through 👍

[trjExpensify]

Okay, so I think we add GIF, PNG and SVG to this test case under a new sub-header:

GIF, SVG and PNG

1. Repeat the steps to upload an avatar, but now choose a PNG file within the file size limits
2. Verify that the avatar uploads successfully
3. Repeat the steps to upload an avatar, but now choose an SVG file
4. Verify that the avatar uploads successfully
5. Repeat the steps to upload an avatar, but now choose a GIF file
6. Verify that the avatar uploads successfully
7. Verify that the saved avatar is a static image that only contains the first frame of the animation

Let me know if you agree, and I'll create the GH.

[mananjadhav]

The test looks good.

within the file size limits

I don't have access to the Testrail but do we have this limit specified somewhere?

---

@trjExpensify @Beamanator This is ready for payout today but I have a questions. While the review was done within the timelines (it had 2 PRs), it was merged a week later. Will the timeline bonus be affected with this?

[trjExpensify]

I don't have access to the Testrail but do we have this limit specified somewhere?

Ah yeah, the earlier part of this test script is about file size/limits, so here I'm not rehashing that:

[mananjadhav]

thanks for posting the testcase.

[trjExpensify]

@trjExpensify @Beamanator This is ready for payout today but I have a questions. While the review was done within the timelines (it had 2 PRs), it was merged a week later. Will the timeline bonus be affected with this?

Hey @mananjadhav, the bonus won't apply on this issue because the review wasn't completed until 4 days later. I see you approved the PR on the 16th, but the checklist wasn't completed until the 17th. Those two actions should come together for a review to be deemed complete.

I've gone ahead and settled up the contracts. I'll create the regression test issue for Applause now and close this issue out. Thanks everyone!

[trjExpensify]

Regression test here: https://github.com/Expensify/Expensify/issues/265438

[mananjadhav]

Thanks for confirmation @trjExpensify , but I had some questions on how we calculate timeline, so I've raised a question in the slack thread here.

[kbecciv]

@trjExpensify Can you please create the regression test issue or I can create one, please let me know.
QA team is unable to update GIF file in avatar on Android, Save button is not responding.

video_21.mp4

[trjExpensify]

Hey @kbecciv, sorry for the slight delay, I've been OoO. The regression test issue was created a while back here, is that what you're looking for?

[kbecciv]

@trjExpensify Correct, steps are added in TR. QA team is having issue to update GIF file in avatar on Android device. "Save" button is not responding. Do you want me to create a separate GH issue?

[trjExpensify]

Yep, please create a bug report for that 👍

[kbecciv]

@trjExpensify Logged separate issue #18088

[trjExpensify]

Thanks!