[New] add componentDidCatch support, and simulateError

SUMMARY.md

@@ -65,6 +65,7 @@
     * [setState(nextState[, callback])](/docs/api/ShallowWrapper/setState.md)
     * [shallow([options])](/docs/api/ShallowWrapper/shallow.md)
     * [simulate(event[, data])](/docs/api/ShallowWrapper/simulate.md)
+    * [simulateError(error)](/docs/api/ShallowWrapper/simulateError.md)
     * [slice([begin[, end]])](/docs/api/ShallowWrapper/slice.md)
     * [some(selector)](/docs/api/ShallowWrapper/some.md)
     * [someWhere(predicate)](/docs/api/ShallowWrapper/someWhere.md)
@@ -121,6 +122,7 @@
     * [setProps(nextProps[, callback])](/docs/api/ReactWrapper/setProps.md)
     * [setState(nextState[, callback])](/docs/api/ReactWrapper/setState.md)
     * [simulate(event[, data])](/docs/api/ReactWrapper/simulate.md)
+    * [simulateError(error)](/docs/api/ReactWrapper/simulateError.md)
     * [slice([begin[, end]])](/docs/api/ReactWrapper/slice.md)
     * [some(selector)](/docs/api/ReactWrapper/some.md)
     * [someWhere(predicate)](/docs/api/ReactWrapper/someWhere.md)

docs/api/ReactWrapper/simulateError.md

@@ -0,0 +1,65 @@
+# `.simulateError(error) => Self`
+
+Simulate a component throwing an error as part of its rendering lifecycle.
+
+This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` lifecycle method).
+
+
+#### Arguments
+
+1. `error` (`Any`): The error to throw.
+
+
+
+#### Returns
+
+`ReactWrapper`: Returns itself.
+
+
+
+#### Example
+
+```jsx
+function Something() {
+  // this is just a placeholder
+  return null;
+}
+
+class ErrorBoundary extends React.Component {
+  componentDidCatch(error, info) {
+    const { spy } = this.props;
+    spy(error, info);
+  }
+
+  render() {
+    const { children } = this.props;
+    return (
+      <React.Fragment>
+        {children}
+      </React.Fragment>
+    );
+  }
+}
+ErrorBoundary.propTypes = {
+  children: PropTypes.node.isRequired,
+  spy: PropTypes.func.isRequired,
+};
+
+const spy = sinon.spy();
+const wrapper = mount(<ErrorBoundary spy={spy}><Something /></ErrorBoundary>);
+const error = new Error('hi!');
+wrapper.find(Something).simulateError(error);
+
+expect(spy).to.have.property('callCount', 1);
+expect(spy.args).to.deep.equal([
+  error,
+  {
+    componentStack: `
+    in Something (created by ErrorBoundary)
+    in ErrorBoundary (created by WrapperComponent)
+    in WrapperComponent`,
+  },
+]);
+```
+
+

docs/api/ShallowWrapper/simulateError.md

@@ -0,0 +1,65 @@
+# `.simulateError(error) => Self`
+
+Simulate a component throwing an error as part of its rendering lifecycle.
+
+This is particularly useful in combination with React 16 error boundaries (ie, the `componentDidCatch` lifecycle method).
+
+
+#### Arguments
+
+1. `error` (`Any`): The error to throw.
+
+
+
+#### Returns
+
+`ShallowWrapper`: Returns itself.
+
+
+
+#### Example
+
+```jsx
+function Something() {
+  // this is just a placeholder
+  return null;
+}
+
+class ErrorBoundary extends React.Component {
+  componentDidCatch(error, info) {
+    const { spy } = this.props;
+    spy(error, info);
+  }
+
+  render() {
+    const { children } = this.props;
+    return (
+      <React.Fragment>
+        {children}
+      </React.Fragment>
+    );
+  }
+}
+ErrorBoundary.propTypes = {
+  children: PropTypes.node.isRequired,
+  spy: PropTypes.func.isRequired,
+};
+
+const spy = sinon.spy();
+const wrapper = shallow(<ErrorBoundary spy={spy}><Something /></ErrorBoundary>);
+const error = new Error('hi!');
+wrapper.find(Something).simulateError(error);
+
+expect(spy).to.have.property('callCount', 1);
+expect(spy.args).to.deep.equal([
+  error,
+  {
+    componentStack: `
+    in Something (created by ErrorBoundary)
+    in ErrorBoundary (created by WrapperComponent)
+    in WrapperComponent`,
+  },
+]);
+```
+
+

packages/enzyme-adapter-react-16.1/src/ReactSixteenOneAdapter.js

@@ -27,6 +27,7 @@ import {
   createMountWrapper,
   propsWithKeysAndRef,
   ensureKeyOrUndefined,
+  simulateError,
 } from 'enzyme-adapter-utils';
 import { findCurrentFiberUsingSlowPath } from 'react-reconciler/reflection';
 
@@ -262,6 +263,19 @@ class ReactSixteenOneAdapter extends EnzymeAdapter {
       getNode() {
         return instance ? toTree(instance._reactInternalFiber).rendered : null;
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        const { instance: catchingInstance } = nodeHierarchy
+          .find(x => x.instance && x.instance.componentDidCatch) || {};
+
+        simulateError(
+          error,
+          catchingInstance,
+          rootNode,
+          nodeHierarchy,
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, mock) {
         const mappedEvent = mapNativeEventNames(event, eventOptions);
         const eventFn = TestUtils.Simulate[mappedEvent];
@@ -279,6 +293,7 @@ class ReactSixteenOneAdapter extends EnzymeAdapter {
   }
 
   createShallowRenderer(/* options */) {
+    const adapter = this;
     const renderer = new ShallowRenderer();
     let isDOM = false;
     let cachedNode = null;
@@ -327,6 +342,16 @@ class ReactSixteenOneAdapter extends EnzymeAdapter {
             : elementToTree(output),
         };
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        simulateError(
+          error,
+          renderer._instance,
+          cachedNode,
+          nodeHierarchy.concat(cachedNode),
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, ...args) {
         const handler = node.props[propFromEvent(event, eventOptions)];
         if (handler) {

packages/enzyme-adapter-react-16.2/src/ReactSixteenTwoAdapter.js

@@ -28,6 +28,7 @@ import {
   createMountWrapper,
   propsWithKeysAndRef,
   ensureKeyOrUndefined,
+  simulateError,
 } from 'enzyme-adapter-utils';
 import { findCurrentFiberUsingSlowPath } from 'react-reconciler/reflection';
 
@@ -264,6 +265,19 @@ class ReactSixteenTwoAdapter extends EnzymeAdapter {
       getNode() {
         return instance ? toTree(instance._reactInternalFiber).rendered : null;
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        const { instance: catchingInstance } = nodeHierarchy
+          .find(x => x.instance && x.instance.componentDidCatch) || {};
+
+        simulateError(
+          error,
+          catchingInstance,
+          rootNode,
+          nodeHierarchy,
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, mock) {
         const mappedEvent = mapNativeEventNames(event, eventOptions);
         const eventFn = TestUtils.Simulate[mappedEvent];
@@ -281,6 +295,7 @@ class ReactSixteenTwoAdapter extends EnzymeAdapter {
   }
 
   createShallowRenderer(/* options */) {
+    const adapter = this;
     const renderer = new ShallowRenderer();
     let isDOM = false;
     let cachedNode = null;
@@ -329,6 +344,16 @@ class ReactSixteenTwoAdapter extends EnzymeAdapter {
             : elementToTree(output),
         };
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        simulateError(
+          error,
+          renderer._instance,
+          cachedNode,
+          nodeHierarchy.concat(cachedNode),
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, ...args) {
         const handler = node.props[propFromEvent(event, eventOptions)];
         if (handler) {

packages/enzyme-adapter-react-16.3/src/ReactSixteenThreeAdapter.js

@@ -34,6 +34,7 @@ import {
   createMountWrapper,
   propsWithKeysAndRef,
   ensureKeyOrUndefined,
+  simulateError,
 } from 'enzyme-adapter-utils';
 import { findCurrentFiberUsingSlowPath } from 'react-reconciler/reflection';
 
@@ -283,6 +284,19 @@ class ReactSixteenThreeAdapter extends EnzymeAdapter {
       getNode() {
         return instance ? toTree(instance._reactInternalFiber).rendered : null;
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        const { instance: catchingInstance } = nodeHierarchy
+          .find(x => x.instance && x.instance.componentDidCatch) || {};
+
+        simulateError(
+          error,
+          catchingInstance,
+          rootNode,
+          nodeHierarchy,
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, mock) {
         const mappedEvent = mapNativeEventNames(event, eventOptions);
         const eventFn = TestUtils.Simulate[mappedEvent];
@@ -300,6 +314,7 @@ class ReactSixteenThreeAdapter extends EnzymeAdapter {
   }
 
   createShallowRenderer(/* options */) {
+    const adapter = this;
     const renderer = new ShallowRenderer();
     let isDOM = false;
     let cachedNode = null;
@@ -348,6 +363,16 @@ class ReactSixteenThreeAdapter extends EnzymeAdapter {
             : elementToTree(output),
         };
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        simulateError(
+          error,
+          renderer._instance,
+          cachedNode,
+          nodeHierarchy.concat(cachedNode),
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, ...args) {
         const handler = node.props[propFromEvent(event, eventOptions)];
         if (handler) {

packages/enzyme-adapter-react-16/src/ReactSixteenAdapter.js

@@ -35,6 +35,7 @@ import {
   createMountWrapper,
   propsWithKeysAndRef,
   ensureKeyOrUndefined,
+  simulateError,
 } from 'enzyme-adapter-utils';
 import findCurrentFiberUsingSlowPath from './findCurrentFiberUsingSlowPath';
 import detectFiberTags from './detectFiberTags';
@@ -284,6 +285,19 @@ class ReactSixteenAdapter extends EnzymeAdapter {
       getNode() {
         return instance ? toTree(instance._reactInternalFiber).rendered : null;
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        const { instance: catchingInstance } = nodeHierarchy
+          .find(x => x.instance && x.instance.componentDidCatch) || {};
+
+        simulateError(
+          error,
+          catchingInstance,
+          rootNode,
+          nodeHierarchy,
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, mock) {
         const mappedEvent = mapNativeEventNames(event, eventOptions);
         const eventFn = TestUtils.Simulate[mappedEvent];
@@ -300,6 +314,7 @@ class ReactSixteenAdapter extends EnzymeAdapter {
   }
 
   createShallowRenderer(/* options */) {
+    const adapter = this;
     const renderer = new ShallowRenderer();
     let isDOM = false;
     let cachedNode = null;
@@ -348,6 +363,16 @@ class ReactSixteenAdapter extends EnzymeAdapter {
             : elementToTree(output),
         };
       },
+      simulateError(nodeHierarchy, rootNode, error) {
+        simulateError(
+          error,
+          renderer._instance,
+          cachedNode,
+          nodeHierarchy.concat(cachedNode),
+          nodeTypeFromType,
+          adapter.displayNameOfNode,
+        );
+      },
       simulateEvent(node, event, ...args) {
         const handler = node.props[propFromEvent(event, eventOptions)];
         if (handler) {