Add compatibility for goBack and goForward with history@5 (#163)

* In #113 compatibility with history@5 was added.
In history@5 the `goForward` and `goBack` functions were renamed to `forward` and `back` though. This means that `react-resource-router` will currently fail on these actions.

This PR fixes that and adds compatibility for these two actions with history@5

* Type fix for union type of history@4 and history@5 in unit test

* Explain in comment which method is used in history@4 vs history@5

Author: danskyr

package-lock.json

@@ -93,6 +93,7 @@
     "@testing-library/react": "^10.0.4",
     "@types/enzyme": "^3.10.5",
     "@types/history": "^4.7.6",
+    "@types/history-5": "npm:@types/history@^5.0.0",
     "@types/jest": "^28.1.7",
     "@types/lodash.debounce": "^4.0.6",
     "@types/lodash.noop": "^3.0.6",

package.json

@@ -138,7 +138,11 @@ describe('createLegacyHistory', () => {
     it('should go back in history via history', () => {
       const history = createLegacyHistory();
       window.history.back = jest.fn();
-      history.goBack();
+      if ('goBack' in history) {
+        history.goBack();
+      } else {
+        throw new Error('goBack was expected but not found');
+      }
       expect(window.history.back).toHaveBeenCalled();
     });
   });
@@ -147,7 +151,11 @@ describe('createLegacyHistory', () => {
     it('should go forward in history via history', () => {
       const history = createLegacyHistory();
       window.history.forward = jest.fn();
-      history.goForward();
+      if ('goForward' in history) {
+        history.goForward();
+      } else {
+        throw new Error('goForward was expected but not found');
+      }
       expect(window.history.forward).toHaveBeenCalled();
     });
   });

src/__tests__/unit/common/utils/history/test.ts

@@ -9,6 +9,7 @@ import {
 } from 'react';
 
 import { History, Location as HistoryLocationShape } from 'history';
+import { History as History5 } from 'history-5';
 
 export type LocationShape = HistoryLocationShape;
 
@@ -20,10 +21,10 @@ export type Location = {
   hash: string;
 };
 
-export type BrowserHistory = Omit<
-  History,
-  'location' | 'go' | 'createHref' | 'push' | 'replace'
-> & {
+export type BrowserHistory = (
+  | Omit<History, 'location' | 'go' | 'createHref' | 'push' | 'replace'>
+  | Omit<History5, 'location' | 'go' | 'createHref' | 'push' | 'replace'>
+) & {
   location: Location;
   push: (path: string) => void;
   replace: (path: string) => void;

src/common/types.ts

@@ -309,15 +309,29 @@ const actions: AllRouterActions = {
     ({ getState }) => {
       const { history } = getState();
 
-      history.goBack();
+      // history@4 uses goBack(), history@5 uses back()
+      if ('goBack' in history) {
+        history.goBack();
+      } else if ('back' in history) {
+        history.back();
+      } else {
+        throw new Error('History does not support goBack');
+      }
     },
 
   goForward:
     () =>
     ({ getState }) => {
       const { history } = getState();
 
-      history.goForward();
+      // history@4 uses goForward(), history@5 uses forward()
+      if ('goForward' in history) {
+        history.goForward();
+      } else if ('forward' in history) {
+        history.forward();
+      } else {
+        throw new Error('History does not support goForward');
+      }
     },
 
   registerBlock: