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

[New architecture] Replace @oguzhnatly/react-native-image-manipulator with expo-image-manipulator #36019

Merged

Conversation

kowczarz
Copy link
Contributor

@kowczarz kowczarz commented Feb 7, 2024

Details

Fixed Issues

$ #35984

Tests

  1. Log in to expensify account
  2. Go to Account Settings
  3. Press avatar to edit the profile image
  4. Select upload photo
  5. Pick any photo
  6. adjust the size and location of the picked image
  7. Press save
  8. Profile Image should be updated
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

Screenshots/Videos

Android: Native
android.native_H.265.mp4
Android: mWeb Chrome
android.web_H.265.mp4
iOS: Native
ios.native_H.265.mp4
iOS: mWeb Safari
ios.web_H.265.mp4
MacOS: Chrome / Safari
web_H.265.mp4
MacOS: Desktop
desktop_H.265.mp4

@kowczarz
Copy link
Contributor Author

kowczarz commented Feb 7, 2024

EDIT: This is already fixed

I'm aware about following error on web and desktop, but it's fixed in #30829 and since it's in final review and it probably will be merged soon I didn't apply same fixes here to avoid merge conflicts.

ERROR in ./node_modules/expo-modules-core/build/uuid/uuid.web.js 7:10-27
Module not found: Error: Can't resolve 'crypto' in '/path/to/project/App/node_modules/expo-modules-core/build/uuid'

BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.
This is no longer the case. Verify if you need this module and configure a polyfill for it.

@roryabraham
Copy link
Contributor

Want to clarify with whatever C+ gets assigned to this issue that we'll pay a $250 bounty for the review instead of the standard $500

@kowczarz kowczarz marked this pull request as ready for review February 19, 2024 19:49
@kowczarz kowczarz requested a review from a team as a code owner February 19, 2024 19:49
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team February 19, 2024 19:49
Copy link

melvin-bot bot commented Feb 19, 2024

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

@mananjadhav
Copy link
Collaborator

@kowczarz Can you add some info for the Test Steps/QA Steps for the QA team when they test the changes in staging.

@kowczarz
Copy link
Contributor Author

@mananjadhav done

import {SaveFormat} from 'expo-image-manipulator';

function getSaveFormat(type: string) {
switch (type) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Currently we support: jpg, jpeg, png, gif, bmp, svg. For jpg, bmp, gif the fallback as jpeg is fine, but if I upload an svg today on staging/production,
the fallback is png. With this will it be jpeg?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's being handled here, I just changed the library, but I tried to keep logic untouched.

fetch(result.uri)
.then((res) => res.blob())
.then((blob) => {
const file = new File([blob], options.name || 'fileName.jpeg', {type: options.type || 'image/jpeg'});
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am wondering in which case will options.name will not be set and we'll have to fallback for fileName.jpeg? Can we use any other fallback? instead of hardcoding?

Copy link
Contributor Author

Choose a reason for hiding this comment

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


function getSaveFormat(type: string) {
switch (type) {
case 'image/png':
Copy link
Collaborator

Choose a reason for hiding this comment

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

should this be moved to CONST? instead of switch case?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved the file type to const, but I think it looks better with switch/case than if we just create an object that maps gif and bmp to jpeg.

src/CONST.ts Outdated
@@ -1008,6 +1008,12 @@ const CONST = {
VIDEO: 'video',
},

FILE_FORMAT: {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
FILE_FORMAT: {
IMAGE_MIME_TYPES: {

or IMAGE_FILE_FORMAT

* Crops and rotates the image on web
*/
import {manipulateAsync} from 'expo-image-manipulator';
import getSaveFormat from 'src/libs/cropOrRotateImage/getSaveFormat';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
import getSaveFormat from 'src/libs/cropOrRotateImage/getSaveFormat';
import getSaveFormat from './getSaveFormat';

This path is incorrect and breaking the build.

@mananjadhav
Copy link
Collaborator

@kowczarz Can you correct the path as the build is breaking and also resolve the conflicts?

I wanted to confirm one thing, did you get any console error when testing the PR? I got a console error only once Maximum update depth exceeded. I didn't get it again and I must've tried atleast 10 times. On main I didn't get even once. So I am concerned if we end up adding any console.error.

import RNFetchBlob from 'react-native-blob-util';
import getSaveFormat from 'src/libs/cropOrRotateImage/getSaveFormat';
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
import getSaveFormat from 'src/libs/cropOrRotateImage/getSaveFormat';
import getSaveFormat from './getSaveFormat';

@mananjadhav

This comment was marked as outdated.

@roryabraham
Copy link
Contributor

@kowczarz heads up you've got conflicts here

@mountiny
Copy link
Contributor

@kowczarz lets try to resolve the conflicts

@mananjadhav can you complete the checklist please once resolved

@mananjadhav
Copy link
Collaborator

@kowczarz Any updates?

@mountiny Yes waiting for the conflict resolution and also the import path fix.

@mananjadhav
Copy link
Collaborator

@kowczarz Quick bump.

@kosmydel
Copy link
Contributor

kosmydel commented Mar 4, 2024

Hey, we're sorry for the delay.

I've resolved conflicts and addressed the review.

I wanted to confirm one thing, did you get any console error when testing the PR? I got a console error only once Maximum update depth exceeded. I didn't get it again and I must've tried atleast 10 times. On main I didn't get even once. So I am concerned if we end up adding any console.error.

@mananjadhav The first time I followed the test plan I got some Maximum update depth exceeded. But I was able to reproduce it only once (and I've tried it also more than 10 times). I'm not sure why did it happen. I will give it some more tries.

@kosmydel
Copy link
Contributor

kosmydel commented Mar 4, 2024

It's ready for review. However I'm not sure why the Gihub Actions check is failing.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Mar 4, 2024

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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
android-image-edit.mov
Android: mWeb Chrome
mweb-chrome-image-edit.mov
iOS: Native
ios-image-edit.mov
iOS: mWeb Safari
mweb-safari-image-edit.mov
MacOS: Chrome / Safari
web-image-edit.mov
MacOS: Desktop
desktop-image-edit.mov

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Changes worked fine for me, and the build too. I am not sure about the Github action. @roryabraham Can you help rerunning once?

@melvin-bot melvin-bot bot requested a review from mountiny March 4, 2024 17:45
@mountiny
Copy link
Contributor

mountiny commented Mar 4, 2024

@kosmydel @kowczarz did you build the gh actions

"gh-actions-build": "./.github/scripts/buildActions.sh",
?

@kosmydel
Copy link
Contributor

kosmydel commented Mar 5, 2024

I've merged main, but it also didn't help.

@roryabraham roryabraham merged commit f4f5de1 into Expensify:main Mar 5, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Mar 5, 2024

✋ 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
Copy link
Contributor

OSBotify commented Mar 6, 2024

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.48-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 7, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.48-0 🚀

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

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.

6 participants