Policy members keyed by accountID #20397

neil-marcellini · 2023-06-07T17:34:48Z

Details

Fixed Issues

$ #20211
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 / Chrome
- iOS / native
- iOS / 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 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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 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(themeColors.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 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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…embers

Beamanator

So it looks like some things we'll need to do next are:

Stop needing to map emails to accountIDs in onyx (in ${ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MEMBERS_DRAFT}${policyID} & elsewhere)
Make sure linting & tests work
Work out the kinks & bugs

Beamanator · 2023-06-08T01:52:03Z

src/components/AvatarWithIndicator.js


    /** The employee list of all policies (coming from Onyx) */
-    policiesMemberList: PropTypes.objectOf(policyMemberPropType),
+    allPolicyMembers: PropTypes.objectOf(PropTypes.objectOf(policyMemberPropType)),


~~NAB - I feel like policyMembers could be a slightly more appropriate new variable since that exactly matches the new onyx key.~~

Now I realize it's cuz we're getting ALL of them. like your variable explains. I'll shut up 😬

~~Also, why PropTypes.objectOf(PropTypes.objectOf(? I think we can keep just PropTypes.objectOf( right?~~

Also now I think it makes sense since this is an object of collections 😬

Maybe update the comment like you did somewhere below: /** A collection of objects for all policies which key policy member objects by accountIDs */

Beamanator · 2023-06-08T13:51:37Z

src/libs/PolicyUtils.js

 /**
- * Checks if we have any errors stored within the POLICY_MEMBER_LIST. Determines whether we should show a red brick road error or not.
- * Data structure: {email: {role:'user', errors: []}, email2: {role:'admin', errors: [{1231312313: 'Unable to do X'}]}, ...}
+ * Checks if we have any errors stored within the POLICY_MEMBERS. Determines whether we should show a red brick road error or not.


NAB

Suggested change

* Checks if we have any errors stored within the POLICY_MEMBERS. Determines whether we should show a red brick road error or not.

* Checks if we have any errors stored within the POLICY_MEMBERS list. Determines whether we should show a red brick road error or not.

Beamanator · 2023-06-08T13:52:58Z

src/libs/PolicyUtils.js

+function getPolicyBrickRoadIndicatorStatus(policy, policyMembersCollection) {
+    const policyMembers = lodashGet(policyMembersCollection, `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policy.id}`, {});


This seems like a good place to use allPolicyMembers since it's literally all policy members collections, right?

Suggested change

function getPolicyBrickRoadIndicatorStatus(policy, policyMembersCollection) {

const policyMembers = lodashGet(policyMembersCollection, `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policy.id}`, {});

function getPolicyBrickRoadIndicatorStatus(policy, allPolicyMembers) {

const policyMembers = lodashGet(allPolicyMembers, `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policy.id}`, {});

Beamanator · 2023-06-08T13:55:27Z

src/libs/PolicyUtils.js

+ *
+ * We only return members without errors. Otherwise, the members with errors would immediately be removed before the user has a chance to read the error.
+ */
+function getClientPolicyMemberEmailsToAccountIDs(policyMembers, personalDetails) {


What will it take for us to be able to get rid of this?

Beamanator · 2023-06-08T13:56:29Z

src/libs/actions/Policy.js

+            value: _.object(accountIDs, Array(members.length).fill({errors: ErrorUtils.getMicroSecondOnyxError('workspace.people.error.genericRemove')})),
        },
    ];
    API.write(


We should eventually change emailList to accountIDList in the API command param, right? Is there an issue for this already?

Beamanator · 2023-06-08T13:57:14Z

src/libs/actions/Policy.js

 * @returns {Object} - object with onyxSuccessData, onyxOptimisticData, and optimisticReportIDs (map login to reportID)
 */
-function createPolicyExpenseChats(policyID, members, betas) {
+function createPolicyExpenseChats(policyID, invitedEmailsToAccountIDs, betas) {


aah looks like lint caught here - we still use members in this function

Beamanator · 2023-06-08T14:13:08Z

Merging b/c I want to get everything on the personalDetails-migration branch, then start clean on fixing things up

melvin-bot · 2023-06-08T14:13:09Z

@sobitneupane @arosiclair 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 · 2023-06-08T16:09:14Z

Oh lol ok I wasn't expecting you to merge this quite yet. Anyways no problem, I'll be planning to finish up the rest of this migration with another PR.

OSBotify · 2023-06-16T18:52:37Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.29-0 🚀

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

OSBotify · 2023-06-21T02:20:07Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

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

s77rt · 2023-07-10T19:09:12Z

src/pages/workspace/WorkspaceMembersPage.js

-            const details = lodashGet(this.props.personalDetails, email, {displayName: email, login: email});
+            const details = this.props.personalDetails[accountID];
+            if (!details) {
+                Log.hmmm(`[WorkspaceMembersPage] no personal details found for policy member with accountID: ${accountID}`);
+                return;
+            }


This caused a regression #22442. When we add a new user offline we didn't set their optimistic data in personalDetails but we used the fallback object (the one in lodashGet). Now neither is available which made the offline behaviour broken (user not added to the members list).

neil-marcellini added 2 commits June 7, 2023 10:32

Add new policy members key

f376593

workspaces list with policy members by accountID

1d585b7

neil-marcellini self-assigned this Jun 7, 2023

neil-marcellini added 4 commits June 7, 2023 10:38

Avatar with policy members by accountID

c74be2c

Settings page with policy members by accountID

0348e22

withPolicy HOC members by accountID

60db587

Workspace page with members by accountID

eae14eb

neil-marcellini changed the base branch from personalDetailsList-migration to beaman-continueMigration June 7, 2023 18:17

neil-marcellini added 13 commits June 7, 2023 11:18

Merge branch 'beaman-continueMigration' into neil-collection-policy-m…

97bf498

…embers

Merge branch 'beaman-continueMigration' into neil-collection-policy-m…

637cce2

…embers

Get policy member details by accountID

3d577f5

Fix get workspace members when keyed by accountID

43d050a

Set selected employees with members by accountIDs

5204d4c

Create util to get emails from policy members

f141959

Workspace invite with policy members by accountID

6dd4a1a

Use new util to get policy member emails

bde9682

Map member emails to accountIDs for easy access

fc38685

Remove policy members optimistically by accountID

8d9c4eb

policyMembers is actually allPolicyMembers

e55550d

Rename to allPolicyMembers and update prop type

bac0a50

WIP invitedEmailsToAccountIDs

ed057cc

Beamanator approved these changes Jun 8, 2023

View reviewed changes

Beamanator marked this pull request as ready for review June 8, 2023 14:12

Beamanator requested a review from a team as a code owner June 8, 2023 14:12

Beamanator merged commit dde8e89 into beaman-continueMigration Jun 8, 2023

Beamanator deleted the neil-collection-policy-members branch June 8, 2023 14:12

melvin-bot bot removed the request for review from a team June 8, 2023 14:13

melvin-bot bot requested review from arosiclair and sobitneupane June 8, 2023 14:13

Beamanator removed request for arosiclair and sobitneupane June 8, 2023 14:13

OSBotify mentioned this pull request Jun 16, 2023

Deploy Checklist: New Expensify 2023-06-16 #20928

Closed

PauloGasparSv mentioned this pull request Jun 19, 2023

Workspace - New users invited to WS are not displayed in members list but chats are created for them #20961

Closed

6 tasks

melvin-bot bot mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-06-28] Replace logins with accountIDs in policy members list #20211

Closed

s77rt reviewed Jul 10, 2023

View reviewed changes

s77rt mentioned this pull request Jul 25, 2023

[HOLD for payment 2023-08-01] [$1000] User was not shown on Invite members page after immediately inviting #22442

Closed

6 tasks

tienifr mentioned this pull request Jan 12, 2024

[$500] Room settings-Members added/deleted in a room in offline mode are not grayed out/crossed #31764

Closed

6 tasks

	* Checks if we have any errors stored within the POLICY_MEMBERS. Determines whether we should show a red brick road error or not.
	* Checks if we have any errors stored within the POLICY_MEMBERS list. Determines whether we should show a red brick road error or not.

		function getPolicyBrickRoadIndicatorStatus(policy, policyMembersCollection) {
		const policyMembers = lodashGet(policyMembersCollection, `${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policy.id}`, {});

Policy members keyed by accountID #20397

Policy members keyed by accountID #20397

Uh oh!

Conversation

neil-marcellini commented Jun 7, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Beamanator commented Jun 8, 2023

Uh oh!

melvin-bot bot commented Jun 8, 2023

Uh oh!

neil-marcellini commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Jun 16, 2023

Uh oh!

OSBotify commented Jun 21, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

neil-marcellini commented Jun 8, 2023 •

edited

Loading