feat(createPubSubConnector): Added boolean option { forceInitialValues }, default to false

When set to true if 'mapSubscriptionsToProps' is an object all mapped actions will be invoked once
when component will mount.

Author: cef62

src/components/createPubSubConnector.js

@@ -44,7 +44,7 @@ export default function createPubSubConnector(mapSubscriptionsToProps, mapPublis
     mapPublishToProps || defaultMapPublishToProps;
   const shouldUpdatePublishProps = finalMapPublishToProps.length > 1;
 
-  const { withRef = false, ownProps = true } = options || {};
+  const { withRef = false, ownProps = true, forceInitialValues = false } = options || {};
 
   let mappedSubscriptions = {};
   function registerMappedSubscriptions(pubSub, subscriptionsMap = {}, updateSubscriptionProps, getProps) {
@@ -105,11 +105,24 @@ export default function createPubSubConnector(mapSubscriptionsToProps, mapPublis
     mappedSubscriptions = Object.keys(subscriptionsMap)
     .reduce((acc, key) => {
       const callback = updateMappedSubscriptions(key, subscriptionsMap[key]);
-      acc[key] = add(key, callback);
+      acc[key] = {
+        callback,
+        originalCallback: subscriptionsMap[key],
+        unsubscribe: add(key, callback),
+      };
       return acc;
     }, {});
   }
 
+  function invokeMappedSubscriptions() {
+    mappedSubscriptions = Object.keys(mappedSubscriptions)
+    .forEach(key => {
+      const { callback, originalCallback } = mappedSubscriptions[key];
+      const initialValues = Array.isArray(originalCallback.initialValues) ? originalCallback.initialValues : [];
+      callback(...initialValues);
+    });
+  }
+
   function initSubscriptionFunction(pubSub, subscriptionsFunction, updateSubscriptionProps, getProps) {
     // init given function, this invocation will subscribe required actions to
     // passed pubSub instance
@@ -154,7 +167,7 @@ export default function createPubSubConnector(mapSubscriptionsToProps, mapPublis
             + `or explicitly pass "pubSubCore" as a prop to "${this.constructor.displayName}".`
           );
         }
-
+        this.state = {};
         this.pubSub = this.pubSubCore.register(this);
         this.mappedSubscriptionProps = {};
 
@@ -186,8 +199,12 @@ export default function createPubSubConnector(mapSubscriptionsToProps, mapPublis
         }
 
         this.publishProps = computePublishProps(this.pubSub, props);
+      }
 
-        this.state = {};
+      componentWillMount() {
+        if (forceInitialValues) {
+          invokeMappedSubscriptions();
+        }
       }
 
       shouldComponentUpdate(nextProps, nextState) {

test/components/createPubSubConnector.spec.js

@@ -1082,3 +1082,77 @@ test(
     t.end();
   }
 );
+
+test(
+  'should invoke all actions mapped when component is instantiated'
+  + ' and option is { forceInitialValues: true }',
+  t => {
+    const SIMPLE_UPDATE = 'simpleUpdate';
+    const pubSubCore = createPubSub();
+
+    class Container extends Component {
+      render() {
+        return (<Passthrough {...this.props} />);
+      }
+    }
+
+    const simpleUpdateHandler = (country = 'unknown country') => {
+      console.log('PD', country);
+      return { country };
+    };
+    simpleUpdateHandler.initialValues = ['default country'];
+
+    const WrapperContainer = createPubSubConnector(
+      { [SIMPLE_UPDATE]: simpleUpdateHandler },
+      null, { forceInitialValues: true }
+    )(Container);
+
+    const tree = TestUtils.renderIntoDocument(
+      <ProviderMock pubSubCore={pubSubCore}>
+      <WrapperContainer />
+      </ProviderMock>
+    );
+    const stub = TestUtils.findRenderedComponentWithType(tree, Passthrough);
+
+    t.is(stub.props.country, 'default country');
+
+    t.end();
+  }
+);
+
+test(
+  'should not invoke actions mapped when component is instantiated'
+  + ' but option is { forceInitialValues: false }',
+  t => {
+    const SIMPLE_UPDATE = 'simpleUpdate';
+    const pubSubCore = createPubSub();
+
+    class Container extends Component {
+      render() {
+        return (<Passthrough {...this.props} />);
+      }
+    }
+
+    const simpleUpdateHandler = (country = 'unknown country') => {
+      console.log('PD', country);
+      return { country };
+    };
+    simpleUpdateHandler.initialValues = ['default country'];
+
+    const WrapperContainer = createPubSubConnector(
+      { [SIMPLE_UPDATE]: simpleUpdateHandler },
+      null, { forceInitialValues: false }
+    )(Container);
+
+    const tree = TestUtils.renderIntoDocument(
+      <ProviderMock pubSubCore={pubSubCore}>
+      <WrapperContainer />
+      </ProviderMock>
+    );
+    const stub = TestUtils.findRenderedComponentWithType(tree, Passthrough);
+
+    t.is(stub.props.country, undefined);
+
+    t.end();
+  }
+);