aboutsummaryrefslogtreecommitdiffstats
path: root/apps/comments/src/actions/inlineUnreadCommentsAction.spec.ts
blob: e8020f1f029eac4523f468d692b28494f62023c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
import { File, Permission, View, FileAction } from '@nextcloud/files'
import { describe, expect, test, vi } from 'vitest'

import { action } from './inlineUnreadCommentsAction'
import logger from '../logger'

const view = {
	id: 'files',
	name: 'Files',
} as View

describe('Inline unread comments action display name tests', () => {
	test('Default values', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 1,
			},
		})

		expect(action).toBeInstanceOf(FileAction)
		expect(action.id).toBe('comments-unread')
		expect(action.displayName([file], view)).toBe('')
		expect(action.title!([file], view)).toBe('1 new comment')
		expect(action.iconSvgInline([], view)).toMatch(/<svg.+<\/svg>/)
		expect(action.enabled!([file], view)).toBe(true)
		expect(action.inline!(file, view)).toBe(true)
		expect(action.default).toBeUndefined()
		expect(action.order).toBe(-140)
	})

	test('Display name when file has two new comments', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 2,
			},
		})

		expect(action.displayName([file], view)).toBe('')
		expect(action.title!([file], view)).toBe('2 new comments')
	})
})

describe('Inline unread comments action enabled tests', () => {
	test('Action is disabled when comments-unread attribute is missing', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: { },
		})

		expect(action.enabled!([file], view)).toBe(false)
	})

	test('Action is disabled when file does not have unread comments', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 0,
			},
		})

		expect(action.enabled!([file], view)).toBe(false)
	})

	test('Action is enabled when file has a single unread comment', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 1,
			},
		})

		expect(action.enabled!([file], view)).toBe(true)
	})

	test('Action is enabled when file has a two unread comments', () => {
		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 2,
			},
		})

		expect(action.enabled!([file], view)).toBe(true)
	})
})

describe('Inline unread comments action execute tests', () => {
	test('Action opens sidebar', async () => {
		const openMock = vi.fn()
		const setActiveTabMock = vi.fn()
		window.OCA = {
			Files: {
				Sidebar: {
					open: openMock,
					setActiveTab: setActiveTabMock,
				},
			},
		}

		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 1,
			},
		})

		const result = await action.exec!(file, view, '/')

		expect(result).toBe(null)
		expect(setActiveTabMock).toBeCalledWith('comments')
		expect(openMock).toBeCalledWith('/foobar.txt')
	})

	test('Action handles sidebar open failure', async () => {
		const openMock = vi.fn(() => { throw new Error('Mock error') })
		const setActiveTabMock = vi.fn()
		window.OCA = {
			Files: {
				Sidebar: {
					open: openMock,
					setActiveTab: setActiveTabMock,
				},
			},
		}
		vi.spyOn(logger, 'error').mockImplementation(() => vi.fn())

		const file = new File({
			id: 1,
			source: 'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
			owner: 'admin',
			mime: 'text/plain',
			permissions: Permission.ALL,
			attributes: {
				'comments-unread': 1,
			},
		})

		const result = await action.exec!(file, view, '/')

		expect(result).toBe(false)
		expect(setActiveTabMock).toBeCalledWith('comments')
		expect(openMock).toBeCalledWith('/foobar.txt')
		expect(logger.error).toBeCalledTimes(1)
	})
})