[NoQA] Add performance tests for getMemberAccountIDsForWorkspace #38271

ShridharGoel · 2024-03-14T04:14:50Z

Details

Add performance tests for getMemberAccountIDsForWorkspace

Fixed Issues

$ #38167
PROPOSAL: #38167 (comment)

Tests

These are new performance tests, does not need manual testing.

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)
[ x 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-03-14T04:14:54Z

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

paultsimura · 2024-03-14T13:16:42Z

tests/perf-test/PolicyUtils.perf-test.js

+        const personalDetails = Object.fromEntries(
+            Array.from({length: 10000}, (_, i) => [
+                `${i}`,
+                {
+                    accountID: 12345,
+                    firstName: 'First',
+                    lastName: 'Last',
+                    displayName: 'First Last',
+                    validated: true,
+                    phoneNumber: 1234567890,
+                    login: `test${i}@example.com`,
+                },
+            ]),


Please reuse the existing createPersonalDetails function:

App/tests/utils/collections/personalDetails.ts

Lines 4 to 12 in 3cbb309

export default function createPersonalDetails(index: number): PersonalDetails {

return {

accountID: index,

avatar: randAvatar(),

displayName: randWord(),

lastName: randWord(),

login: randEmail(),

};

}

paultsimura · 2024-03-14T13:17:20Z

tests/perf-test/PolicyUtils.perf-test.js

+
+describe('[PolicyUtils] Performance tests for getMemberAccountIDsForWorkspace', () => {
+    test('With multiple members without errors and login details', async () => {
+        const policyMembers = Object.fromEntries(Array.from({length: 10000}, (_, i) => [`${i}`, {errors: {}}]));


Please use createCollection:

App/tests/utils/collections/createCollection.ts

Lines 1 to 11 in 3cbb309

export default function createCollection<T>(createKey: (item: T, index: number) => string | number, createItem: (index: number) => T, length = 500): Record<string, T> {

const map: Record<string, T> = {};

for (let i = 0; i < length; i++) {

const item = createItem(i);

const itemKey = createKey(item, i);

map[itemKey] = item;

}

return map;

}

Also, create a separate util function createRandomPolicyMember similar to createRandomPolicy.

Read more here: https://github.com/Expensify/App/blob/6cdf088114314447c546467025d465568ef8f690/tests/README.md#mocking-collections--collection-items

You didn't commit the createRandomPolicyMember util.

paultsimura · 2024-03-14T17:23:00Z

Please don't push the code before performing a basic sanity check – currently, it's worse than before the changes.
Please fix the issues and re-request review by clicking the button here next to my tag:

tests/perf-test/PolicyUtils.perf-test.js

tests/utils/collections/policyMembers.ts

tests/perf-test/PolicyUtils.perf-test.js

tests/utils/collections/personalDetails.ts

tests/utils/collections/policyMembers.ts

tests/perf-test/PolicyUtils.perf-test.ts

paultsimura · 2024-03-16T13:51:39Z

Ok, now that the code looks good, let's look into the function you're writing tests for:

App/src/libs/PolicyUtils.ts

Lines 124 to 143 in fecbd84

    
           /** 
        
            * Create an object mapping member emails to their accountIDs. Filter for members without errors, and get the login email from the personalDetail object using the accountID. 
        
            * 
        
            * 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 getMemberAccountIDsForWorkspace(policyMembers: OnyxEntry<PolicyMembers>, personalDetails: OnyxEntry<PersonalDetailsList>): MemberEmailsToAccountIDs { 
        
               const memberEmailsToAccountIDs: MemberEmailsToAccountIDs = {}; 
        
               Object.keys(policyMembers ?? {}).forEach((accountID) => { 
        
                   const member = policyMembers?.[accountID]; 
        
                   if (Object.keys(member?.errors ?? {})?.length > 0) { 
        
                       return; 
        
                   } 
        
                   const personalDetail = personalDetails?.[accountID]; 
        
                   if (!personalDetail?.login) { 
        
                       return; 
        
                   } 
        
                   memberEmailsToAccountIDs[personalDetail.login] = Number(accountID); 
        
               }); 
        
               return memberEmailsToAccountIDs; 
        
           }

It uses mapping by the keys of policyMembers and personalDetails – we expect both these objects to be in the format:
{ [accountID]: data }.

Therefore, while building the mock data, do not use the custom key builders like policyMembers_${index} and personalDetails_${index} – use just (_, index) => index in all the places so that the keys of PolicyMembers and PersonalDetails match.

paultsimura · 2024-03-16T13:57:55Z

Also, please restructure the test file in the following way:

describe('PolicyUtils', () => {
    describe('getMemberAccountIDsForWorkspace', () => {
        test('500 policy members and full personal details'
        ...
        test('500 policy members and empty personal details'
        ...
        test('500 policy members with errors and full personal details'
        ...
        test('500 policy members with errors and empty personal details'
        ...

ShridharGoel · 2024-03-16T14:19:17Z

@paultsimura Updated.

paultsimura

LGTM.

paultsimura · 2024-03-16T14:46:17Z

@OlimpiaZurek could you please give this PR a second look? 🙏

paultsimura · 2024-03-16T14:49:34Z

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:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- 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 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
- 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OlimpiaZurek · 2024-03-18T10:58:12Z

@ShridharGoel The code looks good, but I'm not sure if all test scenarios are needed here. The purpose of these tests is to measure performance based on large amounts of data and catch possible regressions. Therefore, in my opinion, scenarios where the personalDetails is empty are redundant here.

Additionally, we must take into account the execution time of these tests on CI, and each additional test increases this time.

cc: @paultsimura

paultsimura · 2024-03-18T11:00:25Z

Thank you, that makes sense👍
@ShridharGoel Could you please remove the tests with empty personal details?

paultsimura

Approved with a tiny change – no need to re-request approval after the commit. Thanks ✔️

tests/perf-test/PolicyUtils.perf-test.ts

Co-authored-by: Pavlo Tsimura <[email protected]>

ShridharGoel · 2024-03-18T12:44:38Z

@OlimpiaZurek @mountiny Can you also have a look?

mountiny

@OlimpiaZurek do you want to review?

mountiny · 2024-03-18T13:11:55Z

tests/perf-test/PolicyUtils.perf-test.ts

+        test('500 policy members with personal details', async () => {
+            const policyMembers = createCollection<PolicyMember>(
+                (_, index) => index,
+                () => createRandomPolicyMember(),
+            );
+            const personalDetails = createCollection<PersonalDetails>((_, index) => index, createPersonalDetails);
+
+            await measureFunction(() => getMemberAccountIDsForWorkspace(policyMembers, personalDetails));
+        });
+


I am a bit weary on including both of these tests since if the member has any error they will not be returned.

Not a big deal, the function is not that complex so we could include both cases I think

OSBotify · 2024-03-18T16:30:40Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.54-0 🚀

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

OSBotify · 2024-03-19T23:11:44Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀

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

Add performance tests for getMemberAccountIDsForWorkspace

49bf3e6

ShridharGoel requested a review from a team as a code owner March 14, 2024 04:14

melvin-bot bot removed the request for review from a team March 14, 2024 04:14

melvin-bot bot requested a review from paultsimura March 14, 2024 04:14

ShridharGoel mentioned this pull request Mar 14, 2024

[HOLD for payment 2024-03-26] [$250] [Reassure] Add measureFunction test for getMemberAccountIDsForWorkspace #38167

Closed

Update PolicyUtils.perf-test.js

3cbb309

paultsimura suggested changes Mar 14, 2024

View reviewed changes

ShridharGoel added 3 commits March 14, 2024 22:23

Update PolicyUtils.perf-test.js

d3ac369

Update

b549f74

Add policyMembers.ts in utils

f77b6eb

ShridharGoel added 2 commits March 14, 2024 23:56

Update policyMembers.ts

97bd870

Update

6567928

ShridharGoel requested a review from paultsimura March 14, 2024 18:40

OlimpiaZurek reviewed Mar 14, 2024

View reviewed changes

tests/perf-test/PolicyUtils.perf-test.js Outdated Show resolved Hide resolved

OlimpiaZurek reviewed Mar 14, 2024

View reviewed changes

tests/perf-test/PolicyUtils.perf-test.js Outdated Show resolved Hide resolved

tests/perf-test/PolicyUtils.perf-test.js Outdated Show resolved Hide resolved

tests/perf-test/PolicyUtils.perf-test.js Outdated Show resolved Hide resolved

paultsimura suggested changes Mar 14, 2024

View reviewed changes

mountiny assigned ShridharGoel Mar 15, 2024

mountiny changed the title ~~Add performance tests for getMemberAccountIDsForWorkspace~~ [NoQA] Add performance tests for getMemberAccountIDsForWorkspace Mar 15, 2024

Update with suggested changes

64e94cc

ShridharGoel force-pushed the patch-1 branch from 3f48d02 to 64e94cc Compare March 15, 2024 18:41

ShridharGoel added 3 commits March 16, 2024 00:12

Update with suggested changes

b93a797

Update

be30f2b

Update

f4e527e

ShridharGoel requested review from OlimpiaZurek and paultsimura March 15, 2024 19:16

paultsimura suggested changes Mar 15, 2024

View reviewed changes

ShridharGoel added 2 commits March 16, 2024 12:05

Update

de413bf

Update

cdf0a84

ShridharGoel requested a review from paultsimura March 16, 2024 07:00

Add performance tests for getMemberAccountIDsForWorkspace

b6343bc

paultsimura approved these changes Mar 16, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny March 16, 2024 14:45

paultsimura approved these changes Mar 16, 2024

View reviewed changes

Keep tests with full personal details

24dae43

ShridharGoel requested a review from paultsimura March 18, 2024 11:13

paultsimura approved these changes Mar 18, 2024

View reviewed changes

tests/perf-test/PolicyUtils.perf-test.ts Outdated Show resolved Hide resolved

Update tests/perf-test/PolicyUtils.perf-test.ts

de6946b

Co-authored-by: Pavlo Tsimura <[email protected]>

mountiny approved these changes Mar 18, 2024

View reviewed changes

OlimpiaZurek approved these changes Mar 18, 2024

View reviewed changes

mountiny merged commit e737a63 into Expensify:main Mar 18, 2024
16 checks passed

github-actions bot mentioned this pull request Mar 18, 2024

Deploy Checklist: New Expensify 2024-03-18 #38489

Closed

65 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] Add performance tests for getMemberAccountIDsForWorkspace #38271

[NoQA] Add performance tests for getMemberAccountIDsForWorkspace #38271

ShridharGoel commented Mar 14, 2024 •

edited

Loading

melvin-bot bot commented Mar 14, 2024

paultsimura Mar 14, 2024

ShridharGoel Mar 14, 2024

paultsimura Mar 14, 2024

ShridharGoel Mar 14, 2024

paultsimura Mar 14, 2024

ShridharGoel Mar 14, 2024

paultsimura commented Mar 14, 2024

paultsimura commented Mar 16, 2024

paultsimura commented Mar 16, 2024

ShridharGoel commented Mar 16, 2024

paultsimura left a comment

paultsimura commented Mar 16, 2024

paultsimura commented Mar 16, 2024 •

edited

Loading

OlimpiaZurek commented Mar 18, 2024

paultsimura commented Mar 18, 2024

paultsimura left a comment

ShridharGoel commented Mar 18, 2024

mountiny left a comment

mountiny Mar 18, 2024

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

	export default function createPersonalDetails(index: number): PersonalDetails {
	return {
	accountID: index,
	avatar: randAvatar(),
	displayName: randWord(),
	lastName: randWord(),
	login: randEmail(),
	};
	}

	export default function createCollection<T>(createKey: (item: T, index: number) => string \| number, createItem: (index: number) => T, length = 500): Record<string, T> {
	const map: Record<string, T> = {};

	for (let i = 0; i < length; i++) {
	const item = createItem(i);
	const itemKey = createKey(item, i);
	map[itemKey] = item;
	}

	return map;
	}

[NoQA] Add performance tests for getMemberAccountIDsForWorkspace #38271

[NoQA] Add performance tests for getMemberAccountIDsForWorkspace #38271

Conversation

ShridharGoel commented Mar 14, 2024 • edited Loading

Details

Fixed Issues

Tests

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 14, 2024

paultsimura Mar 14, 2024

Choose a reason for hiding this comment

ShridharGoel Mar 14, 2024

Choose a reason for hiding this comment

paultsimura Mar 14, 2024

Choose a reason for hiding this comment

ShridharGoel Mar 14, 2024

Choose a reason for hiding this comment

paultsimura Mar 14, 2024

Choose a reason for hiding this comment

ShridharGoel Mar 14, 2024

Choose a reason for hiding this comment

paultsimura commented Mar 14, 2024

paultsimura commented Mar 16, 2024

paultsimura commented Mar 16, 2024

ShridharGoel commented Mar 16, 2024

paultsimura left a comment

Choose a reason for hiding this comment

paultsimura commented Mar 16, 2024

paultsimura commented Mar 16, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OlimpiaZurek commented Mar 18, 2024

paultsimura commented Mar 18, 2024

paultsimura left a comment

Choose a reason for hiding this comment

ShridharGoel commented Mar 18, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny Mar 18, 2024

Choose a reason for hiding this comment

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

ShridharGoel commented Mar 14, 2024 •

edited

Loading

paultsimura commented Mar 16, 2024 •

edited

Loading