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

Use official release for SVG library version #12374

Merged
merged 2 commits into from
Nov 4, 2022
Merged

Conversation

Julesssss
Copy link
Contributor

Details

We used a temporary commit for the react-native-svg library for urgency. Now that the official release has been made, we should point to it.

Fixed Issues

$ #12233

Tests

  1. Run the app
  2. Make sure icons and default avatars render correctly throughout the app. (note that avatars aren't cached offline correctly, but that's a separate known issue)
  3. Change your profile avatar, search for a user with a custom avatar, add a comment, view a workspace that has a custom avatar, ect

QA Steps

Run above tests

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 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
  • 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 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 reviewer 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 included screenshots or videos 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
  • 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 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 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 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.

Screenshots

Web

Screenshot 2022-11-02 at 15 18 31

Mobile Web - Chrome

Screenshot_20221102_155059

Mobile Web - Safari

Simulator Screen Shot - iPhone 14 Pro - 2022-11-02 at 15 41 56

Desktop

Screenshot 2022-11-02 at 15 48 51

iOS

Simulator Screen Shot - iPhone 14 Pro - 2022-11-02 at 15 40 38

Android

Screenshot_1667404000

@Julesssss Julesssss requested a review from a team as a code owner November 2, 2022 15:51
@Julesssss Julesssss self-assigned this Nov 2, 2022
@melvin-bot melvin-bot bot requested review from francoisl and Santhosh-Sellavel and removed request for a team November 2, 2022 15:51
@francoisl
Copy link
Contributor

Does this need to be tested with SVGs specifically, or any image type?

@Julesssss
Copy link
Contributor Author

Good question. The crashes were originally reproducible for me with any image type, rather than being associated with a specific image type. So I'd say it's fine to use any type.

@francoisl
Copy link
Contributor

Cool. I can test with the "regular" image types we previously restricted to (png, jpg, etc.), but having an issue with SVGs. I posted in https://expensify.slack.com/archives/C03TQ48KC/p1667413174518089 because I can't figure it out - it seems to have to do with the recent change to allow any attachment file types.

@Santhosh-Sellavel
Copy link
Collaborator

Reviewing this now!

@Santhosh-Sellavel
Copy link
Collaborator

Cool. I can test with the "regular" image types we previously restricted to (png, jpg, etc.), but having an issue with SVGs. I posted in https://expensify.slack.com/archives/C03TQ48KC/p1667413174518089 because I can't figure it out - it seems to have to do with the recent change to allow any attachment file types.

Unable to upload SVG, but that's irrelevant to this PR!
Screenshot 2022-11-04 at 12 54 50 AM

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 3, 2022

Screenshots:

#### Web Screenshot 2022-11-04 at 12 53 24 AM

Desktop

Screenshot 2022-11-04 at 12 52 05 AM

iOS mWeb

Simulator Screen Shot - iPhone 13 - 2022-11-04 at 00 51 25

iOS

Simulator Screen Shot - iPhone 13 - 2022-11-04 at 00 49 50

Android

Screenshot_1667503178

Android mWeb

Screenshot_1667503293

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 3, 2022

PR Reviewer Checklist

The reviewer 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 included screenshots or videos 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
  • 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 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 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 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.

@Santhosh-Sellavel
Copy link
Collaborator

@Julesssss

Since this affects Avatar and common components, I run a storybook.
Seeing many console errors, are we not updating the storybook?

Listing a few but there are more, check the following images, what should we do here!

Screenshot 2022-11-04 at 1 22 43 AM

Screenshot 2022-11-04 at 1 22 37 AM

Screenshot 2022-11-04 at 1 22 30 AM

Screenshot 2022-11-04 at 1 22 18 AM

Screenshot 2022-11-04 at 1 22 58 AM

Screenshot 2022-11-04 at 1 23 04 AM

@Julesssss
Copy link
Contributor Author

Hey, good idea to check Storybook. I can reproduce these errors on older versions, so I think it's fine to ignore here. But we should definitely go ahead and resolve these separately.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 4, 2022

Thanks, @Julesssss, then we are good here!

How should we proceed should I report this in slack,

  • Should we log one issue for all errors
  • Should we log one issue per component
  • Should we log one issue per error warning

Let me know, thanks!

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.

Screenshots: #12374 (comment)
Checklist: #12374 (comment)

C+ Reviewed
🎀 👀 🎀

LGTM!

@Julesssss
Copy link
Contributor Author

Thanks! I think it's fine to raise a single issue, personally.

@Julesssss
Copy link
Contributor Author

All yours @francoisl

@francoisl francoisl merged commit e2ac5e1 into main Nov 4, 2022
@francoisl francoisl deleted the jules-updateSVGLibVersion branch November 4, 2022 17:28
@OSBotify
Copy link
Contributor

OSBotify commented Nov 4, 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
Copy link
Contributor

OSBotify commented Nov 8, 2022

🚀 Deployed to staging by @francoisl in version: 1.2.25-0 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

@Julesssss Can you tag a BZ here, to track payment for C+ Review?

For all PRs that are linked to E/E issues, C+ comments and tags any assigned Expensify engineers in the PR asking them to check the E/E issue.

  • If the E/E issue is a bug, a BZ is already assigned, internal engineer cc's the BZ in a comment on the PR so C+ knows who is paying.
  • If the E/E isn't a bug, internal engineers add the Bug label to assign one, then engineer comments on the PR tagging the BZ who's assigned to issue payment.

@Julesssss
Copy link
Contributor Author

Hey @Santhosh-Sellavel, I reopened the issue to do this.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 9, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.2.25-0 🚀

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

@isabelastisser
Copy link
Contributor

Hi @Santhosh-Sellavel , please apply for this job in Upwork and I will issue the payment. Thanks!

Internal job posting: https://www.upwork.com/ab/applicants/1595083283153248256/job-details

External job posting: https://www.upwork.com/jobs/~017e99e729590faba2

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