Skip to content

Fix - added merge all snapshot config #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luacmartins merged 14 commits into from
Jun 26, 2025
Merged

Fix - added merge all snapshot config #640

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7146e67
added merge all snapshot config
FitseTLT Jun 5, 2025
e745f54
fix test
FitseTLT Jun 5, 2025
2a00b05
added js doc
FitseTLT Jun 6, 2025
1727d2d
rename variable
FitseTLT Jun 9, 2025
6fd2968
rename var
FitseTLT Jun 9, 2025
e8801ac
update comment
FitseTLT Jun 11, 2025
409f7d2
update comment
FitseTLT Jun 11, 2025
ed2076f
Merge branch 'main' into fix-merge-all-key-config-on-update-snapshots
FitseTLT Jun 11, 2025
4c77804
minor update
FitseTLT Jun 12, 2025
8d65989
fix ts
FitseTLT Jun 12, 2025
c1d12de
test perf test
FitseTLT Jun 20, 2025
65e2c65
Revert "test perf test"
FitseTLT Jun 20, 2025
fdedf73
refactored to use Set
FitseTLT Jun 24, 2025
3726a54
remove getter function
FitseTLT Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/OnyxUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ const lastConnectionCallbackData = new Map<number, OnyxValue<OnyxKey>>();

let snapshotKey: OnyxKey | null = null;

let fullyMergedSnapshotKeys: string[] = [];
let fullyMergedSnapshotKeys: Set<string> | undefined;

// Keeps track of the last subscriptionID that was used so we can keep incrementing it
let lastSubscriptionID = 0;
Expand All @@ -87,7 +87,7 @@ function getSnapshotKey(): OnyxKey | null {
return snapshotKey;
}

function getFullyMergedSnapshotKeys(): string[] {
function getFullyMergedSnapshotKeys(): Set<string> | undefined {
return fullyMergedSnapshotKeys;
}

Expand Down Expand Up @@ -160,7 +160,7 @@ function initStoreValues(keys: DeepRecord<string, OnyxKey>, initialKeyStates: Pa

if (typeof keys.COLLECTION === 'object' && typeof keys.COLLECTION.SNAPSHOT === 'string') {
snapshotKey = keys.COLLECTION.SNAPSHOT;
fullyMergedSnapshotKeys = fullyMergedSnapshotKeysParam ?? [];
fullyMergedSnapshotKeys = new Set(fullyMergedSnapshotKeysParam ?? []);
}
}

Expand Down Expand Up @@ -1422,7 +1422,15 @@ function updateSnapshots(data: OnyxUpdate[], mergeFn: typeof Onyx.merge): Array<

const oldValue = updatedData[key] || {};
const fullyMergedKeys = getFullyMergedSnapshotKeys();
const newValue = fullyMergedKeys.some((collectionKey) => isCollectionMemberKey(collectionKey, key)) ? value : lodashPick(value, Object.keys(snapshotData[key]));
let collectionKey: string | undefined;
try {
collectionKey = getCollectionKey(key);
} catch (e) {
Comment thread
FitseTLT marked this conversation as resolved.
// If getCollectionKey() throws an error it means the key is not a collection key.
collectionKey = undefined;
}
const shouldFullyMerge = fullyMergedKeys?.has(collectionKey || key);
const newValue = shouldFullyMerge ? value : lodashPick(value, Object.keys(snapshotData[key]));

updatedData = {...updatedData, [key]: Object.assign(oldValue, newValue)};
});
Expand Down
11 changes: 7 additions & 4 deletions tests/unit/onyxTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Onyx.init({
[ONYX_KEYS.KEY_WITH_UNDERSCORE]: 'default',
},
skippableCollectionMemberIDs: ['skippable-id'],
fullyMergedSnapshotKeys: [ONYX_KEYS.COLLECTION.ANIMALS],
fullyMergedSnapshotKeys: [ONYX_KEYS.COLLECTION.ANIMALS, ONYX_KEYS.OTHER_TEST],
});

describe('Onyx', () => {
Expand Down Expand Up @@ -1450,13 +1450,15 @@ describe('Onyx', () => {
const snapshot1 = `${ONYX_KEYS.COLLECTION.SNAPSHOT}1`;

const initialValue = {name: 'Fluffy'};
const initialValueOtherTest = {1: {name: 'Kitty'}};
const finalValuePeople = {name: 'Kitty'};
const finalValueOtherTest = {1: {name: 'First person'}, 2: {name: 'Second person'}};
const finalValueCat = {name: 'Kitty', nickName: 'Fitse'};
const onyxUpdate = {name: 'Kitty', nickName: 'Fitse'};

await Onyx.set(cat, initialValue);
await Onyx.set(people, initialValue);
await Onyx.set(snapshot1, {data: {[cat]: initialValue, [people]: initialValue}});
await Onyx.set(snapshot1, {data: {[ONYX_KEYS.OTHER_TEST]: initialValueOtherTest, [cat]: initialValue, [people]: initialValue}});

const callback = jest.fn();

Expand All @@ -1470,11 +1472,12 @@ describe('Onyx', () => {
await Onyx.update([
{key: cat, value: onyxUpdate, onyxMethod: Onyx.METHOD.MERGE},
{key: people, value: onyxUpdate, onyxMethod: Onyx.METHOD.MERGE},
{key: ONYX_KEYS.OTHER_TEST, value: finalValueOtherTest, onyxMethod: Onyx.METHOD.MERGE},
]);

expect(callback).toBeCalledTimes(2);
expect(callback).toHaveBeenNthCalledWith(1, {data: {[cat]: initialValue, [people]: initialValue}}, snapshot1);
expect(callback).toHaveBeenNthCalledWith(2, {data: {[cat]: finalValueCat, [people]: finalValuePeople}}, snapshot1);
expect(callback).toHaveBeenNthCalledWith(1, {data: {[cat]: initialValue, [ONYX_KEYS.OTHER_TEST]: initialValueOtherTest, [people]: initialValue}}, snapshot1);
expect(callback).toHaveBeenNthCalledWith(2, {data: {[cat]: finalValueCat, [ONYX_KEYS.OTHER_TEST]: finalValueOtherTest, [people]: finalValuePeople}}, snapshot1);
});

describe('update', () => {
Expand Down
Loading