1 files changed, 261 insertions, 0 deletions
diff --git a/apps/files/src/views/favorites.spec.ts b/apps/files/src/views/favorites.spec.ts
new file mode 100644
index 00000000000..f793eb9f54c
--- /dev/null
+++ b/apps/files/src/views/favorites.spec.ts
@@ -0,0 +1,261 @@
+/* eslint-disable import/no-named-as-default-member */
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import type { Folder as CFolder, Navigation } from '@nextcloud/files'
+
+import * as filesUtils from '@nextcloud/files'
+import * as filesDavUtils from '@nextcloud/files/dav'
+import { CancelablePromise } from 'cancelable-promise'
+import { basename } from 'path'
+import { beforeEach, describe, expect, test, vi } from 'vitest'
+import * as eventBus from '@nextcloud/event-bus'
+
+import { action } from '../actions/favoriteAction'
+import * as favoritesService from '../services/Favorites'
+import { registerFavoritesView } from './favorites'
+
+// eslint-disable-next-line import/namespace
+const { Folder, getNavigation } = filesUtils
+
+vi.mock('@nextcloud/axios')
+
+window.OC = {
+	...window.OC,
+	TAG_FAVORITE: '_$!<Favorite>!$_',
+}
+
+declare global {
+	interface Window {
+		_nc_navigation?: Navigation
+	}
+}
+
+describe('Favorites view definition', () => {
+	let Navigation
+	beforeEach(() => {
+		vi.resetAllMocks()
+
+		delete window._nc_navigation
+		Navigation = getNavigation()
+		expect(window._nc_navigation).toBeDefined()
+	})
+
+	test('Default empty favorite view', async () => {
+		vi.spyOn(eventBus, 'subscribe')
+		vi.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		vi.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')
+
+		expect(eventBus.subscribe).toHaveBeenCalledTimes(3)
+		expect(eventBus.subscribe).toHaveBeenNthCalledWith(1, 'files:favorites:added', expect.anything())
+		expect(eventBus.subscribe).toHaveBeenNthCalledWith(2, 'files:favorites:removed', expect.anything())
+		expect(eventBus.subscribe).toHaveBeenNthCalledWith(3, 'files:node:renamed', expect.anything())
+
+		// one main view and no children
+		expect(Navigation.views.length).toBe(1)
+		expect(favoritesView).toBeDefined()
+		expect(favoriteFoldersViews.length).toBe(0)
+
+		expect(favoritesView?.id).toBe('favorites')
+		expect(favoritesView?.name).toBe('Favorites')
+		expect(favoritesView?.caption).toBeDefined()
+		expect(favoritesView?.icon).toMatch(/<svg.+<\/svg>/)
+		expect(favoritesView?.order).toBe(15)
+		expect(favoritesView?.columns).toStrictEqual([])
+		expect(favoritesView?.getContents).toBeDefined()
+	})
+
+	test('Default with favorites', async () => {
+		const favoriteFolders = [
+			new Folder({
+				id: 1,
+				root: '/files/admin',
+				source: 'http://nextcloud.local/remote.php/dav/files/admin/foo',
+				owner: 'admin',
+			}),
+			new Folder({
+				id: 2,
+				root: '/files/admin',
+				source: 'http://nextcloud.local/remote.php/dav/files/admin/bar',
+				owner: 'admin',
+			}),
+			new Folder({
+				id: 3,
+				root: '/files/admin',
+				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',
+			}),
+		]
+		vi.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve(favoriteFolders))
+		vi.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(5)
+		expect(favoritesView).toBeDefined()
+		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).toMatch(/<svg.+<\/svg>/)
+			expect(favoriteView?.order).toBe(expectedOrder[index])
+			expect(favoriteView?.params).toStrictEqual({
+				dir: folder.path,
+				fileid: String(folder.fileid),
+				view: 'favorites',
+			})
+			expect(favoriteView?.parent).toBe('favorites')
+			expect(favoriteView?.columns).toStrictEqual([])
+			expect(favoriteView?.getContents).toBeDefined()
+		})
+	})
+})
+
+describe('Dynamic update of favorite folders', () => {
+	let Navigation
+	beforeEach(() => {
+		vi.restoreAllMocks()
+
+		delete window._nc_navigation
+		Navigation = getNavigation()
+	})
+
+	test('Add a favorite folder creates a new entry in the navigation', async () => {
+		vi.spyOn(eventBus, 'emit')
+		vi.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		vi.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 no children
+		expect(Navigation.views.length).toBe(1)
+		expect(favoritesView).toBeDefined()
+		expect(favoriteFoldersViews.length).toBe(0)
+
+		// Create new folder to favorite
+		const folder = new Folder({
+			id: 1,
+			source: 'http://nextcloud.local/remote.php/dav/files/admin/Foo/Bar',
+			owner: 'admin',
+		})
+
+		// Exec the action
+		await action.exec(folder, favoritesView, '/')
+
+		expect(eventBus.emit).toHaveBeenCalledTimes(1)
+		expect(eventBus.emit).toHaveBeenCalledWith('files:favorites:added', folder)
+	})
+
+	test('Remove a favorite folder remove the entry from the navigation column', async () => {
+		vi.spyOn(eventBus, 'emit')
+		vi.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([
+			new Folder({
+				id: 42,
+				root: '/files/admin',
+				source: 'http://nextcloud.local/remote.php/dav/files/admin/Foo/Bar',
+				owner: 'admin',
+			}),
+		]))
+		vi.spyOn(favoritesService, 'getContents').mockReturnValue(CancelablePromise.resolve({ folder: {} as CFolder, contents: [] }))
+
+		await registerFavoritesView()
+		let favoritesView = Navigation.views.find(view => view.id === 'favorites')
+		let favoriteFoldersViews = Navigation.views.filter(view => view.parent === 'favorites')
+
+		// one main view and no children
+		expect(Navigation.views.length).toBe(2)
+		expect(favoritesView).toBeDefined()
+		expect(favoriteFoldersViews.length).toBe(1)
+
+		// Create new folder to favorite
+		const folder = new Folder({
+			id: 1,
+			source: 'http://nextcloud.local/remote.php/dav/files/admin/Foo/Bar',
+			owner: 'admin',
+			root: '/files/admin',
+			attributes: {
+				favorite: 1,
+			},
+		})
+
+		const fo = vi.fn()
+		eventBus.subscribe('files:favorites:removed', fo)
+
+		// Exec the action
+		await action.exec(folder, favoritesView, '/')
+
+		expect(eventBus.emit).toHaveBeenCalledTimes(1)
+		expect(eventBus.emit).toHaveBeenCalledWith('files:favorites:removed', folder)
+		expect(fo).toHaveBeenCalled()
+
+		favoritesView = Navigation.views.find(view => view.id === 'favorites')
+		favoriteFoldersViews = Navigation.views.filter(view => view.parent === 'favorites')
+
+		// one main view and no children
+		expect(Navigation.views.length).toBe(1)
+		expect(favoritesView).toBeDefined()
+		expect(favoriteFoldersViews.length).toBe(0)
+	})
+
+	test('Renaming a favorite folder updates the navigation', async () => {
+		vi.spyOn(eventBus, 'emit')
+		vi.spyOn(filesDavUtils, 'getFavoriteNodes').mockReturnValue(CancelablePromise.resolve([]))
+		vi.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 no children
+		expect(Navigation.views.length).toBe(1)
+		expect(favoritesView).toBeDefined()
+		expect(favoriteFoldersViews.length).toBe(0)
+
+		// expect(eventBus.emit).toHaveBeenCalledTimes(2)
+
+		// Create new folder to favorite
+		const folder = new Folder({
+			id: 1,
+			source: 'http://nextcloud.local/remote.php/dav/files/admin/Foo/Bar',
+			owner: 'admin',
+		})
+
+		// Exec the action
+		await action.exec(folder, favoritesView, '/')
+		expect(eventBus.emit).toHaveBeenNthCalledWith(1, 'files:favorites:added', folder)
+
+		// Create a folder with the same id but renamed
+		const renamedFolder = new Folder({
+			id: 1,
+			source: 'http://nextcloud.local/remote.php/dav/files/admin/Foo/Bar.renamed',
+			owner: 'admin',
+		})
+
+		// Exec the rename action
+		eventBus.emit('files:node:renamed', renamedFolder)
+		expect(eventBus.emit).toHaveBeenNthCalledWith(2, 'files:node:renamed', renamedFolder)
+	})
+})