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.

Sign up for GitHub

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

Jump to bottom

update react-native-svg version #10334

Merged
merged 8 commits into from Sep 1, 2022
Merged

update react-native-svg version #10334

merged 8 commits into from Sep 1, 2022

Conversation

mateusbra
Copy link
Contributor

@mateusbra mateusbra commented Aug 10, 2022 •
edited

Details

Update version of react-native-svg to the latest.

Fixed Issues

$ #10221

Tests

  • Verify you can npm install normally.
  • Verify svgs didn't changed and shows normally through all the app:
  1. Open the app
  2. Click on the + green button
  3. Verify SVG Icons renders normally(New chat,New group,Send money,Request money,Split bill)
  4. Click on settings button
  5. Verify SVG Icons renders normally(Workspaces,Profile,Preferences,Security,Payments,About,Sign Out)
  6. Open any chat
  7. Click on the + button
  8. Verify SVG Icons renders normally(Request money,Send Money,Add attachment)

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

  • Verify svgs didn't changed and shows normally through all the app:
  1. Open the app
  2. Click on the + green button
  3. Verify SVG Icons renders normally(New chat,New group,Send money,Request money,Split bill)
  4. Click on settings button
  5. Verify SVG Icons renders normally(Workspaces,Profile,Preferences,Security,Payments,About,Sign Out)
  6. Open any chat
  7. Click on the + button
  8. Verify SVG Icons renders normally(Request money,Send Money,Add attachment)

Screenshots

Web

WhatsApp Image 2022-08-10 at 15 27 23 (2)
WhatsApp Image 2022-08-10 at 15 27 23 (1)
WhatsApp Image 2022-08-10 at 15 27 23

Mobile Web

Android:
mweb-android-3
mweb-android-2
mweb-android-1
Ios:
mweb-ios-3
mweb-ios-2
mweb-ios-1

Desktop

desktop-3
desktop-2
desktop-1

iOS

WhatsApp Image 2022-08-11 at 21 12 12
WhatsApp Image 2022-08-11 at 21 11 24
WhatsApp Image 2022-08-11 at 21 10 52

Android

android-3
android-1
android-2

@mateusbra mateusbra requested a review from a team as a code owner August 10, 2022 01:04
@melvin-bot melvin-bot bot requested review from AndrewGable and parasharrajat and removed request for a team August 10, 2022 01:04
@mateusbra
Copy link
Contributor Author

I'm having some issues to run the app on all platforms, so I'll povide the screenshots when I'm able to run it.

@mateusbra
Copy link
Contributor Author

CHANGELOGS SINCE VERSION 12.1

@parasharrajat
Copy link
Member

@mateusbra Please attach videos for all platforms.

@mateusbra
Copy link
Contributor Author

Working on it right now, I'm facing issues running npm run android and npm run ios. https://expensify.slack.com/archives/C01GTK53T8Q/p1660156287818209 it gives me this error on my macos and also on my windows. Once I'm able to run on both native platforms I'll provide the screenshots.

Also, is this Jest unit test failing because of the upgrade of RN version of the project or I'm I doing something wrong here?

@parasharrajat
Copy link
Member

parasharrajat commented Aug 10, 2022 •
edited

We can rerun these tests. There was a runtime memory issue.

Do the following for builds.

  1. npm cache verify.
  2. npm ci.

@mateusbra
Copy link
Contributor Author

About this error, I found this link saying it could be the node version, what you think we should do here @parasharrajat ?

parasharrajat
parasharrajat previously approved these changes Aug 12, 2022
View reviewed changes
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

I am getting signature changes on npm-install. This has happened to me before but everything is working fine.

cc: @AndrewGable Could you please run npm-install to see if you are getting the same?

Also, it seems like there are some memory issues with jest tests.

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.

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

@mateusbra How can QA run npm-install on staging? Correct the QA steps.

  1. Move the npm install statement to tests.
  2. Add proper tests that you have run.
  3. In QA steps mention how they can test SVG rendering on a running app.

@AndrewGable
Copy link
Contributor

FYI - Tests are failing and there are conflicts. But changes look good. I will do a quick review and merge once this is fixed.

@AndrewGable
Copy link
Contributor

Hmm ok so we can't merge with failing tests. We are upgrading the node version here: #10439

So we could hold this PR until that one is merged if you think it will fix it.

@parasharrajat
Copy link
Member

@mateusbra Please merge main and retest.

@AndrewGable
Copy link
Contributor

Bump @mateusbra

@mateusbra
Copy link
Contributor Author

Hey guys, sorry for the delay, I was out for some days,I'll focus on this one in order to be merged ASAP...
While this PR was open a new version of react-native-svg was released.
Do you think we should update it to the newer version(v13.1.0)? or should we keep the version we currently were testing(v12.4.3)?

@parasharrajat
Copy link
Member

Thanks for the response. Are there any breaking changes? If the upgrade is smooth and works great, let's do that.

@mateusbra
Copy link
Contributor Author

mateusbra commented Aug 30, 2022 •
edited

There aren't any breaking change.
There is a breaking change:

Fabric is React Native's new rendering system. As of version 13.0.0 of this project, Fabric is supported only for react-native 0.69.0+. Support for earlier versions is not possible due to breaking changes in configuration.

We currently are using "react-native": "npm:@expensify/react-native@0.69.4", so I don't think we are going to have problems with this.

I will test on all platforms and if it works fine I'll use this new version(v13.1.0)

@mateusbra
Copy link
Contributor Author

mateusbra commented Aug 30, 2022 •
edited

It worked fine on my tests.
Also, the upgrading node/npm version PR solved the runtime memory issue on jest tests.

cc: @parasharrajat
cc: @AndrewGable

@parasharrajat
Copy link
Member

Please complelete the author checklist.

parasharrajat
parasharrajat approved these changes Aug 31, 2022
View reviewed changes
Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

LGTM. Please complete the checklist.
cc: @AndrewGable

@AndrewGable AndrewGable merged commit 052c177 into Expensify:main Sep 1, 2022
@OSBotify
Copy link
Contributor

OSBotify commented Sep 1, 2022

✋ 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 OSBotify mentioned this pull request Sep 1, 2022
Closed
24 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Sep 1, 2022

🚀 Deployed to staging by @AndrewGable in version: 1.1.96-0 🚀

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

@parasharrajat parasharrajat mentioned this pull request Sep 1, 2022
Closed
@arosiclair arosiclair mentioned this pull request Sep 1, 2022
Closed
@luacmartins luacmartins mentioned this pull request Sep 2, 2022
Merged
@roryabraham roryabraham mentioned this pull request Sep 2, 2022
Closed
38 tasks
@melvin-bot melvin-bot bot mentioned this pull request Sep 5, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndrewGable AndrewGable AndrewGable approved these changes

@parasharrajat parasharrajat parasharrajat approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@mateusbra @parasharrajat @AndrewGable @OSBotify