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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
|
import Vuex from 'vuex'
import { createLocalVue, mount, shallowMount } from '@vue/test-utils'
import { cloneDeep } from 'lodash'
import { EventBus } from '../../../../services/EventBus'
import storeConfig from '../../../../store/storeConfig'
import { CONVERSATION, ATTENDEE } from '../../../../constants'
import Check from 'vue-material-design-icons/Check'
import CheckAll from 'vue-material-design-icons/CheckAll'
import Quote from '../../../Quote'
import Mention from './MessagePart/Mention'
import FilePreview from './MessagePart/FilePreview'
import DeckCard from './MessagePart/DeckCard'
import Location from './MessagePart/Location'
import DefaultParameter from './MessagePart/DefaultParameter'
import MessageButtonsBar from './MessageButtonsBar/MessageButtonsBar.vue'
import Message from './Message'
// needed because of https://github.com/vuejs/vue-test-utils/issues/1507
const RichTextStub = {
props: {
text: {
type: String,
},
arguments: {
type: Object,
},
},
template: '<div/>',
}
describe('Message.vue', () => {
const TOKEN = 'XXTOKENXX'
let localVue
let testStoreConfig
let store
let messageProps
let conversationProps
let getActorTypeMock
beforeEach(() => {
localVue = createLocalVue()
localVue.use(Vuex)
conversationProps = {
token: TOKEN,
lastCommonReadMessage: 0,
type: CONVERSATION.TYPE.GROUP,
readOnly: CONVERSATION.STATE.READ_WRITE,
}
testStoreConfig = cloneDeep(storeConfig)
testStoreConfig.modules.tokenStore.getters.getToken
= jest.fn().mockReturnValue(() => TOKEN)
testStoreConfig.modules.conversationsStore.getters.conversation
= jest.fn().mockReturnValue((token) => conversationProps)
testStoreConfig.modules.actorStore.getters.getActorId
= jest.fn().mockReturnValue(() => 'user-id-1')
getActorTypeMock = jest.fn().mockReturnValue(() => ATTENDEE.ACTOR_TYPE.USERS)
testStoreConfig.modules.actorStore.getters.getActorType = getActorTypeMock
messageProps = {
message: 'test message',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
actorId: 'user-id-1',
actorDisplayName: 'user-display-name-1',
messageParameters: {},
id: 123,
isTemporary: false,
isFirstMessage: true,
isReplyable: true,
timestamp: new Date('2020-05-07 09:23:00').getTime() / 1000,
token: TOKEN,
systemMessage: '',
messageType: 'comment',
}
// Dummy message getter so that the message component is always
// properly mounted.
testStoreConfig.modules.messagesStore.getters.message
= jest.fn().mockReturnValue(() => {
return {
reactions: '',
}
})
// Dummy hasReactions getter so that the message component is always
// properly mounted.
testStoreConfig.modules.messagesStore.getters.hasReactions
= jest.fn().mockReturnValue(() => false)
})
afterEach(() => {
jest.clearAllMocks()
})
describe('message rendering', () => {
beforeEach(() => {
store = new Vuex.Store(testStoreConfig)
})
test('renders rich text message', async () => {
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const message = wrapper.findComponent({ name: 'RichText' })
expect(message.attributes('text')).toBe('test message')
})
test('renders emoji as single plain text', async () => {
messageProps.isSingleEmoji = true
messageProps.message = '🌧️'
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const emoji = wrapper.find('.message-body__main__text')
expect(emoji.text()).toBe('🌧️')
const message = wrapper.findComponent({ name: 'RichText' })
expect(message.exists()).toBe(false)
})
describe('call button', () => {
beforeEach(() => {
testStoreConfig.modules.messagesStore.getters.messagesList = jest.fn().mockReturnValue((token) => {
return [{
id: 1,
systemMessage: 'call_started',
message: 'message one',
}, {
id: 2,
systemMessage: 'call_started',
message: 'message two',
}]
})
store = new Vuex.Store(testStoreConfig)
})
test('shows join call button on last message when a call is in progress', () => {
messageProps.id = 2
messageProps.systemMessage = 'call_started'
messageProps.message = 'message two'
conversationProps.hasCall = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const richText = wrapper.findComponent({ name: 'RichText' })
expect(richText.attributes('text')).toBe('message two')
const callButton = wrapper.findComponent({ name: 'CallButton' })
expect(callButton.exists()).toBe(true)
})
test('does not show join call button on non-last message when a call is in progress', () => {
messageProps.id = 1
messageProps.systemMessage = 'call_started'
messageProps.message = 'message one'
conversationProps.hasCall = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const callButton = wrapper.findComponent({ name: 'CallButton' })
expect(callButton.exists()).toBe(false)
})
test('does not show join call button when no call is in progress', () => {
messageProps.id = 2
messageProps.systemMessage = 'call_started'
messageProps.message = 'message two'
conversationProps.hasCall = false
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const callButton = wrapper.findComponent({ name: 'CallButton' })
expect(callButton.exists()).toBe(false)
})
test('does not show join call button when self is in call', () => {
messageProps.id = 2
messageProps.systemMessage = 'call_started'
messageProps.message = 'message two'
conversationProps.hasCall = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
mixins: [{
// mock the isInCall mixin
computed: {
isInCall: () => true,
},
}],
})
const callButton = wrapper.findComponent({ name: 'CallButton' })
expect(callButton.exists()).toBe(false)
})
})
test('renders deleted system message', () => {
messageProps.systemMessage = 'comment_deleted'
messageProps.message = 'message deleted'
conversationProps.hasCall = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
mixins: [{
// mock the isInCall mixin
computed: {
isInCall: () => true,
},
}],
})
const richText = wrapper.findComponent({ name: 'RichText' })
expect(richText.attributes('text')).toBe('message deleted')
})
test('renders date', () => {
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const date = wrapper.find('.date')
expect(date.exists()).toBe(true)
expect(date.text()).toBe('09:23')
})
test('renders quote block', () => {
const parentMessage = {
id: 120,
message: 'quoted text',
actorId: 'another-user',
actorDisplayName: 'anotherUser',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
messageParameters: {},
token: TOKEN,
parentId: -1,
reactions: '',
}
messageProps.parent = 120
const messageGetterMock = jest.fn().mockReturnValue(parentMessage)
testStoreConfig.modules.messagesStore.getters.message = jest.fn(() => messageGetterMock)
store = new Vuex.Store(testStoreConfig)
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
// parent message got queried from the store
expect(messageGetterMock).toHaveBeenCalledWith(TOKEN, 120)
const quote = wrapper.findComponent(Quote)
expect(quote.exists()).toBe(true)
expect(quote.attributes('message')).toBe('quoted text')
})
describe('rich objects', () => {
/**
* @param {object} message The rich-object-string message text
* @param {object} messageParameters The rich-object-string parameters
* @param {object} expectedRichParameters The expected Vue objects for the parameters
*/
function renderRichObject(message, messageParameters, expectedRichParameters) {
messageProps.message = message
messageProps.messageParameters = messageParameters
const wrapper = shallowMount(Message, {
localVue,
store,
stubs: {
RichText: RichTextStub,
},
propsData: messageProps,
})
const messageEl = wrapper.findComponent({ name: 'RichText' })
// note: indices as object keys are on purpose
expect(messageEl.props('arguments')).toStrictEqual(expectedRichParameters)
}
test('renders mentions', () => {
const mentions = {
'mention-user1': {
id: 'alice',
name: 'Alice',
type: 'user',
},
'mention-user2': {
id: 'bob',
name: 'Bob',
type: 'guest',
},
'mention-call1': {
id: 'some_call',
type: 'call',
},
}
renderRichObject(
'hello {mention-user1}, {mention-user2} wants to have a {mention-call1} with you',
mentions,
{
'mention-user1': {
component: Mention,
props: mentions['mention-user1'],
},
'mention-user2': {
component: Mention,
props: mentions['mention-user2'],
},
'mention-call1': {
component: Mention,
props: mentions['mention-call1'],
},
}
)
})
test('renders file previews', () => {
const params = {
actor: {
id: 'alice',
name: 'Alice',
type: 'user',
},
file: {
path: 'some/path',
type: 'file',
},
}
renderRichObject(
'{file}',
params, {
actor: {
component: Mention,
props: params.actor,
},
file: {
component: FilePreview,
props: params.file,
},
}
)
})
test('renders deck cards', () => {
const params = {
actor: {
id: 'alice',
name: 'Alice',
type: 'user',
},
'deck-card': {
metadata: '{id:123}',
type: 'deck-card',
},
}
renderRichObject(
'{deck-card}',
params, {
actor: {
component: Mention,
props: params.actor,
},
'deck-card': {
component: DeckCard,
props: params['deck-card'],
},
}
)
})
test('renders geo locations', () => {
const params = {
'geo-location': {
metadata: '{id:123}',
type: 'geo-location',
},
}
renderRichObject(
'{geo-location}',
params, {
'geo-location': {
component: Location,
props: params['geo-location'],
},
}
)
})
test('renders other rich objects', () => {
const params = {
actor: {
id: 'alice',
name: 'Alice',
type: 'user',
},
unknown: {
path: 'some/path',
type: 'unknown',
},
}
renderRichObject(
'{unknown}',
params, {
actor: {
component: Mention,
props: params.actor,
},
unknown: {
component: DefaultParameter,
props: params.unknown,
},
}
)
})
})
test('displays unread message marker that marks the message seen when visible', () => {
messageProps.lastReadMessageId = 123
messageProps.nextMessageId = 333
const observeVisibility = jest.fn()
const wrapper = shallowMount(Message, {
localVue,
store,
directives: {
observeVisibility,
},
propsData: messageProps,
})
const marker = wrapper.find('.new-message-marker')
expect(marker.exists()).toBe(true)
expect(observeVisibility).toHaveBeenCalled()
const directiveValue = observeVisibility.mock.calls[0][1]
expect(wrapper.vm.seen).toEqual(false)
directiveValue.value(false)
expect(wrapper.vm.seen).toEqual(false)
directiveValue.value(true)
expect(wrapper.vm.seen).toEqual(true)
// stays true if it was visible once
directiveValue.value(false)
expect(wrapper.vm.seen).toEqual(true)
})
test('does not display read marker on the very last message', () => {
messageProps.lastReadMessageId = 123
messageProps.nextMessageId = null // last message
const observeVisibility = jest.fn()
const wrapper = shallowMount(Message, {
localVue,
store,
directives: {
observeVisibility,
},
propsData: messageProps,
})
const marker = wrapper.find('.new-message-marker')
expect(marker.exists()).toBe(false)
})
})
describe('author rendering', () => {
const AUTHOR_SELECTOR = '.message-body__author'
beforeEach(() => {
store = new Vuex.Store(testStoreConfig)
})
test('renders author if first message', async () => {
messageProps.isFirstMessage = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const displayName = wrapper.find(AUTHOR_SELECTOR)
expect(displayName.text()).toBe('user-display-name-1')
})
test('does not render author if not first message', async () => {
messageProps.isFirstMessage = false
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const displayName = wrapper.find(AUTHOR_SELECTOR)
expect(displayName.exists()).toBe(false)
})
})
describe('actions', () => {
beforeEach(() => {
store = new Vuex.Store(testStoreConfig)
})
test('does not render actions for system messages are available', async () => {
messageProps.systemMessage = 'this is a system message'
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
await wrapper.vm.$nextTick()
const messageButtonsBar = wrapper.findComponent(MessageButtonsBar)
expect(messageButtonsBar.exists()).toBe(false)
})
test('does not render actions for temporary messages', async () => {
messageProps.isTemporary = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
await wrapper.vm.$nextTick()
const messageButtonsBar = wrapper.findComponent(MessageButtonsBar)
expect(messageButtonsBar.exists()).toBe(false)
})
test('actions become visible on mouse over', async () => {
messageProps.sendingFailure = 'timeout'
const wrapper = mount(Message, {
localVue,
store,
propsData: messageProps,
})
await wrapper.vm.$nextTick()
const messageButtonsBar = wrapper.findComponent(MessageButtonsBar)
expect(wrapper.vm.showMessageButtonsBar).toBe(false)
expect(messageButtonsBar.isVisible()).toBe(false)
await wrapper.find('.message-body').trigger('mouseover')
expect(wrapper.vm.showMessageButtonsBar).toBe(true)
expect(messageButtonsBar.isVisible()).toBe(true)
await wrapper.find('.message-body').trigger('mouseleave')
expect(wrapper.vm.showMessageButtonsBar).toBe(false)
expect(messageButtonsBar.isVisible()).toBe(false)
// actions are always present and rendered
const actions = wrapper.findAllComponents({ name: 'Actions' })
expect(actions.length).toBe(2)
})
})
describe('status', () => {
beforeEach(() => {
store = new Vuex.Store(testStoreConfig)
})
test('lets user retry sending a timed out message', async () => {
messageProps.sendingFailure = 'timeout'
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
await wrapper.find('.message-body').trigger('mouseover')
const reloadButton = wrapper.find('.sending-failed')
expect(reloadButton.exists()).toBe(true)
await reloadButton.trigger('mouseover')
expect(wrapper.vm.showReloadButton).toBe(true)
const reloadButtonIcon = reloadButton.find('button')
expect(reloadButtonIcon.exists()).toBe(true)
const retryEvent = jest.fn()
EventBus.$on('retry-message', retryEvent)
await reloadButtonIcon.trigger('click')
expect(retryEvent).toHaveBeenCalledWith(123)
})
test('displays the message already with a spinner while sending it', () => {
messageProps.isTemporary = true
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
})
const message = wrapper.findComponent({ name: 'RichText' })
expect(message.attributes('text')).toBe('test message')
expect(wrapper.find('.icon-loading-small').exists()).toBe(true)
})
test('displays icon when message was read by everyone', () => {
conversationProps.lastCommonReadMessage = 123
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
mixins: [{
computed: {
participant: () => {
return {
actorId: 'user-id-1',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
}
},
},
}],
})
expect(wrapper.findComponent(Check).exists()).toBe(false)
expect(wrapper.findComponent(CheckAll).exists()).toBe(true)
})
test('displays sent icon when own message was sent', () => {
conversationProps.lastCommonReadMessage = 0
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
mixins: [{
computed: {
participant: () => {
return {
actorId: 'user-id-1',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
}
},
},
}],
})
expect(wrapper.findComponent(Check).exists()).toBe(true)
expect(wrapper.findComponent(CheckAll).exists()).toBe(false)
})
test('does not displays check icon for other people\'s messages', () => {
conversationProps.lastCommonReadMessage = 123
const wrapper = shallowMount(Message, {
localVue,
store,
propsData: messageProps,
mixins: [{
computed: {
participant: () => {
return {
actorId: 'user-id-2',
actorType: ATTENDEE.ACTOR_TYPE.USERS,
}
},
},
}],
})
expect(wrapper.findComponent(Check).exists()).toBe(false)
expect(wrapper.findComponent(CheckAll).exists()).toBe(false)
})
})
})
|