-
Notifications
You must be signed in to change notification settings - Fork 24k
/
RNTesterPlatformTestEventRecorder.js
173 lines (160 loc) · 4.8 KB
/
RNTesterPlatformTestEventRecorder.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
/**
* 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.
*
* @format
* @flow
*/
import type {ViewProps} from 'react-native/Libraries/Components/View/ViewPropTypes';
import {useMemo} from 'react';
type EventRecorderOptions = $ReadOnly<{
mergeEventTypes: Array<string>,
relevantEvents: Array<string>,
}>;
type EventRecord = {
chronologicalOrder: number,
sequentialOccurrences: number,
nestedEvents: ?Array<EventRecord>,
target: string,
type: string,
event: Object,
};
class RNTesterPlatformTestEventRecorder {
allRecords: Array<EventRecord> = [];
relevantEvents: Array<string> = [];
rawOrder: number = 1;
eventsInScope: Array<EventRecord> = []; // Tracks synchronous event dispatches
recording: boolean = true;
mergeTypesTruthMap: {[string]: boolean} = {};
constructor(options: EventRecorderOptions) {
if (options.mergeEventTypes && Array.isArray(options.mergeEventTypes)) {
options.mergeEventTypes.forEach(eventType => {
this.mergeTypesTruthMap[eventType] = true;
});
}
if (options.relevantEvents && Array.isArray(options.relevantEvents)) {
this.relevantEvents = options.relevantEvents;
}
}
_createEventRecord(
rawEvent: Object,
target: string,
type: string,
): EventRecord {
return {
chronologicalOrder: this.rawOrder++,
sequentialOccurrences: 1,
nestedEvents: undefined,
target,
type,
event: rawEvent,
};
}
_recordEvent(e: Object, targetName: string, eventType: string): ?EventRecord {
const record = this._createEventRecord(e, targetName, eventType);
let recordList = this.allRecords;
// Adjust which sequential list to use depending on scope
if (this.eventsInScope.length > 0) {
let newRecordList =
this.eventsInScope[this.eventsInScope.length - 1].nestedEvents;
if (newRecordList == null) {
newRecordList = this.eventsInScope[
this.eventsInScope.length - 1
].nestedEvents = [];
}
recordList = newRecordList;
}
if (this.mergeTypesTruthMap[eventType] && recordList.length > 0) {
const tail = recordList[recordList.length - 1];
// Same type and target?
if (tail.type === eventType && tail.target === targetName) {
tail.sequentialOccurrences++;
return;
}
}
recordList.push(record);
return record;
}
_generateRecordedEventHandlerWithCallback(
targetName: string,
callback?: (event: Object, eventType: string) => void,
): (Object, string) => void {
return (e: Object, eventType: string) => {
if (this.recording) {
this._recordEvent(e, targetName, eventType);
if (callback) {
callback(e, eventType);
}
}
};
}
useRecorderTestEventHandlers(
targetNames: $ReadOnlyArray<string>,
callback?: (event: Object, eventType: string, targetName: string) => void,
): $ReadOnly<{[targetName: string]: ViewProps}> {
// Yes this method exists as a class's prototype method but it will still only be used
// in functional components
// eslint-disable-next-line react-hooks/rules-of-hooks
return useMemo(() => {
const result: {[targetName: string]: ViewProps} = {};
for (const targetName of targetNames) {
const recordedEventHandler =
this._generateRecordedEventHandlerWithCallback(
targetName,
(event, eventType) =>
callback && callback(event, eventType, targetName),
);
const eventListenerProps = this.relevantEvents.reduce(
(acc, eventName) => {
const eventPropName =
'on' + eventName[0].toUpperCase() + eventName.slice(1);
return {
...acc,
[eventPropName]: e => {
recordedEventHandler(e, eventName);
},
};
},
{},
);
result[targetName] = eventListenerProps;
}
return result;
}, [callback, targetNames]);
}
checkRecords(
expected: Array<{
type: string,
target: string,
optional?: boolean,
}>,
): boolean {
if (expected.length < this.allRecords.length) {
return false;
}
let j = 0;
for (let i = 0; i < expected.length; ++i) {
if (j >= this.allRecords.length) {
if (expected[i].optional === true) {
continue;
}
return false;
}
if (
expected[i].type === this.allRecords[j].type &&
expected[i].target === this.allRecords[j].target
) {
j++;
continue;
}
if (expected[i].optional === true) {
continue;
}
return false;
}
return true;
}
}
export default RNTesterPlatformTestEventRecorder;