feat: export within helper from library

Author: bcarroll22

src/__tests__/queries.find.js

@@ -120,7 +120,7 @@ test('find rejects when something cannot be found', async () => {
 });
 
 test('actually works with async code', async () => {
-  const { findByTestId, rerender, container } = render(<View />);
+  const { findByTestId, rerender } = render(<View />);
   setTimeout(() => rerender(<Text testID="text">correct tree</Text>), 20);
-  await expect(findByTestId('text', {}, { container })).resolves.toBeTruthy();
+  await expect(findByTestId('text', {})).resolves.toBeTruthy();
 });

src/__tests__/wait-for-element.js

@@ -13,8 +13,8 @@ test('waits for element to appear in the document', async () => {
 });
 
 test('waits for element to appear in a specified container', async () => {
-  const { rerender, container, getByTestId } = render(<View />);
-  const promise = waitForElement(() => getByTestId('test'), { container });
+  const { rerender, getByTestId } = render(<View />);
+  const promise = waitForElement(() => getByTestId('test'));
   setTimeout(() => rerender(<View testID="test" />));
   const element = await promise;
   expect(element).toBeTruthy();
@@ -44,7 +44,7 @@ test('can specify our own timeout time', async () => {
 });
 
 test('throws last thrown error', async () => {
-  const { rerender, container } = render(<View />);
+  const { rerender } = render(<View />);
   let error;
   setTimeout(() => {
     error = new Error('first error');
@@ -58,14 +58,14 @@ test('throws last thrown error', async () => {
     () => {
       throw error;
     },
-    { container, timeout: 50 },
+    { timeout: 50 },
   );
   await expect(promise).rejects.toThrow(error);
 });
 
 test('waits until callback does not return null', async () => {
-  const { rerender, container, queryByTestId } = render(<View />);
-  const promise = waitForElement(() => queryByTestId('text'), { container });
+  const { rerender, queryByTestId } = render(<View />);
+  const promise = waitForElement(() => queryByTestId('text'));
   rerender(<View testID="text" />);
   const element = await promise;
   expect(element).toBeTruthy();

src/__tests__/within.js

@@ -0,0 +1,16 @@
+import React from 'react';
+import { Button, View } from 'react-native';
+
+import { render, within } from '../';
+
+test('it works when scoping to a smaller set of elements', () => {
+  const { getByTestId } = render(
+    <View>
+      <View testID="filter-box">
+        <Button testID="search-button" onPress={jest.fn()} title="press me" />
+      </View>
+    </View>,
+  );
+
+  within(getByTestId('filter-box')).getByTestId('search-button');
+});

src/get-queries-for-element.js

@@ -8,4 +8,4 @@ function getQueriesForElement(container, queries = defaultQueries) {
   }, {});
 }
 
-export { getQueriesForElement };
+export { getQueriesForElement, getQueriesForElement as within };

src/queries.js

@@ -5,6 +5,7 @@ import { getNodeText } from './get-node-text';
 import { waitForElement } from './wait-for-element';
 import { fuzzyMatches, makeNormalizer, matches } from './matches';
 import {
+  getBaseElement,
   getElementError,
   firstResultOrNull,
   queryAllByProp,
@@ -175,7 +176,7 @@ function queryAllByText(
   text,
   { types = ['Text', 'TextInput'], exact = true, collapseWhitespace, trim, normalizer } = {},
 ) {
-  const baseElement = container.root;
+  const baseElement = getBaseElement(container);
   const matcher = exact ? matches : fuzzyMatches;
   const matchNormalizer = makeNormalizer({ collapseWhitespace, trim, normalizer });
 
@@ -187,7 +188,7 @@ function queryAllByText(
     [],
   );
 
-  return [...baseArray]
+  return baseArray
     .filter(node => matcher(getNodeText(node), node, text, matchNormalizer))
     .map(removeBadProperties);
 }
@@ -202,11 +203,8 @@ function queryByText(...args) {
  |--------------------------------------------------------------------------
  */
 function makeFinder(getter) {
-  return (testContainer, text, options, waitForElementOptions) =>
-    waitForElement(
-      (container = testContainer) => getter(container, text, options),
-      waitForElementOptions,
-    );
+  return (container, text, options, waitForElementOptions) =>
+    waitForElement(() => getter(container, text, options), waitForElementOptions);
 }
 
 /*

src/query-helpers.js

@@ -38,6 +38,10 @@ function defaultFilter(node) {
   return mockedTypes.includes(node.type);
 }
 
+function getBaseElement(container) {
+  return container.root ? container.root : container;
+}
+
 function removeBadProperties(node) {
   // We take the guiding principles seriously around these parts. These methods just let
   // you do too much unfortunately, and they make it hard to follow the rules of the
@@ -65,7 +69,7 @@ function queryAllByProp(
   match,
   { filter, exact = true, collapseWhitespace, trim, normalizer } = {},
 ) {
-  const baseElement = container.root;
+  const baseElement = getBaseElement(container);
   const matcher = exact ? matches : fuzzyMatches;
   const matchNormalizer = makeNormalizer({ collapseWhitespace, trim, normalizer });
   const allNodes = Array.from(baseElement.findAll(c => c.props[attribute]));
@@ -86,6 +90,7 @@ function queryByProp(...args) {
 
 export {
   defaultFilter,
+  getBaseElement,
   getElementError,
   firstResultOrNull,
   filterNodeByType,

src/wait-for-element-to-be-removed.js

@@ -1,7 +1,7 @@
 import { getConfig } from './config';
 import { getSetImmediate } from './helpers';
 
-function waitForElementToBeRemoved(callback, { container, interval = 50, timeout = 4500 } = {}) {
+function waitForElementToBeRemoved(callback, { interval = 50, timeout = 4500 } = {}) {
   return new Promise((resolve, reject) => {
     if (typeof callback !== 'function') {
       reject(new Error('waitForElementToBeRemoved requires a callback as the first parameter'));
@@ -12,7 +12,7 @@ function waitForElementToBeRemoved(callback, { container, interval = 50, timeout
 
     // Check if the element is not present
     /* istanbul ignore next */
-    const result = container ? callback(container) : callback();
+    const result = callback();
     if (!result || (Array.isArray(result) && !result.length)) {
       onDone(
         new Error(
@@ -38,7 +38,7 @@ function waitForElementToBeRemoved(callback, { container, interval = 50, timeout
     function onMutation() {
       try {
         /* istanbul ignore next */
-        const result = container ? callback(container) : callback();
+        const result = callback();
         if (!result || (Array.isArray(result) && !result.length)) {
           onDone(null, true);
         } else {

src/wait-for-element.js

@@ -1,7 +1,7 @@
 import { getConfig } from './config';
 import { getSetImmediate } from './helpers';
 
-function waitForElement(callback, { container, interval = 50, timeout = 4500 } = {}) {
+function waitForElement(callback, { interval = 50, timeout = 4500 } = {}) {
   return new Promise((resolve, reject) => {
     if (typeof callback !== 'function') {
       reject(new Error('waitForElement requires a callback as the first parameter'));
@@ -23,7 +23,7 @@ function waitForElement(callback, { container, interval = 50, timeout = 4500 } =
 
     function onMutation() {
       try {
-        const result = container ? callback(container) : callback();
+        const result = callback();
         if (result) {
           onDone(null, result);
         }