-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
fix(store): Prevent out-of-order server responses to mess up the folder listing #62032
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.
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
Open
DerDreschner
wants to merge
2
commits into
master
Choose a base branch
from
fix/race-condition-on-sort
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−5
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /*! | ||
| * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| import axios from '@nextcloud/axios' | ||
| import { createPinia, setActivePinia } from 'pinia' | ||
| import { beforeEach, describe, expect, test, vi } from 'vitest' | ||
| import { useViewConfigStore } from './viewConfig.ts' | ||
|
|
||
| vi.mock('@nextcloud/auth', () => ({ | ||
| getCurrentUser: () => ({ uid: 'test', displayName: 'Test' }), | ||
| })) | ||
| vi.mock('@nextcloud/axios', () => ({ | ||
| default: { | ||
| put: vi.fn(), | ||
| }, | ||
| })) | ||
| vi.mock('@nextcloud/router', () => ({ | ||
| generateUrl: (url: string) => url, | ||
| })) | ||
| vi.mock('@nextcloud/initial-state', () => ({ | ||
| loadState: () => ({}), | ||
| })) | ||
|
|
||
| describe('View config store keeps sorting state consistent under slow requests', () => { | ||
| // Captured resolvers for the pending PUT requests, so a test can decide when | ||
| // (and in which order) the "server" responds. | ||
| let putResolvers: Array<() => void> | ||
|
|
||
| beforeEach(() => { | ||
| setActivePinia(createPinia()) | ||
| putResolvers = [] | ||
| vi.mocked(axios.put).mockImplementation(() => new Promise((resolve) => { | ||
| putResolvers.push(() => resolve({ data: {} } as never)) | ||
| })) | ||
| }) | ||
|
|
||
| test('reflects a sorting change locally without waiting for the server round-trip', () => { | ||
| const store = useViewConfigStore() | ||
|
|
||
| store.setSortingBy('size', 'files') | ||
|
|
||
| // The PUT requests are still pending, yet the local config is already | ||
| // updated so the header and file list can react immediately. | ||
| expect(putResolvers.length).toBeGreaterThan(0) | ||
| expect(store.getConfig('files')).toMatchObject({ | ||
| sorting_mode: 'size', | ||
| sorting_direction: 'asc', | ||
| }) | ||
| }) | ||
|
|
||
| test('consecutive direction toggles read the freshly updated local state', () => { | ||
| const store = useViewConfigStore() | ||
|
|
||
| // Rapid header clicks: sort by size (asc), then flip twice. Each toggle | ||
| // must read the direction the previous action just wrote locally, even | ||
| // though none of the PUTs have resolved yet. | ||
| store.setSortingBy('size', 'files') | ||
| expect(store.getConfig('files').sorting_direction).toBe('asc') | ||
|
|
||
| store.toggleSortingDirection('files') | ||
| expect(store.getConfig('files').sorting_direction).toBe('desc') | ||
|
|
||
| store.toggleSortingDirection('files') | ||
| expect(store.getConfig('files').sorting_direction).toBe('asc') | ||
| }) | ||
|
|
||
| test('an out-of-order server response does not clobber the local state', async () => { | ||
| const store = useViewConfigStore() | ||
|
|
||
| store.setSortingBy('size', 'files') | ||
| store.toggleSortingDirection('files') | ||
| store.toggleSortingDirection('files') | ||
|
|
||
| expect(store.getConfig('files').sorting_direction).toBe('asc') | ||
|
|
||
| // Let the queued PUTs resolve in reverse order: since the local store is | ||
| // no longer driven by request resolution, the latest value must survive. | ||
| for (const resolve of [...putResolvers].reverse()) { | ||
| resolve() | ||
| } | ||
| await Promise.resolve() | ||
|
|
||
| expect(store.getConfig('files').sorting_direction).toBe('asc') | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This causes invalid state if the PUT fails, that why it is emitted after the PUT.