Add a comment why replacing shouldComponentUpdate is needed

enzymejs · Sep 26, 2017 · ea4b71c · ea4b71c
1 parent 971f501
commit ea4b71c
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/enzyme/src/ShallowWrapper.js b/packages/enzyme/src/ShallowWrapper.js
@@ -375,7 +375,10 @@ class ShallowWrapper {
         const prevState = instance.state;
         const prevContext = instance.context;
         let shouldRender = true;
-        // dirty hack: avoid calling shouldComponentUpdate twice
+        // This is a dirty hack but it requires to know the result of shouldComponentUpdate.
+        // When shouldComponentUpdate returns false we shouldn't call componentDidUpdate.
+        // shouldComponentUpdate is called in `instance.setState`
+        // so we replace shouldComponentUpdate to know the result and restore it later.
         let originalShouldComponentUpdate;
         if (
           this[OPTIONS].lifecycleExperimental &&