add setCollection method #594

zirgulis · 2024-11-05T14:38:57Z

Details

In order to better align the Expensify client data with the server data there's a need to introduce a new setCollection method which will set the new collection data and remove the old one.

Related Issues

Expensify/App#51864

Automated Tests

Added test to cover all possible cases

Manual Tests

Author Checklist

I linked the correct issue in the ### Related 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

github-actions · 2024-11-05T14:39:11Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

zirgulis · 2024-11-05T14:41:09Z

I have read the CLA Document and I hereby sign the CLA

iwiznia · 2024-11-07T15:18:23Z

lib/Onyx.ts

+ * @param collection Object collection keyed by individual collection member keys and values
+ */
+function setCollection<TKey extends CollectionKeyBase, TMap>(collectionKey: TKey, collection: OnyxMergeCollectionInput<TKey, TMap>): Promise<void> {
+    if (!OnyxUtils.isValidNonEmptyCollectionForMerge(collection)) {


I think it's totally valid to set a collection to empty if you want to clear it, not sure why we would prevent that

lib/Onyx.ts

iwiznia · 2024-11-07T15:22:58Z

lib/Onyx.ts

+
+    return OnyxUtils.getAllKeys().then((persistedKeys) => {
+        // Find existing collection members
+        const existingCollectionKeys = Array.from(persistedKeys).filter((key) => key.startsWith(collectionKey));


Isn't this creating a potentially huge array from the set only to select a few entries from it and discard the set? Why not iterate the set and get the entries we want, reducing the memory footprint?

iwiznia · 2024-11-07T15:27:39Z

lib/Onyx.ts

+            );
+
+        // Combine removals with new collection data
+        const finalCollection = {


Similarly here, isn't this creating a new variable with the combination of both removalCollection and collection and thus using more memory and CPU and instead would be better to avoid that by adding the removalCollection keys to the collection directly?

allroundexperts · 2024-11-07T18:10:47Z

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

Screen.Recording.2024-11-19.at.3.11.18.AM.mov

MacOS: Desktop

iwiznia · 2024-11-08T16:53:31Z

lib/Onyx.ts

+            if (!key.startsWith(collectionKey)) {
+                return;
+            }


Is this even possible? If so how?

@iwiznia there will be other persisted keys in the store which do not correspond to collectionKey, therefore we need to skip such keys.

Oh, right 🤦

iwiznia · 2024-11-08T16:55:45Z

tests/unit/onyxTest.ts

+                let result: OnyxCollection<unknown>;
+                const routeA = `${ONYX_KEYS.COLLECTION.ROUTES}A`;
+                const routeB = `${ONYX_KEYS.COLLECTION.ROUTES}B`;
+                const routeB1 = `${ONYX_KEYS.COLLECTION.ROUTES}B1`;


NAB why call this B1 and not C (and make the next one D)?

@iwiznia the intention here was to showcase that the key (routeB1) might start with a similar value as the other key (routeB) but it would be properly filtered out in the setCollection

allroundexperts · 2024-11-11T09:28:32Z

@zirgulis Are you aware that your changes don't work on dev environment because of https://github.com/callstack-internal/react-native-onyx/blob/b58dbc56f485ad8b5f1d44f8b5f26f87dacf2481/lib/OnyxUtils.ts#L1243?

allroundexperts · 2024-11-11T09:54:15Z

@zirgulis This does not work for collections like reportActions_6182122210844260 or policyCategories_ECE2428DDAF1717F. It's because of https://github.com/allroundexperts/react-native-onyx/blob/da8f578b537fd7266d0b538467c8922423cb1dd1/lib/OnyxUtils.ts#L432 it seems.

iwiznia · 2024-11-11T15:38:53Z

@zirgulis Are you aware that your changes don't work on dev environment because of https://github.com/callstack-internal/react-native-onyx/blob/b58dbc56f485ad8b5f1d44f8b5f26f87dacf2481/lib/OnyxUtils.ts#L1243?

Weird, why do we have that code?

zirgulis · 2024-11-14T12:11:20Z

@zirgulis This does not work for collections like reportActions_6182122210844260 or policyCategories_ECE2428DDAF1717F. It's because of https://github.com/allroundexperts/react-native-onyx/blob/da8f578b537fd7266d0b538467c8922423cb1dd1/lib/OnyxUtils.ts#L432 it seems.

Could you please elaborate why it won't work? I tested this locally and it seem to work without any issues

video:
https://github.com/user-attachments/assets/cf916215-b15b-45d3-8b0b-0f50c4ae0224

allroundexperts · 2024-11-15T21:03:47Z

@zirgulis Please see the video below:

Screen.Recording.2024-11-16.at.2.02.22.AM.mov

Am I using an incorrect collection?

zirgulis · 2024-11-18T10:11:27Z

@allroundexperts I think you are incorrectly using setCollection API. This method will be used to basically nuke all the related collections and set the new ones. Please see:

react-native-onyx/lib/Onyx.ts

Line 735 in da8f578

* Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT, {

Expensify/App#51864 (comment)

allroundexperts · 2024-11-18T15:34:31Z

@zirgulis That is what I was trying to do. I was trying to get rid of all actions, and create a single new action. Can you point me to a collection on which I can use this method?

zirgulis · 2024-11-18T15:59:11Z

@allroundexperts to get rid of all report actions you need to pass the first param ONYXKEYS.COLLECTION.REPORT_ACTIONS

Using the collection in your video the code would be:

    Onyx.setCollection(ONYXKEYS.COLLECTION.REPORT_ACTIONS, {
        reportActions_1152761011764792: {
            496254244723951511: {
                actionName: 'REPORTPREVIEW',
                actorAccountID: 0,
                // ... the rest of the object
            },
        },
    });

allroundexperts

Works good.

Screen.Recording.2024-11-19.at.3.11.18.AM.mov

For anyone interested in the test steps, here is what I did:

Pull the PR and run npm run build.
Copy the dist folder, and replace it with the dist folder inside the node_modules/react-native-onyx directory in the expensify web app.
Run npx patch-package react-native-onyx inside the web app.
Remove the node_modules folder, and run npm install
Run npm run web, and in the console test the new method.

os-botify · 2024-11-18T22:32:44Z

🚀 Published to npm in 2.0.81 🎉

add setCollection

38a6db6

zirgulis changed the title ~~add setCollection~~ add setCollection method Nov 5, 2024

CLABotify added a commit to Expensify/CLA that referenced this pull request Nov 6, 2024

@zirgulis has signed the CLA in Expensify/react-native-onyx#594

243c147

zirgulis marked this pull request as ready for review November 7, 2024 11:53

zirgulis requested a review from a team as a code owner November 7, 2024 11:53

melvin-bot bot requested review from carlosmiceli and removed request for a team November 7, 2024 11:54

zirgulis mentioned this pull request Nov 7, 2024

[HOLD for payment 2024-12-07] [LHN Mismatch] Add SetCollection to Onyx Expensify/App#51864

Closed

puneetlath requested a review from allroundexperts November 7, 2024 14:57

iwiznia requested changes Nov 7, 2024

View reviewed changes

make setCollection more efficient, update tests

da8f578

zirgulis requested a review from iwiznia November 8, 2024 11:15

iwiznia reviewed Nov 8, 2024

View reviewed changes

iwiznia approved these changes Nov 8, 2024

View reviewed changes

allroundexperts approved these changes Nov 18, 2024

View reviewed changes

puneetlath approved these changes Nov 18, 2024

View reviewed changes

puneetlath merged commit 7d3f428 into Expensify:main Nov 18, 2024
5 checks passed

zirgulis mentioned this pull request Nov 25, 2024

add setCollection support to Onyx.update() #600

Merged

42 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add setCollection method #594

add setCollection method #594

zirgulis commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

zirgulis commented Nov 5, 2024

iwiznia Nov 7, 2024

iwiznia Nov 7, 2024

iwiznia Nov 7, 2024

allroundexperts commented Nov 7, 2024 •

edited

Loading

iwiznia Nov 8, 2024

zirgulis Nov 8, 2024

iwiznia Nov 8, 2024

iwiznia Nov 8, 2024

zirgulis Nov 8, 2024

allroundexperts commented Nov 11, 2024

allroundexperts commented Nov 11, 2024

iwiznia commented Nov 11, 2024

zirgulis commented Nov 14, 2024

allroundexperts commented Nov 15, 2024

zirgulis commented Nov 18, 2024

allroundexperts commented Nov 18, 2024

zirgulis commented Nov 18, 2024

allroundexperts left a comment

os-botify bot commented Nov 18, 2024

add setCollection method #594

add setCollection method #594

Conversation

zirgulis commented Nov 5, 2024 • edited Loading

Details

Related Issues

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

github-actions bot commented Nov 5, 2024 • edited Loading

zirgulis commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts commented Nov 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allroundexperts commented Nov 11, 2024

allroundexperts commented Nov 11, 2024

iwiznia commented Nov 11, 2024

zirgulis commented Nov 14, 2024

allroundexperts commented Nov 15, 2024

zirgulis commented Nov 18, 2024

allroundexperts commented Nov 18, 2024

zirgulis commented Nov 18, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

os-botify bot commented Nov 18, 2024

zirgulis commented Nov 5, 2024 •

edited

Loading

github-actions bot commented Nov 5, 2024 •

edited

Loading

allroundexperts commented Nov 7, 2024 •

edited

Loading