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

Policy employees merge refactor #10395

Merged
merged 22 commits into from
Sep 28, 2022
Merged

Conversation

chiragsalian
Copy link
Contributor

@chiragsalian chiragsalian commented Aug 16, 2022

Held on https://github.com/Expensify/Web-Expensify/pull/34602

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/211556

Tests

Admin test

  1. Log into the same admin account in two browsers. One normal browser and another incognito.
  2. On both browsers. Click on Avatar icon -> Select any workspace -> Manage members.
  3. On one browser add a member and confirm it was successfully added in the normal browser and that it shows up immediately in the incognito browser indicating that the push notification worked well.
Screen.Recording.2022-09-13.at.3.34.52.PM.mov

Admin and new user test.

  1. Repeat the same steps above with the only difference being the admin logs into normal browser while the new user logs into incognito browser.
  2. Confirm the new user immediately gets the new workspace chat and sees contact information of the other members on the same policy
Screen.Recording.2022-09-13.at.3.55.34.PM.mov

Admin and existing user test

  1. Repeat the same steps above with the only difference being the admin logs into normal browser while the existing user logs into incognito browser.
  2. When a new user is added confirm the existing user can immediately find the new user in new chat easily using first and last name.
Screen.Recording.2022-09-13.at.3.59.17.PM.mov
  • Verify that no errors appear in the JS console
    I see a JS console error but it's not related to my changes.

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
  • 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 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

Same as Tests.

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@chiragsalian chiragsalian self-assigned this Aug 16, 2022
@chiragsalian chiragsalian changed the title [WIP] Policy employees merge refactor [HOLD on Web-E 34602] Policy employees merge refactor Sep 14, 2022
@chiragsalian chiragsalian marked this pull request as ready for review September 14, 2022 00:30
@chiragsalian chiragsalian requested a review from a team as a code owner September 14, 2022 00:30
@melvin-bot melvin-bot bot requested review from MonilBhavsar and removed request for a team September 14, 2022 00:30
src/languages/es.js Outdated Show resolved Hide resolved
src/libs/actions/Policy.js Outdated Show resolved Hide resolved
src/libs/actions/Policy.js Outdated Show resolved Hide resolved
@chiragsalian
Copy link
Contributor Author

Ready for re-review

Copy link
Contributor

@MonilBhavsar MonilBhavsar 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! Will test once the Web-E PR discussions are resolved and merged

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Tested with Web-PR.
The tests mentioned in the tests section works well, but doesn't work offline. @chiragsalian it is should be pattern B, right? Could you please check If I'm holding something wrong or we need some more changes here.

@JmillsExpensify JmillsExpensify changed the title [HOLD on Web-E 34602] Policy employees merge refactor Policy employees merge refactor Sep 22, 2022
@melvin-bot
Copy link

melvin-bot bot commented Sep 22, 2022

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@JmillsExpensify
Copy link

Web-E 34602 was merged and is on staging, so should hit production on Monday. I removed the hold but be careful until then.

@chiragsalian
Copy link
Contributor Author

chiragsalian commented Sep 26, 2022

Sorry, I didn't get this. Are both PR's interdependent?

For online testing, they are not dependent on each other. For offline testing, yes there is a block of code here ioni uses which the PR here is dependent off. I've explain my reason why I've not copied it over here,

Finally the data provided to WorkspaceMembersPage does not contain all the necessary information and that I realized is done here in ioni's PR so you can copy over the same to test pendingActions. I'm not copying it over as it's dupe work.

Also, can we please include some tests/QA for offline mode too 🙏

The reason I've not included it is because its dependent on ioni's PR. We usually just write the normal test case (example) for QA. I could copy over ioni's code and write up offline steps, but it sort of feels like dupe work which will cause an unnecessary merge conflict. Anyway, I don't feel too strongly about copying the code but let me know if you feel strongly about it.

src/components/OfflineWithFeedback.js Outdated Show resolved Hide resolved
src/libs/actions/Policy.js Outdated Show resolved Hide resolved
@chiragsalian
Copy link
Contributor Author

Updated and ready for review.

@chiragsalian
Copy link
Contributor Author

Updated

Copy link
Contributor

@MonilBhavsar MonilBhavsar 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 and works well! Please add QA steps 🙏

@chiragsalian
Copy link
Contributor Author

Yup thank you, i added to mention its the same as tests.

@chiragsalian chiragsalian merged commit 33c2b5a into main Sep 28, 2022
@chiragsalian chiragsalian deleted the chirag-Policy_Employees_Merge-refactor branch September 28, 2022 17:01
@melvin-bot melvin-bot bot added the Emergency label Sep 28, 2022
@melvin-bot
Copy link

melvin-bot bot commented Sep 28, 2022

@chiragsalian looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@chiragsalian
Copy link
Contributor Author

Not emergency, tests had passed just fine.

@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 @chiragsalian in version: 1.2.10-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @chiragsalian in version: 1.2.10-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @roryabraham in version: 1.2.10-1 🚀

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.

5 participants