Skip to content

Skip keyless update entries in updateSnapshots instead of crashing #818

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

Draft
elirangoshen wants to merge 2 commits into
base: main
Choose a base branch
from
+31 −0
Draft

Skip keyless update entries in updateSnapshots instead of crashing #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebca04f
Skip keyless update entries in updateSnapshots instead of crashing
elirangoshen Aug 5, 2026
81627b0
Remove review-flagged comments
elirangoshen Aug 10, 2026
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
4 changes: 4 additions & 0 deletions lib/OnyxUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1211,6 +1211,10 @@ function updateSnapshots<TKey extends OnyxKey>(data: Array<OnyxUpdate<TKey>>, me
let updatedData: Record<string, unknown> = {};

for (const {key, value} of data) {
if (typeof key !== 'string') {
continue;
Comment on lines +1214 to +1215

@VickyStash VickyStash Aug 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add Log message, same as it's done in Onyx.update

}

// snapshots are normal keys so we want to skip update if they are written to Onyx
if (OnyxKeys.isCollectionMemberKey(snapshotCollectionKey, key)) {
continue;
Expand Down
27 changes: 27 additions & 0 deletions tests/unit/onyxTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1535,6 +1535,33 @@ describe('Onyx', () => {
expect(callback.mock.calls[1][1]).toBe(ONYX_KEYS.COLLECTION.SNAPSHOT);
});

it('should skip update entries without a key when updating Snapshots instead of rejecting', async () => {
const cat = `${ONYX_KEYS.COLLECTION.ANIMALS}cat`;
const snapshot1 = `${ONYX_KEYS.COLLECTION.SNAPSHOT}1`;

const initialValue = {name: 'Fluffy'};
const finalValue = {name: 'Kitty'};

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

const callback = jest.fn();

Onyx.connect({
key: ONYX_KEYS.COLLECTION.SNAPSHOT,
callback,
});

await waitForPromisesToResolve();

const keylessUpdate = {onyxMethod: Onyx.METHOD.MERGE, value: {name: 'Ghost'}} as unknown as OnyxUpdate<OnyxKey>;

await expect(Onyx.update([keylessUpdate, {key: cat, value: finalValue, onyxMethod: Onyx.METHOD.MERGE}])).resolves.not.toThrow();

// The valid update still lands in the snapshot.
expect(callback.mock.calls.at(-1)?.[0]).toEqual({[snapshot1]: {data: {[cat]: finalValue}}});
});

describe('update', () => {
let logInfoFn = jest.fn();

Expand Down
Loading