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

Deprecate POLICY_MEMBERS #39489

Merged
merged 29 commits into from
Apr 16, 2024

Conversation

ZhenjaHorbach
Copy link
Contributor

@ZhenjaHorbach ZhenjaHorbach commented Apr 3, 2024

Details

Fixed Issues

$ #39376
PROPOSAL: #39376 (comment)

Tests

  1. Open the app
  2. Create new workspace
  3. Verify that all employee interaction functions are working correctly (Including adding, deleting, changing the role of an employee)
  • Verify that no errors appear in the JS console

Offline tests

  1. Open the app
  2. Create new workspace
  3. Verify that all employee interaction functions are working correctly (Including adding, deleting, changing the role of an employee)

QA Steps

  1. Open the app
  2. Create new workspace
  3. Verify that all employee interaction functions are working correctly (Including adding, deleting, changing the role of an employee)
  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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_53PpKTmv.mp4
Android: mWeb Chrome
android_53PpKTmv.mp4
iOS: Native
screen-recording-2024-04-10-at-095336_HZtOZKoD.mp4
iOS: mWeb Safari
ios-web_u4b22UV5.mp4
MacOS: Chrome / Safari
web_4GP3iVyI.mp4
MacOS: Desktop
desktop_LGtQ0qQS.mp4

@ZhenjaHorbach ZhenjaHorbach requested a review from a team as a code owner April 3, 2024 12:54
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team April 3, 2024 12:54
Copy link

melvin-bot bot commented Apr 3, 2024

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

@luacmartins luacmartins self-requested a review April 5, 2024 23:44
@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Apr 8, 2024

@eVoloshchak @luacmartins
Hello )
PR is ready for code review

But before filling out the checklist, I would like to fix one bug that creates problems with displaying elements
When we create a new workspace an array (employeeList) is returned instead of an object from the backend

@luacmartins
Could you please take a look from your internal side ?)

image

@luacmartins
Copy link
Contributor

Looking!

@luacmartins
Copy link
Contributor

I raised an internal PR to fix that issue. @ZhenjaHorbach did you see the incorrect shape being returned in any other API endpoints?

@luacmartins luacmartins changed the title Deprecate POLICY_MEMBERS [HOLD Web-E #41583] Deprecate POLICY_MEMBERS Apr 8, 2024
@ZhenjaHorbach
Copy link
Contributor Author

I raised an internal PR to fix that issue. @ZhenjaHorbach did you see the incorrect shape being returned in any other API endpoints?

For all the time I tested
I only had this problem related to BE)

@luacmartins
Copy link
Contributor

Sounds good, thanks for confirming! That PR should be deployed in the next couple of days. @eVoloshchak we can continue reviewing this one and treat that as NAB for now.

@ZhenjaHorbach
Copy link
Contributor Author

Sounds good, thanks for confirming! That PR should be deployed in the next couple of days. @eVoloshchak we can continue reviewing this one and treat that as NAB for now.

Although if we compare POLICY_MEMBERS and POLICY
I noticed that, unlike POLICY_MEMBERS, we do not receive a default role when adding someone to workspace

But this is a small problem)
Which we can fix on FE )

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good, just a few small comments

src/libs/PolicyMembersUtils.ts Outdated Show resolved Hide resolved
src/libs/PolicyUtils.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Show resolved Hide resolved
src/pages/workspace/WorkspaceMembersPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceMembersPage.tsx Outdated Show resolved Hide resolved
Comment on lines 63 to 75
const policyMembers: OnyxEntry<PolicyMembers> = await new Promise((resolve) => {
const connectionID = Onyx.connect({
key: `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policyID}`,
callback: (members) => {
Onyx.disconnect(connectionID);
resolve(members);
},
});
});

// check if the user was added as an admin to the policy
expect(policyMembers?.[ESH_ACCOUNT_ID]?.role).toBe(CONST.POLICY.ROLE.ADMIN);

Copy link
Contributor

Choose a reason for hiding this comment

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

You may need to check for policyEmployeeList.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch )
I forgot about this test
I will update it this weekend

@trjExpensify
Copy link
Contributor

👋 We have conflicts here! @ZhenjaHorbach can you address them today, please? Thanks!

@ZhenjaHorbach
Copy link
Contributor Author

👋 We have conflicts here! @ZhenjaHorbach can you address them today, please? Thanks!

Hello )
No problem
I'll do it during the day

@ZhenjaHorbach
Copy link
Contributor Author

ZhenjaHorbach commented Apr 15, 2024

👋 We have conflicts here! @ZhenjaHorbach can you address them today, please? Thanks!

@trjExpensify
I fixed conflicts

@flodnv
Copy link
Contributor

flodnv commented Apr 15, 2024

I looked at what was done here, looks great overall, thanks a lot for taking the time to clean this up and improve it! 👍

luacmartins
luacmartins previously approved these changes Apr 15, 2024
@luacmartins
Copy link
Contributor

Web-E PR is in staging. We can merge this after today's web deploy

@flodnv
Copy link
Contributor

flodnv commented Apr 16, 2024

FYI, conflicts

@luacmartins luacmartins changed the title [HOLD Web-E #41600] Deprecate POLICY_MEMBERS Deprecate POLICY_MEMBERS Apr 16, 2024
@luacmartins
Copy link
Contributor

Web-E is in prod. Removing hold and merging.

@luacmartins luacmartins merged commit 7efdde8 into Expensify:main Apr 16, 2024
17 checks passed
@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 https://github.com/luacmartins in version: 1.4.63-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

value: {
[sessionAccountID]: null,
pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE,
Copy link
Contributor

Choose a reason for hiding this comment

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

we should had cleared the policy data after successfully leaving a workspace and not put the pendingAction to delete. This change caused #43436

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.

8 participants