-
-
Notifications
You must be signed in to change notification settings - Fork 360
Expand file tree
/
Copy pathsdk.test.ts
More file actions
1303 lines (1037 loc) · 38.8 KB
/
sdk.test.ts
File metadata and controls
1303 lines (1037 loc) · 38.8 KB
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
import type { Breadcrumb, BreadcrumbHint, Integration, Scope } from '@sentry/core';
import { debug, initAndBind } from '@sentry/core';
import { makeFetchTransport } from '@sentry/react';
import { getDevServer } from '../src/js/integrations/debugsymbolicatorutils';
import type { ReactNativeClientOptions } from '../src/js/options';
import { init, withScope } from '../src/js/sdk';
import type { ReactNativeTracingIntegration } from '../src/js/tracing';
import { REACT_NATIVE_TRACING_INTEGRATION_NAME, reactNativeTracingIntegration } from '../src/js/tracing';
import { makeNativeTransport } from '../src/js/transports/native';
import { getDefaultEnvironment, isExpoGo, notWeb } from '../src/js/utils/environment';
import { RN_GLOBAL_OBJ } from '../src/js/utils/worldwide';
import { NATIVE } from './mockWrapper';
import { firstArg, secondArg } from './testutils';
jest.spyOn(debug, 'error');
jest.mock('../src/js/wrapper', () => jest.requireActual('./mockWrapper'));
jest.mock('../src/js/utils/environment');
jest.mock('@sentry/core', () => ({
...jest.requireActual('@sentry/core'),
initAndBind: jest.fn(),
}));
jest.mock('../src/js/integrations/debugsymbolicatorutils', () => ({
getDevServer: jest.fn(),
}));
describe('Tests the SDK functionality', () => {
beforeEach(() => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true);
(notWeb as jest.Mock).mockImplementation(() => true);
});
afterEach(() => {
jest.clearAllMocks();
});
describe('init', () => {
describe('enableAutoPerformanceTracing', () => {
const reactNavigationInstrumentation = (): ReactNativeTracingIntegration => {
return reactNativeTracingIntegration();
};
it('Auto Performance is disabled by default', () => {
init({});
expect(autoPerformanceIsEnabled()).toBe(false);
});
it('Auto Performance is disabled when tracesSampleRate is set to undefined', () => {
init({
tracesSampleRate: undefined,
});
expect(autoPerformanceIsEnabled()).toBe(false);
});
it('Auto Performance is disabled when tracesSampler is set to undefined', () => {
init({
tracesSampler: undefined,
});
expect(autoPerformanceIsEnabled()).toBe(false);
});
it('Auto Performance is enabled when tracing is enabled (tracesSampler)', () => {
init({
tracesSampler: () => true,
enableAutoPerformanceTracing: true,
});
expect(autoPerformanceIsEnabled()).toBe(true);
});
it('Auto Performance is enabled when tracing is enabled (tracesSampleRate)', () => {
init({
tracesSampleRate: 0.5,
enableAutoPerformanceTracing: true,
});
expect(autoPerformanceIsEnabled()).toBe(true);
});
it('Do not overwrite user defined integrations when passing integrations', () => {
const tracing = reactNavigationInstrumentation();
init({
tracesSampleRate: 0.5,
enableAutoPerformanceTracing: true,
integrations: [tracing],
});
const options = usedIntegrations();
expect(options.filter(integration => integration.name === REACT_NATIVE_TRACING_INTEGRATION_NAME).length).toBe(
1,
);
expect(options.some(integration => integration === tracing)).toBe(true);
});
it('Do not overwrite user defined integrations when passing defaultIntegrations', () => {
const tracing = reactNavigationInstrumentation();
init({
tracesSampleRate: 0.5,
enableAutoPerformanceTracing: true,
defaultIntegrations: [tracing],
});
const options = usedIntegrations();
expect(options.filter(integration => integration.name === REACT_NATIVE_TRACING_INTEGRATION_NAME).length).toBe(
1,
);
expect(options.some(integration => integration === tracing)).toBe(true);
});
});
describe('initialization from sentry.options.json', () => {
it('initializes without __SENTRY_OPTIONS__', () => {
delete RN_GLOBAL_OBJ.__SENTRY_OPTIONS__;
init({});
expect(initAndBind).toHaveBeenCalledOnce();
});
it('adds options from __SENTRY_OPTIONS__', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = {
dsn: 'https://key@example.io/value',
};
init({});
expect(usedOptions()?.dsn).toBe('https://key@example.io/value');
});
it('options init override options from __SENTRY_OPTIONS__', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = {
dsn: 'https://key@example.io/file',
};
init({
dsn: 'https://key@example.io/code',
});
expect(usedOptions()?.dsn).toBe('https://key@example.io/code');
});
it('initializing with __SENTRY_OPTIONS__ disabled native auto initialization', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = {};
init({});
expect(usedOptions()?.autoInitializeNativeSdk).toBe(false);
});
it('initializing without __SENTRY_OPTIONS__ enables native auto initialization', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = undefined;
init({});
expect(usedOptions()?.autoInitializeNativeSdk).toBe(true);
});
it('initializing with __SENTRY_OPTIONS__ keeps native auto initialization true if set', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = {};
init({
autoInitializeNativeSdk: true,
});
expect(usedOptions()?.autoInitializeNativeSdk).toBe(true);
});
it('initializing with __SENTRY_OPTIONS__ keeps native auto initialization false if set', () => {
RN_GLOBAL_OBJ.__SENTRY_OPTIONS__ = {};
init({
autoInitializeNativeSdk: false,
});
expect(usedOptions()?.autoInitializeNativeSdk).toBe(false);
});
});
describe('environment', () => {
it('detect development environment', () => {
(getDefaultEnvironment as jest.Mock).mockImplementation(() => 'development');
init({
enableNative: true,
});
expect(usedOptions()?.environment).toBe('development');
});
it('uses custom environment', () => {
init({
environment: 'custom',
});
expect(usedOptions()?.environment).toBe('custom');
});
it('it keeps empty string environment', () => {
init({
environment: '',
});
expect(usedOptions()?.environment).toBe('');
});
it('it keeps undefined environment', () => {
init({
environment: undefined,
});
expect(usedOptions()?.environment).toBe(undefined);
});
});
describe('release', () => {
afterEach(() => {
(notWeb as jest.Mock).mockReset();
RN_GLOBAL_OBJ.SENTRY_RELEASE = undefined;
});
it('uses release from global for web', () => {
RN_GLOBAL_OBJ.SENTRY_RELEASE = {
name: 'test',
version: '1.0.0',
};
(notWeb as jest.Mock).mockImplementation(() => false);
init({});
expect(usedOptions()?.release).toEqual('test@1.0.0');
});
it('uses release from options for web', () => {
RN_GLOBAL_OBJ.SENTRY_RELEASE = {
name: 'test',
version: '1.0.0',
};
(notWeb as jest.Mock).mockImplementation(() => false);
init({
release: 'custom@2.0.0',
});
expect(usedOptions()?.release).toEqual('custom@2.0.0');
});
it('uses undefined for others', () => {
RN_GLOBAL_OBJ.SENTRY_RELEASE = {
name: 'test',
version: '1.0.0',
};
(notWeb as jest.Mock).mockImplementation(() => true);
init({});
expect(usedOptions()?.release).toBeUndefined();
});
});
describe('transport options buffer size', () => {
it('uses default transport options buffer size', () => {
init({
tracesSampleRate: 0.5,
enableAutoPerformanceTracing: true,
});
expect(usedOptions()?.transportOptions?.bufferSize).toBe(30);
});
it('uses custom transport options buffer size', () => {
init({
transportOptions: {
bufferSize: 99,
},
});
expect(usedOptions()?.transportOptions?.bufferSize).toBe(99);
});
it('uses max queue size', () => {
init({
maxQueueSize: 88,
});
expect(usedOptions()?.transportOptions?.bufferSize).toBe(88);
});
});
});
describe('transport initialization', () => {
describe('native SDK unavailable', () => {
it('fetchTransport set and enableNative set to false', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
init({});
expect(NATIVE.isNativeAvailable).toHaveBeenCalled();
// @ts-expect-error enableNative not publicly available here.
expect(usedOptions()?.enableNative).toEqual(false);
expect(usedOptions()?.transport).toEqual(makeFetchTransport);
});
it('fetchTransport set and passed enableNative ignored when true', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
init({ enableNative: true });
expect(NATIVE.isNativeAvailable).toHaveBeenCalled();
// @ts-expect-error enableNative not publicly available here.
expect(usedOptions()?.enableNative).toEqual(false);
expect(usedOptions()?.transport).toEqual(makeFetchTransport);
});
it('fetchTransport set and isNativeAvailable not called when passed enableNative set to false', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
init({ enableNative: false });
expect(NATIVE.isNativeAvailable).not.toHaveBeenCalled();
// @ts-expect-error enableNative not publicly available here.
expect(usedOptions()?.enableNative).toEqual(false);
expect(usedOptions()?.transport).toEqual(makeFetchTransport);
});
it('custom transport set and enableNative set to false', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
const mockTransport = jest.fn();
init({
transport: mockTransport,
});
expect(usedOptions()?.transport).toEqual(mockTransport);
expect(NATIVE.isNativeAvailable).toHaveBeenCalled();
// @ts-expect-error enableNative not publicly available here.
expect(usedOptions()?.enableNative).toEqual(false);
});
});
it('uses transport from the options', () => {
const mockTransport = jest.fn();
init({
transport: mockTransport,
});
expect(usedOptions()?.transport).toEqual(mockTransport);
});
it('uses native transport', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true);
init({});
expect(usedOptions()?.transport).toEqual(makeNativeTransport);
});
it('uses fallback fetch transport', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
init({});
expect(usedOptions()?.transport).toEqual(makeFetchTransport);
});
it('checks sdk options first', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true);
init({ enableNative: false });
expect(usedOptions()?.transport).toEqual(makeFetchTransport);
expect(NATIVE.isNativeAvailable).not.toHaveBeenCalled();
});
it('check both options and native availability', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => true);
init({ enableNative: true });
expect(usedOptions()?.transport).toEqual(makeNativeTransport);
expect(NATIVE.isNativeAvailable).toHaveBeenCalled();
});
});
describe('initIsSafe', () => {
test('initialScope callback is safe after init', () => {
const mockInitialScope = jest.fn(() => {
throw 'Test error';
});
init({ initialScope: mockInitialScope });
expect(() => {
(usedOptions()?.initialScope as (scope: Scope) => Scope)({} as any);
}).not.toThrow();
expect(mockInitialScope).toHaveBeenCalledTimes(1);
});
test('beforeBreadcrumb callback is safe after init', () => {
const mockBeforeBreadcrumb = jest.fn(() => {
throw 'Test error';
});
init({ beforeBreadcrumb: mockBeforeBreadcrumb });
expect(() => {
usedOptions()?.beforeBreadcrumb?.({} as any);
}).not.toThrow();
expect(mockBeforeBreadcrumb).toHaveBeenCalledTimes(1);
});
test('integrations callback should not crash init', () => {
const mockIntegrations = jest.fn(() => {
throw 'Test error';
});
expect(() => {
init({ integrations: mockIntegrations });
}).not.toThrow();
expect(mockIntegrations).toHaveBeenCalledTimes(1);
});
test('tracesSampler callback is safe after init', () => {
const mockTraceSampler = jest.fn(() => {
throw 'Test error';
});
init({ tracesSampler: mockTraceSampler });
expect(() => {
usedOptions()?.tracesSampler?.({} as any);
}).not.toThrow();
expect(mockTraceSampler).toHaveBeenCalledTimes(1);
});
});
describe('strictTraceContinuation', () => {
it('passes strictTraceContinuation option through to client options', () => {
init({
strictTraceContinuation: true,
});
expect(usedOptions()?.strictTraceContinuation).toBe(true);
});
it('passes orgId option through to client options', () => {
init({
orgId: '12345',
});
expect(usedOptions()?.orgId).toBe('12345');
});
it('passes numeric orgId option through to client options', () => {
init({
orgId: 12345,
});
expect(usedOptions()?.orgId).toBe(12345);
});
it('defaults strictTraceContinuation to undefined when not set', () => {
init({});
expect(usedOptions()?.strictTraceContinuation).toBeUndefined();
});
});
describe('beforeBreadcrumb', () => {
it('should filters out dev server breadcrumbs', () => {
const devServerUrl = 'http://localhost:8081';
(getDevServer as jest.Mock).mockReturnValue({ url: devServerUrl });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'https://example@sentry.io/123',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: devServerUrl },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toBeNull();
});
it('should filter out dsn breadcrumbs', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'https://abc@def.ingest.sentry.io/1234567',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'https://def.ingest.sentry.io/1234567' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toBeNull();
});
it('should filter out dsn breadcrumbs that the ports match', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'https://sentry@selfhosted.app.server:8181/1234567',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'https://selfhosted.app.server:8181/api' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toBeNull();
});
it('should keep breadcrumbs if the ports do not match', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'https://sentry@selfhosted.app.server:8181/1234567',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'https://selfhosted.app.server:8080/api' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
it('should keep breadcrumbs if the url parsing fails for dsn', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'invalid-dsn',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'https://def.ingest.sentry.io/1234567' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
it('should keep non dev server or dsn breadcrumbs', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
return breadcrumb;
};
const passedOptions = {
dsn: 'https://example@sentry.io/123',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'http://testurl.com/service' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
it('verify the user beforeBreadcrumb is chained', () => {
const devServerUrl = 'http://localhost:8081';
(getDevServer as jest.Mock).mockReturnValue({ url: devServerUrl });
const mockBeforeBreadcrumb = (breadcrumb: Breadcrumb, _hint?: BreadcrumbHint) => {
breadcrumb.data = { url: devServerUrl }; // Set to an excluded url
return breadcrumb;
};
const passedOptions = {
dsn: 'https://example@sentry.io/123',
beforeBreadcrumb: mockBeforeBreadcrumb,
};
init(passedOptions);
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'http://testurl.com/service' }, // Not an excluded url
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toBeNull();
});
});
it('should keep the breadcrumb when the dev server and dsn are undefined', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: undefined });
init({});
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'http://testurl.com/service' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
it('should keep the breadcrumb when the dev server does not match and the dsn is undefined', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: 'http://localhost:8081' });
init({});
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'http://testurl.com/service' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
it('should keep the breadcrumb when the dev server is undefined and the dsn does not match', () => {
(getDevServer as jest.Mock).mockReturnValue({ url: undefined });
init({ dsn: 'https://example@sentry.io/123' });
const breadcrumb: Breadcrumb = {
type: 'http',
data: { url: 'http://testurl.com/service' },
};
const result = usedOptions()?.beforeBreadcrumb!(breadcrumb);
expect(result).toEqual(breadcrumb);
});
describe('withScope', () => {
test('withScope callback does not throw', () => {
const mockScopeCallback = jest.fn(() => {
throw 'Test error';
});
expect(() => withScope(mockScopeCallback)).not.toThrow();
expect(mockScopeCallback).toHaveBeenCalledTimes(1);
});
});
describe('integrations', () => {
it('replaces default integrations', () => {
const mockDefaultIntegration = createMockedIntegration();
init({
defaultIntegrations: [mockDefaultIntegration],
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual([mockDefaultIntegration]);
});
it('no http client integration by default', () => {
init({});
expectNotIntegration('HttpClient');
});
it('adds http client integration', () => {
init({
enableCaptureFailedRequests: true,
});
expectIntegration('HttpClient');
});
it('user defined http client integration overwrites default', () => {
init({
enableCaptureFailedRequests: true,
integrations: [
<Integration>{
name: 'HttpClient',
setupOnce: () => {},
isUserDefined: true,
},
],
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual(
expect.arrayContaining([
expect.objectContaining({
name: 'HttpClient',
isUserDefined: true,
}),
]),
);
expect(actualIntegrations?.filter(integration => integration.name === 'HttpClient')).toHaveLength(1);
});
it('no screenshot integration by default', () => {
init({});
expectNotIntegration('Screenshot');
});
it('adds screenshot integration', () => {
init({
attachScreenshot: true,
});
expectIntegration('Screenshot');
});
it('no view hierarchy integration by default', () => {
init({});
expectNotIntegration('ViewHierarchy');
});
it('adds view hierarchy integration', () => {
init({
attachViewHierarchy: true,
});
expectIntegration('ViewHierarchy');
});
it('no profiling integration by default', () => {
init({});
expectNotIntegration('HermesProfiling');
});
it('adds profiling integration', () => {
init({
profilesSampleRate: 0.7,
});
expectIntegration('HermesProfiling');
});
it('adds browserSessionIntegration on web when enableAutoSessionTracking is set true', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
(notWeb as jest.Mock).mockImplementation(() => false);
init({ enableAutoSessionTracking: true });
expectIntegration('BrowserSession');
});
it('no browserSessionIntegration on web when enableAutoSessionTracking is set false', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
(notWeb as jest.Mock).mockImplementation(() => false);
init({ enableAutoSessionTracking: false });
expectNotIntegration('BrowserSession');
});
it('no browserSessionIntegration on web when enableAutoSessionTracking is not set', () => {
(NATIVE.isNativeAvailable as jest.Mock).mockImplementation(() => false);
(notWeb as jest.Mock).mockImplementation(() => false);
init({});
expectNotIntegration('BrowserSession');
});
it('no browserSessionIntegration on mobile', () => {
init({ enableAutoSessionTracking: true });
expectNotIntegration('BrowserSession');
});
it('no spotlight integration by default', () => {
init({});
expectNotIntegration('Spotlight');
});
it('no app start integration by default', () => {
init({});
expectNotIntegration('AppStart');
});
it('when tracing enabled app start integration added by default', () => {
init({
tracesSampleRate: 0.5,
});
expectIntegration('AppStart');
});
it('when tracing enabled and app start disabled the integration is not added', () => {
init({
tracesSampleRate: 0.5,
enableAppStartTracking: false,
});
expectNotIntegration('AppStart');
});
it('when tracing enabled app start without native (on web, Expo Go) integration is not added', () => {
init({
tracesSampleRate: 0.5,
enableNative: false,
});
expectNotIntegration('AppStart');
});
it('no native frames integration by default', () => {
init({});
expectNotIntegration('NativeFrames');
});
it('when tracing enabled native frames integration added by default', () => {
init({
tracesSampleRate: 0.5,
});
expectIntegration('NativeFrames');
});
it('when tracing enabled and native frames disabled the integration is not added', () => {
init({
tracesSampleRate: 0.5,
enableNativeFramesTracking: false,
});
expectNotIntegration('NativeFrames');
});
it('when tracing enabled (on web, Expo Go) native frames integration is not added', () => {
init({
tracesSampleRate: 0.5,
enableNative: false,
});
expectNotIntegration('NativeFrames');
});
it('when tracing not set stall tracking the integration is not added', () => {
init({});
expectNotIntegration('StallTracking');
});
it('when tracing enabled stall tracking integration added by default', () => {
init({
tracesSampleRate: 0.5,
});
expectIntegration('StallTracking');
});
it('when tracing enabled and stall tracking disabled the integration is not added', () => {
init({
tracesSampleRate: 0.5,
enableStallTracking: false,
});
expectNotIntegration('StallTracking');
});
describe('user interaction integration', () => {
test('no integration when tracing disabled', () => {
init({});
expectNotIntegration('UserInteraction');
});
test('no integration when tracing enabled', () => {
init({
tracesSampleRate: 0.5,
});
expectNotIntegration('UserInteraction');
});
test('no integration when tracing enabled but user interaction explicitly disabled', () => {
init({
tracesSampleRate: 0.5,
enableUserInteractionTracing: false,
});
expectNotIntegration('UserInteraction');
});
test('integration added when tracing enabled and user interaction enabled', () => {
init({
tracesSampleRate: 0.5,
enableUserInteractionTracing: true,
});
expectIntegration('UserInteraction');
});
});
describe('app registry integration', () => {
test('no integration when tracing disabled', () => {
init({});
expectNotIntegration('AppRegistry');
});
test('integration added when tracing enabled', () => {
init({
tracesSampleRate: 0.5,
});
expectIntegration('AppRegistry');
});
});
describe('time to display integration', () => {
it('no integration when tracing disabled', () => {
init({});
expectNotIntegration('TimeToDisplay');
});
it('integration added when tracing enabled', () => {
init({
tracesSampleRate: 0.5,
});
expectIntegration('TimeToDisplay');
});
});
it('adds spotlight integration with spotlight bool', () => {
init({
spotlight: true,
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
});
it('adds spotlight integration with direct url', () => {
init({
spotlight: 'http://localhost:8969/stream',
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual(expect.arrayContaining([expect.objectContaining({ name: 'Spotlight' })]));
});
it('no default integrations', () => {
init({
defaultIntegrations: false,
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual([]);
});
it('merges with passed default integrations', () => {
const mockIntegration = createMockedIntegration();
const mockDefaultIntegration = createMockedIntegration({ name: 'MockedDefaultIntegration' });
init({
integrations: [mockIntegration],
defaultIntegrations: [mockDefaultIntegration],
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual(expect.arrayContaining([mockIntegration, mockDefaultIntegration])); // order doesn't matter
expect(actualIntegrations?.length).toBe(2); // there should be no extra unexpected integrations
});
it('merges with default integrations', () => {
const mockIntegration = createMockedIntegration();
init({
integrations: [mockIntegration],
});
const actualOptions = usedOptions();
const actualIntegrations = actualOptions?.integrations;
expect(actualIntegrations).toEqual(expect.arrayContaining([mockIntegration]));
expect(actualIntegrations?.length).toBeGreaterThan(1); // there should be default integrations + the test one
});
it('passes default integrations to the function', () => {
const mockIntegration = createMockedIntegration();
const mockIntegrationFactory = jest.fn((_integrations: Integration[]) => [mockIntegration]);
init({
integrations: mockIntegrationFactory,
});
const actualPassedIntegrations = mockIntegrationFactory.mock.calls[0][firstArg];
expect(actualPassedIntegrations.length).toBeGreaterThan(0);