refactor: add util function to normalize node argument (#3998)

* refactor: add util function to normalize node argument * refactor code * update name and return * rename
dequelabs · May 12, 2023 · 4f18976 · 4f18976
1 parent ca28301
commit 4f18976
Show file tree

Hide file tree

Showing 25 changed files with 129 additions and 125 deletions.
diff --git a/lib/commons/aria/arialabel-text.js b/lib/commons/aria/arialabel-text.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Get the text value of aria-label, if any
@@ -8,14 +7,11 @@ import { getNodeFromTree } from '../../core/utils';
  * @param {VirtualNode|Element} element
  * @return {string} ARIA label
  */
-function arialabelText(vNode) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    if (vNode.nodeType !== 1) {
-      return '';
-    }
-    vNode = getNodeFromTree(vNode);
+export default function arialabelText(element) {
+  const { vNode } = nodeLookup(element);
+  if (vNode?.props.nodeType !== 1) {
+    return '';
   }
+
   return vNode.attr('aria-label') || '';
 }
-
-export default arialabelText;
diff --git a/lib/commons/aria/arialabelledby-text.js b/lib/commons/aria/arialabelledby-text.js
@@ -1,26 +1,23 @@
 import idrefs from '../dom/idrefs';
 import accessibleText from '../text/accessible-text';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Get the accessible name based on aria-labelledby
  *
  * @deprecated Do not use Element directly. Pass VirtualNode instead
- * @param {VirtualNode} element
+ * @param {VirtualNode|Element} element
  * @param {Object} context
  * @property {Bool} inLabelledByContext Whether or not the lookup is part of aria-labelledby reference
  * @property {Bool} inControlContext Whether or not the lookup is part of a native label reference
  * @property {Element} startNode First node in accessible name computation
  * @property {Bool} debug Enable logging for formControlValue
  * @return {string} Concatenated text value for referenced elements
  */
-function arialabelledbyText(vNode, context = {}) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    if (vNode.nodeType !== 1) {
-      return '';
-    }
-    vNode = getNodeFromTree(vNode);
+function arialabelledbyText(element, context = {}) {
+  const { vNode } = nodeLookup(element);
+  if (vNode?.props.nodeType !== 1) {
+    return '';
   }
 
   /**

diff --git a/lib/commons/aria/get-element-unallowed-roles.js b/lib/commons/aria/get-element-unallowed-roles.js
@@ -2,8 +2,7 @@ import isValidRole from './is-valid-role';
 import getImplicitRole from './implicit-role';
 import getRoleType from './get-role-type';
 import isAriaRoleAllowedOnElement from './is-aria-role-allowed-on-element';
-import { tokenList, isHtmlElement, getNodeFromTree } from '../../core/utils';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
+import { tokenList, isHtmlElement, nodeLookup } from '../../core/utils';
 
 // dpub roles which are subclassing roles that are implicit on some native
 // HTML elements (img, link, etc.)
@@ -54,8 +53,7 @@ function getRoleSegments(vNode) {
  * @return {Array<String>} retruns an array of roles that are not allowed on the given node
  */
 function getElementUnallowedRoles(node, allowImplicit = true) {
-  const vNode =
-    node instanceof AbstractVirtualNode ? node : getNodeFromTree(node);
+  const { vNode } = nodeLookup(node);
   // by pass custom elements
   if (!isHtmlElement(vNode)) {
     return [];

diff --git a/lib/commons/aria/get-role.js b/lib/commons/aria/get-role.js
@@ -2,8 +2,7 @@ import getExplicitRole from './get-explicit-role';
 import getImplicitRole from './implicit-role';
 import getGlobalAriaAttrs from '../standards/get-global-aria-attrs';
 import isFocusable from '../dom/is-focusable';
-import { getNodeFromTree } from '../../core/utils';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
+import { nodeLookup } from '../../core/utils';
 
 // when an element inherits the presentational role from a parent
 // is not defined in the spec, but through testing it seems to be
@@ -125,8 +124,7 @@ function hasConflictResolution(vNode) {
  * @deprecated noImplicit option is deprecated. Use aria.getExplicitRole instead.
  */
 function resolveRole(node, { noImplicit, ...roleOptions } = {}) {
-  const vNode =
-    node instanceof AbstractVirtualNode ? node : getNodeFromTree(node);
+  const { vNode } = nodeLookup(node);
   if (vNode.props.nodeType !== 1) {
     return null;
   }

diff --git a/lib/commons/dom/focus-disabled.js b/lib/commons/dom/focus-disabled.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 import isHiddenForEveryone from './is-hidden-for-everyone';
 import isInert from './is-inert';
 
@@ -26,7 +25,7 @@ function isDisabledAttrAllowed(nodeName) {
  * @return {Boolean} Whether focusing has been disabled on an element.
  */
 function focusDisabled(el) {
-  const vNode = el instanceof AbstractVirtualNode ? el : getNodeFromTree(el);
+  const { vNode } = nodeLookup(el);
 
   if (
     (isDisabledAttrAllowed(vNode.props.nodeName) &&

diff --git a/lib/commons/dom/is-focusable.js b/lib/commons/dom/is-focusable.js
@@ -1,7 +1,6 @@
 import focusDisabled from './focus-disabled';
 import isNativelyFocusable from './is-natively-focusable';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Determines if an element is keyboard or programmatically focusable.
@@ -12,7 +11,7 @@ import { getNodeFromTree } from '../../core/utils';
  * @return {Boolean} The element's focusability status
  */
 export default function isFocusable(el) {
-  const vNode = el instanceof AbstractVirtualNode ? el : getNodeFromTree(el);
+  const { vNode } = nodeLookup(el);
 
   if (vNode.props.nodeType !== 1) {
     return false;

diff --git a/lib/commons/dom/is-hidden-for-everyone.js b/lib/commons/dom/is-hidden-for-everyone.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 import memoize from '../../core/utils/memoize';
 import {
   nativelyHidden,
@@ -30,7 +29,7 @@ export default function isHiddenForEveryone(
   vNode,
   { skipAncestors, isAncestor = false } = {}
 ) {
-  vNode = vNode instanceof AbstractVirtualNode ? vNode : getNodeFromTree(vNode);
+  vNode = nodeLookup(vNode).vNode;
 
   if (skipAncestors) {
     return isHiddenSelf(vNode, isAncestor);

diff --git a/lib/commons/dom/is-hidden-with-css.js b/lib/commons/dom/is-hidden-with-css.js
@@ -1,6 +1,5 @@
 import getComposedParent from './get-composed-parent';
-import { getNodeFromTree } from '../../core/utils';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Determine whether an element is hidden based on css
@@ -12,17 +11,18 @@ import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-n
  * @return {Boolean} the element's hidden status
  * @deprecated use isHiddenForEveryone
  */
-function isHiddenWithCSS(node, descendentVisibilityValue) {
-  const vNode =
-    node instanceof AbstractVirtualNode ? node : getNodeFromTree(node);
-  const el = node instanceof window.Node ? node : vNode?.actualNode;
+function isHiddenWithCSS(el, descendentVisibilityValue) {
+  const { vNode, domNode } = nodeLookup(el);
 
   if (!vNode) {
-    return _isHiddenWithCSS(el, descendentVisibilityValue);
+    return _isHiddenWithCSS(domNode, descendentVisibilityValue);
   }
 
   if (vNode._isHiddenWithCSS === void 0) {
-    vNode._isHiddenWithCSS = _isHiddenWithCSS(el, descendentVisibilityValue);
+    vNode._isHiddenWithCSS = _isHiddenWithCSS(
+      domNode,
+      descendentVisibilityValue
+    );
   }
 
   return vNode._isHiddenWithCSS;

diff --git a/lib/commons/dom/is-in-tab-order.js b/lib/commons/dom/is-in-tab-order.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 import isFocusable from './is-focusable';
 
 /**
@@ -11,7 +10,7 @@ import isFocusable from './is-focusable';
  * @return {Boolean} The element's tabindex status
  */
 export default function isInTabOrder(el) {
-  const vNode = el instanceof AbstractVirtualNode ? el : getNodeFromTree(el);
+  const { vNode } = nodeLookup(el);
 
   if (vNode.props.nodeType !== 1) {
     return false;

diff --git a/lib/commons/dom/is-natively-focusable.js b/lib/commons/dom/is-natively-focusable.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree, querySelectorAll } from '../../core/utils';
+import { nodeLookup, querySelectorAll } from '../../core/utils';
 import focusDisabled from './focus-disabled';
 
 /**
@@ -12,7 +11,7 @@ import focusDisabled from './focus-disabled';
  * if its tabindex were removed. Else, false.
  */
 function isNativelyFocusable(el) {
-  const vNode = el instanceof AbstractVirtualNode ? el : getNodeFromTree(el);
+  const { vNode } = nodeLookup(el);
 
   if (!vNode || focusDisabled(vNode)) {
     return false;

diff --git a/lib/commons/dom/is-offscreen.js b/lib/commons/dom/is-offscreen.js
@@ -1,7 +1,7 @@
 import getComposedParent from './get-composed-parent';
 import getElementCoordinates from './get-element-coordinates';
 import getViewportSize from './get-viewport-size';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
+import { nodeLookup } from '../../core/utils';
 
 function noParentScrolled(element, offset) {
   element = getComposedParent(element);
@@ -32,25 +32,23 @@ function isOffscreen(element, { isAncestor } = {}) {
     return false;
   }
 
-  element =
-    element instanceof AbstractVirtualNode ? element.actualNode : element;
-
-  if (!element) {
+  const { domNode } = nodeLookup(element);
+  if (!domNode) {
     return undefined;
   }
 
   let leftBoundary;
   const docElement = document.documentElement;
-  const styl = window.getComputedStyle(element);
+  const styl = window.getComputedStyle(domNode);
   const dir = window
     .getComputedStyle(document.body || docElement)
     .getPropertyValue('direction');
-  const coords = getElementCoordinates(element);
+  const coords = getElementCoordinates(domNode);
 
   // bottom edge beyond
   if (
     coords.bottom < 0 &&
-    (noParentScrolled(element, coords.bottom) || styl.position === 'absolute')
+    (noParentScrolled(domNode, coords.bottom) || styl.position === 'absolute')
   ) {
     return true;
   }

diff --git a/lib/commons/dom/is-visible-on-screen.js b/lib/commons/dom/is-visible-on-screen.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 import memoize from '../../core/utils/memoize';
 import isHiddenForEveryone from './is-hidden-for-everyone';
 import {
@@ -27,7 +26,7 @@ const hiddenMethods = [
  * @return {Boolean} True if the element is visible on screen
  */
 export default function isVisibleOnScreen(vNode) {
-  vNode = vNode instanceof AbstractVirtualNode ? vNode : getNodeFromTree(vNode);
+  vNode = nodeLookup(vNode).vNode;
   return isVisibleOnScreenVirtual(vNode);
 }
 

diff --git a/lib/commons/dom/is-visible-to-screenreader.js b/lib/commons/dom/is-visible-to-screenreader.js
@@ -1,5 +1,4 @@
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 import memoize from '../../core/utils/memoize';
 import isHiddenForEveryone from './is-hidden-for-everyone';
 import { ariaHidden, areaHidden } from './visibility-methods';
@@ -13,7 +12,7 @@ import isInert from './is-inert';
  * @return {Boolean} True if the element is visible to a screen reader
  */
 export default function isVisibleToScreenReaders(vNode) {
-  vNode = vNode instanceof AbstractVirtualNode ? vNode : getNodeFromTree(vNode);
+  vNode = nodeLookup(vNode).vNode;
   return isVisibleToScreenReadersVirtual(vNode);
 }
 

diff --git a/lib/commons/dom/is-visual-content.js b/lib/commons/dom/is-visual-content.js
@@ -1,5 +1,4 @@
-import { getNodeFromTree } from '../../core/utils';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
+import { nodeLookup } from '../../core/utils';
 
 const visualRoles = [
   'checkbox',
@@ -22,7 +21,7 @@ const visualRoles = [
  * @return {Boolean}
  */
 function isVisualContent(el) {
-  const vNode = el instanceof AbstractVirtualNode ? el : getNodeFromTree(el);
+  const { vNode } = nodeLookup(el);
   const role = axe.commons.aria.getExplicitRole(vNode);
   if (role) {
     return visualRoles.indexOf(role) !== -1;

diff --git a/lib/commons/matches/attributes.js b/lib/commons/matches/attributes.js
@@ -1,6 +1,5 @@
 import fromFunction from './from-function';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Check if a virtual node matches some attribute(s)
@@ -23,9 +22,7 @@ import { getNodeFromTree } from '../../core/utils';
  * @returns {Boolean}
  */
 function attributes(vNode, matcher) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    vNode = getNodeFromTree(vNode);
-  }
+  vNode = nodeLookup(vNode).vNode;
   return fromFunction(attrName => vNode.attr(attrName), matcher);
 }
 

diff --git a/lib/commons/matches/from-definition.js b/lib/commons/matches/from-definition.js
@@ -6,8 +6,7 @@ import implicitRole from './implicit-role';
 import nodeName from './node-name';
 import properties from './properties';
 import semanticRole from './semantic-role';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree, matches } from '../../core/utils';
+import { nodeLookup, matches } from '../../core/utils';
 
 const matchers = {
   hasAccessibleName,
@@ -44,9 +43,7 @@ const matchers = {
  * @returns {Boolean}
  */
 function fromDefinition(vNode, definition) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    vNode = getNodeFromTree(vNode);
-  }
+  vNode = nodeLookup(vNode).vNode;
 
   if (Array.isArray(definition)) {
     return definition.some(definitionItem =>

diff --git a/lib/commons/matches/node-name.js b/lib/commons/matches/node-name.js
@@ -1,6 +1,5 @@
 import fromPrimative from './from-primative';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Check if the nodeName of a virtual node matches some value.
@@ -20,9 +19,7 @@ import { getNodeFromTree } from '../../core/utils';
  * @returns {Boolean}
  */
 function nodeName(vNode, matcher) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    vNode = getNodeFromTree(vNode);
-  }
+  vNode = nodeLookup(vNode).vNode;
   return fromPrimative(vNode.props.nodeName, matcher);
 }
 

diff --git a/lib/commons/matches/properties.js b/lib/commons/matches/properties.js
@@ -1,6 +1,5 @@
 import fromFunction from './from-function';
-import AbstractVirtualNode from '../../core/base/virtual-node/abstract-virtual-node';
-import { getNodeFromTree } from '../../core/utils';
+import { nodeLookup } from '../../core/utils';
 
 /**
  * Check if a virtual node matches some attribute(s)
@@ -23,9 +22,7 @@ import { getNodeFromTree } from '../../core/utils';
  * @returns {Boolean}
  */
 function properties(vNode, matcher) {
-  if (!(vNode instanceof AbstractVirtualNode)) {
-    vNode = getNodeFromTree(vNode);
-  }
+  vNode = nodeLookup(vNode).vNode;
   return fromFunction(propName => vNode.props[propName], matcher);
 }