fix: merge initial params on push

react-navigation · Nov 17, 2019 · 11efb06 · 11efb06
1 parent c17ad18
commit 11efb06
Show file tree

Hide file tree

Showing 13 changed files with 292 additions and 107 deletions.
diff --git a/packages/core/src/__tests__/NavigationContainer.test.tsx b/packages/core/src/__tests__/NavigationContainer.test.tsx
@@ -163,14 +163,14 @@ it('handle dispatching with ref', () => {
         return true;
       },
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'REVERSE') {
           return {
             ...state,
             routes: state.routes.slice().reverse(),
           };
         }
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;

diff --git a/packages/core/src/__tests__/useDescriptors.test.tsx b/packages/core/src/__tests__/useDescriptors.test.tsx
@@ -419,12 +419,12 @@ it(`returns false for canGoBack when current router doesn't handle GO_BACK`, ()
     const ChildRouter: Router<NavigationState, MockActions> = {
       ...CurrentMockRouter,
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'GO_BACK') {
           return null;
         }
 
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;
@@ -470,12 +470,12 @@ it('returns true for canGoBack when current router handles GO_BACK', () => {
     const ChildRouter: Router<NavigationState, MockActions> = {
       ...CurrentMockRouter,
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'GO_BACK') {
           return state;
         }
 
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;
@@ -537,12 +537,12 @@ it('returns true for canGoBack when parent router handles GO_BACK', () => {
     const ChildRouter: Router<NavigationState, MockActions> = {
       ...CurrentMockRouter,
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'GO_BACK') {
           return state;
         }
 
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;

diff --git a/packages/core/src/__tests__/useEventEmitter.test.tsx b/packages/core/src/__tests__/useEventEmitter.test.tsx
@@ -230,7 +230,7 @@ it('fires blur event when a route is removed with a delay', async () => {
         };
       },
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         switch (action.type) {
           case 'PUSH':
             return {
@@ -248,7 +248,7 @@ it('fires blur event when a route is removed with a delay', async () => {
             };
           }
           default:
-            return router.getStateForAction(state, action);
+            return router.getStateForAction(state, action, options);
         }
       },
 

diff --git a/packages/core/src/__tests__/useOnAction.test.tsx b/packages/core/src/__tests__/useOnAction.test.tsx
@@ -20,15 +20,15 @@ it("lets parent handle the action if child didn't", () => {
     > = {
       ...CurrentMockRouter,
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'REVERSE') {
           return {
             ...state,
             routes: state.routes.slice().reverse(),
           };
         }
 
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ParentRouter;
@@ -103,14 +103,14 @@ it("lets children handle the action if parent didn't", () => {
         return true;
       },
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'REVERSE') {
           return {
             ...state,
             routes: state.routes.slice().reverse(),
           };
         }
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;
@@ -229,15 +229,15 @@ it("action doesn't bubble if target is specified", () => {
         return true;
       },
 
-      getStateForAction(state, action) {
+      getStateForAction(state, action, options) {
         if (action.type === 'REVERSE') {
           return {
             ...state,
             routes: state.routes.slice().reverse(),
           };
         }
 
-        return CurrentMockRouter.getStateForAction(state, action);
+        return CurrentMockRouter.getStateForAction(state, action, options);
       },
     };
     return ChildRouter;

diff --git a/packages/core/src/types.tsx b/packages/core/src/types.tsx
@@ -118,6 +118,11 @@ export type RouterFactory<
   RouterOptions extends DefaultRouterOptions
 > = (options: RouterOptions) => Router<State, Action>;
 
+export type RouterConfigOptions = {
+  routeNames: string[];
+  routeParamList: ParamListBase;
+};
+
 export type Router<
   State extends NavigationState,
   Action extends NavigationAction
@@ -134,10 +139,7 @@ export type Router<
    * @param options.routeNames List of valid route names as defined in the screen components.
    * @param options.routeParamsList Object containing params for each route.
    */
-  getInitialState(options: {
-    routeNames: string[];
-    routeParamList: ParamListBase;
-  }): State;
+  getInitialState(options: RouterConfigOptions): State;
 
   /**
    * Rehydrate the full navigation state from a given partial state.
@@ -148,10 +150,7 @@ export type Router<
    */
   getRehydratedState(
     partialState: PartialState<State> | State,
-    options: {
-      routeNames: string[];
-      routeParamList: ParamListBase;
-    }
+    options: RouterConfigOptions
   ): State;
 
   /**
@@ -163,10 +162,7 @@ export type Router<
    */
   getStateForRouteNamesChange(
     state: State,
-    options: {
-      routeNames: string[];
-      routeParamList: ParamListBase;
-    }
+    options: RouterConfigOptions
   ): State;
 
   /**
@@ -183,10 +179,13 @@ export type Router<
    *
    * @param state State object to apply the action on.
    * @param action Action object to apply.
+   * @param options.routeNames List of valid route names as defined in the screen components.
+   * @param options.routeParamsList Object containing params for each route.
    */
   getStateForAction(
     state: State,
-    action: Action
+    action: Action,
+    options: RouterConfigOptions
   ): State | PartialState<State> | null;
 
   /**

diff --git a/packages/core/src/useNavigationBuilder.tsx b/packages/core/src/useNavigationBuilder.tsx
@@ -243,7 +243,11 @@ export default function useNavigationBuilder<
     // The update should be limited to current navigator only, so we call the router manually
     const updatedState = router.getStateForAction(
       state,
-      navigate(route.params.screen, route.params.params)
+      navigate(route.params.screen, route.params.params),
+      {
+        routeNames,
+        routeParamList,
+      }
     );
 
     nextState =
@@ -309,6 +313,10 @@ export default function useNavigationBuilder<
     setState,
     key,
     listeners: actionListeners,
+    routerConfigOptions: {
+      routeNames,
+      routeParamList,
+    },
   });
 
   const onRouteFocus = useOnRouteFocus({

diff --git a/packages/core/src/useNavigationHelpers.tsx b/packages/core/src/useNavigationHelpers.tsx
@@ -73,13 +73,18 @@ export default function useNavigationHelpers<
       isFocused: parentNavigationHelpers
         ? parentNavigationHelpers.isFocused
         : () => true,
-      canGoBack: () =>
-        router.getStateForAction(
-          getState(),
-          CommonActions.goBack() as Action
-        ) !== null ||
-        (parentNavigationHelpers && parentNavigationHelpers.canGoBack()) ||
-        false,
+      canGoBack: () => {
+        const state = getState();
+
+        return (
+          router.getStateForAction(state, CommonActions.goBack() as Action, {
+            routeNames: state.routeNames,
+            routeParamList: {},
+          }) !== null ||
+          (parentNavigationHelpers && parentNavigationHelpers.canGoBack()) ||
+          false
+        );
+      },
     } as NavigationHelpers<ParamListBase, EventMap> &
       (NavigationProp<ParamListBase, string, any, any, any> | undefined);
   }, [

diff --git a/packages/core/src/useOnAction.tsx b/packages/core/src/useOnAction.tsx
@@ -7,6 +7,7 @@ import {
   NavigationState,
   PartialState,
   Router,
+  RouterConfigOptions,
 } from './types';
 
 type Options = {
@@ -15,6 +16,7 @@ type Options = {
   getState: () => NavigationState;
   setState: (state: NavigationState | PartialState<NavigationState>) => void;
   listeners: ChildActionListener[];
+  routerConfigOptions: RouterConfigOptions;
 };
 
 /**
@@ -32,6 +34,7 @@ export default function useOnAction({
   setState,
   key,
   listeners,
+  routerConfigOptions,
 }: Options) {
   const {
     onAction: onActionParent,
@@ -40,6 +43,14 @@ export default function useOnAction({
     trackAction,
   } = React.useContext(NavigationBuilderContext);
 
+  const routerConfigOptionsRef = React.useRef<RouterConfigOptions>(
+    routerConfigOptions
+  );
+
+  React.useEffect(() => {
+    routerConfigOptionsRef.current = routerConfigOptions;
+  });
+
   const onAction = React.useCallback(
     (
       action: NavigationAction,
@@ -59,7 +70,11 @@ export default function useOnAction({
         return false;
       }
 
-      let result = router.getStateForAction(state, action);
+      let result = router.getStateForAction(
+        state,
+        action,
+        routerConfigOptionsRef.current
+      );
 
       // If a target is specified and set to current navigator, the action shouldn't bubble
       // So instead of `null`, we use the state object for such cases to signal that action was handled