Implemented partialSetCollection #677

shubham1206agra · 2025-08-15T15:58:50Z

Details

Implemented partialSetCollection so that update uses this for collection keys to eliminate extra notify calls.

Related Issues

#313

Automated Tests

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

lib/OnyxUtils.ts

parasharrajat · 2025-08-20T14:42:15Z

@shubham1206agra is this implementation directly coming from the design doc, or is there any linked conversation which I can follow?

shubham1206agra · 2025-08-20T14:45:23Z

@parasharrajat We discussed about this here https://expensify.slack.com/archives/C08CZDJFJ77/p1755275332300729

tgolen · 2025-09-08T15:11:54Z

Hi, what's the status of this PR and what are the next steps?

shubham1206agra · 2025-09-09T17:22:07Z

@parasharrajat You can start the testing now. Just test for any anomalies in the App.

tgolen · 2025-09-11T15:35:16Z

@shubham1206agra There is a conflict in Onyx that will probably effect this PR that you want to fix before having it tested.

shubham1206agra · 2025-09-11T15:53:06Z

@tgolen Done

tgolen · 2025-09-12T15:51:41Z

Thanks! @parasharrajat you can start testing whenever you are ready then!

parasharrajat · 2025-09-12T16:09:24Z

Sure,

parasharrajat · 2025-09-16T09:14:14Z

lib/OnyxUtils.ts

+    // Confirm all the collection keys belong to the same parent
+    if (!doAllCollectionItemsBelongToSameParent(collectionKey, resultCollectionKeys)) {
+        Logger.logAlert(`setCollection called with keys that do not belong to the same parent ${collectionKey}. Skipping this update.`);
+        return Promise.resolve();


Maybe we should reject this and throw an error back. This is a development mistake, so they should not proceed with such code. Silencing this error could give false positive.

This is the standard implementation across different methods. We are logging an alert. If we throw an error here, it will cause issues (crash) if we get some bad updates from BE.

Ok. Talking about backend updates where are we handling the backend updates for this new method.

@shubham1206agra Are we handling backend updates for this somewhere or it is not required?

react-native-onyx/lib/Onyx.ts

Line 516 in 6978c02

function update(data: OnyxUpdate[]): Promise<void> {

parasharrajat · 2025-09-16T09:19:05Z

tests/unit/onyxUtilsTest.ts

+        afterEach(() => {
+            Onyx.clear();
+        });
+        it('should replace all existing collection members with new values and keep old ones intact', async () => {


This tests does not to match with function description.

Any existing collection members not included in the new data will not be removed

What do you think should happen here?

Oops, I just saw that "not be removed".

parasharrajat · 2025-09-16T10:22:55Z

@shubham1206agra Do you have some issue to link to this PR?

shubham1206agra · 2025-09-18T11:54:21Z

#677 (comment)

parasharrajat · 2025-09-18T15:21:15Z

Going to test this PR against NewDot...

tgolen · 2025-09-23T14:11:51Z

@parasharrajat How is the testing going?

parasharrajat · 2025-09-23T14:27:45Z

I will have next update today.

parasharrajat · 2025-09-24T17:00:38Z

Ok, I tested with rules changes to workspaces triggering violations, name changes to workspaces, deleting multiple transactions, etc. And I didn't find any issue with this PR.

tgolen · 2025-09-25T00:23:32Z

@carlosmiceli do you want to review this and then merge it?

os-botify · 2025-09-25T00:35:24Z

🚀 Published to npm in 2.0.141 🎉

parasharrajat · 2025-10-03T11:42:37Z

There is no parent issue linked. @tgolen can you create a payment task for me on this task for PR review?

tgolen · 2025-10-04T02:34:21Z

OK, I created Expensify/App#71844 to handle payments.

Implemented partialSetCollection

99287ca

tgolen reviewed Aug 15, 2025

View reviewed changes

lib/OnyxUtils.ts Show resolved Hide resolved

tgolen requested a review from parasharrajat August 20, 2025 14:01

shubham1206agra added 5 commits September 9, 2025 20:39

Merge main

2cc2352

Fix batch after merge main

a86719f

Fix batch after merge main

b31ab1f

Add unit tests

7039e81

Add perf tests

c8e41fd

shubham1206agra marked this pull request as ready for review September 9, 2025 17:17

shubham1206agra requested a review from a team as a code owner September 9, 2025 17:17

melvin-bot bot requested review from carlosmiceli and removed request for a team September 9, 2025 17:18

shubham1206agra added 2 commits September 11, 2025 21:21

Merge main

b06e249

Update doc

d230066

parasharrajat suggested changes Sep 16, 2025

View reviewed changes

parasharrajat approved these changes Sep 24, 2025

View reviewed changes

tgolen approved these changes Sep 25, 2025

View reviewed changes

carlosmiceli approved these changes Sep 25, 2025

View reviewed changes

carlosmiceli merged commit 895679a into Expensify:main Sep 25, 2025
5 checks passed

fabioh8010 mentioned this pull request Sep 26, 2025

Bump Onyx to 3.0.1 Expensify/App#71369

Merged

54 tasks

tgolen mentioned this pull request Oct 4, 2025

$250 Implemented partialSetCollection in react-native-onyx Expensify/App#71844

Closed

Implemented partialSetCollection #677

Implemented partialSetCollection #677

Conversation

shubham1206agra commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Related Issues

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

parasharrajat commented Aug 20, 2025

Uh oh!

shubham1206agra commented Aug 20, 2025

Uh oh!

tgolen commented Sep 8, 2025

Uh oh!

shubham1206agra commented Sep 9, 2025

Uh oh!

tgolen commented Sep 11, 2025

Uh oh!

shubham1206agra commented Sep 11, 2025

Uh oh!

tgolen commented Sep 12, 2025

Uh oh!

parasharrajat commented Sep 12, 2025

Uh oh!

parasharrajat Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

parasharrajat Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

parasharrajat Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

parasharrajat Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

shubham1206agra Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

parasharrajat Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

parasharrajat commented Sep 16, 2025

Uh oh!

shubham1206agra commented Sep 18, 2025

Uh oh!

parasharrajat commented Sep 18, 2025

Uh oh!

tgolen commented Sep 23, 2025

Uh oh!

parasharrajat commented Sep 23, 2025

Uh oh!

parasharrajat commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tgolen commented Sep 25, 2025

Uh oh!

Uh oh!

os-botify bot commented Sep 25, 2025

Uh oh!

parasharrajat commented Oct 3, 2025

Uh oh!

tgolen commented Oct 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

shubham1206agra commented Aug 15, 2025 •

edited

Loading

parasharrajat Sep 16, 2025 •

edited

Loading

parasharrajat commented Sep 24, 2025 •

edited

Loading