pure.js 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. var _exportNames = {
  7. render: true,
  8. renderHook: true,
  9. cleanup: true,
  10. act: true,
  11. fireEvent: true
  12. };
  13. Object.defineProperty(exports, "act", {
  14. enumerable: true,
  15. get: function () {
  16. return _actCompat.default;
  17. }
  18. });
  19. exports.cleanup = cleanup;
  20. Object.defineProperty(exports, "fireEvent", {
  21. enumerable: true,
  22. get: function () {
  23. return _fireEvent.fireEvent;
  24. }
  25. });
  26. exports.render = render;
  27. exports.renderHook = renderHook;
  28. var React = _interopRequireWildcard(require("react"));
  29. var _reactDom = _interopRequireDefault(require("react-dom"));
  30. var ReactDOMClient = _interopRequireWildcard(require("react-dom/client"));
  31. var _dom = require("@testing-library/dom");
  32. Object.keys(_dom).forEach(function (key) {
  33. if (key === "default" || key === "__esModule") return;
  34. if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
  35. if (key in exports && exports[key] === _dom[key]) return;
  36. Object.defineProperty(exports, key, {
  37. enumerable: true,
  38. get: function () {
  39. return _dom[key];
  40. }
  41. });
  42. });
  43. var _actCompat = _interopRequireWildcard(require("./act-compat"));
  44. var _fireEvent = require("./fire-event");
  45. function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
  46. function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
  47. (0, _dom.configure)({
  48. unstable_advanceTimersWrapper: cb => {
  49. return (0, _actCompat.default)(cb);
  50. },
  51. // We just want to run `waitFor` without IS_REACT_ACT_ENVIRONMENT
  52. // But that's not necessarily how `asyncWrapper` is used since it's a public method.
  53. // Let's just hope nobody else is using it.
  54. asyncWrapper: async cb => {
  55. const previousActEnvironment = (0, _actCompat.getIsReactActEnvironment)();
  56. (0, _actCompat.setReactActEnvironment)(false);
  57. try {
  58. return await cb();
  59. } finally {
  60. (0, _actCompat.setReactActEnvironment)(previousActEnvironment);
  61. }
  62. },
  63. eventWrapper: cb => {
  64. let result;
  65. (0, _actCompat.default)(() => {
  66. result = cb();
  67. });
  68. return result;
  69. }
  70. }); // Ideally we'd just use a WeakMap where containers are keys and roots are values.
  71. // We use two variables so that we can bail out in constant time when we render with a new container (most common use case)
  72. /**
  73. * @type {Set<import('react-dom').Container>}
  74. */
  75. const mountedContainers = new Set();
  76. /**
  77. * @type Array<{container: import('react-dom').Container, root: ReturnType<typeof createConcurrentRoot>}>
  78. */
  79. const mountedRootEntries = [];
  80. function createConcurrentRoot(container, {
  81. hydrate,
  82. ui,
  83. wrapper: WrapperComponent
  84. }) {
  85. let root;
  86. if (hydrate) {
  87. (0, _actCompat.default)(() => {
  88. root = ReactDOMClient.hydrateRoot(container, WrapperComponent ? /*#__PURE__*/React.createElement(WrapperComponent, null, ui) : ui);
  89. });
  90. } else {
  91. root = ReactDOMClient.createRoot(container);
  92. }
  93. return {
  94. hydrate() {
  95. /* istanbul ignore if */
  96. if (!hydrate) {
  97. throw new Error('Attempted to hydrate a non-hydrateable root. This is a bug in `@testing-library/react`.');
  98. } // Nothing to do since hydration happens when creating the root object.
  99. },
  100. render(element) {
  101. root.render(element);
  102. },
  103. unmount() {
  104. root.unmount();
  105. }
  106. };
  107. }
  108. function createLegacyRoot(container) {
  109. return {
  110. hydrate(element) {
  111. _reactDom.default.hydrate(element, container);
  112. },
  113. render(element) {
  114. _reactDom.default.render(element, container);
  115. },
  116. unmount() {
  117. _reactDom.default.unmountComponentAtNode(container);
  118. }
  119. };
  120. }
  121. function renderRoot(ui, {
  122. baseElement,
  123. container,
  124. hydrate,
  125. queries,
  126. root,
  127. wrapper: WrapperComponent
  128. }) {
  129. const wrapUiIfNeeded = innerElement => WrapperComponent ? /*#__PURE__*/React.createElement(WrapperComponent, null, innerElement) : innerElement;
  130. (0, _actCompat.default)(() => {
  131. if (hydrate) {
  132. root.hydrate(wrapUiIfNeeded(ui), container);
  133. } else {
  134. root.render(wrapUiIfNeeded(ui), container);
  135. }
  136. });
  137. return {
  138. container,
  139. baseElement,
  140. debug: (el = baseElement, maxLength, options) => Array.isArray(el) ? // eslint-disable-next-line no-console
  141. el.forEach(e => console.log((0, _dom.prettyDOM)(e, maxLength, options))) : // eslint-disable-next-line no-console,
  142. console.log((0, _dom.prettyDOM)(el, maxLength, options)),
  143. unmount: () => {
  144. (0, _actCompat.default)(() => {
  145. root.unmount();
  146. });
  147. },
  148. rerender: rerenderUi => {
  149. renderRoot(wrapUiIfNeeded(rerenderUi), {
  150. container,
  151. baseElement,
  152. root
  153. }); // Intentionally do not return anything to avoid unnecessarily complicating the API.
  154. // folks can use all the same utilities we return in the first place that are bound to the container
  155. },
  156. asFragment: () => {
  157. /* istanbul ignore else (old jsdom limitation) */
  158. if (typeof document.createRange === 'function') {
  159. return document.createRange().createContextualFragment(container.innerHTML);
  160. } else {
  161. const template = document.createElement('template');
  162. template.innerHTML = container.innerHTML;
  163. return template.content;
  164. }
  165. },
  166. ...(0, _dom.getQueriesForElement)(baseElement, queries)
  167. };
  168. }
  169. function render(ui, {
  170. container,
  171. baseElement = container,
  172. legacyRoot = false,
  173. queries,
  174. hydrate = false,
  175. wrapper
  176. } = {}) {
  177. if (!baseElement) {
  178. // default to document.body instead of documentElement to avoid output of potentially-large
  179. // head elements (such as JSS style blocks) in debug output
  180. baseElement = document.body;
  181. }
  182. if (!container) {
  183. container = baseElement.appendChild(document.createElement('div'));
  184. }
  185. let root; // eslint-disable-next-line no-negated-condition -- we want to map the evolution of this over time. The root is created first. Only later is it re-used so we don't want to read the case that happens later first.
  186. if (!mountedContainers.has(container)) {
  187. const createRootImpl = legacyRoot ? createLegacyRoot : createConcurrentRoot;
  188. root = createRootImpl(container, {
  189. hydrate,
  190. ui,
  191. wrapper
  192. });
  193. mountedRootEntries.push({
  194. container,
  195. root
  196. }); // we'll add it to the mounted containers regardless of whether it's actually
  197. // added to document.body so the cleanup method works regardless of whether
  198. // they're passing us a custom container or not.
  199. mountedContainers.add(container);
  200. } else {
  201. mountedRootEntries.forEach(rootEntry => {
  202. // Else is unreachable since `mountedContainers` has the `container`.
  203. // Only reachable if one would accidentally add the container to `mountedContainers` but not the root to `mountedRootEntries`
  204. /* istanbul ignore else */
  205. if (rootEntry.container === container) {
  206. root = rootEntry.root;
  207. }
  208. });
  209. }
  210. return renderRoot(ui, {
  211. container,
  212. baseElement,
  213. queries,
  214. hydrate,
  215. wrapper,
  216. root
  217. });
  218. }
  219. function cleanup() {
  220. mountedRootEntries.forEach(({
  221. root,
  222. container
  223. }) => {
  224. (0, _actCompat.default)(() => {
  225. root.unmount();
  226. });
  227. if (container.parentNode === document.body) {
  228. document.body.removeChild(container);
  229. }
  230. });
  231. mountedRootEntries.length = 0;
  232. mountedContainers.clear();
  233. }
  234. function renderHook(renderCallback, options = {}) {
  235. const {
  236. initialProps,
  237. ...renderOptions
  238. } = options;
  239. const result = /*#__PURE__*/React.createRef();
  240. function TestComponent({
  241. renderCallbackProps
  242. }) {
  243. const pendingResult = renderCallback(renderCallbackProps);
  244. React.useEffect(() => {
  245. result.current = pendingResult;
  246. });
  247. return null;
  248. }
  249. const {
  250. rerender: baseRerender,
  251. unmount
  252. } = render( /*#__PURE__*/React.createElement(TestComponent, {
  253. renderCallbackProps: initialProps
  254. }), renderOptions);
  255. function rerender(rerenderCallbackProps) {
  256. return baseRerender( /*#__PURE__*/React.createElement(TestComponent, {
  257. renderCallbackProps: rerenderCallbackProps
  258. }));
  259. }
  260. return {
  261. result,
  262. rerender,
  263. unmount
  264. };
  265. } // just re-export everything from dom-testing-library
  266. /* eslint func-name-matching:0 */