-
Notifications
You must be signed in to change notification settings - Fork 51k
Expand file tree
/
Copy pathprofilerContext-test.js
More file actions
942 lines (789 loc) · 31.7 KB
/
profilerContext-test.js
File metadata and controls
942 lines (789 loc) · 31.7 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
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
*/
import typeof ReactTestRenderer from 'react-test-renderer';
import type {FrontendBridge} from 'react-devtools-shared/src/bridge';
import type {Context} from 'react-devtools-shared/src/devtools/views/Profiler/ProfilerContext';
import type {DispatcherContext} from 'react-devtools-shared/src/devtools/views/Components/TreeContext';
import type Store from 'react-devtools-shared/src/devtools/store';
import {getVersionedRenderImplementation} from './utils';
describe('ProfilerContext', () => {
let React;
let ReactDOM;
let ReactDOMClient;
let TestRenderer: ReactTestRenderer;
let bridge: FrontendBridge;
let legacyRender;
let store: Store;
let utils;
let BridgeContext;
let ProfilerContext;
let ProfilerContextController;
let StoreContext;
let TreeContextController;
let TreeDispatcherContext;
let TreeStateContext;
beforeEach(() => {
utils = require('./utils');
utils.beforeEachProfiling();
legacyRender = utils.legacyRender;
bridge = global.bridge;
store = global.store;
store.collapseNodesByDefault = false;
store.recordChangeDescriptions = true;
React = require('react');
ReactDOM = require('react-dom');
ReactDOMClient = require('react-dom/client');
TestRenderer = utils.requireTestRenderer();
BridgeContext =
require('react-devtools-shared/src/devtools/views/context').BridgeContext;
ProfilerContext =
require('react-devtools-shared/src/devtools/views/Profiler/ProfilerContext').ProfilerContext;
ProfilerContextController =
require('react-devtools-shared/src/devtools/views/Profiler/ProfilerContext').ProfilerContextController;
StoreContext =
require('react-devtools-shared/src/devtools/views/context').StoreContext;
TreeContextController =
require('react-devtools-shared/src/devtools/views/Components/TreeContext').TreeContextController;
TreeDispatcherContext =
require('react-devtools-shared/src/devtools/views/Components/TreeContext').TreeDispatcherContext;
TreeStateContext =
require('react-devtools-shared/src/devtools/views/Components/TreeContext').TreeStateContext;
});
const {render} = getVersionedRenderImplementation();
const Contexts = ({
children = null,
defaultInspectedElementID = null,
defaultInspectedElementIndex = null,
}: any) => (
<BridgeContext.Provider value={bridge}>
<StoreContext.Provider value={store}>
<TreeContextController
defaultInspectedElementID={defaultInspectedElementID}
defaultInspectedElementIndex={defaultInspectedElementIndex}>
<ProfilerContextController>{children}</ProfilerContextController>
</TreeContextController>
</StoreContext.Provider>
</BridgeContext.Provider>
);
// @reactVersion <= 18.2
// @reactVersion >= 18.0
it('updates updates profiling support based on the attached roots (legacy render)', async () => {
const Component = () => null;
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
await utils.actAsync(() => {
TestRenderer.create(
<Contexts>
<ContextReader />
</Contexts>,
);
});
expect(context.supportsProfiling).toBe(false);
const containerA = document.createElement('div');
const containerB = document.createElement('div');
await utils.actAsync(() => legacyRender(<Component />, containerA));
expect(context.supportsProfiling).toBe(true);
await utils.actAsync(() => legacyRender(<Component />, containerB));
await utils.actAsync(() => ReactDOM.unmountComponentAtNode(containerA));
expect(context.supportsProfiling).toBe(true);
await utils.actAsync(() => ReactDOM.unmountComponentAtNode(containerB));
expect(context.supportsProfiling).toBe(false);
});
// @reactVersion >= 18
it('updates updates profiling support based on the attached roots (createRoot)', async () => {
const Component = () => null;
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
await utils.actAsync(() => {
TestRenderer.create(
<Contexts>
<ContextReader />
</Contexts>,
);
});
expect(context.supportsProfiling).toBe(false);
const containerA = document.createElement('div');
const containerB = document.createElement('div');
const rootA = ReactDOMClient.createRoot(containerA);
const rootB = ReactDOMClient.createRoot(containerB);
await utils.actAsync(() => rootA.render(<Component />));
expect(context.supportsProfiling).toBe(true);
await utils.actAsync(() => rootB.render(<Component />));
await utils.actAsync(() => rootA.unmount());
expect(context.supportsProfiling).toBe(true);
await utils.actAsync(() => rootB.unmount());
expect(context.supportsProfiling).toBe(false);
});
it('should gracefully handle an empty profiling session (with no recorded commits)', async () => {
const Example = () => null;
utils.act(() => render(<Example />));
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
// Profile but don't record any updates.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => {
TestRenderer.create(
<Contexts>
<ContextReader />
</Contexts>,
);
});
expect(context).not.toBeNull();
expect(context.didRecordCommits).toBe(false);
expect(context.isProcessingData).toBe(false);
expect(context.isProfiling).toBe(true);
expect(context.profilingData).toBe(null);
await utils.actAsync(() => store.profilerStore.stopProfiling());
expect(context).not.toBeNull();
expect(context.didRecordCommits).toBe(false);
expect(context.isProcessingData).toBe(false);
expect(context.isProfiling).toBe(false);
expect(context.profilingData).toBe(null);
});
// @reactVersion <= 18.2
// @reactVersion >= 18.0
it('should auto-select the root ID matching the Components tab selection if it has profiling data (legacy render)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerOne = document.createElement('div');
const containerTwo = document.createElement('div');
utils.act(() => legacyRender(<Parent />, containerOne));
utils.act(() => legacyRender(<Parent />, containerTwo));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates to both roots.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => legacyRender(<Parent />, containerOne));
await utils.actAsync(() => legacyRender(<Parent />, containerTwo));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={store.getElementIDAtIndex(3)}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
expect(context).not.toBeNull();
expect(context.rootID).toBe(
store.getRootIDForElement(((store.getElementIDAtIndex(3): any): number)),
);
});
// @reactVersion >= 18
it('should auto-select the root ID matching the Components tab selection if it has profiling data (createRoot)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerOne = document.createElement('div');
const containerTwo = document.createElement('div');
const rootOne = ReactDOMClient.createRoot(containerOne);
const rootTwo = ReactDOMClient.createRoot(containerTwo);
utils.act(() => rootOne.render(<Parent />));
utils.act(() => rootTwo.render(<Parent />));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates to both roots.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => rootOne.render(<Parent />));
await utils.actAsync(() => rootTwo.render(<Parent />));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={store.getElementIDAtIndex(3)}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
expect(context).not.toBeNull();
expect(context.rootID).toBe(
store.getRootIDForElement(((store.getElementIDAtIndex(3): any): number)),
);
});
// @reactVersion <= 18.2
// @reactVersion >= 18.0
it('should not select the root ID matching the Components tab selection if it has no profiling data (legacy render)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerOne = document.createElement('div');
const containerTwo = document.createElement('div');
utils.act(() => legacyRender(<Parent />, containerOne));
utils.act(() => legacyRender(<Parent />, containerTwo));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates to only the first root.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => legacyRender(<Parent />, containerOne));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={store.getElementIDAtIndex(3)}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
// Verify the default profiling root is the first one.
expect(context).not.toBeNull();
expect(context.rootID).toBe(
store.getRootIDForElement(((store.getElementIDAtIndex(0): any): number)),
);
});
// @reactVersion >= 18
it('should not select the root ID matching the Components tab selection if it has no profiling data (createRoot)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerOne = document.createElement('div');
const containerTwo = document.createElement('div');
const rootOne = ReactDOMClient.createRoot(containerOne);
const rootTwo = ReactDOMClient.createRoot(containerTwo);
utils.act(() => rootOne.render(<Parent />));
utils.act(() => rootTwo.render(<Parent />));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates to only the first root.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => rootOne.render(<Parent />));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={store.getElementIDAtIndex(3)}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
// Verify the default profiling root is the first one.
expect(context).not.toBeNull();
expect(context.rootID).toBe(
store.getRootIDForElement(((store.getElementIDAtIndex(0): any): number)),
);
});
// @reactVersion <= 18.2
// @reactVersion >= 18.0
it('should maintain root selection between profiling sessions so long as there is data for that root (legacy render)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerA = document.createElement('div');
const containerB = document.createElement('div');
utils.act(() => legacyRender(<Parent />, containerA));
utils.act(() => legacyRender(<Parent />, containerB));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => legacyRender(<Parent />, containerA));
await utils.actAsync(() => legacyRender(<Parent />, containerB));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
let dispatch: DispatcherContext = ((null: any): DispatcherContext);
let inspectedElementID = null;
function ContextReader() {
context = React.useContext(ProfilerContext);
dispatch = React.useContext(TreeDispatcherContext);
inspectedElementID =
React.useContext(TreeStateContext).inspectedElementID;
return null;
}
const id = ((store.getElementIDAtIndex(3): any): number);
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={id}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
expect(inspectedElementID).toBe(id);
// Profile and record more updates to both roots
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => legacyRender(<Parent />, containerA));
await utils.actAsync(() => legacyRender(<Parent />, containerB));
await utils.actAsync(() => store.profilerStore.stopProfiling());
const otherID = ((store.getElementIDAtIndex(0): any): number);
// Change the selected element within a the Components tab.
utils.act(() => dispatch({type: 'SELECT_ELEMENT_AT_INDEX', payload: 0}));
// Verify that the initial Profiler root selection is maintained.
expect(inspectedElementID).toBe(otherID);
expect(context).not.toBeNull();
expect(context.rootID).toBe(store.getRootIDForElement(id));
});
// @reactVersion >= 18.0
it('should maintain root selection between profiling sessions so long as there is data for that root (createRoot)', async () => {
const Parent = () => <Child />;
const Child = () => null;
const containerA = document.createElement('div');
const containerB = document.createElement('div');
const rootA = ReactDOMClient.createRoot(containerA);
const rootB = ReactDOMClient.createRoot(containerB);
utils.act(() => rootA.render(<Parent />));
utils.act(() => rootB.render(<Parent />));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <Parent>
<Child>
[root]
▾ <Parent>
<Child>
`);
// Profile and record updates.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => rootA.render(<Parent />));
await utils.actAsync(() => rootB.render(<Parent />));
await utils.actAsync(() => store.profilerStore.stopProfiling());
let context: Context = ((null: any): Context);
let dispatch: DispatcherContext = ((null: any): DispatcherContext);
let inspectedElementID = null;
function ContextReader() {
context = React.useContext(ProfilerContext);
dispatch = React.useContext(TreeDispatcherContext);
inspectedElementID =
React.useContext(TreeStateContext).inspectedElementID;
return null;
}
const id = ((store.getElementIDAtIndex(3): any): number);
// Select an element within the second root.
await utils.actAsync(() =>
TestRenderer.create(
<Contexts
defaultInspectedElementID={id}
defaultInspectedElementIndex={3}>
<ContextReader />
</Contexts>,
),
);
expect(inspectedElementID).toBe(id);
// Profile and record more updates to both roots
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => rootA.render(<Parent />));
await utils.actAsync(() => rootB.render(<Parent />));
await utils.actAsync(() => store.profilerStore.stopProfiling());
const otherID = ((store.getElementIDAtIndex(0): any): number);
// Change the selected element within a the Components tab.
utils.act(() => dispatch({type: 'SELECT_ELEMENT_AT_INDEX', payload: 0}));
// Verify that the initial Profiler root selection is maintained.
expect(inspectedElementID).toBe(otherID);
expect(context).not.toBeNull();
expect(context.rootID).toBe(store.getRootIDForElement(id));
});
it('should sync selected element in the Components tab too, provided the element is a match', async () => {
const GrandParent = ({includeChild}) => (
<Parent includeChild={includeChild} />
);
const Parent = ({includeChild}) => (includeChild ? <Child /> : null);
const Child = () => null;
utils.act(() => render(<GrandParent includeChild={true} />));
expect(store).toMatchInlineSnapshot(`
[root]
▾ <GrandParent>
▾ <Parent>
<Child>
`);
const parentID = ((store.getElementIDAtIndex(1): any): number);
const childID = ((store.getElementIDAtIndex(2): any): number);
// Profile and record updates.
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => render(<GrandParent includeChild={true} />));
await utils.actAsync(() => render(<GrandParent includeChild={false} />));
await utils.actAsync(() => store.profilerStore.stopProfiling());
expect(store).toMatchInlineSnapshot(`
[root]
▾ <GrandParent>
<Parent>
`);
let context: Context = ((null: any): Context);
let inspectedElementID = null;
function ContextReader() {
context = React.useContext(ProfilerContext);
inspectedElementID =
React.useContext(TreeStateContext).inspectedElementID;
return null;
}
await utils.actAsync(() =>
TestRenderer.create(
<Contexts>
<ContextReader />
</Contexts>,
),
);
expect(inspectedElementID).toBeNull();
// Select an element in the Profiler tab and verify that the selection is synced to the Components tab.
await utils.actAsync(() => context.selectFiber(parentID, 'Parent'));
expect(inspectedElementID).toBe(parentID);
// Select an unmounted element and verify no Components tab selection doesn't change.
await utils.actAsync(() => context.selectFiber(childID, 'Child'));
expect(inspectedElementID).toBe(parentID);
});
it('should toggle profiling when the keyboard shortcut is pressed', async () => {
// Context providers
const Profiler =
require('react-devtools-shared/src/devtools/views/Profiler/Profiler').default;
const {
TimelineContextController,
} = require('react-devtools-timeline/src/TimelineContext');
const {
SettingsContextController,
} = require('react-devtools-shared/src/devtools/views/Settings/SettingsContext');
const {
ModalDialogContextController,
} = require('react-devtools-shared/src/devtools/views/ModalDialog');
// Dom component for profiling to be enabled
const Component = () => null;
utils.act(() => render(<Component />));
const profilerContainer = document.createElement('div');
document.body.appendChild(profilerContainer);
// Create a root for the profiler
const profilerRoot = ReactDOMClient.createRoot(profilerContainer);
// Render the profiler
utils.act(() => {
profilerRoot.render(
<Contexts>
<SettingsContextController browserTheme="light">
<ModalDialogContextController>
<TimelineContextController>
<Profiler />
</TimelineContextController>
</ModalDialogContextController>
</SettingsContextController>
</Contexts>,
);
});
// Verify that the profiler is not profiling.
expect(store.profilerStore.isProfilingBasedOnUserInput).toBe(false);
// Trigger the keyboard shortcut.
const ownerWindow = profilerContainer.ownerDocument.defaultView;
const isMac =
typeof navigator !== 'undefined' &&
navigator.platform.toUpperCase().indexOf('MAC') >= 0;
const keyEvent = new KeyboardEvent('keydown', {
key: 'e',
metaKey: isMac,
ctrlKey: !isMac,
bubbles: true,
});
// Dispatch keyboard event to toggle profiling on
// Try utils.actAsync with recursivelyFlush=false
await utils.actAsync(() => {
ownerWindow.dispatchEvent(keyEvent);
}, false);
expect(store.profilerStore.isProfilingBasedOnUserInput).toBe(true);
// Dispatch keyboard event to toggle profiling off
await utils.actAsync(() => {
ownerWindow.dispatchEvent(keyEvent);
}, false);
expect(store.profilerStore.isProfilingBasedOnUserInput).toBe(false);
document.body.removeChild(profilerContainer);
}, 20000);
it('should navigate between commits when the keyboard shortcut is pressed', async () => {
const Parent = () => <Child />;
const Child = () => null;
const container = document.createElement('div');
const root = ReactDOMClient.createRoot(container);
utils.act(() => root.render(<Parent />));
// Profile and record multiple commits
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => root.render(<Parent />)); // Commit 1
await utils.actAsync(() => root.render(<Parent />)); // Commit 2
await utils.actAsync(() => root.render(<Parent />)); // Commit 3
await utils.actAsync(() => store.profilerStore.stopProfiling());
const Profiler =
require('react-devtools-shared/src/devtools/views/Profiler/Profiler').default;
const {
TimelineContextController,
} = require('react-devtools-timeline/src/TimelineContext');
const {
SettingsContextController,
} = require('react-devtools-shared/src/devtools/views/Settings/SettingsContext');
const {
ModalDialogContextController,
} = require('react-devtools-shared/src/devtools/views/ModalDialog');
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
const profilerContainer = document.createElement('div');
document.body.appendChild(profilerContainer);
const profilerRoot = ReactDOMClient.createRoot(profilerContainer);
await utils.actAsync(() => {
profilerRoot.render(
<Contexts>
<SettingsContextController browserTheme="light">
<ModalDialogContextController>
<TimelineContextController>
<Profiler />
<ContextReader />
</TimelineContextController>
</ModalDialogContextController>
</SettingsContextController>
</Contexts>,
);
});
// Verify we have profiling data with 3 commits
expect(context.didRecordCommits).toBe(true);
expect(context.profilingData).not.toBeNull();
const rootID = context.rootID;
expect(rootID).not.toBeNull();
const dataForRoot = context.profilingData.dataForRoots.get(rootID);
expect(dataForRoot.commitData.length).toBe(3);
// Should start at the first commit
expect(context.selectedCommitIndex).toBe(0);
const ownerWindow = profilerContainer.ownerDocument.defaultView;
const isMac =
typeof navigator !== 'undefined' &&
navigator.platform.toUpperCase().indexOf('MAC') >= 0;
// Test ArrowRight navigation (forward) with correct modifier
const arrowRightEvent = new KeyboardEvent('keydown', {
key: 'ArrowRight',
metaKey: isMac,
ctrlKey: !isMac,
bubbles: true,
});
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(1);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(2);
// Test wrap-around (last -> first)
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(0);
// Test ArrowLeft navigation (backward) with correct modifier
const arrowLeftEvent = new KeyboardEvent('keydown', {
key: 'ArrowLeft',
metaKey: isMac,
ctrlKey: !isMac,
bubbles: true,
});
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowLeftEvent);
}, false);
expect(context.selectedCommitIndex).toBe(2);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowLeftEvent);
}, false);
expect(context.selectedCommitIndex).toBe(1);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowLeftEvent);
}, false);
expect(context.selectedCommitIndex).toBe(0);
// Cleanup
await utils.actAsync(() => profilerRoot.unmount());
document.body.removeChild(profilerContainer);
});
it('should handle commit selection edge cases when filtering commits', async () => {
const Scheduler = require('scheduler');
// Create components that do varying amounts of work to generate different commit durations
const Parent = ({count}) => {
Scheduler.unstable_advanceTime(10);
const items = [];
for (let i = 0; i < count; i++) {
items.push(<Child key={i} duration={i} />);
}
return <div>{items}</div>;
};
const Child = ({duration}) => {
Scheduler.unstable_advanceTime(duration);
return <span>{duration}</span>;
};
const container = document.createElement('div');
const root = ReactDOMClient.createRoot(container);
utils.act(() => root.render(<Parent count={1} />));
// Profile and record multiple commits with different amounts of work
await utils.actAsync(() => store.profilerStore.startProfiling());
await utils.actAsync(() => root.render(<Parent count={5} />)); // Commit 1 - 20ms
await utils.actAsync(() => root.render(<Parent count={20} />)); // Commit 2 - 200ms
await utils.actAsync(() => root.render(<Parent count={50} />)); // Commit 3 - 1235ms
await utils.actAsync(() => root.render(<Parent count={10} />)); // Commit 4 - 55ms
await utils.actAsync(() => store.profilerStore.stopProfiling());
// Context providers
const Profiler =
require('react-devtools-shared/src/devtools/views/Profiler/Profiler').default;
const {
TimelineContextController,
} = require('react-devtools-timeline/src/TimelineContext');
const {
SettingsContextController,
} = require('react-devtools-shared/src/devtools/views/Settings/SettingsContext');
const {
ModalDialogContextController,
} = require('react-devtools-shared/src/devtools/views/ModalDialog');
let context: Context = ((null: any): Context);
function ContextReader() {
context = React.useContext(ProfilerContext);
return null;
}
const profilerContainer = document.createElement('div');
document.body.appendChild(profilerContainer);
const profilerRoot = ReactDOMClient.createRoot(profilerContainer);
await utils.actAsync(() => {
profilerRoot.render(
<Contexts>
<SettingsContextController browserTheme="light">
<ModalDialogContextController>
<TimelineContextController>
<Profiler />
<ContextReader />
</TimelineContextController>
</ModalDialogContextController>
</SettingsContextController>
</Contexts>,
);
});
// Verify we have profiling data with 4 commits
expect(context.didRecordCommits).toBe(true);
expect(context.profilingData).not.toBeNull();
const rootID = context.rootID;
expect(rootID).not.toBeNull();
const dataForRoot = context.profilingData.dataForRoots.get(rootID);
expect(dataForRoot.commitData.length).toBe(4);
// Edge case 1: Should start at the first commit
expect(context.selectedCommitIndex).toBe(0);
const ownerWindow = profilerContainer.ownerDocument.defaultView;
const isMac =
typeof navigator !== 'undefined' &&
navigator.platform.toUpperCase().indexOf('MAC') >= 0;
const arrowRightEvent = new KeyboardEvent('keydown', {
key: 'ArrowRight',
metaKey: isMac,
ctrlKey: !isMac,
bubbles: true,
});
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(1);
await utils.actAsync(() => {
context.setIsCommitFilterEnabled(true);
});
// Edge case 2: When filtering is enabled, selected commit should remain if it's still visible
expect(context.filteredCommitIndices.length).toBe(4);
expect(context.selectedCommitIndex).toBe(1);
expect(context.selectedFilteredCommitIndex).toBe(1);
await utils.actAsync(() => {
context.setMinCommitDuration(1000000);
});
// Edge case 3: When all commits are filtered out, selection should be null
expect(context.filteredCommitIndices).toEqual([]);
expect(context.selectedCommitIndex).toBe(null);
expect(context.selectedFilteredCommitIndex).toBe(null);
await utils.actAsync(() => {
context.setMinCommitDuration(0);
});
// Edge case 4: After restoring commits, first commit should be auto-selected
expect(context.filteredCommitIndices.length).toBe(4);
expect(context.selectedCommitIndex).toBe(0);
expect(context.selectedFilteredCommitIndex).toBe(0);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(1);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(2);
await utils.actAsync(() => {
ownerWindow.dispatchEvent(arrowRightEvent);
}, false);
expect(context.selectedCommitIndex).toBe(3);
// Filter out the currently selected commit using actual commit data
const commitDurations = dataForRoot.commitData.map(
commit => commit.duration,
);
const selectedCommitDuration = commitDurations[3];
const filterThreshold = selectedCommitDuration + 0.001;
await utils.actAsync(() => {
context.setMinCommitDuration(filterThreshold);
});
// Edge case 5: Should auto-select first available commit when current one is filtered
expect(context.selectedCommitIndex).not.toBe(null);
expect(context.selectedFilteredCommitIndex).toBe(1);
await utils.actAsync(() => {
context.setIsCommitFilterEnabled(false);
});
// Edge case 6: When filtering is disabled, selected commit should remain
expect(context.filteredCommitIndices.length).toBe(4);
expect(context.selectedCommitIndex).toBe(2);
expect(context.selectedFilteredCommitIndex).toBe(2);
await utils.actAsync(() => profilerRoot.unmount());
document.body.removeChild(profilerContainer);
});
});