@testing-library/react-native 12.2.1 → 12.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (302) hide show
  1. package/package.json +2 -3
  2. package/.DS_Store +0 -0
  3. package/.codecov.yml +0 -9
  4. package/.eslintcache +0 -1
  5. package/.eslintignore +0 -3
  6. package/.eslintrc +0 -19
  7. package/.flowconfig +0 -63
  8. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -38
  9. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -14
  10. package/.github/ISSUE_TEMPLATE/question.md +0 -9
  11. package/.github/PULL_REQUEST_TEMPLATE.md +0 -10
  12. package/.github/actions/setup-deps/action.yml +0 -22
  13. package/.github/actions/setup-website-deps/action.yml +0 -22
  14. package/.github/dependabot.yml +0 -10
  15. package/.github/workflows/deploy-website.yml +0 -36
  16. package/.github/workflows/example-apps.yml +0 -25
  17. package/.github/workflows/main.yml +0 -103
  18. package/.gitignore +0 -11
  19. package/.prettierrc.js +0 -5
  20. package/CODE_OF_CONDUCT.md +0 -73
  21. package/CONTRIBUTING.md +0 -64
  22. package/babel.config.js +0 -22
  23. package/examples/basic/.expo/README.md +0 -15
  24. package/examples/basic/.expo/packager-info.json +0 -4
  25. package/examples/basic/.expo/settings.json +0 -10
  26. package/examples/basic/.expo-shared/assets.json +0 -4
  27. package/examples/basic/.gitignore +0 -14
  28. package/examples/basic/App.tsx +0 -20
  29. package/examples/basic/README.md +0 -11
  30. package/examples/basic/__tests__/App.test.tsx +0 -137
  31. package/examples/basic/app.json +0 -31
  32. package/examples/basic/assets/adaptive-icon.png +0 -0
  33. package/examples/basic/assets/favicon.png +0 -0
  34. package/examples/basic/assets/icon.png +0 -0
  35. package/examples/basic/assets/splash.png +0 -0
  36. package/examples/basic/babel.config.js +0 -6
  37. package/examples/basic/components/Home.tsx +0 -28
  38. package/examples/basic/components/LoginForm.tsx +0 -138
  39. package/examples/basic/jest-setup.ts +0 -7
  40. package/examples/basic/jest.config.js +0 -5
  41. package/examples/basic/package.json +0 -30
  42. package/examples/basic/tsconfig.json +0 -7
  43. package/examples/basic/yarn.lock +0 -7499
  44. package/examples/react-navigation/README.md +0 -16
  45. package/examples/react-navigation/babel.config.js +0 -4
  46. package/examples/react-navigation/jest-setup.js +0 -11
  47. package/examples/react-navigation/jest.config.js +0 -10
  48. package/examples/react-navigation/package.json +0 -31
  49. package/examples/react-navigation/src/App.js +0 -21
  50. package/examples/react-navigation/src/DrawerNavigator.js +0 -15
  51. package/examples/react-navigation/src/DrawerNavigator.test.js +0 -42
  52. package/examples/react-navigation/src/NativeStackNavigator.js +0 -15
  53. package/examples/react-navigation/src/NativeStackNavigator.test.js +0 -34
  54. package/examples/react-navigation/src/StackNavigator.js +0 -15
  55. package/examples/react-navigation/src/StackNavigator.test.js +0 -34
  56. package/examples/react-navigation/src/TabNavigator.js +0 -15
  57. package/examples/react-navigation/src/TabNavigator.test.js +0 -21
  58. package/examples/react-navigation/src/screens/DetailsScreen.js +0 -43
  59. package/examples/react-navigation/src/screens/DetailsScreen.test.js +0 -27
  60. package/examples/react-navigation/src/screens/DrawerHomeScreen.js +0 -26
  61. package/examples/react-navigation/src/screens/HomeScreen.js +0 -48
  62. package/examples/react-navigation/src/screens/SettingsScreen.js +0 -20
  63. package/examples/react-navigation/src/test-utils.js +0 -12
  64. package/examples/react-navigation/yarn.lock +0 -5018
  65. package/examples/redux/App.js +0 -27
  66. package/examples/redux/README.md +0 -5
  67. package/examples/redux/actions/todoActions.js +0 -25
  68. package/examples/redux/babel.config.js +0 -6
  69. package/examples/redux/components/AddTodo.js +0 -73
  70. package/examples/redux/components/AddTodo.test.js +0 -27
  71. package/examples/redux/components/TodoElem.js +0 -25
  72. package/examples/redux/components/TodoList.js +0 -29
  73. package/examples/redux/components/TodoList.test.js +0 -34
  74. package/examples/redux/index.js +0 -8
  75. package/examples/redux/jest-setup.js +0 -2
  76. package/examples/redux/jest.config.js +0 -4
  77. package/examples/redux/package.json +0 -23
  78. package/examples/redux/reducers/index.js +0 -6
  79. package/examples/redux/reducers/todoReducer.js +0 -27
  80. package/examples/redux/store.js +0 -10
  81. package/examples/redux/test-utils.js +0 -11
  82. package/examples/redux/yarn.lock +0 -4819
  83. package/experiments-app/.expo/README.md +0 -15
  84. package/experiments-app/.expo/devices.json +0 -3
  85. package/experiments-app/.expo/packager-info.json +0 -9
  86. package/experiments-app/.expo/settings.json +0 -9
  87. package/experiments-app/.gitignore +0 -17
  88. package/experiments-app/.prettierrc.js +0 -5
  89. package/experiments-app/app.json +0 -30
  90. package/experiments-app/assets/adaptive-icon.png +0 -0
  91. package/experiments-app/assets/favicon.png +0 -0
  92. package/experiments-app/assets/icon.png +0 -0
  93. package/experiments-app/assets/splash.png +0 -0
  94. package/experiments-app/babel.config.js +0 -6
  95. package/experiments-app/index.js +0 -4
  96. package/experiments-app/package.json +0 -29
  97. package/experiments-app/src/App.tsx +0 -31
  98. package/experiments-app/src/MainScreen.tsx +0 -52
  99. package/experiments-app/src/experiments.ts +0 -35
  100. package/experiments-app/src/screens/FlatListEvents.tsx +0 -57
  101. package/experiments-app/src/screens/ScrollViewEvents.tsx +0 -65
  102. package/experiments-app/src/screens/SectionListEvents.tsx +0 -91
  103. package/experiments-app/src/screens/TextInputEventPropagation.tsx +0 -42
  104. package/experiments-app/src/screens/TextInputEvents.tsx +0 -48
  105. package/experiments-app/src/utils/helpers.ts +0 -18
  106. package/experiments-app/tsconfig.json +0 -6
  107. package/experiments-app/yarn.lock +0 -6709
  108. package/experiments-rtl/.babelrc +0 -8
  109. package/experiments-rtl/.eslintrc.json +0 -3
  110. package/experiments-rtl/.gitignore +0 -35
  111. package/experiments-rtl/README.md +0 -34
  112. package/experiments-rtl/jest-setup.js +0 -1
  113. package/experiments-rtl/jest.config.js +0 -4
  114. package/experiments-rtl/next.config.js +0 -4
  115. package/experiments-rtl/package.json +0 -38
  116. package/experiments-rtl/postcss.config.js +0 -6
  117. package/experiments-rtl/public/next.svg +0 -1
  118. package/experiments-rtl/public/vercel.svg +0 -1
  119. package/experiments-rtl/src/app/__tests__/click.test.tsx +0 -31
  120. package/experiments-rtl/src/app/__tests__/managed-text-input.test.tsx +0 -51
  121. package/experiments-rtl/src/app/globals.css +0 -27
  122. package/experiments-rtl/src/app/layout.tsx +0 -22
  123. package/experiments-rtl/src/app/page.tsx +0 -113
  124. package/experiments-rtl/tailwind.config.ts +0 -20
  125. package/experiments-rtl/tsconfig.json +0 -28
  126. package/experiments-rtl/yarn.lock +0 -5418
  127. package/flow-typed/npm/jest_v26.x.x.js +0 -1218
  128. package/flow-typed/npm/react-test-renderer_v16.x.x.js +0 -81
  129. package/jest-setup.ts +0 -10
  130. package/renovate.json +0 -19
  131. package/scripts/test_react_17 +0 -12
  132. package/src/__tests__/__snapshots__/render-debug.test.tsx.snap +0 -548
  133. package/src/__tests__/__snapshots__/render.test.tsx.snap +0 -39
  134. package/src/__tests__/act.test.tsx +0 -56
  135. package/src/__tests__/auto-cleanup-skip.test.tsx +0 -39
  136. package/src/__tests__/auto-cleanup.test.tsx +0 -50
  137. package/src/__tests__/cleanup.test.tsx +0 -26
  138. package/src/__tests__/config.test.ts +0 -55
  139. package/src/__tests__/fireEvent-textInput.test.tsx +0 -154
  140. package/src/__tests__/fireEvent.test.tsx +0 -485
  141. package/src/__tests__/host-component-names.test.tsx +0 -109
  142. package/src/__tests__/host-text-nesting.test.tsx +0 -90
  143. package/src/__tests__/jest-native.test.tsx +0 -84
  144. package/src/__tests__/questionsBoard.test.tsx +0 -62
  145. package/src/__tests__/react-native-api.test.tsx +0 -126
  146. package/src/__tests__/render-debug.test.tsx +0 -207
  147. package/src/__tests__/render-stringValidation.test.tsx +0 -157
  148. package/src/__tests__/render.test.tsx +0 -256
  149. package/src/__tests__/renderHook.test.tsx +0 -114
  150. package/src/__tests__/screen.test.tsx +0 -66
  151. package/src/__tests__/timerUtils.ts +0 -7
  152. package/src/__tests__/timers.test.ts +0 -27
  153. package/src/__tests__/waitFor.test.tsx +0 -327
  154. package/src/__tests__/waitForElementToBeRemoved.test.tsx +0 -151
  155. package/src/__tests__/within.test.tsx +0 -96
  156. package/src/act.ts +0 -86
  157. package/src/cleanup.ts +0 -15
  158. package/src/config.ts +0 -72
  159. package/src/fireEvent.ts +0 -159
  160. package/src/flush-micro-tasks.ts +0 -30
  161. package/src/helpers/__tests__/accessiblity.test.tsx +0 -373
  162. package/src/helpers/__tests__/component-tree.test.tsx +0 -226
  163. package/src/helpers/__tests__/format-default.tsx +0 -114
  164. package/src/helpers/__tests__/getTextContent.test.tsx +0 -49
  165. package/src/helpers/__tests__/includeHiddenElements.test.tsx +0 -39
  166. package/src/helpers/__tests__/query-name.test.ts +0 -10
  167. package/src/helpers/__tests__/timers.test.ts +0 -8
  168. package/src/helpers/accessiblity.ts +0 -108
  169. package/src/helpers/component-tree.ts +0 -94
  170. package/src/helpers/debugDeep.ts +0 -27
  171. package/src/helpers/debugShallow.ts +0 -22
  172. package/src/helpers/deprecation.ts +0 -53
  173. package/src/helpers/errors.ts +0 -66
  174. package/src/helpers/findAll.ts +0 -70
  175. package/src/helpers/format-default.ts +0 -72
  176. package/src/helpers/format.ts +0 -47
  177. package/src/helpers/getTextContent.ts +0 -20
  178. package/src/helpers/host-component-names.tsx +0 -88
  179. package/src/helpers/matchers/__tests__/matchArrayValue.test.ts +0 -34
  180. package/src/helpers/matchers/__tests__/matchObject.test.ts +0 -37
  181. package/src/helpers/matchers/__tests__/matchStringValue.test.ts +0 -15
  182. package/src/helpers/matchers/accessibilityState.ts +0 -48
  183. package/src/helpers/matchers/accessibilityValue.ts +0 -24
  184. package/src/helpers/matchers/matchArrayProp.ts +0 -21
  185. package/src/helpers/matchers/matchLabelText.ts +0 -50
  186. package/src/helpers/matchers/matchObjectProp.ts +0 -25
  187. package/src/helpers/matchers/matchStringProp.ts +0 -23
  188. package/src/helpers/matchers/matchTextContent.ts +0 -20
  189. package/src/helpers/pointer-events.ts +0 -27
  190. package/src/helpers/query-name.ts +0 -4
  191. package/src/helpers/stringValidation.ts +0 -36
  192. package/src/helpers/timers.ts +0 -98
  193. package/src/index.ts +0 -33
  194. package/src/matches.ts +0 -49
  195. package/src/pure.ts +0 -27
  196. package/src/queries/__tests__/a11yState.test.tsx +0 -439
  197. package/src/queries/__tests__/a11yValue.test.tsx +0 -309
  198. package/src/queries/__tests__/displayValue.test.tsx +0 -221
  199. package/src/queries/__tests__/hintText.test.tsx +0 -177
  200. package/src/queries/__tests__/labelText.test.tsx +0 -242
  201. package/src/queries/__tests__/makeQueries.test.tsx +0 -235
  202. package/src/queries/__tests__/placeholderText.test.tsx +0 -136
  203. package/src/queries/__tests__/role-value.test.tsx +0 -176
  204. package/src/queries/__tests__/role.test.tsx +0 -824
  205. package/src/queries/__tests__/testId.test.tsx +0 -200
  206. package/src/queries/__tests__/text.test.tsx +0 -556
  207. package/src/queries/a11yState.ts +0 -127
  208. package/src/queries/a11yValue.ts +0 -127
  209. package/src/queries/displayValue.ts +0 -71
  210. package/src/queries/hintText.ts +0 -107
  211. package/src/queries/labelText.ts +0 -57
  212. package/src/queries/makeQueries.ts +0 -255
  213. package/src/queries/options.ts +0 -14
  214. package/src/queries/placeholderText.ts +0 -72
  215. package/src/queries/role.ts +0 -131
  216. package/src/queries/testId.ts +0 -66
  217. package/src/queries/text.ts +0 -63
  218. package/src/queries/unsafeProps.ts +0 -76
  219. package/src/queries/unsafeType.ts +0 -73
  220. package/src/react-versions.ts +0 -11
  221. package/src/render-act.ts +0 -19
  222. package/src/render.tsx +0 -183
  223. package/src/renderHook.tsx +0 -56
  224. package/src/screen.ts +0 -123
  225. package/src/shallow.ts +0 -18
  226. package/src/test-utils/events.ts +0 -24
  227. package/src/test-utils/index.ts +0 -1
  228. package/src/user-event/__tests__/__snapshots__/clear.test.tsx.snap +0 -269
  229. package/src/user-event/__tests__/clear.test.tsx +0 -217
  230. package/src/user-event/clear.ts +0 -59
  231. package/src/user-event/event-builder/common.ts +0 -66
  232. package/src/user-event/event-builder/index.ts +0 -7
  233. package/src/user-event/event-builder/text-input.ts +0 -86
  234. package/src/user-event/index.ts +0 -18
  235. package/src/user-event/press/__tests__/longPress.real-timers.test.tsx +0 -117
  236. package/src/user-event/press/__tests__/longPress.test.tsx +0 -157
  237. package/src/user-event/press/__tests__/press.real-timers.test.tsx +0 -320
  238. package/src/user-event/press/__tests__/press.test.tsx +0 -457
  239. package/src/user-event/press/constants.ts +0 -7
  240. package/src/user-event/press/index.ts +0 -1
  241. package/src/user-event/press/press.ts +0 -163
  242. package/src/user-event/setup/index.ts +0 -2
  243. package/src/user-event/setup/setup.ts +0 -142
  244. package/src/user-event/type/__tests__/__snapshots__/type-managed.test.tsx.snap +0 -339
  245. package/src/user-event/type/__tests__/__snapshots__/type.test.tsx.snap +0 -668
  246. package/src/user-event/type/__tests__/parseKeys.test.ts +0 -23
  247. package/src/user-event/type/__tests__/type-managed.test.tsx +0 -120
  248. package/src/user-event/type/__tests__/type.test.tsx +0 -335
  249. package/src/user-event/type/index.ts +0 -1
  250. package/src/user-event/type/parseKeys.ts +0 -41
  251. package/src/user-event/type/type.ts +0 -138
  252. package/src/user-event/utils/__tests__/dispatch-event.test.tsx +0 -41
  253. package/src/user-event/utils/__tests__/wait.test.ts +0 -62
  254. package/src/user-event/utils/content-size.ts +0 -25
  255. package/src/user-event/utils/dispatch-event.ts +0 -38
  256. package/src/user-event/utils/host-components.ts +0 -6
  257. package/src/user-event/utils/index.ts +0 -6
  258. package/src/user-event/utils/text-range.ts +0 -4
  259. package/src/user-event/utils/wait.ts +0 -15
  260. package/src/user-event/utils/warn-about-real-timers.ts +0 -13
  261. package/src/waitFor.ts +0 -228
  262. package/src/waitForElementToBeRemoved.ts +0 -42
  263. package/src/within.ts +0 -30
  264. package/tsconfig.json +0 -17
  265. package/tsconfig.release.json +0 -8
  266. package/website/.gitignore +0 -20
  267. package/website/README.md +0 -33
  268. package/website/docker/.dockerignore +0 -3
  269. package/website/docker/Dockerfile +0 -9
  270. package/website/docker/docker-compose.yml +0 -11
  271. package/website/docs/API.md +0 -940
  272. package/website/docs/EslintPLluginTestingLibrary.md +0 -28
  273. package/website/docs/FAQ.md +0 -44
  274. package/website/docs/GettingStarted.md +0 -100
  275. package/website/docs/HowShouldIQuery.md +0 -21
  276. package/website/docs/MigrationV11.md +0 -64
  277. package/website/docs/MigrationV12.md +0 -67
  278. package/website/docs/MigrationV2.md +0 -126
  279. package/website/docs/MigrationV7.md +0 -119
  280. package/website/docs/MigrationV9.md +0 -67
  281. package/website/docs/Queries.md +0 -572
  282. package/website/docs/ReactNavigation.md +0 -371
  283. package/website/docs/ReduxIntegration.md +0 -137
  284. package/website/docs/TestingEnvironment.md +0 -154
  285. package/website/docs/Troubleshooting.md +0 -44
  286. package/website/docs/UnderstandingAct.md +0 -227
  287. package/website/docs/UserEvent.md +0 -191
  288. package/website/docusaurus.config.js +0 -114
  289. package/website/package.json +0 -31
  290. package/website/sidebars.js +0 -20
  291. package/website/src/components/Feature.js +0 -31
  292. package/website/src/css/custom.css +0 -13
  293. package/website/src/css/index.module.css +0 -77
  294. package/website/src/pages/index.js +0 -82
  295. package/website/static/.nojekyll +0 -0
  296. package/website/static/css/custom.css +0 -28
  297. package/website/static/img/hit.png +0 -0
  298. package/website/static/img/locomotive.png +0 -0
  299. package/website/static/img/owl.png +0 -0
  300. package/website/static/img/tools.png +0 -0
  301. package/website/yarn.lock +0 -7669
  302. package/yarn.lock +0 -7765
@@ -1,62 +0,0 @@
1
- import { wait } from '../wait';
2
-
3
- beforeEach(() => {
4
- jest.useRealTimers();
5
- });
6
-
7
- describe('wait()', () => {
8
- it('wait works with real timers', async () => {
9
- jest.spyOn(globalThis, 'setTimeout');
10
- const advanceTimers = jest.fn(() => Promise.resolve());
11
- await wait({ delay: 20, advanceTimers });
12
-
13
- expect(globalThis.setTimeout).toHaveBeenCalledTimes(1);
14
- expect(globalThis.setTimeout).toHaveBeenCalledWith(expect.anything(), 20);
15
- expect(advanceTimers).toHaveBeenCalledTimes(1);
16
- expect(advanceTimers).toHaveBeenCalledWith(20);
17
- });
18
-
19
- it.each(['modern', 'legacy'])(
20
- 'wait works with %s fake timers',
21
- async (type) => {
22
- jest.useFakeTimers({ legacyFakeTimers: type === 'legacy' });
23
- jest.spyOn(globalThis, 'setTimeout');
24
- const advanceTimers = jest.fn((n) => jest.advanceTimersByTime(n));
25
- await wait({ delay: 100, advanceTimers });
26
-
27
- expect(globalThis.setTimeout).toHaveBeenCalledTimes(1);
28
- expect(globalThis.setTimeout).toHaveBeenCalledWith(
29
- expect.anything(),
30
- 100
31
- );
32
- expect(advanceTimers).toHaveBeenCalledTimes(1);
33
- expect(advanceTimers).toHaveBeenCalledWith(100);
34
- }
35
- );
36
-
37
- it('wait with null delay does not wait with real timers', async () => {
38
- jest.spyOn(globalThis, 'setTimeout');
39
- const advanceTimers = jest.fn();
40
-
41
- // @ts-expect-error
42
- await wait({ delay: null, advanceTimers });
43
-
44
- expect(globalThis.setTimeout).not.toHaveBeenCalled();
45
- expect(advanceTimers).not.toHaveBeenCalled();
46
- });
47
-
48
- it.each(['modern', 'legacy'])(
49
- 'wait with null delay does not wait with %s fake timers',
50
- async (type) => {
51
- jest.useFakeTimers({ legacyFakeTimers: type === 'legacy' });
52
- jest.spyOn(globalThis, 'setTimeout');
53
- const advanceTimers = jest.fn();
54
-
55
- // @ts-expect-error
56
- await wait({ delay: null, advanceTimers });
57
-
58
- expect(globalThis.setTimeout).not.toHaveBeenCalled();
59
- expect(advanceTimers).not.toHaveBeenCalled();
60
- }
61
- );
62
- });
@@ -1,25 +0,0 @@
1
- export interface ContentSize {
2
- width: number;
3
- height: number;
4
- }
5
-
6
- /**
7
- * Simple function for getting mock the size of given text.
8
- *
9
- * It works by calculating height based on number of lines and width based on
10
- * the longest line length. It does not take into account font size, font
11
- * family, as well as different letter sizes.
12
- *
13
- * @param text text to be measure
14
- * @returns width and height of the text
15
- */
16
-
17
- export function getTextContentSize(text: string): ContentSize {
18
- const lines = text.split('\n');
19
- const maxLineLength = Math.max(...lines.map((line) => line.length));
20
-
21
- return {
22
- width: maxLineLength * 5,
23
- height: lines.length * 16,
24
- };
25
- }
@@ -1,38 +0,0 @@
1
- import { ReactTestInstance } from 'react-test-renderer';
2
- import act from '../../act';
3
-
4
- /**
5
- * Basic dispatch event function used by User Event module.
6
- *
7
- * @param element element trigger event on
8
- * @param eventName name of the event
9
- * @param event event payload
10
- */
11
- export function dispatchEvent(
12
- element: ReactTestInstance,
13
- eventName: string,
14
- event: unknown
15
- ) {
16
- const handler = getEventHandler(element, eventName);
17
- if (!handler) {
18
- return;
19
- }
20
-
21
- act(() => {
22
- handler(event);
23
- });
24
- }
25
-
26
- function getEventHandler(element: ReactTestInstance, eventName: string) {
27
- const handleName = getEventHandlerName(eventName);
28
- const handle = element.props[handleName] as unknown;
29
- if (typeof handle !== 'function') {
30
- return undefined;
31
- }
32
-
33
- return handle;
34
- }
35
-
36
- function getEventHandlerName(eventName: string) {
37
- return `on${eventName.charAt(0).toUpperCase()}${eventName.slice(1)}`;
38
- }
@@ -1,6 +0,0 @@
1
- import { ReactTestInstance } from 'react-test-renderer';
2
- import { isHostTextInput } from '../../helpers/host-component-names';
3
-
4
- export function isEditableTextInput(element: ReactTestInstance) {
5
- return isHostTextInput(element) && element.props.editable !== false;
6
- }
@@ -1,6 +0,0 @@
1
- export * from './content-size';
2
- export * from './dispatch-event';
3
- export * from './host-components';
4
- export * from './text-range';
5
- export * from './wait';
6
- export * from './warn-about-real-timers';
@@ -1,4 +0,0 @@
1
- export interface TextRange {
2
- start: number;
3
- end: number;
4
- }
@@ -1,15 +0,0 @@
1
- import { UserEventConfig } from '../setup';
2
-
3
- export function wait(config: UserEventConfig, durationInMs?: number) {
4
- const delay = durationInMs ?? config.delay;
5
- if (typeof delay !== 'number') {
6
- return;
7
- }
8
-
9
- return Promise.all([
10
- new Promise<void>((resolve) =>
11
- globalThis.setTimeout(() => resolve(), delay)
12
- ),
13
- config.advanceTimers(delay),
14
- ]);
15
- }
@@ -1,13 +0,0 @@
1
- import { jestFakeTimersAreEnabled } from '../../helpers/timers';
2
-
3
- export const warnAboutRealTimersIfNeeded = () => {
4
- const areFakeTimersEnabled = jestFakeTimersAreEnabled();
5
- if (areFakeTimersEnabled) {
6
- return;
7
- }
8
-
9
- // eslint-disable-next-line no-console
10
- console.warn(`It is recommended to use userEvent with fake timers
11
- Some events involve duration so your tests may take a long time to run.
12
- For instance calling userEvent.longPress with real timers will take 500 ms.`);
13
- };
package/src/waitFor.ts DELETED
@@ -1,228 +0,0 @@
1
- /* globals jest */
2
- import act, { setReactActEnvironment, getIsReactActEnvironment } from './act';
3
- import { getConfig } from './config';
4
- import { flushMicroTasks, flushMicroTasksLegacy } from './flush-micro-tasks';
5
- import { ErrorWithStack, copyStackTrace } from './helpers/errors';
6
- import {
7
- setTimeout,
8
- clearTimeout,
9
- jestFakeTimersAreEnabled,
10
- } from './helpers/timers';
11
- import { checkReactVersionAtLeast } from './react-versions';
12
-
13
- const DEFAULT_INTERVAL = 50;
14
-
15
- export type WaitForOptions = {
16
- timeout?: number;
17
- interval?: number;
18
- stackTraceError?: ErrorWithStack;
19
- onTimeout?: (error: Error) => Error;
20
- };
21
-
22
- function waitForInternal<T>(
23
- expectation: () => T,
24
- {
25
- timeout = getConfig().asyncUtilTimeout,
26
- interval = DEFAULT_INTERVAL,
27
- stackTraceError,
28
- onTimeout,
29
- }: WaitForOptions
30
- ): Promise<T> {
31
- if (typeof expectation !== 'function') {
32
- throw new TypeError('Received `expectation` arg must be a function');
33
- }
34
-
35
- // eslint-disable-next-line no-async-promise-executor
36
- return new Promise(async (resolve, reject) => {
37
- let lastError: unknown, intervalId: ReturnType<typeof setTimeout>;
38
- let finished = false;
39
- let promiseStatus = 'idle';
40
-
41
- let overallTimeoutTimer: NodeJS.Timeout | null = null;
42
-
43
- const usingFakeTimers = jestFakeTimersAreEnabled();
44
-
45
- if (usingFakeTimers) {
46
- checkExpectation();
47
- // this is a dangerous rule to disable because it could lead to an
48
- // infinite loop. However, eslint isn't smart enough to know that we're
49
- // setting finished inside `onDone` which will be called when we're done
50
- // waiting or when we've timed out.
51
- // eslint-disable-next-line no-unmodified-loop-condition
52
- let fakeTimeRemaining = timeout;
53
- while (!finished) {
54
- if (!jestFakeTimersAreEnabled()) {
55
- const error = new Error(
56
- `Changed from using fake timers to real timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to real timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
57
- );
58
- if (stackTraceError) {
59
- copyStackTrace(error, stackTraceError);
60
- }
61
- reject(error);
62
- return;
63
- }
64
-
65
- // when fake timers are used we want to simulate the interval time passing
66
- if (fakeTimeRemaining <= 0) {
67
- handleTimeout();
68
- return;
69
- } else {
70
- fakeTimeRemaining -= interval;
71
- }
72
-
73
- // we *could* (maybe should?) use `advanceTimersToNextTimer` but it's
74
- // possible that could make this loop go on forever if someone is using
75
- // third party code that's setting up recursive timers so rapidly that
76
- // the user's timer's don't get a chance to resolve. So we'll advance
77
- // by an interval instead. (We have a test for this case).
78
- jest.advanceTimersByTime(interval);
79
-
80
- // It's really important that checkExpectation is run *before* we flush
81
- // in-flight promises. To be honest, I'm not sure why, and I can't quite
82
- // think of a way to reproduce the problem in a test, but I spent
83
- // an entire day banging my head against a wall on this.
84
- checkExpectation();
85
-
86
- // In this rare case, we *need* to wait for in-flight promises
87
- // to resolve before continuing. We don't need to take advantage
88
- // of parallelization so we're fine.
89
- // https://stackoverflow.com/a/59243586/971592
90
- // eslint-disable-next-line no-await-in-loop
91
- await flushMicroTasks();
92
- }
93
- } else {
94
- overallTimeoutTimer = setTimeout(handleTimeout, timeout);
95
- intervalId = setInterval(checkRealTimersCallback, interval);
96
- checkExpectation();
97
- }
98
-
99
- function onDone(
100
- done: { type: 'result'; result: T } | { type: 'error'; error: unknown }
101
- ) {
102
- finished = true;
103
- if (overallTimeoutTimer) {
104
- clearTimeout(overallTimeoutTimer);
105
- }
106
-
107
- if (!usingFakeTimers) {
108
- clearInterval(intervalId);
109
- }
110
-
111
- if (done.type === 'error') {
112
- reject(done.error);
113
- } else {
114
- resolve(done.result);
115
- }
116
- }
117
-
118
- function checkRealTimersCallback() {
119
- if (jestFakeTimersAreEnabled()) {
120
- const error = new Error(
121
- `Changed from using real timers to fake timers while using waitFor. This is not allowed and will result in very strange behavior. Please ensure you're awaiting all async things your test is doing before changing to fake timers. For more info, please go to https://github.com/testing-library/dom-testing-library/issues/830`
122
- );
123
- if (stackTraceError) {
124
- copyStackTrace(error, stackTraceError);
125
- }
126
- return reject(error);
127
- } else {
128
- return checkExpectation();
129
- }
130
- }
131
-
132
- function checkExpectation() {
133
- if (promiseStatus === 'pending') return;
134
- try {
135
- const result = expectation();
136
-
137
- // @ts-ignore result can be a promise
138
- // eslint-disable-next-line promise/prefer-await-to-then
139
- if (typeof result?.then === 'function') {
140
- const promiseResult: Promise<T> = result as any;
141
- promiseStatus = 'pending';
142
- // eslint-disable-next-line promise/catch-or-return, promise/prefer-await-to-then
143
- promiseResult.then(
144
- (resolvedValue) => {
145
- promiseStatus = 'resolved';
146
- onDone({ type: 'result', result: resolvedValue });
147
- return;
148
- },
149
- (rejectedValue) => {
150
- promiseStatus = 'rejected';
151
- lastError = rejectedValue;
152
- return;
153
- }
154
- );
155
- } else {
156
- onDone({ type: 'result', result: result });
157
- }
158
- // If `callback` throws, wait for the next mutation, interval, or timeout.
159
- } catch (error) {
160
- // Save the most recent callback error to reject the promise with it in the event of a timeout
161
- lastError = error;
162
- }
163
- }
164
-
165
- function handleTimeout() {
166
- let error: Error;
167
- if (lastError) {
168
- if (lastError instanceof Error) {
169
- error = lastError;
170
- } else {
171
- error = new Error(String(lastError));
172
- }
173
-
174
- if (stackTraceError) {
175
- copyStackTrace(error, stackTraceError);
176
- }
177
- } else {
178
- error = new Error('Timed out in waitFor.');
179
- if (stackTraceError) {
180
- copyStackTrace(error, stackTraceError);
181
- }
182
- }
183
- if (typeof onTimeout === 'function') {
184
- const result = onTimeout(error);
185
- if (result) {
186
- error = result;
187
- }
188
- }
189
- onDone({ type: 'error', error });
190
- }
191
- });
192
- }
193
-
194
- export default async function waitFor<T>(
195
- expectation: () => T,
196
- options?: WaitForOptions
197
- ): Promise<T> {
198
- // Being able to display a useful stack trace requires generating it before doing anything async
199
- const stackTraceError = new ErrorWithStack('STACK_TRACE_ERROR', waitFor);
200
- const optionsWithStackTrace = { stackTraceError, ...options };
201
-
202
- if (checkReactVersionAtLeast(18, 0)) {
203
- const previousActEnvironment = getIsReactActEnvironment();
204
- setReactActEnvironment(false);
205
-
206
- try {
207
- const result = await waitForInternal(expectation, optionsWithStackTrace);
208
- // Flush the microtask queue before restoring the `act` environment
209
- await flushMicroTasksLegacy();
210
- return result;
211
- } finally {
212
- setReactActEnvironment(previousActEnvironment);
213
- }
214
- }
215
-
216
- if (!checkReactVersionAtLeast(16, 9)) {
217
- return waitForInternal(expectation, optionsWithStackTrace);
218
- }
219
-
220
- let result: T;
221
-
222
- await act(async () => {
223
- result = await waitForInternal(expectation, optionsWithStackTrace);
224
- });
225
-
226
- // Either we have result or `waitFor` threw error
227
- return result!;
228
- }
@@ -1,42 +0,0 @@
1
- import waitFor from './waitFor';
2
- import type { WaitForOptions } from './waitFor';
3
- import { ErrorWithStack } from './helpers/errors';
4
-
5
- function isRemoved<T>(result: T): boolean {
6
- return !result || (Array.isArray(result) && !result.length);
7
- }
8
-
9
- export default async function waitForElementToBeRemoved<T>(
10
- expectation: () => T,
11
- options?: WaitForOptions
12
- ): Promise<T> {
13
- // Created here so we get a nice stacktrace
14
- const timeoutError = new ErrorWithStack(
15
- 'Timed out in waitForElementToBeRemoved.',
16
- waitForElementToBeRemoved
17
- );
18
-
19
- // Elements have to be present initally and then removed.
20
- const initialElements = expectation();
21
- if (isRemoved(initialElements)) {
22
- throw new ErrorWithStack(
23
- 'The element(s) given to waitForElementToBeRemoved are already removed. waitForElementToBeRemoved requires that the element(s) exist(s) before waiting for removal.',
24
- waitForElementToBeRemoved
25
- );
26
- }
27
-
28
- return waitFor(() => {
29
- let result;
30
- try {
31
- result = expectation();
32
- } catch (error) {
33
- return initialElements;
34
- }
35
-
36
- if (!isRemoved(result)) {
37
- throw timeoutError;
38
- }
39
-
40
- return initialElements;
41
- }, options);
42
- }
package/src/within.ts DELETED
@@ -1,30 +0,0 @@
1
- import type { ReactTestInstance } from 'react-test-renderer';
2
- import { bindByTextQueries } from './queries/text';
3
- import { bindByTestIdQueries } from './queries/testId';
4
- import { bindByDisplayValueQueries } from './queries/displayValue';
5
- import { bindByPlaceholderTextQueries } from './queries/placeholderText';
6
- import { bindByLabelTextQueries } from './queries/labelText';
7
- import { bindByHintTextQueries } from './queries/hintText';
8
- import { bindByRoleQueries } from './queries/role';
9
- import { bindByA11yStateQueries } from './queries/a11yState';
10
- import { bindByA11yValueQueries } from './queries/a11yValue';
11
- import { bindUnsafeByTypeQueries } from './queries/unsafeType';
12
- import { bindUnsafeByPropsQueries } from './queries/unsafeProps';
13
-
14
- export function within(instance: ReactTestInstance) {
15
- return {
16
- ...bindByTextQueries(instance),
17
- ...bindByTestIdQueries(instance),
18
- ...bindByDisplayValueQueries(instance),
19
- ...bindByPlaceholderTextQueries(instance),
20
- ...bindByLabelTextQueries(instance),
21
- ...bindByHintTextQueries(instance),
22
- ...bindByRoleQueries(instance),
23
- ...bindByA11yStateQueries(instance),
24
- ...bindByA11yValueQueries(instance),
25
- ...bindUnsafeByTypeQueries(instance),
26
- ...bindUnsafeByPropsQueries(instance),
27
- };
28
- }
29
-
30
- export const getQueriesForElement = within;
package/tsconfig.json DELETED
@@ -1,17 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "strict": true,
4
- "esModuleInterop": true,
5
- "allowSyntheticDefaultImports": true,
6
- "skipLibCheck": true,
7
- "jsx": "react",
8
- "target": "ES2020",
9
- "lib": ["ES2020", "DOM"],
10
- "module": "commonjs",
11
- "moduleResolution": "node",
12
- "declaration": true,
13
- "noEmit": true,
14
- "outDir": "build"
15
- },
16
- "include": ["src/**/*"]
17
- }
@@ -1,8 +0,0 @@
1
- {
2
- "extends": "./tsconfig.json",
3
- "compilerOptions": {
4
- "noEmit": false,
5
- "emitDeclarationOnly": true
6
- },
7
- "exclude": ["**/__tests__**"]
8
- }
@@ -1,20 +0,0 @@
1
- # Dependencies
2
- /node_modules
3
-
4
- # Production
5
- /build
6
-
7
- # Generated files
8
- .docusaurus
9
- .cache-loader
10
-
11
- # Misc
12
- .DS_Store
13
- .env.local
14
- .env.development.local
15
- .env.test.local
16
- .env.production.local
17
-
18
- npm-debug.log*
19
- yarn-debug.log*
20
- yarn-error.log*
package/website/README.md DELETED
@@ -1,33 +0,0 @@
1
- # Website
2
-
3
- This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
4
-
5
- ### Installation
6
-
7
- ```
8
- $ yarn
9
- ```
10
-
11
- ### Local Development
12
-
13
- ```
14
- $ yarn start
15
- ```
16
-
17
- This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
18
-
19
- ### Build
20
-
21
- ```
22
- $ yarn build
23
- ```
24
-
25
- This command generates static content into the `build` directory and can be served using any static contents hosting service.
26
-
27
- ### Deployment
28
-
29
- ```
30
- $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31
- ```
32
-
33
- If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
@@ -1,3 +0,0 @@
1
- */node_modules
2
- *.log
3
- .docusaurus
@@ -1,9 +0,0 @@
1
- FROM node:8.17.0
2
-
3
- WORKDIR /app/website
4
-
5
- EXPOSE 3000 35729
6
- COPY ./website /app/website
7
- RUN yarn install
8
-
9
- CMD ["yarn", "start"]
@@ -1,11 +0,0 @@
1
- version: '3'
2
-
3
- services:
4
- docusaurus:
5
- build: .
6
- ports:
7
- - 3000:3000
8
- - 35729:35729
9
- volumes:
10
- - ./website:/app/website
11
- working_dir: /app/website