forked from Expensify/App
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathReportTest.ts
1416 lines (1204 loc) · 64.1 KB
/
ReportTest.ts
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
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable @typescript-eslint/naming-convention */
import {afterEach, beforeAll, beforeEach, describe, expect, it} from '@jest/globals';
import {addSeconds, format, subMinutes} from 'date-fns';
import {toZonedTime} from 'date-fns-tz';
import type {Mock} from 'jest-mock';
import Onyx from 'react-native-onyx';
import type {OnyxCollection, OnyxEntry, OnyxUpdate} from 'react-native-onyx';
import {WRITE_COMMANDS} from '@libs/API/types';
import * as EmojiUtils from '@libs/EmojiUtils';
import HttpUtils from '@libs/HttpUtils';
import CONST from '@src/CONST';
import OnyxUpdateManager from '@src/libs/actions/OnyxUpdateManager';
import * as PersistedRequests from '@src/libs/actions/PersistedRequests';
import * as Report from '@src/libs/actions/Report';
import * as User from '@src/libs/actions/User';
import DateUtils from '@src/libs/DateUtils';
import Log from '@src/libs/Log';
import * as SequentialQueue from '@src/libs/Network/SequentialQueue';
import * as ReportUtils from '@src/libs/ReportUtils';
import ONYXKEYS from '@src/ONYXKEYS';
import type * as OnyxTypes from '@src/types/onyx';
import getIsUsingFakeTimers from '../utils/getIsUsingFakeTimers';
import PusherHelper from '../utils/PusherHelper';
import * as TestHelper from '../utils/TestHelper';
import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';
import waitForNetworkPromises from '../utils/waitForNetworkPromises';
const UTC = 'UTC';
jest.mock('@src/libs/actions/Report', () => {
const originalModule = jest.requireActual<Report>('@src/libs/actions/Report');
return {
...originalModule,
showReportActionNotification: jest.fn(),
};
});
jest.mock('@hooks/useScreenWrapperTransitionStatus', () => ({
default: () => ({
didScreenTransitionEnd: true,
}),
}));
const originalXHR = HttpUtils.xhr;
OnyxUpdateManager();
describe('actions/Report', () => {
beforeAll(() => {
PusherHelper.setup();
Onyx.init({
keys: ONYXKEYS,
});
});
beforeEach(() => {
HttpUtils.xhr = originalXHR;
const promise = Onyx.clear().then(jest.useRealTimers);
if (getIsUsingFakeTimers()) {
// flushing pending timers
// Onyx.clear() promise is resolved in batch which happens after the current microtasks cycle
setImmediate(jest.runOnlyPendingTimers);
}
return promise;
});
afterEach(() => {
jest.clearAllMocks();
PusherHelper.teardown();
});
it('should store a new report action in Onyx when onyxApiUpdate event is handled via Pusher', () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const TEST_USER_LOGIN = 'test@test.com';
const REPORT_ID = '1';
let reportActionID: string;
const REPORT_ACTION = {
actionName: CONST.REPORT.ACTIONS.TYPE.ADD_COMMENT,
actorAccountID: TEST_USER_ACCOUNT_ID,
automatic: false,
avatar: 'https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/avatar_3.png',
message: [{type: 'COMMENT', html: 'Testing a comment', text: 'Testing a comment', translationKey: ''}],
person: [{type: 'TEXT', style: 'strong', text: 'Test User'}],
shouldShow: true,
};
let reportActions: OnyxEntry<OnyxTypes.ReportActions>;
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (val) => (reportActions = val),
});
// Set up Onyx with some test user data
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID, TEST_USER_LOGIN)
.then(() => {
User.subscribeToUserEvents();
return waitForBatchedUpdates();
})
.then(() => TestHelper.setPersonalDetails(TEST_USER_LOGIN, TEST_USER_ACCOUNT_ID))
.then(() => {
// This is a fire and forget response, but once it completes we should be able to verify that we
// have an "optimistic" report action in Onyx.
Report.addComment(REPORT_ID, 'Testing a comment');
return waitForBatchedUpdates();
})
.then(() => {
const resultAction: OnyxEntry<OnyxTypes.ReportAction> = Object.values(reportActions ?? {}).at(0);
reportActionID = resultAction?.reportActionID ?? '-1';
expect(resultAction?.message).toEqual(REPORT_ACTION.message);
expect(resultAction?.person).toEqual(REPORT_ACTION.person);
expect(resultAction?.pendingAction).toBeUndefined();
// We subscribed to the Pusher channel above and now we need to simulate a reportComment action
// Pusher event so we can verify that action was handled correctly and merged into the reportActions.
PusherHelper.emitOnyxUpdate([
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`,
value: {
reportID: REPORT_ID,
participants: {
[TEST_USER_ACCOUNT_ID]: {
notificationPreference: 'always',
},
},
lastVisibleActionCreated: '2022-11-22 03:48:27.267',
lastMessageText: 'Testing a comment',
lastActorAccountID: TEST_USER_ACCOUNT_ID,
},
},
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
value: {
[reportActionID]: {pendingAction: null},
},
},
]);
// Once a reportComment event is emitted to the Pusher channel we should see the comment get processed
// by the Pusher callback and added to the storage so we must wait for promises to resolve again and
// then verify the data is in Onyx.
return waitForBatchedUpdates();
})
.then(() => {
// Verify there is only one action and our optimistic comment has been removed
expect(Object.keys(reportActions ?? {}).length).toBe(1);
const resultAction = reportActions?.[reportActionID];
// Verify that our action is no longer in the loading state
expect(resultAction?.pendingAction).toBeUndefined();
});
});
it('should update pins in Onyx when togglePinned is called', () => {
const TEST_USER_ACCOUNT_ID = 1;
const TEST_USER_LOGIN = 'test@test.com';
const REPORT_ID = '1';
let reportIsPinned: boolean;
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`,
callback: (val) => (reportIsPinned = val?.isPinned ?? false),
});
// Set up Onyx with some test user data
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID, TEST_USER_LOGIN)
.then(() => {
Report.togglePinnedState(REPORT_ID, false);
return waitForBatchedUpdates();
})
.then(() => {
// Test that Onyx immediately updated the report pin state.
expect(reportIsPinned).toEqual(true);
});
});
it('Should not leave duplicate comments when logger sends packet because of calling process queue while processing the queue', () => {
const TEST_USER_ACCOUNT_ID = 1;
const TEST_USER_LOGIN = 'test@test.com';
const REPORT_ID = '1';
const LOGGER_MAX_LOG_LINES = 50;
// GIVEN a test user with initial data
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID, TEST_USER_LOGIN)
.then(() => TestHelper.setPersonalDetails(TEST_USER_LOGIN, TEST_USER_ACCOUNT_ID))
.then(() => {
global.fetch = TestHelper.getGlobalFetchMock();
// WHEN we add enough logs to send a packet
for (let i = 0; i <= LOGGER_MAX_LOG_LINES; i++) {
Log.info('Test log info');
}
// And leave a comment on a report
Report.addComment(REPORT_ID, 'Testing a comment');
// Then we should expect that there is on persisted request
expect(PersistedRequests.getAll().length).toBe(1);
// When we wait for the queue to run
return waitForBatchedUpdates();
})
.then(() => {
// THEN only ONE call to AddComment will happen
const URL_ARGUMENT_INDEX = 0;
const addCommentCalls = (global.fetch as jest.Mock).mock.calls.filter((callArguments: string[]) => callArguments.at(URL_ARGUMENT_INDEX)?.includes('AddComment'));
expect(addCommentCalls.length).toBe(1);
});
});
it('should be updated correctly when new comments are added, deleted or marked as unread', () => {
jest.useFakeTimers();
global.fetch = TestHelper.getGlobalFetchMock();
const REPORT_ID = '1';
let report: OnyxEntry<OnyxTypes.Report>;
let reportActionCreatedDate: string;
let currentTime: string;
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`,
callback: (val) => (report = val),
});
let reportActions: OnyxTypes.ReportActions;
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (val) => (reportActions = val ?? {}),
});
const USER_1_LOGIN = 'user@test.com';
const USER_1_ACCOUNT_ID = 1;
const USER_2_ACCOUNT_ID = 2;
const setPromise = Onyx.set(`${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`, {reportName: 'Test', reportID: REPORT_ID})
.then(() => TestHelper.signInWithTestUser(USER_1_ACCOUNT_ID, USER_1_LOGIN))
.then(waitForNetworkPromises)
.then(() => {
// Given a test user that is subscribed to Pusher events
User.subscribeToUserEvents();
return waitForBatchedUpdates();
})
.then(() => TestHelper.setPersonalDetails(USER_1_LOGIN, USER_1_ACCOUNT_ID))
.then(() => {
// When a Pusher event is handled for a new report comment that includes a mention of the current user
reportActionCreatedDate = DateUtils.getDBTime();
PusherHelper.emitOnyxUpdate([
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`,
value: {
reportID: REPORT_ID,
participants: {
[USER_1_ACCOUNT_ID]: {
notificationPreference: 'always',
},
},
lastMessageText: 'Comment 1',
lastActorAccountID: USER_2_ACCOUNT_ID,
lastVisibleActionCreated: reportActionCreatedDate,
lastMentionedTime: reportActionCreatedDate,
lastReadTime: DateUtils.subtractMillisecondsFromDateTime(reportActionCreatedDate, 1),
},
},
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
value: {
1: {
actionName: CONST.REPORT.ACTIONS.TYPE.ADD_COMMENT,
actorAccountID: USER_2_ACCOUNT_ID,
automatic: false,
avatar: 'https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/avatar_3.png',
message: [{type: 'COMMENT', html: 'Comment 1', text: 'Comment 1'}],
person: [{type: 'TEXT', style: 'strong', text: 'Test User'}],
shouldShow: true,
created: reportActionCreatedDate,
reportActionID: '1',
},
},
},
]);
return waitForNetworkPromises();
})
.then(() => {
// Then the report will be unread
expect(ReportUtils.isUnread(report)).toBe(true);
// And show a green dot for unread mentions in the LHN
expect(ReportUtils.isUnreadWithMention(report)).toBe(true);
// When the user visits the report
jest.advanceTimersByTime(10);
currentTime = DateUtils.getDBTime();
Report.openReport(REPORT_ID);
Report.readNewestAction(REPORT_ID);
waitForBatchedUpdates();
return waitForBatchedUpdates();
})
.then(() => {
// The report will be read
expect(ReportUtils.isUnread(report)).toBe(false);
expect(toZonedTime(report?.lastReadTime ?? '', UTC).getTime()).toBeGreaterThanOrEqual(toZonedTime(currentTime, UTC).getTime());
// And no longer show the green dot for unread mentions in the LHN
expect(ReportUtils.isUnreadWithMention(report)).toBe(false);
// When the user manually marks a message as "unread"
jest.advanceTimersByTime(10);
Report.markCommentAsUnread(REPORT_ID, reportActionCreatedDate);
return waitForBatchedUpdates();
})
.then(() => {
// Then the report will be unread and show the green dot for unread mentions in LHN
expect(ReportUtils.isUnread(report)).toBe(true);
expect(ReportUtils.isUnreadWithMention(report)).toBe(true);
expect(report?.lastReadTime).toBe(DateUtils.subtractMillisecondsFromDateTime(reportActionCreatedDate, 1));
// When a new comment is added by the current user
jest.advanceTimersByTime(10);
currentTime = DateUtils.getDBTime();
Report.addComment(REPORT_ID, 'Current User Comment 1');
return waitForBatchedUpdates();
})
.then(() => {
// The report will be read, the green dot for unread mentions will go away, and the lastReadTime updated
expect(ReportUtils.isUnread(report)).toBe(false);
expect(ReportUtils.isUnreadWithMention(report)).toBe(false);
expect(toZonedTime(report?.lastReadTime ?? '', UTC).getTime()).toBeGreaterThanOrEqual(toZonedTime(currentTime, UTC).getTime());
expect(report?.lastMessageText).toBe('Current User Comment 1');
// When another comment is added by the current user
jest.advanceTimersByTime(10);
currentTime = DateUtils.getDBTime();
Report.addComment(REPORT_ID, 'Current User Comment 2');
return waitForBatchedUpdates();
})
.then(() => {
// The report will be read and the lastReadTime updated
expect(ReportUtils.isUnread(report)).toBe(false);
expect(toZonedTime(report?.lastReadTime ?? '', UTC).getTime()).toBeGreaterThanOrEqual(toZonedTime(currentTime, UTC).getTime());
expect(report?.lastMessageText).toBe('Current User Comment 2');
// When another comment is added by the current user
jest.advanceTimersByTime(10);
currentTime = DateUtils.getDBTime();
Report.addComment(REPORT_ID, 'Current User Comment 3');
return waitForBatchedUpdates();
})
.then(() => {
// The report will be read and the lastReadTime updated
expect(ReportUtils.isUnread(report)).toBe(false);
expect(toZonedTime(report?.lastReadTime ?? '', UTC).getTime()).toBeGreaterThanOrEqual(toZonedTime(currentTime, UTC).getTime());
expect(report?.lastMessageText).toBe('Current User Comment 3');
const USER_1_BASE_ACTION = {
actionName: CONST.REPORT.ACTIONS.TYPE.ADD_COMMENT,
actorAccountID: USER_1_ACCOUNT_ID,
automatic: false,
avatar: 'https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/avatar_3.png',
person: [{type: 'TEXT', style: 'strong', text: 'Test User'}],
shouldShow: true,
created: DateUtils.getDBTime(Date.now() - 3),
};
jest.advanceTimersByTime(10);
const optimisticReportActions: OnyxUpdate = {
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
value: {
200: {
...USER_1_BASE_ACTION,
message: [{type: 'COMMENT', html: 'Current User Comment 1', text: 'Current User Comment 1'}],
created: DateUtils.getDBTime(Date.now() - 2),
reportActionID: '200',
},
300: {
...USER_1_BASE_ACTION,
message: [{type: 'COMMENT', html: 'Current User Comment 2', text: 'Current User Comment 2'}],
created: DateUtils.getDBTime(Date.now() - 1),
reportActionID: '300',
},
400: {
...USER_1_BASE_ACTION,
message: [{type: 'COMMENT', html: 'Current User Comment 3', text: 'Current User Comment 3'}],
created: DateUtils.getDBTime(),
reportActionID: '400',
},
},
};
jest.advanceTimersByTime(10);
reportActionCreatedDate = DateUtils.getDBTime();
if (optimisticReportActions.value?.[400]) {
optimisticReportActions.value[400].created = reportActionCreatedDate;
}
// When we emit the events for these pending created actions to update them to not pending
PusherHelper.emitOnyxUpdate([
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT}${REPORT_ID}`,
value: {
reportID: REPORT_ID,
participants: {
[USER_1_ACCOUNT_ID]: {
notificationPreference: 'always',
},
},
lastMessageText: 'Current User Comment 3',
lastActorAccountID: 1,
lastVisibleActionCreated: reportActionCreatedDate,
lastReadTime: reportActionCreatedDate,
},
},
optimisticReportActions,
]);
return waitForNetworkPromises();
})
.then(() => {
// If the user deletes a comment that is before the last read
Report.deleteReportComment(REPORT_ID, {...reportActions[200]});
return waitForBatchedUpdates();
})
.then(() => {
// Then no change will occur
expect(report?.lastReadTime).toBe(reportActionCreatedDate);
expect(ReportUtils.isUnread(report)).toBe(false);
// When the user manually marks a message as "unread"
Report.markCommentAsUnread(REPORT_ID, reportActionCreatedDate);
return waitForBatchedUpdates();
})
.then(() => {
// Then we should expect the report to be to be unread
expect(ReportUtils.isUnread(report)).toBe(true);
expect(report?.lastReadTime).toBe(DateUtils.subtractMillisecondsFromDateTime(reportActionCreatedDate, 1));
// If the user deletes the last comment after the lastReadTime the lastMessageText will reflect the new last comment
Report.deleteReportComment(REPORT_ID, {...reportActions[400]});
return waitForBatchedUpdates();
})
.then(() => {
expect(ReportUtils.isUnread(report)).toBe(false);
expect(report?.lastMessageText).toBe('Current User Comment 2');
});
waitForBatchedUpdates(); // flushing onyx.set as it will be batched
return setPromise;
});
it('Should properly update comment with links', () => {
/* This tests a variety of scenarios when a user edits a comment.
* We should generate a link when editing a message unless the link was
* already in the comment and the user deleted it on purpose.
*/
global.fetch = TestHelper.getGlobalFetchMock();
// User edits comment to add link
// We should generate link
let originalCommentMarkdown = 'Original Comment';
let afterEditCommentText = 'Original Comment www.google.com';
let newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
let expectedOutput = 'Original Comment <a href="https://www.google.com" target="_blank" rel="noreferrer noopener">www.google.com</a>';
expect(newCommentHTML).toBe(expectedOutput);
// User deletes www.google.com link from comment but keeps link text
// We should not generate link
originalCommentMarkdown = 'Comment [www.google.com](https://www.google.com)';
afterEditCommentText = 'Comment www.google.com';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = 'Comment www.google.com';
expect(newCommentHTML).toBe(expectedOutput);
// User Delete only () part of link but leaves the []
// We should not generate link
originalCommentMarkdown = 'Comment [www.google.com](https://www.google.com)';
afterEditCommentText = 'Comment [www.google.com]';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = 'Comment [www.google.com]';
expect(newCommentHTML).toBe(expectedOutput);
// User Generates multiple links in one edit
// We should generate both links
originalCommentMarkdown = 'Comment';
afterEditCommentText = 'Comment www.google.com www.facebook.com';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput =
'Comment <a href="https://www.google.com" target="_blank" rel="noreferrer noopener">www.google.com</a> ' +
'<a href="https://www.facebook.com" target="_blank" rel="noreferrer noopener">www.facebook.com</a>';
expect(newCommentHTML).toBe(expectedOutput);
// Comment has two links but user deletes only one of them
// Should not generate link again for the deleted one
originalCommentMarkdown = 'Comment [www.google.com](https://www.google.com) [www.facebook.com](https://www.facebook.com)';
afterEditCommentText = 'Comment www.google.com [www.facebook.com](https://www.facebook.com)';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = 'Comment www.google.com <a href="https://www.facebook.com" target="_blank" rel="noreferrer noopener">www.facebook.com</a>';
expect(newCommentHTML).toBe(expectedOutput);
// User edits and replaces comment with a link containing underscores
// We should generate link
originalCommentMarkdown = 'Comment';
afterEditCommentText = 'https://www.facebook.com/hashtag/__main/?__eep__=6';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = '<a href="https://www.facebook.com/hashtag/__main/?__eep__=6" target="_blank" rel="noreferrer noopener">https://www.facebook.com/hashtag/__main/?__eep__=6</a>';
expect(newCommentHTML).toBe(expectedOutput);
// User edits and deletes the link containing underscores
// We should not generate link
originalCommentMarkdown = '[https://www.facebook.com/hashtag/__main/?__eep__=6](https://www.facebook.com/hashtag/__main/?__eep__=6)';
afterEditCommentText = 'https://www.facebook.com/hashtag/__main/?__eep__=6';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = 'https://www.facebook.com/hashtag/__main/?__eep__=6';
expect(newCommentHTML).toBe(expectedOutput);
// User edits and replaces comment with a link containing asterisks
// We should generate link
originalCommentMarkdown = 'Comment';
afterEditCommentText = 'http://example.com/foo/*/bar/*/test.txt';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = '<a href="http://example.com/foo/*/bar/*/test.txt" target="_blank" rel="noreferrer noopener">http://example.com/foo/*/bar/*/test.txt</a>';
expect(newCommentHTML).toBe(expectedOutput);
// User edits and deletes the link containing asterisks
// We should not generate link
originalCommentMarkdown = '[http://example.com/foo/*/bar/*/test.txt](http://example.com/foo/*/bar/*/test.txt)';
afterEditCommentText = 'http://example.com/foo/*/bar/*/test.txt';
newCommentHTML = Report.handleUserDeletedLinksInHtml(afterEditCommentText, originalCommentMarkdown);
expectedOutput = 'http://example.com/foo/*/bar/*/test.txt';
expect(newCommentHTML).toBe(expectedOutput);
});
it('should show a notification for report action updates with shouldNotify', () => {
const TEST_USER_ACCOUNT_ID = 1;
const REPORT_ID = '1';
const REPORT_ACTION = {
actionName: CONST.REPORT.ACTIONS.TYPE.ADD_COMMENT,
};
// Setup user and pusher listeners
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID)
.then(waitForBatchedUpdates)
.then(() => {
User.subscribeToUserEvents();
return waitForBatchedUpdates();
})
.then(() => {
// Simulate a Pusher Onyx update with a report action with shouldNotify
PusherHelper.emitOnyxUpdate([
{
onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
value: {
1: REPORT_ACTION,
},
shouldNotify: true,
},
]);
return SequentialQueue.getCurrentRequest().then(waitForBatchedUpdates);
})
.then(() => {
// Ensure we show a notification for this new report action
expect(Report.showReportActionNotification).toBeCalledWith(REPORT_ID, REPORT_ACTION);
});
});
it('should properly toggle reactions on a message', () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const TEST_USER_LOGIN = 'test@test.com';
const REPORT_ID = '1';
const EMOJI_CODE = '👍';
const EMOJI_SKIN_TONE = 2;
const EMOJI_NAME = '+1';
const EMOJI = {
code: EMOJI_CODE,
name: EMOJI_NAME,
types: ['👍🏿', '👍🏾', '👍🏽', '👍🏼', '👍🏻'],
};
let reportActions: OnyxTypes.ReportActions;
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (val) => (reportActions = val ?? {}),
});
const reportActionsReactions: OnyxCollection<OnyxTypes.ReportActionReactions> = {};
Onyx.connect({
key: ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS,
callback: (val, key) => {
reportActionsReactions[key] = val ?? {};
},
});
let reportAction: OnyxTypes.ReportAction | undefined;
let reportActionID: string;
// Set up Onyx with some test user data
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID, TEST_USER_LOGIN)
.then(() => {
User.subscribeToUserEvents();
return waitForBatchedUpdates();
})
.then(() => TestHelper.setPersonalDetails(TEST_USER_LOGIN, TEST_USER_ACCOUNT_ID))
.then(() => {
// This is a fire and forget response, but once it completes we should be able to verify that we
// have an "optimistic" report action in Onyx.
Report.addComment(REPORT_ID, 'Testing a comment');
return waitForBatchedUpdates();
})
.then(() => {
reportAction = Object.values(reportActions).at(0);
reportActionID = reportAction?.reportActionID ?? '-1';
if (reportAction) {
// Add a reaction to the comment
Report.toggleEmojiReaction(REPORT_ID, reportAction, EMOJI, reportActionsReactions[0]);
}
return waitForBatchedUpdates();
})
.then(() => {
reportAction = Object.values(reportActions).at(0);
// Expect the reaction to exist in the reportActionsReactions collection
expect(reportActionsReactions).toHaveProperty(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`);
// Expect the reaction to have the emoji on it
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`];
expect(reportActionReaction).toHaveProperty(EMOJI.name);
// Expect the emoji to have the user accountID
const reportActionReactionEmoji = reportActionReaction?.[EMOJI.name];
expect(reportActionReactionEmoji?.users).toHaveProperty(`${TEST_USER_ACCOUNT_ID}`);
if (reportAction) {
// Now we remove the reaction
Report.toggleEmojiReaction(REPORT_ID, reportAction, EMOJI, reportActionReaction);
}
return waitForBatchedUpdates();
})
.then(() => {
// Expect the reaction to have null where the users reaction used to be
expect(reportActionsReactions).toHaveProperty(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`);
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`];
expect(reportActionReaction?.[EMOJI.name].users[TEST_USER_ACCOUNT_ID]).toBeUndefined();
})
.then(() => {
reportAction = Object.values(reportActions).at(0);
if (reportAction) {
// Add the same reaction to the same report action with a different skintone
Report.toggleEmojiReaction(REPORT_ID, reportAction, EMOJI, reportActionsReactions[0]);
}
return waitForBatchedUpdates()
.then(() => {
reportAction = Object.values(reportActions).at(0);
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`];
if (reportAction) {
Report.toggleEmojiReaction(REPORT_ID, reportAction, EMOJI, reportActionReaction, EMOJI_SKIN_TONE);
}
return waitForBatchedUpdates();
})
.then(() => {
reportAction = Object.values(reportActions).at(0);
// Expect the reaction to exist in the reportActionsReactions collection
expect(reportActionsReactions).toHaveProperty(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`);
// Expect the reaction to have the emoji on it
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`];
expect(reportActionReaction).toHaveProperty(EMOJI.name);
// Expect the emoji to have the user accountID
const reportActionReactionEmoji = reportActionReaction?.[EMOJI.name];
expect(reportActionReactionEmoji?.users).toHaveProperty(`${TEST_USER_ACCOUNT_ID}`);
// Expect two different skintone reactions
const reportActionReactionEmojiUserSkinTones = reportActionReactionEmoji?.users[TEST_USER_ACCOUNT_ID].skinTones;
expect(reportActionReactionEmojiUserSkinTones).toHaveProperty('-1');
expect(reportActionReactionEmojiUserSkinTones).toHaveProperty('2');
if (reportAction) {
// Now we remove the reaction, and expect that both variations are removed
Report.toggleEmojiReaction(REPORT_ID, reportAction, EMOJI, reportActionReaction);
}
return waitForBatchedUpdates();
})
.then(() => {
// Expect the reaction to have null where the users reaction used to be
expect(reportActionsReactions).toHaveProperty(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`);
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${reportActionID}`];
expect(reportActionReaction?.[EMOJI.name].users[TEST_USER_ACCOUNT_ID]).toBeUndefined();
});
});
});
it("shouldn't add the same reaction twice when changing preferred skin color and reaction doesn't support skin colors", () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const TEST_USER_LOGIN = 'test@test.com';
const REPORT_ID = '1';
const EMOJI_CODE = '😄';
const EMOJI_NAME = 'smile';
const EMOJI = {
code: EMOJI_CODE,
name: EMOJI_NAME,
};
let reportActions: OnyxTypes.ReportActions = {};
Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (val) => (reportActions = val ?? {}),
});
const reportActionsReactions: OnyxCollection<OnyxTypes.ReportActionReactions> = {};
Onyx.connect({
key: ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS,
callback: (val, key) => {
reportActionsReactions[key] = val ?? {};
},
});
let resultAction: OnyxTypes.ReportAction | undefined;
// Set up Onyx with some test user data
return TestHelper.signInWithTestUser(TEST_USER_ACCOUNT_ID, TEST_USER_LOGIN)
.then(() => {
User.subscribeToUserEvents();
return waitForBatchedUpdates();
})
.then(() => TestHelper.setPersonalDetails(TEST_USER_LOGIN, TEST_USER_ACCOUNT_ID))
.then(() => {
// This is a fire and forget response, but once it completes we should be able to verify that we
// have an "optimistic" report action in Onyx.
Report.addComment(REPORT_ID, 'Testing a comment');
return waitForBatchedUpdates();
})
.then(() => {
resultAction = Object.values(reportActions).at(0);
if (resultAction) {
// Add a reaction to the comment
Report.toggleEmojiReaction(REPORT_ID, resultAction, EMOJI, {});
}
return waitForBatchedUpdates();
})
.then(() => {
resultAction = Object.values(reportActions).at(0);
// Now we toggle the reaction while the skin tone has changed.
// As the emoji doesn't support skin tones, the emoji
// should get removed instead of added again.
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${resultAction?.reportActionID}`];
if (resultAction) {
Report.toggleEmojiReaction(REPORT_ID, resultAction, EMOJI, reportActionReaction, 2);
}
return waitForBatchedUpdates();
})
.then(() => {
// Expect the reaction to have null where the users reaction used to be
expect(reportActionsReactions).toHaveProperty(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${resultAction?.reportActionID}`);
const reportActionReaction = reportActionsReactions[`${ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS}${resultAction?.reportActionID}`];
expect(reportActionReaction?.[EMOJI.name].users[TEST_USER_ACCOUNT_ID]).toBeUndefined();
});
});
it('should send only one OpenReport, replacing any extra ones with same reportIDs', async () => {
global.fetch = TestHelper.getGlobalFetchMock();
const REPORT_ID = '1';
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: true});
await waitForBatchedUpdates();
for (let i = 0; i < 5; i++) {
Report.openReport(REPORT_ID, undefined, ['test@user.com'], {
isOptimisticReport: true,
reportID: REPORT_ID,
});
}
expect(PersistedRequests.getAll().length).toBe(1);
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: false});
await waitForBatchedUpdates();
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.OPEN_REPORT, 1);
});
it('should replace duplicate OpenReport commands with the same reportID', async () => {
global.fetch = TestHelper.getGlobalFetchMock();
const REPORT_ID = '1';
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: true});
await waitForBatchedUpdates();
for (let i = 0; i < 8; i++) {
let reportID = REPORT_ID;
if (i > 4) {
reportID = `${i}`;
}
Report.openReport(reportID, undefined, ['test@user.com'], {
isOptimisticReport: true,
reportID: REPORT_ID,
});
}
expect(PersistedRequests.getAll().length).toBe(4);
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: false});
await waitForBatchedUpdates();
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.OPEN_REPORT, 4);
});
it('should remove AddComment and UpdateComment without sending any request when DeleteComment is set', async () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const REPORT_ID = '1';
const TEN_MINUTES_AGO = subMinutes(new Date(), 10);
const created = format(addSeconds(TEN_MINUTES_AGO, 10), CONST.DATE.FNS_DB_FORMAT_STRING);
Onyx.set(ONYXKEYS.NETWORK, {isOffline: true});
Report.addComment(REPORT_ID, 'Testing a comment');
// Need the reportActionID to delete the comments
const newComment = PersistedRequests.getAll().at(0);
const reportActionID = (newComment?.data?.reportActionID as string) ?? '-1';
const reportAction = TestHelper.buildTestReportComment(created, TEST_USER_ACCOUNT_ID, reportActionID);
Report.editReportComment(REPORT_ID, reportAction, 'Testing an edited comment');
await waitForBatchedUpdates();
await new Promise<void>((resolve) => {
const connection = Onyx.connect({
key: ONYXKEYS.PERSISTED_REQUESTS,
callback: (persistedRequests) => {
Onyx.disconnect(connection);
expect(persistedRequests?.at(0)?.command).toBe(WRITE_COMMANDS.ADD_COMMENT);
expect(persistedRequests?.at(1)?.command).toBeUndefined();
resolve();
},
});
});
// Checking the Report Action exists before deleting it
await new Promise<void>((resolve) => {
const connection = Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (reportActions) => {
Onyx.disconnect(connection);
expect(reportActions?.[reportActionID]).not.toBeNull();
expect(reportActions?.[reportActionID].reportActionID).toBe(reportActionID);
resolve();
},
});
});
Report.deleteReportComment(REPORT_ID, reportAction);
await waitForBatchedUpdates();
expect(PersistedRequests.getAll().length).toBe(0);
// Checking the Report Action doesn't exist after deleting it
const connection = Onyx.connect({
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${REPORT_ID}`,
callback: (reportActions) => {
Onyx.disconnect(connection);
expect(reportActions?.[reportActionID]).toBeUndefined();
},
});
Onyx.set(ONYXKEYS.NETWORK, {isOffline: false});
await waitForBatchedUpdates();
// Checking no requests were or will be made
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.ADD_COMMENT, 0);
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.UPDATE_COMMENT, 0);
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.DELETE_COMMENT, 0);
});
it('should send DeleteComment request and remove UpdateComment accordingly', async () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const REPORT_ID = '1';
const TEN_MINUTES_AGO = subMinutes(new Date(), 10);
const created = format(addSeconds(TEN_MINUTES_AGO, 10), CONST.DATE.FNS_DB_FORMAT_STRING);
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: false});
Report.addComment(REPORT_ID, 'Testing a comment');
// Need the reportActionID to delete the comments
const newComment = PersistedRequests.getAll().at(1);
const reportActionID = (newComment?.data?.reportActionID as string) ?? '-1';
const reportAction = TestHelper.buildTestReportComment(created, TEST_USER_ACCOUNT_ID, reportActionID);
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: true});
Report.editReportComment(REPORT_ID, reportAction, 'Testing an edited comment');
await waitForBatchedUpdates();
await new Promise<void>((resolve) => {
const connection = Onyx.connect({
key: ONYXKEYS.PERSISTED_REQUESTS,
callback: (persistedRequests) => {
Onyx.disconnect(connection);
expect(persistedRequests?.at(0)?.command).toBe(WRITE_COMMANDS.UPDATE_COMMENT);
resolve();
},
});
});
Report.deleteReportComment(REPORT_ID, reportAction);
await waitForBatchedUpdates();
expect(PersistedRequests.getAll().length).toBe(1);
Onyx.set(ONYXKEYS.NETWORK, {isOffline: false});
await waitForBatchedUpdates();
// Checking no requests were or will be made
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.ADD_COMMENT, 1);
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.UPDATE_COMMENT, 0);
TestHelper.expectAPICommandToHaveBeenCalled(WRITE_COMMANDS.DELETE_COMMENT, 1);
});
it('should send DeleteComment request after AddComment is rollbacked', async () => {
global.fetch = jest.fn().mockRejectedValue(new TypeError(CONST.ERROR.FAILED_TO_FETCH));
const mockedXhr = jest.fn();
mockedXhr
.mockImplementationOnce(originalXHR)
.mockImplementationOnce(() =>
Promise.resolve({
jsonCode: CONST.JSON_CODE.EXP_ERROR,
}),
)
.mockImplementation(() =>
Promise.resolve({
jsonCode: CONST.JSON_CODE.SUCCESS,
}),
);
HttpUtils.xhr = mockedXhr;
await waitForBatchedUpdates();
const TEST_USER_ACCOUNT_ID = 1;
const REPORT_ID = '1';
const TEN_MINUTES_AGO = subMinutes(new Date(), 10);
const created = format(addSeconds(TEN_MINUTES_AGO, 10), CONST.DATE.FNS_DB_FORMAT_STRING);
Report.addComment(REPORT_ID, 'Testing a comment');
await waitForNetworkPromises();
const newComment = PersistedRequests.getAll().at(1);
const reportActionID = (newComment?.data?.reportActionID as string) ?? '-1';
const reportAction = TestHelper.buildTestReportComment(created, TEST_USER_ACCOUNT_ID, reportActionID);
await waitForBatchedUpdates();
expect(PersistedRequests.getAll().length).toBe(1);
expect(PersistedRequests.getAll().at(0)?.isRollbacked).toBeTruthy();
Report.deleteReportComment(REPORT_ID, reportAction);
jest.runOnlyPendingTimers();
await waitForBatchedUpdates();
const httpCalls = (HttpUtils.xhr as Mock).mock.calls;
const addCommentCalls = httpCalls.filter(([command]) => command === 'AddComment');
const deleteCommentCalls = httpCalls.filter(([command]) => command === 'DeleteComment');
if (httpCalls.length === 3) {
expect(addCommentCalls).toHaveLength(2);
expect(deleteCommentCalls).toHaveLength(1);
}
});
it('should send not DeleteComment request and remove AddAttachment accordingly', async () => {
global.fetch = TestHelper.getGlobalFetchMock();
const TEST_USER_ACCOUNT_ID = 1;
const REPORT_ID = '1';
const TEN_MINUTES_AGO = subMinutes(new Date(), 10);
const created = format(addSeconds(TEN_MINUTES_AGO, 10), CONST.DATE.FNS_DB_FORMAT_STRING);
await Onyx.set(ONYXKEYS.NETWORK, {isOffline: true});
const file = new File([''], 'test.txt', {type: 'text/plain'});