Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix image file size when uploaded from ios #10297

Merged
merged 2 commits into from
Aug 12, 2022
Merged

Conversation

ntdiary
Copy link
Contributor

@ntdiary ntdiary commented Aug 8, 2022

Details

  1. upgrade the version of react-native-image-picker
  2. add a new request handler to deal the selected image

Fixed Issues

$ #9424

Tests

  1. Launch the app
  2. Go to a chat and upload an image from a ios device.
  3. Check the image size on device.
  4. Now open the chat on recipient account in a web browser.
  5. Open and download the received image.
  6. Check the image file size.
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  1. Launch the app
  2. Go to a chat and upload an image from a ios device.
  3. Check the image size on device.
  4. Now open the chat on recipient account in a web browser.
  5. Open and download the received image.
  6. Check the image file size.
  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

https://youtu.be/oQQwplchSw8

Android

@ntdiary ntdiary requested a review from a team as a code owner August 8, 2022 14:47
@melvin-bot melvin-bot bot requested review from mountiny and Santhosh-Sellavel and removed request for a team August 8, 2022 14:47
Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntdiary

This handler is not part of the original proposal, please show us some clarity on that why is it needed.

cc: @mountiny

Comment on lines +1 to +12
//
// OriginImageRequestHandler.h
// NewExpensify
//
// Created by ntdiary on 2022/8/8.
//

#import <React/RCTURLRequestHandler.h>

@interface OriginImageRequestHandler : NSObject <RCTURLRequestHandler>

@end
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a header file created by convention.

Comment on lines +20 to +32
@implementation OriginImageRequestHandler
{
NSOperationQueue *_fileQueue;
}

RCT_EXPORT_MODULE()

- (void)invalidate
{
[_fileQueue cancelAllOperations];
_fileQueue = nil;
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this handler needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in my proposal, the issue root cause is UIImageJPEGRepresentation and UIImagePNGRepresentation.

these functions will change the image binary data when selecting and uploading.
...
for react-native-image-picker, can submit a PR with adding a option to keep origin data.
for react-native, can customize a new handler to deal the image upload.

We need to use this handler to upload the image file instead of the default RCTImageLoader.mm,
because the RCTImageLoader.mm also uses the above two functions.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntdiary Thanks! As Santosh said, more context is definitely needed here, also in more comments in the file for other engineers.... and us 😅

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 8, 2022

Hi, I thought it was made clear in the proposal 😂

react-native use RCTImageLoader#sendRequest by default to convert the image uri to binary data ( this image uri is returned by the react-native-image-picker ), and I also mentioned it in this issue
So we need to add a new handler to replace it.
Additionally, this new handler won't affect normal image loading

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 9, 2022

@mountiny @Santhosh-Sellavel, I'm going to add a short comment. Is this ok ? 🙂

diff --git a/ios/NewExpensify/OriginImageRequestHandler.mm b/ios/NewExpensify/OriginImageRequestHandler.mm
index d6dc968f9..346b43a9e 100644
--- a/ios/NewExpensify/OriginImageRequestHandler.mm
+++ b/ios/NewExpensify/OriginImageRequestHandler.mm
@@ -4,6 +4,8 @@
 //
 //  Created by ntdiary on 2022/8/8.
 //
+//  Use this handler to upload images returned by react-native-image-picker instead of the default RCTImageLoader.mm
+//  See https://github.com/facebook/react-native/issues/33760#issuecomment-1196562161

 #import <Foundation/Foundation.h>
 #import <ReactCommon/RCTTurboModule.h>

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntdiary I think it would be handy to also explain what the different parts of the file do, what do you think @Santhosh-Sellavel

@Santhosh-Sellavel
Copy link
Collaborator

Agree its useful

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 10, 2022

@mountiny I can try it, and there is something I need to explain 🙂
Its function is described in the protocol file (RCTURLRequestHandler.h)

These two files are copies of RCTFileRequestHandler in react-native, the only difference is that I changed its canHandleRequest condition and handlerPriority.
They are automatically loaded by by RCTNetworking.mm and are only used in react-native.

(RCTNetworking.mm uses RCTImageLoader to parse the image by default, like the image below)

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 10, 2022

How about this revision ?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntdiary Looks much better to me, thanks!

@Santhosh-Sellavel
Copy link
Collaborator

@ntdiary

Can you update the screenshot recording to ensure, everything works as expected?
Please fill the author checklist

@Santhosh-Sellavel
Copy link
Collaborator

@mountiny Can you initiate work flows to perform checks

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 11, 2022

@Santhosh-Sellavel This issue and revision only occurs on ios platform.
I'm not so sure, should I fill in all items in the author checklist and update all platform screenshots?
or only related to this revision and ios platform?

@mountiny
Copy link
Contributor

I swear to god I pressed that button!

I think it would be nice to test this and show video of android working well at least and check the checkboxes in the list too. But we can move ahead even without it this time since it touches ios predominantly (however updating the package could theoretically cause problems to android as well)

@ntdiary @Santhosh-Sellavel Great job guys! I hope @ntdiary you will pick up more issues in the repo, it was good to work with you!

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Aug 11, 2022

@ntdiary

You checked this,

  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

But didn't check off the checks that don't apply to the PR.

😂

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 11, 2022

@Santhosh-Sellavel uh, sorry, I canceled it first. 😅
i'm still trying to run the App on Android,
but it is running very slow, no matter if i build it from main branch or this branch
I'm checking what's going on.

@mountiny
Copy link
Contributor

@Santhosh-Sellavel Any chance you could help out with testing on android? I guess once confirmed all works well we can approve and merge 🙌

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Aug 11, 2022

PR 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we can move ahead even without it this time since it touches ios predominantly (however updating the package could theoretically cause problems to android as well)

If you are okay with the above, then we are good to go!

@mountiny

@ntdiary
Copy link
Contributor Author

ntdiary commented Aug 11, 2022

Hi, I have tested it on android and updated the checklist, although it runs slowly.
And I found this issue, it seems that everyone has encountered this problem in DEV env.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job guys, thank you both!

@mountiny mountiny merged commit 28d8b57 into Expensify:main Aug 12, 2022
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@trjExpensify
Copy link
Contributor

👋 Just making a note that this introduced a regression with the Take Photo attachment functionality as noted here. We're adding a regression test for our QA suite, but let's be careful to ensure we're test both types of image uploads in the future (from file / from taking a photo). Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants