[NoQA] chore(tests): unified utilities for mocking collections #30833

adhorodyski · 2023-11-03T11:20:13Z

Details

This PR introduces basic testing primitives for working with collections. The goal of these APIs is to provide a solid, unified base for all the tests and reduce boilerplate needed anytime you need to work with a collection (or a collection item).

API

The createCollection(): Record<string, T> utility generates an N-length (default=500) map based on the provided key and item functions. The output can be used later on to eg. populate Onyx.

createRandomPolicy(): Policy and createRandomReport(): Report are the first item utilities introduced to better explain the idea - they can be altered at any stage to provide good defaults and more should come with time.

Generating random collection of policies (default length=500):

const policies = createCollection<Policy>(item => `policies_${item.id}`, createRandomPolicy);

/**
    Output:
    {
        "policies_0": policyItem0,
        "policies_1": policyItem1,
        ...
    }
*/

Same thing, but with overrides:

const policies = createCollection<Policy>(
    item => `policies_${item.id}`,
    index => ({ ...createRandomPolicy(index), isPinned: true })
);

Fixed Issues

$ #30994
PROPOSAL: https://expensify.slack.com/archives/C01GTK53T8Q/p1699275209779529

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

Screenshots/Videos

N/A - this PR only includes testing utilities.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

adhorodyski · 2023-11-03T11:22:39Z

@mountiny could you please advise on the docs we can update when introducing these utilities? I'd love for people to have a place they can refer to for an explanation/have good defaults.

tests/utils/collections/policies.ts

barttom · 2023-11-03T12:15:58Z

I have a concern about this solution:
If data can be random, are we able to create a proper testing scenario that can match every time?
Maybe could You prepare a doc how to use it?

mountiny · 2023-11-03T12:25:00Z

@adhorodyski I think you can add this to the README of tests folder, that would make sense or create anothe md file there and link from the readme if you dont want to make that too long

adhorodyski · 2023-11-03T12:36:05Z

@barttom you totally can set the properties you care about with overrides, just spread the default object first (or not 😜 just stay safe, keep it typed!).

The goal of these utilities is to create well typed, real-world looking objects (that take enough space and have all required properties), not to provide the real objects you might need - that's still on you (it's just that sometimes the dummy ones work).

You can also provide your whole new createItem implementation and just use the rand*() utilities, up to you and your usecase 😉

I haven't tried to provide ready to use implementations of createRandomPoliciesCollection() (and others) having in mind the very scenario you described. Hope this helps!

TLDR; you can treat this more like a set of utilities for mocking, not the mocks themselves 😊

adhorodyski · 2023-11-06T14:28:09Z

@mountiny just updated the docs under tests/readme 😊

melvin-bot · 2023-11-06T14:28:52Z

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

amyevans

Seems useful, will wait to see if there's additional feedback in the Slack thread though

amyevans

Alright no additional feedback, but it's a dev dependency so I don't think it's a big deal, plus the benefit is nice! Merging!

amyevans · 2023-11-08T21:32:35Z

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

OSBotify · 2023-11-08T21:40:25Z

✋ 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 · 2023-11-10T16:00:21Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:53:48Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

OSBotify · 2023-11-14T22:13:54Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:57:10Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

adhorodyski added 6 commits November 2, 2023 21:14

chore: add @ngneat/falso as a dev dependency

502bf98

feat: add createRandomCollection generic utility

7a6ddad

chore: change the api on createCollection util

32b18c3

feat: add createRandomPolicy util

fedab6c

chore: fix imports

075611b

chore: add basic randomized report mock

d3ee4e2

barttom reviewed Nov 3, 2023

View reviewed changes

tests/utils/collections/policies.ts Show resolved Hide resolved

adhorodyski and others added 4 commits November 6, 2023 10:25

Merge branch 'Expensify:main' into chore/testing-utils

292c5ee

Merge branch 'Expensify:main' into chore/testing-utils

d3dcb68

Merge branch 'Expensify:main' into chore/testing-utils

a04a983

docs: add section on mocking collections within tests/readme

193cf19

adhorodyski marked this pull request as ready for review November 6, 2023 14:28

adhorodyski requested a review from a team as a code owner November 6, 2023 14:28

melvin-bot bot requested review from amyevans and removed request for a team November 6, 2023 14:28

amyevans reviewed Nov 6, 2023

View reviewed changes

Merge branch 'Expensify:main' into chore/testing-utils

56a1e16

mountiny assigned adhorodyski Nov 7, 2023

mountiny changed the title ~~chore(tests): unified utilities for mocking collections~~ [NoQA] chore(tests): unified utilities for mocking collections Nov 7, 2023

amyevans approved these changes Nov 8, 2023

View reviewed changes

amyevans merged commit c473b17 into Expensify:main Nov 8, 2023

adhorodyski deleted the chore/testing-utils branch November 8, 2023 22:32

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

melvin-bot bot mentioned this pull request Nov 14, 2023

[HOLD for payment 2023-11-21] Unified testing utilities for mocks using a fake data generation library #30994

Closed

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] chore(tests): unified utilities for mocking collections #30833

[NoQA] chore(tests): unified utilities for mocking collections #30833

adhorodyski commented Nov 3, 2023 •

edited by mountiny

Loading

adhorodyski commented Nov 3, 2023

barttom commented Nov 3, 2023

mountiny commented Nov 3, 2023

adhorodyski commented Nov 3, 2023 •

edited

Loading

adhorodyski commented Nov 6, 2023

melvin-bot bot commented Nov 6, 2023

amyevans left a comment

amyevans left a comment

amyevans commented Nov 8, 2023 •

edited

Loading

OSBotify commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

[NoQA] chore(tests): unified utilities for mocking collections #30833

[NoQA] chore(tests): unified utilities for mocking collections #30833

Conversation

adhorodyski commented Nov 3, 2023 • edited by mountiny Loading

Details

API

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

adhorodyski commented Nov 3, 2023

barttom commented Nov 3, 2023

mountiny commented Nov 3, 2023

adhorodyski commented Nov 3, 2023 • edited Loading

adhorodyski commented Nov 6, 2023

melvin-bot bot commented Nov 6, 2023

amyevans left a comment

Choose a reason for hiding this comment

amyevans left a comment

Choose a reason for hiding this comment

amyevans commented Nov 8, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

adhorodyski commented Nov 3, 2023 •

edited by mountiny

Loading

adhorodyski commented Nov 3, 2023 •

edited

Loading

amyevans commented Nov 8, 2023 •

edited

Loading