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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
|
import Vuex from 'vuex'
import { createLocalVue, shallowMount, mount, RouterLinkStub } from '@vue/test-utils'
import { cloneDeep } from 'lodash'
import storeConfig from '../../../store/storeConfig'
import { CONVERSATION, PARTICIPANT, ATTENDEE } from '../../../constants'
import ActionButton from '@nextcloud/vue/dist/Components/ActionButton'
import { showSuccess, showError } from '@nextcloud/dialogs'
import Conversation from './Conversation'
jest.mock('@nextcloud/dialogs', () => ({
showSuccess: jest.fn(),
showError: jest.fn(),
}))
describe('Conversation.vue', () => {
const TOKEN = 'XXTOKENXX'
let store
let localVue
let testStoreConfig
let item
let messagesMock
beforeEach(() => {
localVue = createLocalVue()
localVue.use(Vuex)
testStoreConfig = cloneDeep(storeConfig)
messagesMock = jest.fn().mockReturnValue({})
testStoreConfig.modules.messagesStore.getters.messages = () => messagesMock
testStoreConfig.modules.actorStore.getters.getUserId = () => jest.fn().mockReturnValue('user-id-self')
store = new Vuex.Store(testStoreConfig)
// common defaults
item = {
token: TOKEN,
actorId: 'actor-id-1',
participants: [
],
participantType: PARTICIPANT.TYPE.USER,
unreadMessages: 0,
unreadMention: false,
objectType: '',
type: CONVERSATION.TYPE.GROUP,
displayName: 'conversation one',
isFavorite: false,
notificationLevel: 0,
lastMessage: {
actorId: 'user-id-alice',
actorDisplayName: 'Alice Wonderland',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
message: 'hello',
messageParameters: {},
systemMessage: '',
timestamp: 100,
},
canLeaveConversation: true,
canDeleteConversation: true,
}
// hack to catch last message rendering
const oldTee = global.t
global.t = jest.fn().mockImplementation(function(pkg, text, data) {
if (data && data.lastMessage) {
return (data.actor || 'You') + ': ' + data.lastMessage
}
return oldTee.apply(this, arguments)
})
})
afterEach(() => {
jest.clearAllMocks()
})
test('renders conversation entry', () => {
const wrapper = mount(Conversation, {
localVue,
store,
stubs: {
RouterLink: RouterLinkStub,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
expect(el.props('title')).toBe('conversation one')
const icon = el.findComponent({ name: 'ConversationIcon' })
expect(icon.props('item')).toStrictEqual(item)
expect(icon.props('hideFavorite')).toStrictEqual(false)
expect(icon.props('hideCall')).toStrictEqual(false)
})
describe('displayed subtitle', () => {
/**
* @param item
* @param expectedText
* @param isSearchResult
*/
function testConversationLabel(item, expectedText, isSearchResult = false) {
const wrapper = mount(Conversation, {
localVue,
store,
stubs: {
RouterLink: RouterLinkStub,
},
propsData: {
isSearchResult,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.vm.$slots.subtitle[0].text.trim()).toBe(expectedText)
}
test('display joining conversation message when not joined yet', () => {
item.actorId = null
testConversationLabel(item, 'Joining conversation …')
})
test('displays nothing when there is no last chat message', () => {
item.lastMessage = {}
testConversationLabel(item, '')
})
describe('author name', () => {
test('displays last chat message with shortened author name', () => {
testConversationLabel(item, 'Alice: hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays last chat message with author name if no space in name', () => {
item.lastMessage.actorDisplayName = 'Bob'
testConversationLabel(item, 'Bob: hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays own last chat message with "You" as author', () => {
item.lastMessage.actorId = 'user-id-self'
testConversationLabel(item, 'You: hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays last system message without author', () => {
item.lastMessage.message = 'Alice has joined the call'
item.lastMessage.systemMessage = 'call_joined'
testConversationLabel(item, 'Alice has joined the call')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays last message without author in one to one conversations', () => {
item.type = CONVERSATION.TYPE.ONE_TO_ONE
testConversationLabel(item, 'hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays own last message with "You" author in one to one conversations', () => {
item.type = CONVERSATION.TYPE.ONE_TO_ONE
item.lastMessage.actorId = 'user-id-self'
testConversationLabel(item, 'You: hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays last guest message with default author when none set', () => {
item.type = CONVERSATION.TYPE.PUBLIC
item.lastMessage.actorDisplayName = ''
item.lastMessage.actorType = ATTENDEE.ACTOR_TYPE.GUESTS
testConversationLabel(item, 'Guest: hello')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays last message for search results', () => {
// search results have no actor id
item.actorId = null
testConversationLabel(item, 'Alice: hello', true)
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
})
test('replaces placeholders in rich object of last message', () => {
item.lastMessage.message = '{file}'
item.lastMessage.messageParameters = {
file: {
name: 'filename.jpg',
},
}
testConversationLabel(item, 'Alice: filename.jpg')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
describe('last message from messages store', () => {
// see Conversation.lastChatMessage() description for the reasoning
let displayedLastStoreMessage
let lastMessageFromConversation
beforeEach(() => {
displayedLastStoreMessage = {
id: 100,
actorId: 'user-id-alice',
actorDisplayName: 'Alice Wonderland',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
message: 'hello from store',
messageParameters: {},
systemMessage: '',
timestamp: 100,
}
lastMessageFromConversation = {
id: 110,
actorId: 'user-id-alice',
actorDisplayName: 'Alice Wonderland',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
message: 'hello from conversation',
messageParameters: {},
systemMessage: '',
timestamp: 100,
}
item.lastMessage = lastMessageFromConversation
messagesMock.mockClear().mockReturnValue({
100: displayedLastStoreMessage,
})
})
test('displays store message when more recent', () => {
displayedLastStoreMessage.timestamp = 2000
testConversationLabel(item, 'Alice: hello from store')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays conversation message when last one is a temporary command message', () => {
messagesMock.mockClear().mockReturnValue({
'temp-100': displayedLastStoreMessage,
})
displayedLastStoreMessage.timestamp = 2000
displayedLastStoreMessage.id = 'temp-100'
displayedLastStoreMessage.message = '/me doing things'
testConversationLabel(item, 'Alice: hello from conversation')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays conversation message when last one is a bot message', () => {
displayedLastStoreMessage.timestamp = 2000
displayedLastStoreMessage.actorType = ATTENDEE.ACTOR_TYPE.BOTS
testConversationLabel(item, 'Alice: hello from conversation')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
test('displays store message when last one is a changelog bot message', () => {
displayedLastStoreMessage.timestamp = 2000
displayedLastStoreMessage.actorType = ATTENDEE.ACTOR_TYPE.BOTS
displayedLastStoreMessage.actorId = ATTENDEE.CHANGELOG_BOT_ID
testConversationLabel(item, 'Alice: hello from store')
expect(messagesMock).toHaveBeenCalledWith(TOKEN)
})
})
})
describe('unread messages counter', () => {
/**
* @param item
* @param expectedCounterText
* @param expectedHighlighted
*/
function testCounter(item, expectedCounterText, expectedHighlighted) {
const wrapper = mount(Conversation, {
localVue,
store,
stubs: {
RouterLink: RouterLinkStub,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
expect(el.props('counterNumber')).toBe(expectedCounterText)
expect(el.props('counterHighlighted')).toBe(expectedHighlighted)
}
test('renders unread messages counter', () => {
item.unreadMessages = 5
testCounter(item, 5, false)
})
test('renders unread mentions highlighted for non one-to-one conversations', () => {
item.unreadMessages = 5
item.unreadMention = true
testCounter(item, 5, true)
})
test('renders unread mentions always highlighted for one-to-one conversations', () => {
item.unreadMessages = 5
item.unreadMention = false
item.type = CONVERSATION.TYPE.ONE_TO_ONE
testCounter(item, 5, true)
})
test('does not render counter when no unread messages', () => {
const wrapper = mount(Conversation, {
localVue,
store,
stubs: {
RouterLink: RouterLinkStub,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
expect(el.vm.$slots.counter).not.toBeDefined()
})
})
describe('actions', () => {
let $router
beforeEach(() => {
$router = { push: jest.fn() }
})
/**
* @param wrapper
* @param text
*/
function findActionButton(wrapper, text) {
const actionButtons = wrapper.findAllComponents(ActionButton)
const items = actionButtons.filter(actionButton => {
return actionButton.text() === text
})
if (!items.exists()) {
return items
}
return items.at(0)
}
/**
* @param actionName
*/
function shallowMountAndGetAction(actionName) {
const wrapper = shallowMount(Conversation, {
localVue,
store: new Vuex.Store(testStoreConfig),
mocks: {
$router,
},
stubs: {
ActionButton,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
return findActionButton(el, actionName)
}
test('forwards click event on list item', async () => {
const wrapper = mount(Conversation, {
localVue,
store,
stubs: {
RouterLink: RouterLinkStub,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
await el.find('a').trigger('click')
expect(wrapper.emitted().click).toBeTruthy()
})
describe('notification level', () => {
/**
* @param actionName
* @param level
*/
async function testSetNotificationLevel(actionName, level) {
const setNotificationLevelAction = jest.fn().mockResolvedValueOnce()
testStoreConfig.modules.conversationsStore.actions.setNotificationLevel = setNotificationLevelAction
const action = shallowMountAndGetAction(actionName)
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(setNotificationLevelAction).toHaveBeenCalledWith(expect.anything(), { token: TOKEN, notificationLevel: level })
}
test('sets notification to all messages', async () => {
await testSetNotificationLevel('All messages', 1)
})
test('sets notification to at-mentions only', async () => {
await testSetNotificationLevel('@-mentions only', 2)
})
test('sets notification to off', async () => {
await testSetNotificationLevel('Off', 3)
})
})
describe('leaving conversation', () => {
test('leaves conversation', async () => {
const actionHandler = jest.fn()
testStoreConfig.modules.participantsStore.actions.removeCurrentUserFromConversation = actionHandler
const action = shallowMountAndGetAction('Leave conversation')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(actionHandler).toHaveBeenCalledWith(expect.anything(), { token: TOKEN })
})
test('hides "leave conversation" action when not allowed', async () => {
item.canLeaveConversation = false
const action = shallowMountAndGetAction('Leave conversation')
expect(action.exists()).toBe(false)
})
test('errors with notification when a new moderator is required before leaving', async () => {
const actionHandler = jest.fn().mockRejectedValueOnce({
response: {
status: 400,
},
})
testStoreConfig.modules.participantsStore.actions.removeCurrentUserFromConversation = actionHandler
const action = shallowMountAndGetAction('Leave conversation')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(actionHandler).toHaveBeenCalledWith(expect.anything(), { token: TOKEN })
expect(showError).toHaveBeenCalledWith(expect.stringContaining('promote'))
})
})
describe('deleting conversation', () => {
test('deletes conversation when confirmed', async () => {
const actionHandler = jest.fn().mockResolvedValueOnce()
const updateTokenAction = jest.fn()
testStoreConfig.modules.conversationsStore.actions.deleteConversationFromServer = actionHandler
testStoreConfig.modules.tokenStore.getters.getToken = jest.fn().mockReturnValue(() => 'another-token')
testStoreConfig.modules.tokenStore.actions.updateToken = updateTokenAction
OC.dialogs.confirm = jest.fn()
const action = shallowMountAndGetAction('Delete conversation')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(OC.dialogs.confirm).toHaveBeenCalled()
// call callback directly
OC.dialogs.confirm.mock.calls[0][2](true)
expect(actionHandler).toHaveBeenCalledWith(expect.anything(), { token: TOKEN })
expect($router.push).not.toHaveBeenCalled()
expect(updateTokenAction).not.toHaveBeenCalled()
})
test('does not delete conversation when not confirmed', async () => {
const actionHandler = jest.fn().mockResolvedValueOnce()
const updateTokenAction = jest.fn()
testStoreConfig.modules.conversationsStore.actions.deleteConversationFromServer = actionHandler
testStoreConfig.modules.tokenStore.getters.getToken = jest.fn().mockReturnValue(() => 'another-token')
testStoreConfig.modules.tokenStore.actions.updateToken = updateTokenAction
OC.dialogs.confirm = jest.fn()
const action = shallowMountAndGetAction('Delete conversation')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(OC.dialogs.confirm).toHaveBeenCalled()
// call callback directly
OC.dialogs.confirm.mock.calls[0][2](false)
expect(actionHandler).not.toHaveBeenCalled()
expect($router.push).not.toHaveBeenCalled()
expect(updateTokenAction).not.toHaveBeenCalled()
})
test('hides "delete conversation" action when not allowed', async () => {
item.canDeleteConversation = false
const action = shallowMountAndGetAction('Delete conversation')
expect(action.exists()).toBe(false)
})
})
test('copies link conversation', async () => {
const copyTextMock = jest.fn().mockResolvedValueOnce()
const wrapper = shallowMount(Conversation, {
localVue,
store: new Vuex.Store(testStoreConfig),
mocks: {
$copyText: copyTextMock,
},
stubs: {
ActionButton,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
const action = findActionButton(el, 'Copy link')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
await action.vm.$nextTick()
expect(copyTextMock).toHaveBeenCalledWith('http://localhost/nc-webroot/call/XXTOKENXX')
expect(showSuccess).toHaveBeenCalled()
})
test('sets favorite', async () => {
const toggleFavoriteAction = jest.fn().mockResolvedValueOnce()
testStoreConfig.modules.conversationsStore.actions.toggleFavorite = toggleFavoriteAction
const wrapper = shallowMount(Conversation, {
localVue,
store: new Vuex.Store(testStoreConfig),
stubs: {
ActionButton,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
const action = findActionButton(el, 'Add to favorites')
expect(action.exists()).toBe(true)
expect(findActionButton(el, 'Remove from favorites').exists()).toBe(false)
await action.find('button').trigger('click')
expect(toggleFavoriteAction).toHaveBeenCalledWith(expect.anything(), item)
})
test('unsets favorite', async () => {
const toggleFavoriteAction = jest.fn().mockResolvedValueOnce()
testStoreConfig.modules.conversationsStore.actions.toggleFavorite = toggleFavoriteAction
item.isFavorite = true
const wrapper = shallowMount(Conversation, {
localVue,
store: new Vuex.Store(testStoreConfig),
stubs: {
ActionButton,
},
propsData: {
isSearchResult: false,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
const action = findActionButton(el, 'Remove from favorites')
expect(action.exists()).toBe(true)
expect(findActionButton(el, 'Add to favorites').exists()).toBe(false)
await action.find('button').trigger('click')
expect(toggleFavoriteAction).toHaveBeenCalledWith(expect.anything(), item)
})
test('marks conversation as read', async () => {
const clearLastReadMessageAction = jest.fn().mockResolvedValueOnce()
testStoreConfig.modules.conversationsStore.actions.clearLastReadMessage = clearLastReadMessageAction
const action = shallowMountAndGetAction('Mark as read')
expect(action.exists()).toBe(true)
await action.find('button').trigger('click')
expect(clearLastReadMessageAction).toHaveBeenCalledWith(expect.anything(), { token: item.token })
})
test('does not show actions for search result', () => {
const wrapper = shallowMount(Conversation, {
localVue,
store: new Vuex.Store(testStoreConfig),
stubs: {
ActionButton,
},
propsData: {
isSearchResult: true,
item,
},
})
const el = wrapper.findComponent({ name: 'ListItem' })
expect(el.exists()).toBe(true)
const actionButtons = wrapper.findAllComponents(ActionButton)
expect(actionButtons.exists()).toBe(false)
})
})
})
|