-
Notifications
You must be signed in to change notification settings - Fork 420
/
Copy pathsanitize.test.js
1796 lines (1631 loc) · 57.2 KB
/
sanitize.test.js
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
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// @flow
import { processGeckoProfile } from '../../profile-logic/process-profile';
import { sanitizePII } from '../../profile-logic/sanitize';
import { createGeckoProfile } from '../fixtures/profiles/gecko-profile';
import {
getProfileWithMarkers,
getProfileFromTextSamples,
addActiveTabInformationToProfile,
markTabIdsAsPrivateBrowsing,
addMarkersToThreadWithCorrespondingSamples,
addInnerWindowIdToStacks,
getNetworkMarkers,
} from '../fixtures/profiles/processed-profile';
import { ensureExists } from '../../utils/flow';
import {
correlateIPCMarkers,
deriveMarkersFromRawMarkerTable,
} from '../../profile-logic/marker-data';
import {
getTimeRangeForThread,
computeTimeColumnForRawSamplesTable,
} from '../../profile-logic/profile-data';
import {
callTreeFromProfile,
formatTree,
} from 'firefox-profiler/test/fixtures/utils';
import type { RemoveProfileInformation } from 'firefox-profiler/types';
describe('sanitizePII', function () {
function setup(
piiConfig: $Shape<RemoveProfileInformation>,
originalProfile = processGeckoProfile(createGeckoProfile())
) {
const defaultsPii = {
shouldRemoveThreads: new Set(),
shouldRemoveCounters: new Set(),
shouldRemoveThreadsWithScreenshots: new Set(),
shouldRemoveUrls: false,
shouldFilterToCommittedRange: null,
shouldRemoveExtensions: false,
shouldRemovePreferenceValues: false,
shouldRemovePrivateBrowsingData: false,
shouldRemoveTabsExceptTabID: null,
};
const PIIToRemove = {
...defaultsPii,
...piiConfig,
};
const derivedMarkerInfoForAllThreads = originalProfile.threads.map(
(thread) => {
const ipcCorrelations = correlateIPCMarkers(originalProfile.threads);
const timeRangeForThread = getTimeRangeForThread(
thread,
originalProfile.meta.interval
);
return deriveMarkersFromRawMarkerTable(
thread.markers,
thread.stringArray,
thread.tid || 0,
timeRangeForThread,
ipcCorrelations
);
}
);
const markerSchemaByName = {
FileIO: {
name: 'FileIO',
display: ['marker-chart', 'marker-table', 'timeline-fileio'],
fields: [
{
key: 'operation',
label: 'Operation',
format: 'string',
searchable: true,
},
{
key: 'source',
label: 'Source',
format: 'string',
searchable: true,
},
{
key: 'filename',
label: 'Filename',
format: 'file-path',
searchable: true,
},
{
key: 'threadId',
label: 'Thread ID',
format: 'string',
searchable: true,
},
],
},
Url: {
name: 'Url',
tableLabel: '{marker.name} - {marker.data.url}',
display: ['marker-chart', 'marker-table'],
fields: [
{
key: 'url',
format: 'url',
},
],
},
HostResolver: {
name: 'HostResolver',
tableLabel: '{marker.name} - {marker.data.host}',
display: ['marker-chart', 'marker-table'],
fields: [
{
key: 'host',
format: 'sanitized-string',
searchable: true,
},
{
key: 'originSuffix',
format: 'sanitized-string',
searchable: true,
},
{
key: 'flags',
format: 'string',
},
],
},
};
const sanitizedProfile = sanitizePII(
originalProfile,
derivedMarkerInfoForAllThreads,
PIIToRemove,
markerSchemaByName
).profile;
return {
sanitizedProfile,
originalProfile,
};
}
it('should sanitize the threads if they are provided', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreads: new Set([0, 2]),
});
// There are 3 threads in the beginning.
expect(originalProfile.threads.length).toEqual(3);
// First and last threads are removed and now there are only 1 thread.
expect(sanitizedProfile.threads.length).toEqual(1);
});
it('should sanitize counters if they are provided', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveCounters: new Set([0]),
});
expect(ensureExists(originalProfile.counters).length).toEqual(1);
// The counter should be deleted now.
expect(ensureExists(sanitizedProfile.counters).length).toEqual(0);
});
it('should not sanitize counters if shouldRemoveCounters is not provided', function () {
const { originalProfile, sanitizedProfile } = setup({});
expect(ensureExists(originalProfile.counters).length).toEqual(1);
// The counter should still be there.
expect(ensureExists(sanitizedProfile.counters).length).toEqual(1);
});
it('should sanitize counters if its thread is deleted', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreads: new Set([0]),
});
if (ensureExists(originalProfile.counters)[0].mainThreadIndex !== 0) {
throw new Error(
'This test assumes the the counters mainThreadIndex is 0'
);
}
expect(ensureExists(originalProfile.counters).length).toEqual(1);
// The counter was for the first thread, it should be deleted now.
expect(ensureExists(sanitizedProfile.counters).length).toEqual(0);
});
it('should not sanitize counters if its thread is not deleted', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreads: new Set([1, 2]),
});
if (ensureExists(originalProfile.counters)[0].mainThreadIndex !== 0) {
throw new Error(
'This test assumes the the counters mainThreadIndex is 0'
);
}
expect(ensureExists(originalProfile.counters).length).toEqual(1);
// The counter was for the first thread, it should not be deleted now.
expect(ensureExists(sanitizedProfile.counters).length).toEqual(1);
});
it('should sanitize the counter range if range is filtered', function () {
const originalProfile = processGeckoProfile(createGeckoProfile());
const timeRangeForThread = getTimeRangeForThread(
originalProfile.threads[0],
originalProfile.meta.interval
);
// Make sure that the original time range is 0-7.
expect(timeRangeForThread).toEqual({ start: 0, end: 7 });
const sanitizedRange = { start: 3, end: 5 };
const { sanitizedProfile } = setup(
{
shouldFilterToCommittedRange: sanitizedRange,
},
originalProfile
);
if (ensureExists(originalProfile.counters)[0].mainThreadIndex !== 0) {
throw new Error(
'This test assumes the the counters mainThreadIndex is 0'
);
}
// Make sure the meta data contains the new profile range
expect(sanitizedProfile.meta.profilingStartTime).toEqual(
sanitizedRange.start
);
expect(sanitizedProfile.meta.profilingEndTime).toEqual(sanitizedRange.end);
// Make sure that we still have the same number of counters.
expect(ensureExists(originalProfile.counters).length).toEqual(1);
expect(ensureExists(sanitizedProfile.counters).length).toEqual(1);
const counterSamples = ensureExists(sanitizedProfile.counters)[0].samples;
// Make sure that all the table fields are consistent.
const counterSampleTimes =
computeTimeColumnForRawSamplesTable(counterSamples);
expect(counterSampleTimes).toHaveLength(counterSamples.length);
expect(counterSamples.count).toHaveLength(counterSamples.length);
expect(counterSamples.number).toHaveLength(counterSamples.length);
// Make sure that all the samples are between the sanitized time range.
for (
let sampleIndex = 0;
sampleIndex < counterSamples.length;
sampleIndex++
) {
// We are using inclusive range, so we need to add 1 and subtract 1 to the
// start and end ranges.
expect(counterSampleTimes[sampleIndex]).toBeGreaterThanOrEqual(
sanitizedRange.start - 1
);
expect(counterSampleTimes[sampleIndex]).toBeLessThanOrEqual(
sanitizedRange.end + 1
);
}
});
it('should remove threads starting after the range if range is filtered', function () {
const originalProfile = processGeckoProfile(createGeckoProfile());
const timeRangeForFirstThread = getTimeRangeForThread(
originalProfile.threads[0],
originalProfile.meta.interval
);
// Make sure that the original time range is 0-7.
expect(timeRangeForFirstThread).toEqual({ start: 0, end: 7 });
const { sanitizedProfile } = setup(
{
shouldFilterToCommittedRange: timeRangeForFirstThread,
},
originalProfile
);
function isInTimeRange(thread) {
return (
thread.registerTime < timeRangeForFirstThread.end &&
(!thread.unregisterTime ||
thread.unregisterTime > timeRangeForFirstThread.start)
);
}
const expectedThreadCount =
originalProfile.threads.filter(isInTimeRange).length;
expect(expectedThreadCount).toEqual(2);
expect(sanitizedProfile.threads.length).toEqual(expectedThreadCount);
expect(sanitizedProfile.threads.every(isInTimeRange)).toBeTruthy();
});
it('should remove threads ending before the range if range is filtered', function () {
const originalProfile = processGeckoProfile(createGeckoProfile());
const timeRangeForLastThread = getTimeRangeForThread(
originalProfile.threads[2],
originalProfile.meta.interval
);
// Make sure that the original time range is 0-7.
expect(timeRangeForLastThread).toEqual({ start: 1000, end: 1007 });
const { sanitizedProfile } = setup(
{
shouldFilterToCommittedRange: timeRangeForLastThread,
},
originalProfile
);
function isInTimeRange(thread) {
return (
thread.registerTime < timeRangeForLastThread.end &&
(!thread.unregisterTime ||
thread.unregisterTime > timeRangeForLastThread.start)
);
}
const expectedThreadCount =
originalProfile.threads.filter(isInTimeRange).length;
expect(expectedThreadCount).toEqual(1);
expect(sanitizedProfile.threads.length).toEqual(expectedThreadCount);
expect(sanitizedProfile.threads.every(isInTimeRange)).toBeTruthy();
});
it('should keep empty threads that were already empty', function () {
const originalProfile = processGeckoProfile(createGeckoProfile());
// Remove all the markers and samples from one thread of the original profile.
const { markers, samples } = originalProfile.threads[1];
markers.data = [];
markers.name = [];
markers.startTime = [];
markers.endTime = [];
markers.phase = [];
markers.category = [];
markers.length = 0;
samples.stack = [];
samples.time = [];
samples.threadCPUDelta = [];
samples.eventDelay = [];
samples.length = 0;
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
originalProfile
);
// Verify that the empty thread has not been sanitized out.
expect(sanitizedProfile.threads.length).toEqual(
originalProfile.threads.length
);
});
it('should sanitize profiler overhead if its thread is deleted', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreads: new Set([0]),
});
expect(ensureExists(originalProfile.profilerOverhead).length).toEqual(1);
// The counter was for the first thread, it should be deleted now.
expect(ensureExists(sanitizedProfile.profilerOverhead).length).toEqual(0);
});
it('should not sanitize profiler overhead if its thread is not deleted', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreads: new Set([1, 2]),
});
expect(ensureExists(originalProfile.profilerOverhead).length).toEqual(1);
expect(ensureExists(sanitizedProfile.profilerOverhead).length).toEqual(1);
});
it('should sanitize the screenshots if they are provided', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveThreadsWithScreenshots: new Set([0, 1, 2]),
});
// Checking if we have screenshot markers just in case.
{
let screenshotMarkerFound = false;
for (const thread of originalProfile.threads) {
for (const data of thread.markers.data) {
if (data && data.type === 'CompositorScreenshot') {
screenshotMarkerFound = true;
break;
}
}
}
expect(screenshotMarkerFound).toEqual(true);
}
{
let screenshotMarkerFound = false;
for (const thread of sanitizedProfile.threads) {
for (const data of thread.markers.data) {
if (data && data.type === 'CompositorScreenshot') {
screenshotMarkerFound = true;
break;
}
}
}
expect(screenshotMarkerFound).toEqual(false);
}
});
it('should sanitize the pages information', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveUrls: true,
});
// Checking to make sure that we have a http{,s} URI in the pages array.
const pageUrl = ensureExists(originalProfile.pages).find((page) =>
page.url.includes('http')
);
if (pageUrl === undefined) {
throw new Error(
"There should be an http URL in the 'pages' array in this profile."
);
}
for (const page of ensureExists(sanitizedProfile.pages)) {
expect(page.url.includes(pageUrl.url)).toBe(false);
}
});
it('should keep the chrome URIs inside the pages array', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveUrls: true,
});
// Checking to make sure that we have a chrome URI in the pages array.
const chromePageUrl = ensureExists(originalProfile.pages).find((page) =>
page.url.includes('chrome://')
);
if (chromePageUrl === undefined) {
throw new Error(
"There should be a chrome URL in the 'pages' array in this profile."
);
}
let includesChromeUrl = false;
for (const page of ensureExists(sanitizedProfile.pages)) {
if (page.url.includes(chromePageUrl.url)) {
includesChromeUrl = true;
break;
}
}
expect(includesChromeUrl).toBe(true);
});
it('should sanitize the favicons in the pages information', function () {
const profile = processGeckoProfile(createGeckoProfile());
// Add some favicons to check later
ensureExists(profile.pages)[1].favicon =
'data:image/png;base64,mock-base64-image-data';
const { originalProfile, sanitizedProfile } = setup(
{ shouldRemoveUrls: true },
profile
);
// Checking to make sure that we have favicons in the original profile pages array.
const pageUrl = ensureExists(originalProfile.pages).find(
(page) => page.favicon
);
if (pageUrl === undefined) {
throw new Error(
"There should be a favicon in the 'pages' array in this profile."
);
}
for (const page of ensureExists(sanitizedProfile.pages)) {
expect(page.favicon).toBe(null);
}
});
it('should sanitize all the URLs inside network markers', function () {
const { sanitizedProfile } = setup({
shouldRemoveUrls: true,
});
for (const thread of sanitizedProfile.threads) {
const stringArray = thread.stringArray;
for (let i = 0; i < thread.markers.length; i++) {
const currentMarker = thread.markers.data[i];
if (
currentMarker &&
currentMarker.type &&
currentMarker.type === 'Network'
) {
/* eslint-disable jest/no-conditional-expect */
expect(currentMarker.URI).toBeFalsy();
expect(currentMarker.RedirectURI).toBeFalsy();
const stringIndex = thread.markers.name[i];
expect(stringArray[stringIndex].includes('http')).toBe(false);
/* eslint-enable */
}
}
}
});
it('should sanitize the URLs inside text markers', function () {
const unsanitizedNameField =
'onBeforeRequest https://profiler.firefox.com/ by extension';
const sanitizedNameField = 'onBeforeRequest https://<URL> by extension';
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
getProfileWithMarkers([
[
'Extension Suspend',
0,
1,
{
type: 'Text',
name: unsanitizedNameField,
},
],
])
);
const marker = sanitizedProfile.threads[0].markers.data[0];
if (!marker || marker.type !== 'Text') {
throw new Error('Expected a Text marker');
}
expect(marker.name).toBe(sanitizedNameField);
});
it('should sanitize all the URLs inside string table', function () {
const { sanitizedProfile } = setup({
shouldRemoveUrls: true,
});
for (const thread of sanitizedProfile.threads) {
for (const string of thread.stringArray) {
// We are keeping the http(s) and removing the rest.
// That's why we can't test it with `includes('http')`.
// Tested `.com` here since all of the test urls have .com in it
expect(string.includes('.com')).toBe(false);
}
}
});
it('should sanitize extensions', function () {
const { originalProfile, sanitizedProfile } = setup({
shouldRemoveExtensions: true,
});
{
const extensions = ensureExists(originalProfile.meta.extensions);
expect(extensions.length).toEqual(3);
expect(extensions.id.length).toEqual(3);
expect(extensions.name.length).toEqual(3);
expect(extensions.baseURL.length).toEqual(3);
}
{
const extensions = ensureExists(sanitizedProfile.meta.extensions);
expect(extensions.length).toEqual(0);
expect(extensions.id.length).toEqual(0);
expect(extensions.name.length).toEqual(0);
expect(extensions.baseURL.length).toEqual(0);
}
});
it('should sanitize extension ids inside text markers', function () {
const unsanitizedNameField =
'[email protected], api_call: runtime.onUpdateAvailable.addListener';
const sanitizedNameField =
'api_call: runtime.onUpdateAvailable.addListener';
const { sanitizedProfile } = setup(
{
shouldRemoveExtensions: true,
},
getProfileWithMarkers([
[
'ExtensionParent',
0,
1,
{
type: 'Text',
name: unsanitizedNameField,
},
],
[
'ExtensionChild',
0,
1,
{
type: 'Text',
name: unsanitizedNameField,
},
],
])
);
const markers = sanitizedProfile.threads[0].markers;
for (const marker of [markers.data[0], markers.data[1]]) {
if (!marker || marker.type !== 'Text') {
throw new Error('Expected a Text marker');
}
expect(marker.name).toBe(sanitizedNameField);
}
});
it('should sanitize both URLs and extension ids inside Extension Suspend markers', function () {
const unsanitizedNameField =
'onBeforeRequest https://profiler.firefox.com/ by extension';
const sanitizedNameField = 'onBeforeRequest https://<URL>';
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
shouldRemoveExtensions: true,
},
getProfileWithMarkers([
[
'Extension Suspend',
0,
1,
{
type: 'Text',
name: unsanitizedNameField,
},
],
])
);
const marker = sanitizedProfile.threads[0].markers.data[0];
if (!marker || marker.type !== 'Text') {
throw new Error('Expected a Text marker');
}
expect(marker.name).toBe(sanitizedNameField);
});
it('should not sanitize all the preference values inside preference read markers', function () {
const { sanitizedProfile } = setup(
{
shouldRemovePreferenceValues: false,
},
getProfileWithMarkers([
[
'PreferenceRead',
0,
1,
{
type: 'PreferenceRead',
prefAccessTime: 0,
prefName: 'preferenceName',
prefKind: 'preferenceKind',
prefType: 'preferenceType',
prefValue: 'preferenceValue',
},
],
])
);
expect(sanitizedProfile.threads.length).toEqual(1);
const thread = sanitizedProfile.threads[0];
expect(thread.markers.length).toEqual(1);
const marker = thread.markers.data[0];
// All the conditions have to be checked to make Flow happy.
expect(
marker &&
marker.type &&
marker.type === 'PreferenceRead' &&
marker.prefValue === 'preferenceValue'
).toBeTruthy();
});
it('should sanitize all the preference values inside preference read markers', function () {
const { sanitizedProfile } = setup(
{
shouldRemovePreferenceValues: true,
},
getProfileWithMarkers([
[
'PreferenceRead',
0,
1,
{
type: 'PreferenceRead',
prefAccessTime: 0,
prefName: 'preferenceName',
prefKind: 'preferenceKind',
prefType: 'preferenceType',
prefValue: 'preferenceValue',
},
],
])
);
expect(sanitizedProfile.threads.length).toEqual(1);
const thread = sanitizedProfile.threads[0];
expect(thread.markers.length).toEqual(1);
const marker = thread.markers.data[0];
// All the conditions have to be checked to make Flow happy.
expect(
marker &&
marker.type &&
marker.type === 'PreferenceRead' &&
marker.prefValue === ''
).toBeTruthy();
});
it('should not push any null values to marker values by mistake while filtering', function () {
const { sanitizedProfile } = setup({
shouldRemoveThreadsWithScreenshots: new Set([0, 1, 2]),
});
for (const thread of sanitizedProfile.threads) {
const markersTable = thread.markers;
for (let i = 0; i < markersTable.length; i++) {
// `toBeTruthy` doesn't work here because there are marker categories with `0` value.
// expect.anything() means anything other than null or undefined.
expect(markersTable.name[i]).toEqual(expect.anything());
expect(markersTable.phase[i]).toEqual(expect.anything());
expect(markersTable.data[i]).toEqual(expect.anything());
expect(markersTable.category[i]).toEqual(expect.anything());
// Do not perform this check on startTime or endTime as these may be null.
expect(markersTable.name).toHaveLength(markersTable.length);
expect(markersTable.phase).toHaveLength(markersTable.length);
expect(markersTable.data).toHaveLength(markersTable.length);
expect(markersTable.category).toHaveLength(markersTable.length);
expect(markersTable.startTime).toHaveLength(markersTable.length);
expect(markersTable.endTime).toHaveLength(markersTable.length);
}
}
});
it('should sanitize the FileIO marker paths', function () {
const marker1File = 'permissions.sqlite-journal';
const marker2File = 'CustomizableUI.jsm';
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
getProfileWithMarkers([
[
'FileIO',
1,
2,
{
type: 'FileIO',
source: 'PoisonIOInterposer',
filename:
'/Users/username/Library/Application Support/Firefox/Profiles/profile-id.default/' +
marker1File,
operation: 'create/open',
cause: {
tid: 1112,
time: 1.0,
stack: 0,
},
},
],
[
'FileIO',
3,
4,
{
type: 'FileIO',
source: 'PoisonIOInterposer',
filename:
'C:\\Users\\username\\mozilla-central\\obj-mc-dbg\\dist\\bin\\browser\\modules\\' +
marker2File,
operation: 'create/open',
cause: {
tid: 1113,
time: 1.0,
stack: 0,
},
},
],
[
'FileIO',
5,
6,
{
type: 'FileIO',
source: 'PoisonIOInterposer',
operation: 'fsync',
},
],
])
);
expect(sanitizedProfile.threads.length).toEqual(1);
const thread = sanitizedProfile.threads[0];
expect(thread.markers.length).toEqual(3);
const marker1 = thread.markers.data[0];
const marker2 = thread.markers.data[1];
// Note: the 3rd marker has no filename property, to check that we know how
// to handle this case, but otherwise we do no check on it.
// Marker filename fields should be there in the 2 first markers.
if (!marker1 || !marker1.filename || !marker2 || !marker2.filename) {
throw new Error('Failed to find filename property in the payload');
}
// Now check the filename fields and make sure they are sanitized.
expect(marker1.filename).toBe('<PATH>/' + marker1File);
expect(marker2.filename).toBe('<PATH>\\' + marker2File);
});
it('should sanitize the URL properties in markers', function () {
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
getProfileWithMarkers([
[
'SpeculativeConnect',
1,
2,
{
type: 'Url',
url: 'https://img-getpocket.cdn.mozilla.net',
},
],
])
);
expect(sanitizedProfile.threads.length).toEqual(1);
const thread = sanitizedProfile.threads[0];
expect(thread.markers.length).toEqual(1);
const marker = thread.markers.data[0];
// The url fields should still be there
if (!marker || !marker.url) {
throw new Error('Failed to find url property in the payload');
}
// Now check the url fields and make sure they are sanitized.
expect(marker.url).toBe('https://<URL>');
});
it('should sanitize the sanitized-string markers', function () {
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
getProfileWithMarkers([
[
'nsHostResolver::ResolveHost',
0,
1,
{
type: 'HostResolver',
host: 'domain.name',
originSuffix: '^other.domain',
flags: '0xf00ba4',
},
],
])
);
expect(sanitizedProfile.threads.length).toEqual(1);
const thread = sanitizedProfile.threads[0];
expect(thread.markers.length).toEqual(1);
const marker = thread.markers.data[0];
// The host fields should still be there
if (!marker || !marker.host) {
throw new Error('Failed to find host property in the payload');
}
// Now check the host fields and make sure they are sanitized.
expect(marker.host).toBe('<sanitized>');
expect(marker.originSuffix).toBe('<sanitized>');
expect(marker.flags).toBe('0xf00ba4');
});
it('should sanitize the eTLD+1 field if urls are supposed to be sanitized', function () {
// Create a simple profile with eTLD+1 field in its thread.
const { profile } = getProfileFromTextSamples('A');
profile.threads[0]['eTLD+1'] = 'https://profiler.firefox.com/';
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: true,
},
profile
);
expect(sanitizedProfile.threads[0]['eTLD+1']).toBeFalsy();
});
it('should not sanitize the eTLD+1 field if urls are not supposed to be sanitized', function () {
// Create a simple profile with eTLD+1 field in its thread.
const { profile } = getProfileFromTextSamples('A');
const eTLDPlus1 = 'https://profiler.firefox.com/';
profile.threads[0]['eTLD+1'] = eTLDPlus1;
const { sanitizedProfile } = setup(
{
shouldRemoveUrls: false,
},
profile
);
expect(sanitizedProfile.threads[0]['eTLD+1']).toBe(eTLDPlus1);
});
describe('when sanitizing private browsing data', function () {
it('removes pages information coming from private browsing', function () {
const { profile: originalProfile } = getProfileFromTextSamples(`A`);
const {
firstTabTabID: privateTabTabID,
secondTabTabID: nonPrivateTabTabID,
} = addActiveTabInformationToProfile(originalProfile);
markTabIdsAsPrivateBrowsing(originalProfile, [privateTabTabID]);
// We run the sanitizing function with the sanitize private browsing flag.
const { sanitizedProfile } = setup(
{ shouldRemovePrivateBrowsingData: true },
originalProfile
);
// We also run the sanitizing function without sanitizing anything, as we want
// to make sure we don't remove anything in this case.
const { sanitizedProfile: unsanitizedProfile } = setup(
{},
originalProfile
);
// before sanitization
expect(originalProfile.pages).toContainEqual(
expect.objectContaining({
tabID: privateTabTabID,
})
);
expect(originalProfile.pages).toContainEqual(
expect.objectContaining({
tabID: nonPrivateTabTabID,
})
);
// no sanitization
expect(unsanitizedProfile.pages).toContainEqual(
expect.objectContaining({
tabID: privateTabTabID,
})
);
expect(unsanitizedProfile.pages).toContainEqual(
expect.objectContaining({
tabID: nonPrivateTabTabID,
})
);
// after sanitization
expect(sanitizedProfile.pages).not.toContainEqual(
expect.objectContaining({
tabID: privateTabTabID,
})
);
expect(sanitizedProfile.pages).toContainEqual(
expect.objectContaining({
tabID: nonPrivateTabTabID,
})
);
});
it('removes markers coming from private browsing', function () {
// 0. Create a profile with markers containing both private and non
// private innerWindowIDs, as well as network markers with the
// isPrivateBrowsing information but no innerWindowIDs information
// otherwise.
const { profile: originalProfile } = getProfileFromTextSamples(`A`);
const {
firstTabTabID: privateTabTabID,
firstTabInnerWindowIDs: privateTabInnerWindowIDs,
secondTabInnerWindowIDs: nonPrivateTabInnerWindowIDs,
} = addActiveTabInformationToProfile(originalProfile);
markTabIdsAsPrivateBrowsing(originalProfile, [privateTabTabID]);
addMarkersToThreadWithCorrespondingSamples(originalProfile.threads[0], [
...getNetworkMarkers({
id: 1235,
startTime: 19000,
fetchStart: 19200.2,
endTime: 20433.8,
uri: 'https://example.org/index.html',
payload: {
cache: 'Hit',
pri: 8,
count: 47027,
contentType: 'text/html',
isPrivateBrowsing: true,
},
}),
...getNetworkMarkers({