Include location state in LOCATION_CHANGE payload (#302)

* Include location state and key in LOCATION_CHANGE payload

Closes #301

* Remove location.key

src/ConnectedRouter.js

@@ -29,22 +29,31 @@ const createConnectedRouter = (structure) => {
           pathname: pathnameInStore,
           search: searchInStore,
           hash: hashInStore,
+          state: stateInStore,
         } = getLocation(store.getState())
         // Extract history's location
         const {
           pathname: pathnameInHistory,
           search: searchInHistory,
           hash: hashInHistory,
+          state: stateInHistory,
         } = history.location
 
         // If we do time travelling, the location in store is changed but location in history is not changed
-        if (props.history.action === 'PUSH' && (pathnameInHistory !== pathnameInStore || searchInHistory !== searchInStore || hashInHistory !== hashInStore)) {
+        if (
+          props.history.action === 'PUSH' &&
+          (pathnameInHistory !== pathnameInStore ||
+            searchInHistory !== searchInStore ||
+            hashInHistory !== hashInStore ||
+            stateInStore !== stateInHistory)
+        ) {
           this.inTimeTravelling = true
           // Update history's location to match store's location
           history.push({
             pathname: pathnameInStore,
             search: searchInStore,
             hash: hashInStore,
+            state: stateInStore,
           })
         }
       })

test/ConnectedRouter.test.js

@@ -123,6 +123,19 @@ describe('ConnectedRouter', () => {
       expect(onLocationChangedSpy.mock.calls).toHaveLength(3)
     })
 
+    it('supports location state and key', () => {
+      mount(
+        <Provider store={store}>
+          <ConnectedRouter {...props}>
+            <Route path="/" render={() => <div>Home</div>} />
+          </ConnectedRouter>
+        </Provider>
+      )
+      props.history.push({ pathname: '/new-location', state: { foo: 'bar' } })
+
+      expect(onLocationChangedSpy.mock.calls[1][0].state).toEqual({ foo: 'bar'})
+    })
+
     it('only renders one time when mounted', () => {
       let renderCount = 0