refactor: checks

Author: mdjastrzebski

src/fire-event.ts

@@ -6,7 +6,7 @@ import {
   ScrollViewProps,
 } from 'react-native';
 import act from './act';
-import { isHostElement } from './helpers/component-tree';
+import { isValidElement } from './helpers/component-tree';
 import { isHostScrollView, isHostTextInput } from './helpers/host-component-names';
 import { isPointerEventEnabled } from './helpers/pointer-events';
 import { isTextInputEditable } from './helpers/text-input';
@@ -18,7 +18,7 @@ import { EventBuilder } from './user-event/event-builder';
 type EventHandler = (...args: unknown[]) => unknown;
 
 export function isTouchResponder(element: HostElement) {
-  if (!isHostElement(element)) {
+  if (!isValidElement(element)) {
     return false;
   }
 

src/helpers/__tests__/component-tree.test.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import { View } from 'react-native';
 import { render, screen } from '../..';
-import { getHostSiblings, getUnsafeRootElement } from '../component-tree';
+import { getHostSiblings, getRootElement } from '../component-tree';
 
 function MultipleHostChildren() {
   return (
@@ -46,6 +46,6 @@ describe('getUnsafeRootElement()', () => {
     );
 
     const view = screen.getByTestId('view');
-    expect(getUnsafeRootElement(view)).toEqual(screen.UNSAFE_root);
+    expect(getRootElement(view)).toEqual(screen.UNSAFE_root);
   });
 });

src/helpers/accessibility.ts

@@ -6,7 +6,7 @@ import {
   StyleSheet,
 } from 'react-native';
 import { HostElement } from '../renderer/host-element';
-import { getHostSiblings, getUnsafeRootElement } from './component-tree';
+import { getHostSiblings, getRootElement } from './component-tree';
 import {
   getHostComponentNames,
   isHostImage,
@@ -253,7 +253,7 @@ export function computeAccessibleName(element: HostElement): string | undefined
 
   const labelElementId = computeAriaLabelledBy(element);
   if (labelElementId) {
-    const rootElement = getUnsafeRootElement(element);
+    const rootElement = getRootElement(element);
     const labelElement = findAllByProps(rootElement, { nativeID: labelElementId });
     if (labelElement.length > 0) {
       return getTextContent(labelElement[0]);

src/helpers/component-tree.ts

@@ -4,34 +4,34 @@ import { HostElement } from '../renderer/host-element';
  * Checks if the given element is a host element.
  * @param element The element to check.
  */
-export function isHostElement(element?: HostElement | null): element is HostElement {
+export function isValidElement(element?: HostElement | null): element is HostElement {
   return typeof element?.type === 'string' && element.type !== 'CONTAINER';
 }
 
-/**
- * Returns host siblings for given element.
- * @param element The element start traversing from.
- */
-export function getHostSiblings(element: HostElement | null): HostElement[] {
-  const hostParent = element?.parent ?? null;
-  return (
-    hostParent?.children.filter(
-      (sibling): sibling is HostElement => typeof sibling === 'object' && sibling !== element,
-    ) ?? []
-  );
-}
-
 /**
  * Returns the unsafe root element of the tree (probably composite).
  *
  * @param element The element start traversing from.
  * @returns The root element of the tree (host or composite).
  */
-export function getUnsafeRootElement(element: HostElement) {
+export function getRootElement(element: HostElement) {
   let current: HostElement | null = element;
   while (current?.parent) {
     current = current.parent;
   }
 
   return current;
 }
+
+/**
+ * Returns host siblings for given element.
+ * @param element The element start traversing from.
+ */
+export function getHostSiblings(element: HostElement | null): HostElement[] {
+  const hostParent = element?.parent ?? null;
+  return (
+    hostParent?.children.filter(
+      (sibling): sibling is HostElement => typeof sibling === 'object' && sibling !== element,
+    ) ?? []
+  );
+}

src/helpers/find-all.ts

@@ -1,7 +1,7 @@
 import { getConfig } from '../config';
 import { HostElement } from '../renderer/host-element';
 import { isHiddenFromAccessibility } from './accessibility';
-import { isHostElement } from './component-tree';
+import { isValidElement } from './component-tree';
 
 interface FindAllOptions {
   /** Match elements hidden from accessibility */
@@ -56,7 +56,7 @@ function findAllInternal(
   if (
     // When matchDeepestOnly = true: add current element only if no descendants match
     (!options?.matchDeepestOnly || matchingDescendants.length === 0) &&
-    isHostElement(node) &&
+    isValidElement(node) &&
     predicate(node)
   ) {
     results.push(node);

src/matchers/to-be-on-the-screen.tsx

@@ -1,5 +1,5 @@
 import { matcherHint, RECEIVED_COLOR } from 'jest-matcher-utils';
-import { getUnsafeRootElement } from '../helpers/component-tree';
+import { getRootElement } from '../helpers/component-tree';
 import { HostElement } from '../renderer/host-element';
 import { screen } from '../screen';
 import { checkHostElement, formatElement } from './utils';
@@ -9,7 +9,7 @@ export function toBeOnTheScreen(this: jest.MatcherContext, element: HostElement)
     checkHostElement(element, toBeOnTheScreen, this);
   }
 
-  const pass = element === null ? false : screen.UNSAFE_root === getUnsafeRootElement(element);
+  const pass = element === null ? false : screen.UNSAFE_root === getRootElement(element);
 
   const errorFound = () => {
     return `expected element tree not to contain element, but found\n${formatElement(element)}`;

src/matchers/utils.tsx

@@ -8,7 +8,7 @@ import {
 } from 'jest-matcher-utils';
 import prettyFormat, { plugins } from 'pretty-format';
 import redent from 'redent';
-import { isHostElement } from '../helpers/component-tree';
+import { isValidElement } from '../helpers/component-tree';
 import { defaultMapProps } from '../helpers/format-default';
 import { HostElement, HostNode } from '../renderer/host-element';
 
@@ -50,7 +50,7 @@ export function checkHostElement(
   matcherFn: jest.CustomMatcher,
   context: jest.MatcherContext,
 ): asserts element is HostElement {
-  if (!isHostElement(element)) {
+  if (!isValidElement(element)) {
     throw new HostElementTypeError(element, matcherFn, context);
   }
 }