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

Update expensify-common dependency #12720

Merged
merged 3 commits into from
Nov 21, 2022
Merged

Conversation

cristipaval
Copy link
Contributor

@cristipaval cristipaval commented Nov 14, 2022

Details

This PR addresses 2 issues, that's why there are 2 sets of testing steps.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/238874
$ #12511

Tests and QA Steps

Tests for handling custom subject messages

  1. Run the app
  2. Open any chat and send a custom subject message like following:
    # Test how h1 looks
    H1 tags now should have text of size 17px and bottom margin o size 8px
  3. Check the style of the custom subject to have text of size 17px and bottom margin of size 8px

Tests for markdown links with trailing spaces

Run npm run clean and npm install to get the latest markdown changes on dev.

  1. Sign in with any account
  2. Go to any chat
  3. Paste in a markdown link with trailing spaces in the title e.x [ test ](https://www.expensify.com/)
  4. Verify that the link message is exactly "test" and is blue and underlined.
  • 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 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

Handling custom subject messages

Web

web

Mobile Web - Chrome

android chrome

Mobile Web - Safari

ios safari

Desktop

desktop

iOS

ios native

Android

android native

Tests for markdown links with trailing spaces

Web

web.mov

Mobile Web - Chrome

android-chrome.mov

Mobile Web - Safari

ios-safari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

@cristipaval cristipaval requested a review from a team as a code owner November 14, 2022 20:00
@cristipaval cristipaval self-assigned this Nov 14, 2022
@melvin-bot melvin-bot bot requested review from marcochavezf and Santhosh-Sellavel and removed request for a team November 14, 2022 20:00
@melvin-bot
Copy link

melvin-bot bot commented Nov 14, 2022

@Santhosh-Sellavel @marcochavezf One of you needs to 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]

@neil-marcellini
Copy link
Contributor

Hey @cristipaval. I'm working on this issue and we recently made some changes to expensify-common as well. Would you please add my issue to the fixed issues section and test these steps as well?

  1. Sign in with any account
  2. Go to any chat
  3. Paste in a markdown link with trailing spaces in the title e.x [ test ](https://www.expensify.com/)
  4. Verify that the link message is exactly "test" and is blue and underlined.

@cristipaval
Copy link
Contributor Author

Hey @cristipaval. I'm working on this issue and we recently made some changes to expensify-common as well. Would you please add my issue to the fixed issues section and test these steps as well?

  1. Sign in with any account
  2. Go to any chat
  3. Paste in a markdown link with trailing spaces in the title e.x [ test ](https://www.expensify.com/)
  4. Verify that the link message is exactly "test" and is blue and underlined.

Hey @neil-marcellini! Sure, the testing steps and the fixed issues sections are now updated. Feel free to add screenshots for your tests.

@neil-marcellini
Copy link
Contributor

@cristipaval Thanks! I added screen recordings for the trailing space tests. Also please merge main to fix the conflicts.

@cristipaval cristipaval force-pushed the cristi_update-expensify-common branch from f75fdc3 to ebc28fe Compare November 15, 2022 20:22
…fy-common

# Conflicts:
#	package-lock.json
#	package.json
@cristipaval
Copy link
Contributor Author

Ready for review.

@Santhosh-Sellavel
Copy link
Collaborator

Will get to this tomorrow!

@Santhosh-Sellavel
Copy link
Collaborator

Ah sorry, I couldn't able to get this sooner!

@Santhosh-Sellavel
Copy link
Collaborator

Testing now!

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 19, 2022

Bug: An extra line was added above.

Only the text below was sent, after sent try edit the text look there is extra line above

# Test how h1 looks
H1 tags now should have text of size 17px and bottom margin o size 8px
Screen.Recording.2022-11-19.at.3.38.45.PM.mov

cc: @cristipaval

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 19, 2022

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:
    • 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/Videos

Desktop & Web
Screen.Recording.2022-11-19.at.3.32.01.PM.mov
Screenshot 2022-11-19 at 4 04 30 PM
iOS & Android
Native_And_IOS.mov
Mobile Web - Chrome
Screen_Recording_20221119_153745_Chrome.mp4
Mobile Web - Safari
iOS.mp4

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Nov 19, 2022

@cristipaval

Tests pass. But a doubt are we adding support for using one # only to just support h1, not for ## to support h2?

This happens on staging also, so mostly this should not blocking, but I'll wait for your answer before approving thanks!

cc: @marcochavezf

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.

Tests pass, just need some clarification here other wise looks good!

@cristipaval
Copy link
Contributor Author

@cristipaval

Tests pass. But a doubt are we adding support for using one # only to just support h1, not for ## to support h2?

This happens on staging also, so mostly this should not blocking, but I'll wait for your answer before approving thanks!

cc: @marcochavezf

Hey @Santhosh-Sellavel ! Thanks for reviewing! No, we don't have support for ## yet. We only support # (h1) for now because we use it for sending custom subject messages (which internally have special behaviour but you can't test it. It was tested internally).

@Santhosh-Sellavel
Copy link
Collaborator

Then We are good here!

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.

Looks good, tests well
Over to you @marcochavezf!

@marcochavezf marcochavezf merged commit e1111bc into main Nov 21, 2022
@marcochavezf marcochavezf deleted the cristi_update-expensify-common branch November 21, 2022 19:36
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.2.30-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @marcochavezf in version: 1.2.30-0 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

@cristipaval / @neil-marcellini / @marcochavezf Can you assign a BZ here to track payment for PR review?

@neil-marcellini
Copy link
Contributor

The BZ member assigned to the issue will pay you, which is @abekkala.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @luacmartins in version: 1.2.30-0 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

@abekkala this is due for Payment!

@abekkala
Copy link
Contributor

abekkala commented Dec 5, 2022

@neil-marcellini

The BZ member assigned to the issue will pay you, which is @abekkala.

Was Santosh's review for GH 12511? I did payouts for that one last week but didn't see him assigned to the issue that I'm assigned to? Can I confirm what his Review payout is for?
I was unaware that he needed a review payout for that issue as he wasn't assigned. So I need some clarification if his review payout is for that issue (12511) or if he is getting paid out via a different issue?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Dec 5, 2022

cc: @cristipaval

@neil-marcellini

The BZ member assigned to the issue will pay you, which is @abekkala.

Was Santosh's review for GH 12511? I did payouts for that one last week but didn't see him assigned to the issue that I'm assigned to? Can I confirm what his Review payout is for? I was unaware that he needed a review payout for that issue as he wasn't assigned. So I need some clarification if his review payout is for that issue (12511) or if he is getting paid out via a different issue?

@neil-marcellini
Copy link
Contributor

@abekkala C+ reviewers are automatically assigned to every App PR and they get paid for their review. There's no requirement for them to be assigned to the issue. In this case @Santhosh-Sellavel should be paid for reviewing this PR, and any other PRs that he reviewed in relation to #12511. Of course, he's only paid once per PR.

I had a hard time finding this process in our documentation, so please start a Slack conversation in #bug-zero about adding this to our guidelines.

@abekkala
Copy link
Contributor

abekkala commented Dec 5, 2022

PR review has been Paid! 🎉

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