Merge pull request #1139 from koba04/fix-prev-context-arg-of-cdu

Fix componentDidUpdate no longer receives prevContext on React v16
enzymejs · Sep 26, 2017 · 92da2b3 · 92da2b3
2 parents 8cf9661 + a08df67
commit 92da2b3
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 9 deletions.
diff --git a/packages/enzyme-adapter-react-13/src/ReactThirteenAdapter.js b/packages/enzyme-adapter-react-13/src/ReactThirteenAdapter.js
@@ -96,6 +96,13 @@ function instanceToTree(inst) {
 }
 
 class ReactThirteenAdapter extends EnzymeAdapter {
+  constructor() {
+    super();
+    this.options = {
+      ...this.options,
+      supportPrevContextArgumentOfComponentDidUpdate: true,
+    };
+  }
   createMountRenderer(options) {
     assertDomAvailable('mount');
     const domNode = options.attachTo || global.document.createElement('div');

diff --git a/packages/enzyme-adapter-react-14/src/ReactFourteenAdapter.js b/packages/enzyme-adapter-react-14/src/ReactFourteenAdapter.js
@@ -68,6 +68,13 @@ function instanceToTree(inst) {
 }
 
 class ReactFifteenAdapter extends EnzymeAdapter {
+  constructor() {
+    super();
+    this.options = {
+      ...this.options,
+      supportPrevContextArgumentOfComponentDidUpdate: true,
+    };
+  }
   createMountRenderer(options) {
     assertDomAvailable('mount');
     const domNode = options.attachTo || global.document.createElement('div');

diff --git a/packages/enzyme-adapter-react-15.4/src/ReactFifteenFourAdapter.js b/packages/enzyme-adapter-react-15.4/src/ReactFifteenFourAdapter.js
@@ -98,6 +98,13 @@ function instanceToTree(inst) {
 }
 
 class ReactFifteenFourAdapter extends EnzymeAdapter {
+  constructor() {
+    super();
+    this.options = {
+      ...this.options,
+      supportPrevContextArgumentOfComponentDidUpdate: true,
+    };
+  }
   createMountRenderer(options) {
     assertDomAvailable('mount');
     const domNode = options.attachTo || global.document.createElement('div');

diff --git a/packages/enzyme-adapter-react-15/src/ReactFifteenAdapter.js b/packages/enzyme-adapter-react-15/src/ReactFifteenAdapter.js
@@ -98,6 +98,13 @@ function instanceToTree(inst) {
 }
 
 class ReactFifteenAdapter extends EnzymeAdapter {
+  constructor() {
+    super();
+    this.options = {
+      ...this.options,
+      supportPrevContextArgumentOfComponentDidUpdate: true,
+    };
+  }
   createMountRenderer(options) {
     assertDomAvailable('mount');
     const domNode = options.attachTo || global.document.createElement('div');

diff --git a/packages/enzyme-test-suite/package.json b/packages/enzyme-test-suite/package.json
@@ -40,5 +40,4 @@
     "react": "^15.5.0",
     "react-dom": "^15.5.0"
   }
-}
-
+}
diff --git a/packages/enzyme-test-suite/test/ShallowWrapper-spec.jsx b/packages/enzyme-test-suite/test/ShallowWrapper-spec.jsx
@@ -3231,7 +3231,7 @@ describe('shallow', () => {
               'componentDidUpdate',
               { foo: 'bar' }, { foo: 'baz' },
               { foo: 'state' }, { foo: 'state' },
-              { foo: 'context' }, // this will be gone in 16
+              REACT16 ? undefined : { foo: 'context' },
             ],
             [
               'componentWillReceiveProps',
@@ -3257,7 +3257,7 @@ describe('shallow', () => {
               'componentDidUpdate',
               { foo: 'baz' }, { foo: 'bax' },
               { foo: 'state' }, { foo: 'state' },
-              { foo: 'context' },
+              REACT16 ? undefined : { foo: 'context' },
             ],
           ],
         );
@@ -3440,7 +3440,6 @@ describe('shallow', () => {
     });
 
     context('updating state', () => {
-      // NOTE: There is a bug in react 16 shallow renderer where prevContext is not passed
       it('should call shouldComponentUpdate, componentWillUpdate and componentDidUpdate', () => {
         const spy = sinon.spy();
 
@@ -3501,7 +3500,7 @@ describe('shallow', () => {
             'componentDidUpdate',
             { foo: 'props' }, { foo: 'props' },
             { foo: 'bar' }, { foo: 'baz' },
-            { foo: 'context' },
+            REACT16 ? undefined : { foo: 'context' },
           ],
         ]);
       });
@@ -3661,7 +3660,7 @@ describe('shallow', () => {
             'componentDidUpdate',
             { foo: 'props' }, { foo: 'props' },
             { foo: 'state' }, { foo: 'state' },
-            { foo: 'bar' },
+            REACT16 ? undefined : { foo: 'bar' },
           ],
         ]);
       });

diff --git a/packages/enzyme/src/ShallowWrapper.js b/packages/enzyme/src/ShallowWrapper.js
@@ -311,7 +311,11 @@ class ShallowWrapper {
               instance &&
               typeof instance.componentDidUpdate === 'function'
             ) {
-              instance.componentDidUpdate(prevProps, state, prevContext);
+              if (adapter.options.supportPrevContextArgumentOfComponentDidUpdate) {
+                instance.componentDidUpdate(prevProps, state, prevContext);
+              } else {
+                instance.componentDidUpdate(prevProps, state);
+              }
             }
             this.update();
           // If it doesn't need to rerender, update only its props.
@@ -401,7 +405,11 @@ class ShallowWrapper {
           instance &&
           typeof instance.componentDidUpdate === 'function'
         ) {
-          instance.componentDidUpdate(prevProps, prevState, prevContext);
+          if (adapter.options.supportPrevContextArgumentOfComponentDidUpdate) {
+            instance.componentDidUpdate(prevProps, prevState, prevContext);
+          } else {
+            instance.componentDidUpdate(prevProps, prevState);
+          }
         }
         this.update();
       });