fix(files): sort favorites navigation alphabetically

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>

Author: skjnldsv

apps/files/src/views/favorites.spec.ts

@@ -7,14 +7,16 @@
 import type { Folder as CFolder, Navigation } from '@nextcloud/files'
 
 import { expect } from '@jest/globals'
-import * as filesUtils from '@nextcloud/files'
-import { CancelablePromise } from 'cancelable-promise'
+
 import * as eventBus from '@nextcloud/event-bus'
+import * as filesUtils from '@nextcloud/files'
+import * as filesDavUtils from '@nextcloud/files/dav'
 import { basename } from 'path'
+import { CancelablePromise } from 'cancelable-promise'
 
 import { action } from '../actions/favoriteAction'
-import * as favoritesService from '../services/Favorites'
 import { registerFavoritesView } from './favorites'
+import * as favoritesService from '../services/Favorites'
 
 const { Folder, getNavigation } = filesUtils
 
@@ -31,6 +33,11 @@ jest.mock('@nextcloud/files', () => ({
 	...jest.requireActual('@nextcloud/files'),
 }))
 
+jest.mock('@nextcloud/files/dav', () => ({
+	__esModule: true,
+	...jest.requireActual('@nextcloud/files/dav'),
+}))
+
 jest.mock('@nextcloud/event-bus', () => ({
 	__esModule: true,
 	...jest.requireActual('@nextcloud/event-bus'),
@@ -60,7 +67,7 @@ describe('Favorites view definition', () => {
 
 	test('Default empty favorite view', async () => {
 		jest.spyOn(eventBus, 'subscribe')
-		jest.spyOn(filesUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		jest.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
 		jest.spyOn(favoritesService, 'getContents').mockReturnValue(CancelablePromise.resolve({ folder: {} as CFolder, contents: [] }))
 
 		await registerFavoritesView()
@@ -106,26 +113,35 @@ describe('Favorites view definition', () => {
 				source: 'http://nextcloud.local/remote.php/dav/files/admin/foo/bar',
 				owner: 'admin',
 			}),
+			new Folder({
+				id: 4,
+				root: '/files/admin',
+				source: 'http://nextcloud.local/remote.php/dav/files/admin/foo/bar/yabadaba',
+				owner: 'admin',
+			}),
 		]
-		jest.spyOn(filesUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve(favoriteFolders))
+		jest.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve(favoriteFolders))
 		jest.spyOn(favoritesService, 'getContents').mockReturnValue(CancelablePromise.resolve({ folder: {} as CFolder, contents: [] }))
 
 		await registerFavoritesView()
 		const favoritesView = Navigation.views.find(view => view.id === 'favorites')
 		const favoriteFoldersViews = Navigation.views.filter(view => view.parent === 'favorites')
 
 		// one main view and 3 children
-		expect(Navigation.views.length).toBe(4)
+		expect(Navigation.views.length).toBe(5)
 		expect(favoritesView).toBeDefined()
-		expect(favoriteFoldersViews.length).toBe(3)
+		expect(favoriteFoldersViews.length).toBe(4)
+
+		// Sorted by basename: bar, bar, foo
+		const expectedOrder = [2, 0, 1, 3]
 
 		favoriteFolders.forEach((folder, index) => {
 			const favoriteView = favoriteFoldersViews[index]
 			expect(favoriteView).toBeDefined()
 			expect(favoriteView?.id).toBeDefined()
 			expect(favoriteView?.name).toBe(basename(folder.path))
 			expect(favoriteView?.icon).toBe('<svg>SvgMock</svg>')
-			expect(favoriteView?.order).toBe(index)
+			expect(favoriteView?.order).toBe(expectedOrder[index])
 			expect(favoriteView?.params).toStrictEqual({
 				dir: folder.path,
 				fileid: String(folder.fileid),
@@ -150,7 +166,7 @@ describe('Dynamic update of favourite folders', () => {
 
 	test('Add a favorite folder creates a new entry in the navigation', async () => {
 		jest.spyOn(eventBus, 'emit')
-		jest.spyOn(filesUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		jest.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
 		jest.spyOn(favoritesService, 'getContents').mockReturnValue(CancelablePromise.resolve({ folder: {} as CFolder, contents: [] }))
 
 		await registerFavoritesView()
@@ -179,7 +195,7 @@ describe('Dynamic update of favourite folders', () => {
 	test('Remove a favorite folder remove the entry from the navigation column', async () => {
 		jest.spyOn(eventBus, 'emit')
 		jest.spyOn(eventBus, 'subscribe')
-		jest.spyOn(filesUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([
+		jest.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([
 			new Folder({
 				id: 42,
 				root: '/files/admin',
@@ -226,7 +242,7 @@ describe('Dynamic update of favourite folders', () => {
 
 	test('Renaming a favorite folder updates the navigation', async () => {
 		jest.spyOn(eventBus, 'emit')
-		jest.spyOn(filesUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		jest.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
 		jest.spyOn(favoritesService, 'getContents').mockReturnValue(CancelablePromise.resolve({ folder: {} as CFolder, contents: [] }))
 
 		await registerFavoritesView()

apps/files/src/views/favorites.ts

@@ -4,13 +4,15 @@
  */
 import type { Folder, Node } from '@nextcloud/files'
 
+import { FileType, View, getNavigation } from '@nextcloud/files'
+import { getCanonicalLocale, getLanguage, t } from '@nextcloud/l10n'
+import { getFavoriteNodes } from '@nextcloud/files/dav'
 import { subscribe } from '@nextcloud/event-bus'
-import { FileType, View, getFavoriteNodes, getNavigation } from '@nextcloud/files'
-import { getLanguage, translate as t } from '@nextcloud/l10n'
-import { client } from '../services/WebdavClient.ts'
+
 import FolderSvg from '@mdi/svg/svg/folder.svg?raw'
 import StarSvg from '@mdi/svg/svg/star.svg?raw'
 
+import { client } from '../services/WebdavClient.ts'
 import { getContents } from '../services/Favorites'
 import { hashCode } from '../utils/hashUtils'
 import logger from '../logger'
@@ -118,7 +120,7 @@ export const registerFavoritesView = async () => {
 	 * update the order property of the existing views
 	 */
 	const updateAndSortViews = function() {
-		favoriteFolders.sort((a, b) => a.path.localeCompare(b.path, getLanguage(), { ignorePunctuation: true }))
+		favoriteFolders.sort((a, b) => a.basename.localeCompare(b.basename, [getLanguage(), getCanonicalLocale()], { ignorePunctuation: true, numeric: true, usage: 'sort' }))
 		favoriteFolders.forEach((folder, index) => {
 			const view = favoriteFoldersViews.find((view) => view.id === generateIdFromPath(folder.path))
 			if (view) {
@@ -176,4 +178,6 @@ export const registerFavoritesView = async () => {
 		removePathFromFavorites(favoriteFolder.path)
 		addToFavorites(node)
 	}
+
+	updateAndSortViews()
 }