Skip to content

Bugfix/use onyx infinite loading collection #673

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
chuckdries merged 3 commits into from
Aug 12, 2025
Merged

Bugfix/use onyx infinite loading collection #673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3cb9eb
Add unit test to cover the bug
fabioh8010 Aug 4, 2025
4124cf2
wip: OnyxUtils.subscribeToKey: remove collection check when adding nu…
kacper-mikolajczak Aug 6, 2025
e16e7cd
revert mapping.key check
kacper-mikolajczak Aug 12, 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
2 changes: 1 addition & 1 deletion lib/OnyxUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1377,7 +1377,7 @@ function subscribeToKey<TKey extends OnyxKey>(connectOptions: ConnectOptions<TKe
// since there are none matched. In withOnyx() we wait for all connected keys to return a value before rendering the child
// component. This null value will be filtered out so that the connected component can utilize defaultProps.
if (matchingKeys.length === 0) {
if (mapping.key && !isCollectionKey(mapping.key)) {
Copy link

@DylanDylann DylanDylann Aug 12, 2025

Choose a reason for hiding this comment

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

@kacper-mikolajczak I think we should still keep the mapping.key check

Copy link
Contributor Author

@kacper-mikolajczak kacper-mikolajczak Aug 12, 2025

Choose a reason for hiding this comment

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

I've traced down what addNullishStorageKey method does and it only action it does is adding a key to nullishStorageKeys which is a Set primitive.

Do you think we should not be able to add undefined or null into nullishStorageKeys?

If yes, what do you think of moving this check into addNullishStorageKey, as it can decide on its own what to accept?

Copy link

@DylanDylann DylanDylann Aug 12, 2025

Choose a reason for hiding this comment

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

Do you think we should not be able to add undefined or null into nullishStorageKeys?

nullishStorageKeys is to save the key that its value is nullish. In case the key is nullish and I think we should not add it to nullishStorageKeys

If yes, what do you think of moving this check into addNullishStorageKey, as it can decide on its own what to accept?

Copy link

@DylanDylann DylanDylann Aug 12, 2025

Choose a reason for hiding this comment

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

I prefer to keep it as before (keeping mapping.key check). It will be safer

Copy link
Contributor Author

@kacper-mikolajczak kacper-mikolajczak Aug 12, 2025

Choose a reason for hiding this comment

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

Done ✅

if (mapping.key) {
cache.addNullishStorageKey(mapping.key);
}

Expand Down
24 changes: 24 additions & 0 deletions tests/unit/useOnyxTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,30 @@ describe('useOnyx', () => {
});

describe('misc', () => {
it('should initially return loading state while loading non-existent key, and then return `undefined` and loaded state', async () => {
const {result} = renderHook(() => useOnyx(ONYXKEYS.TEST_KEY));

expect(result.current[0]).toBeUndefined();
expect(result.current[1].status).toEqual('loading');

await act(async () => waitForPromisesToResolve());

expect(result.current[0]).toBeUndefined();
expect(result.current[1].status).toEqual('loaded');
});

it('should initially return loading state while loading non-existent collection key, and then return `undefined` and loaded state', async () => {
const {result} = renderHook(() => useOnyx(ONYXKEYS.COLLECTION.TEST_KEY));

expect(result.current[0]).toBeUndefined();
expect(result.current[1].status).toEqual('loading');

await act(async () => waitForPromisesToResolve());

expect(result.current[0]).toBeUndefined();
expect(result.current[1].status).toEqual('loaded');
});

it('should return value and loaded state when loading cached key', async () => {
Onyx.set(ONYXKEYS.TEST_KEY, 'test');

Expand Down
Loading