Browse Source
fix(files_trashbin): correctly sort custom columns in trashbin view
fix(files_trashbin): correctly sort custom columns in trashbin view
1. Refactor to make code better testable (move columns and view source to `files_views` folder) 2. Fix deletion time fallback (JS Date vs unix timestamp for "delted"-column) 3. Correctly sort `deletedBy` and `originalLocation` columns to use natural sort like any other column 4. Add unit tests for columns and views Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>pull/51394/head
No known key found for this signature in database
GPG Key ID: 45FAE7268762B400
7 changed files with 387 additions and 80 deletions
-
7__tests__/setup-global.js
-
20apps/files_trashbin/src/files-init.ts
-
211apps/files_trashbin/src/files_views/columns.spec.ts
-
138apps/files_trashbin/src/files_views/columns.ts
-
52apps/files_trashbin/src/files_views/trashbinView.spec.ts
-
33apps/files_trashbin/src/files_views/trashbinView.ts
-
6vitest.config.ts
@ -0,0 +1,7 @@ |
|||
/** |
|||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
|||
* SPDX-License-Identifier: CC0-1.0 |
|||
*/ |
|||
export function setup() { |
|||
process.env.TZ = 'UTC' |
|||
} |
|||
@ -0,0 +1,211 @@ |
|||
/** |
|||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
|||
* SPDX-License-Identifier: AGPL-3.0-or-later |
|||
*/ |
|||
|
|||
import { File } from '@nextcloud/files' |
|||
import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest' |
|||
import { deleted, deletedBy, originalLocation } from './columns.ts' |
|||
import { trashbinView } from './trashbinView.ts' |
|||
import * as ncAuth from '@nextcloud/auth' |
|||
|
|||
describe('files_trashbin: file list columns', () => { |
|||
|
|||
describe('column: original location', () => { |
|||
it('has id set', () => { |
|||
expect(originalLocation.id).toBe('files_trashbin--original-location') |
|||
}) |
|||
|
|||
it('has title set', () => { |
|||
expect(originalLocation.title).toBe('Original location') |
|||
}) |
|||
|
|||
it('correctly sorts nodes by original location', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-original-location': 'z-folder/a.txt' } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', attributes: { 'trashbin-original-location': 'folder/b.txt' } }) |
|||
|
|||
expect(originalLocation.sort).toBeTypeOf('function') |
|||
expect(originalLocation.sort!(nodeA, nodeB)).toBeGreaterThan(0) |
|||
expect(originalLocation.sort!(nodeB, nodeA)).toBeLessThan(0) |
|||
}) |
|||
|
|||
it('renders a node with original location', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-original-location': 'folder/a.txt' } }) |
|||
const el: HTMLElement = originalLocation.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('folder') |
|||
expect(el.title).toBe('folder') |
|||
}) |
|||
|
|||
it('renders a node when original location is missing', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain' }) |
|||
const el: HTMLElement = originalLocation.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('Unknown') |
|||
expect(el.title).toBe('Unknown') |
|||
}) |
|||
|
|||
it('renders a node when original location is the root', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-original-location': 'a.txt' } }) |
|||
const el: HTMLElement = originalLocation.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('All files') |
|||
expect(el.title).toBe('All files') |
|||
}) |
|||
}) |
|||
|
|||
describe('column: deleted time', () => { |
|||
it('has id set', () => { |
|||
expect(deleted.id).toBe('files_trashbin--deleted') |
|||
}) |
|||
|
|||
it('has title set', () => { |
|||
expect(deleted.title).toBe('Deleted') |
|||
}) |
|||
|
|||
it('correctly sorts nodes by deleted time', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deletion-time': 1741684522 } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', attributes: { 'trashbin-deletion-time': 1741684422 } }) |
|||
|
|||
expect(deleted.sort).toBeTypeOf('function') |
|||
expect(deleted.sort!(nodeA, nodeB)).toBeLessThan(0) |
|||
expect(deleted.sort!(nodeB, nodeA)).toBeGreaterThan(0) |
|||
}) |
|||
|
|||
it('correctly sorts nodes by deleted time and falls back to mtime', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deletion-time': 1741684522 } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', mtime: new Date(1741684422000) }) |
|||
|
|||
expect(deleted.sort).toBeTypeOf('function') |
|||
expect(deleted.sort!(nodeA, nodeB)).toBeLessThan(0) |
|||
expect(deleted.sort!(nodeB, nodeA)).toBeGreaterThan(0) |
|||
}) |
|||
|
|||
it('correctly sorts nodes even if no deletion date is provided', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain' }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', mtime: new Date(1741684422000) }) |
|||
|
|||
expect(deleted.sort).toBeTypeOf('function') |
|||
expect(deleted.sort!(nodeA, nodeB)).toBeGreaterThan(0) |
|||
expect(deleted.sort!(nodeB, nodeA)).toBeLessThan(0) |
|||
}) |
|||
|
|||
describe('rendering', () => { |
|||
afterAll(() => { |
|||
vi.useRealTimers() |
|||
}) |
|||
|
|||
beforeEach(() => { |
|||
vi.useFakeTimers({ now: 1741684582000 }) |
|||
}) |
|||
|
|||
it('renders a node with deletion date', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deletion-time': 1741684522 } }) |
|||
const el: HTMLElement = deleted.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('a minute ago') |
|||
expect(el.title).toBe('March 11, 2025 9:15 AM') |
|||
}) |
|||
|
|||
it('renders a node when deletion date is missing and falls back to mtime', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', mtime: new Date(1741684522000) }) |
|||
const el: HTMLElement = deleted.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('a minute ago') |
|||
expect(el.title).toBe('March 11, 2025 9:15 AM') |
|||
}) |
|||
|
|||
it('renders a node when deletion date is missing', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain' }) |
|||
const el: HTMLElement = deleted.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('A long time ago') |
|||
}) |
|||
}) |
|||
|
|||
describe('column: deleted by', () => { |
|||
it('has id set', () => { |
|||
expect(deletedBy.id).toBe('files_trashbin--deleted-by') |
|||
}) |
|||
|
|||
it('has title set', () => { |
|||
expect(deletedBy.title).toBe('Deleted by') |
|||
}) |
|||
|
|||
it('correctly sorts nodes by user-id of deleting user', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'zzz' } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'aaa' } }) |
|||
|
|||
expect(deletedBy.sort).toBeTypeOf('function') |
|||
expect(deletedBy.sort!(nodeA, nodeB)).toBeGreaterThan(0) |
|||
expect(deletedBy.sort!(nodeB, nodeA)).toBeLessThan(0) |
|||
}) |
|||
|
|||
it('correctly sorts nodes by display name of deleting user', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-display-name': 'zzz' } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-display-name': 'aaa' } }) |
|||
|
|||
expect(deletedBy.sort).toBeTypeOf('function') |
|||
expect(deletedBy.sort!(nodeA, nodeB)).toBeGreaterThan(0) |
|||
expect(deletedBy.sort!(nodeB, nodeA)).toBeLessThan(0) |
|||
}) |
|||
|
|||
it('correctly sorts nodes by display name of deleting user before user id', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-display-name': '000', 'trashbin-deleted-by-id': 'zzz' } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-display-name': 'aaa', 'trashbin-deleted-by-id': '999' } }) |
|||
|
|||
expect(deletedBy.sort).toBeTypeOf('function') |
|||
expect(deletedBy.sort!(nodeA, nodeB)).toBeLessThan(0) |
|||
expect(deletedBy.sort!(nodeB, nodeA)).toBeGreaterThan(0) |
|||
}) |
|||
|
|||
it('correctly sorts nodes even when one is missing', () => { |
|||
const nodeA = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'aaa' } }) |
|||
const nodeB = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'zzz' } }) |
|||
const nodeC = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/b.txt', mime: 'text/plain' }) |
|||
|
|||
expect(deletedBy.sort).toBeTypeOf('function') |
|||
// aaa is less then "Unknown"
|
|||
expect(deletedBy.sort!(nodeA, nodeC)).toBeLessThan(0) |
|||
// zzz is greater than "Unknown"
|
|||
expect(deletedBy.sort!(nodeB, nodeC)).toBeGreaterThan(0) |
|||
}) |
|||
|
|||
it('renders a node with deleting user', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'user-id' } }) |
|||
const el: HTMLElement = deletedBy.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toMatch(/\suser-id\s/) |
|||
}) |
|||
|
|||
it('renders a node with deleting user display name', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-display-name': 'user-name', 'trashbin-deleted-by-id': 'user-id' } }) |
|||
const el: HTMLElement = deletedBy.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toMatch(/\suser-name\s/) |
|||
}) |
|||
|
|||
it('renders a node even when information is missing', () => { |
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain' }) |
|||
const el: HTMLElement = deletedBy.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('Unknown') |
|||
}) |
|||
|
|||
it('renders a node when current user is the deleting user', () => { |
|||
vi.spyOn(ncAuth, 'getCurrentUser').mockImplementationOnce(() => ({ |
|||
uid: 'user-id', |
|||
displayName: 'user-display-name', |
|||
isAdmin: false, |
|||
})) |
|||
|
|||
const node = new File({ owner: 'test', source: 'https://example.com/remote.php/dav/files/test/a.txt', mime: 'text/plain', attributes: { 'trashbin-deleted-by-id': 'user-id' } }) |
|||
const el: HTMLElement = deletedBy.render(node, trashbinView) |
|||
expect(el).toBeInstanceOf(HTMLElement) |
|||
expect(el.textContent).toBe('You') |
|||
}) |
|||
}) |
|||
|
|||
}) |
|||
|
|||
}) |
|||
@ -0,0 +1,52 @@ |
|||
/** |
|||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
|||
* SPDX-License-Identifier: AGPL-3.0-or-later |
|||
*/ |
|||
import { describe, expect, it } from 'vitest' |
|||
import isSvg from 'is-svg' |
|||
|
|||
import { deleted, deletedBy, originalLocation } from './columns' |
|||
import { TRASHBIN_VIEW_ID, trashbinView } from './trashbinView.ts' |
|||
import { getContents } from '../services/trashbin.ts' |
|||
|
|||
describe('files_trasbin: trashbin files view', () => { |
|||
it('has correct strings', () => { |
|||
expect(trashbinView.id).toBe(TRASHBIN_VIEW_ID) |
|||
expect(trashbinView.name).toBe('Deleted files') |
|||
expect(trashbinView.caption).toBe('List of files that have been deleted.') |
|||
expect(trashbinView.emptyTitle).toBe('No deleted files') |
|||
expect(trashbinView.emptyCaption).toBe('Files and folders you have deleted will show up here') |
|||
}) |
|||
|
|||
it('sorts by deleted time', () => { |
|||
expect(trashbinView.defaultSortKey).toBe('deleted') |
|||
}) |
|||
|
|||
it('is sticky to the bottom in the view list', () => { |
|||
expect(trashbinView.sticky).toBe(true) |
|||
}) |
|||
|
|||
it('has order defined', () => { |
|||
expect(trashbinView.order).toBeTypeOf('number') |
|||
expect(trashbinView.order).toBe(50) |
|||
}) |
|||
|
|||
it('has valid icon', () => { |
|||
expect(trashbinView.icon).toBeTypeOf('string') |
|||
expect(isSvg(trashbinView.icon)).toBe(true) |
|||
}) |
|||
|
|||
it('has custom columns', () => { |
|||
expect(trashbinView.columns).toHaveLength(3) |
|||
expect(trashbinView.columns).toEqual([ |
|||
originalLocation, |
|||
deletedBy, |
|||
deleted, |
|||
]) |
|||
}) |
|||
|
|||
it('has get content method', () => { |
|||
expect(trashbinView.getContents).toBeTypeOf('function') |
|||
expect(trashbinView.getContents).toBe(getContents) |
|||
}) |
|||
}) |
|||
@ -0,0 +1,33 @@ |
|||
/** |
|||
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
|||
* SPDX-License-Identifier: AGPL-3.0-or-later |
|||
*/ |
|||
import { View } from '@nextcloud/files' |
|||
import { t } from '@nextcloud/l10n' |
|||
import { deleted, deletedBy, originalLocation } from './columns.ts' |
|||
import { getContents } from '../services/trashbin.ts' |
|||
|
|||
import svgDelete from '@mdi/svg/svg/delete.svg?raw' |
|||
|
|||
export const trashbinView = new View({ |
|||
id: 'trashbin', |
|||
name: t('files_trashbin', 'Deleted files'), |
|||
caption: t('files_trashbin', 'List of files that have been deleted.'), |
|||
|
|||
emptyTitle: t('files_trashbin', 'No deleted files'), |
|||
emptyCaption: t('files_trashbin', 'Files and folders you have deleted will show up here'), |
|||
|
|||
icon: svgDelete, |
|||
order: 50, |
|||
sticky: true, |
|||
|
|||
defaultSortKey: 'deleted', |
|||
|
|||
columns: [ |
|||
originalLocation, |
|||
deletedBy, |
|||
deleted, |
|||
], |
|||
|
|||
getContents, |
|||
}) |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue