test(files): Add tests for path handling

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

apps/files/src/store/files.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import type { FilesStore, RootsStore, RootOptions, Service, FilesState, FileSource } from '../types'
+import type { FilesStore, RootsStore, RootOptions, Service, FileSource } from '../types'
 import type { FileStat, ResponseDataDetailed } from 'webdav'
 import type { Folder, Node } from '@nextcloud/files'
 
@@ -27,9 +27,10 @@ const fetchNode = async (node: Node): Promise<Node> => {
 
 export const useFilesStore = function(...args) {
 	const store = defineStore('files', {
-		state: (): FilesState => ({
+		state: () => ({
 			files: {} as FilesStore,
 			roots: {} as RootsStore,
+			_initialized: false,
 		}),
 
 		getters: {
@@ -86,6 +87,7 @@ export const useFilesStore = function(...args) {
 				}
 
 				// If we found a cache entry and the cache entry was already loaded (has children) then use it
+				// @ts-expect-error The _children prop is undocumented - we need to make this official
 				return (folder?._children ?? [])
 					.map((source: string) => this.getNode(source))
 					.filter(Boolean)

apps/files/src/store/paths.spec.ts

@@ -0,0 +1,130 @@
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { emit } from '@nextcloud/event-bus'
+import { describe, expect, test } from '@jest/globals'
+import { File, Folder } from '@nextcloud/files'
+import { setActivePinia, createPinia } from 'pinia'
+import { usePathsStore } from './paths.ts'
+import { useFilesStore } from './files.ts'
+
+describe('Path store', () => {
+
+	let store: ReturnType<typeof usePathsStore>
+	let files: ReturnType<typeof useFilesStore>
+	let root: Folder & { _children?: string[] }
+
+	beforeEach(() => {
+		setActivePinia(createPinia())
+
+		root = new Folder({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/', id: 1 })
+		files = useFilesStore()
+		files.setRoot({ service: 'files', root })
+
+		store = usePathsStore()
+	})
+
+	test('Folder is created', () => {
+		// no defined paths
+		expect(store.paths).toEqual({})
+
+		// create the folder
+		const node = new Folder({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/folder', id: 2 })
+		emit('files:node:created', node)
+
+		// see that the path is added
+		expect(store.paths).toEqual({ files: { [node.path]: node.source } })
+
+		// see that the node is added
+		expect(root._children).toEqual([node.source])
+	})
+
+	test('File is created', () => {
+		// no defined paths
+		expect(store.paths).toEqual({})
+
+		// create the file
+		const node = new File({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/file.txt', id: 2, mime: 'text/plain' })
+		emit('files:node:created', node)
+
+		// see that there are still no paths
+		expect(store.paths).toEqual({})
+
+		// see that the node is added
+		expect(root._children).toEqual([node.source])
+	})
+
+	test('Existing file is created', () => {
+		// no defined paths
+		expect(store.paths).toEqual({})
+
+		// create the file
+		const node1 = new File({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/file.txt', id: 2, mime: 'text/plain' })
+		emit('files:node:created', node1)
+
+		// see that there are still no paths
+		expect(store.paths).toEqual({})
+
+		// see that the node is added
+		expect(root._children).toEqual([node1.source])
+
+		// create the same named file again
+		const node2 = new File({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/file.txt', id: 2, mime: 'text/plain' })
+		emit('files:node:created', node2)
+
+		// see that there are still no paths and the children are not duplicated
+		expect(store.paths).toEqual({})
+		expect(root._children).toEqual([node1.source])
+
+	})
+
+	test('Existing folder is created', () => {
+		// no defined paths
+		expect(store.paths).toEqual({})
+
+		// create the file
+		const node1 = new Folder({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/folder', id: 2 })
+		emit('files:node:created', node1)
+
+		// see the path is added
+		expect(store.paths).toEqual({ files: { [node1.path]: node1.source } })
+
+		// see that the node is added
+		expect(root._children).toEqual([node1.source])
+
+		// create the same named file again
+		const node2 = new Folder({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/folder', id: 2 })
+		emit('files:node:created', node2)
+
+		// see that there is still only one paths and the children are not duplicated
+		expect(store.paths).toEqual({ files: { [node1.path]: node1.source } })
+		expect(root._children).toEqual([node1.source])
+	})
+
+	test('Folder is deleted', () => {
+		const node = new Folder({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/folder', id: 2 })
+		emit('files:node:created', node)
+		// see that the path is added and the children are set-up
+		expect(store.paths).toEqual({ files: { [node.path]: node.source } })
+		expect(root._children).toEqual([node.source])
+
+		emit('files:node:deleted', node)
+		// See the path is removed
+		expect(store.paths).toEqual({ files: {} })
+		// See the child is removed
+		expect(root._children).toEqual([])
+	})
+
+	test('File is deleted', () => {
+		const node = new File({ owner: 'test', source: 'http://example.com/remote.php/dav/files/test/file.txt', id: 2, mime: 'text/plain' })
+		emit('files:node:created', node)
+		// see that the children are set-up
+		expect(root._children).toEqual([node.source])
+
+		emit('files:node:deleted', node)
+		// See the child is removed
+		expect(root._children).toEqual([])
+	})
+})

apps/files/src/store/paths.ts

@@ -2,7 +2,7 @@
  * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import type { FileSource, PathsStore, PathOptions, ServicesState, Service } from '../types'
+import type { FileSource, PathOptions, ServicesState, Service } from '../types'
 import { defineStore } from 'pinia'
 import { FileType, Folder, Node, getNavigation } from '@nextcloud/files'
 import { subscribe } from '@nextcloud/event-bus'
@@ -17,7 +17,8 @@ export const usePathsStore = function(...args) {
 	const store = defineStore('paths', {
 		state: () => ({
 			paths: {} as ServicesState,
-		} as PathsStore),
+			_initialized: false,
+		}),
 
 		getters: {
 			getPath: (state) => {

cypress/e2e/files/duplicated-node-regression.cy.ts

@@ -0,0 +1,33 @@
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { createFolder, getRowForFile, triggerActionForFile } from './FilesUtils.ts'
+
+before(() => {
+	cy.createRandomUser()
+		.then((user) => {
+			cy.mkdir(user, '/only once')
+			cy.login(user)
+			cy.visit('/apps/files')
+		})
+})
+
+/**
+ * Regression test for https://github.com/nextcloud/server/issues/47904
+ */
+it('Ensure nodes are not duplicated in the file list', () => {
+	// See the folder
+	getRowForFile('only once').should('be.visible')
+	// Delete the folder
+	cy.intercept('DELETE', '**/remote.php/dav/**').as('deleteFolder')
+	triggerActionForFile('only once', 'delete')
+	cy.wait('@deleteFolder')
+	getRowForFile('only once').should('not.exist')
+	// Create the folder again
+	createFolder('only once')
+	// See folder exists only once
+	getRowForFile('only once')
+		.should('have.length', 1)
+})