Fix navigation params containing None entries

CHANGELOG.md

@@ -5,6 +5,8 @@ ___
 
 Work in progress, to be added to next release notes.
 
+* Fixed RoactNavigation.None present in params when navigating ([#3](https://github.com/jsdotlua/roact-navigation/pull/3))
+
 ### v0.5.10
 
 * Added `useNavigation` hook to the module's export ([#2](https://github.com/jsdotlua/roact-navigation/pull/2))

src/routers/StackRouter.lua

@@ -369,7 +369,7 @@ return function(routeArray, config)
 					routes[lastRouteIndex] = Object.assign(table.clone(route), {
 						params = if action.params == Object.None
 							then Object.None
-							elseif not route.params then table.clone(action.params)
+							elseif not route.params then Object.assign({}, action.params)
 							else Object.assign(table.clone(route.params), action.params),
 					})
 				end
@@ -551,7 +551,7 @@ return function(routeArray, config)
 					params = if lastRoute.params and action.params
 						then Object.assign(table.clone(lastRoute.params), action.params)
 						elseif lastRoute.params then table.clone(lastRoute.params)
-						elseif action.params then table.clone(action.params)
+						elseif action.params then Object.assign({}, action.params)
 						else {}
 				end
 				local routes = table.clone(state.routes)

src/routers/SwitchRouter.lua

@@ -295,7 +295,7 @@ return function(routeArray, config)
 							then Object.None
 							else if newChildState.params
 								then Object.assign(table.clone(newChildState.params), action.params)
-								else table.clone(action.params),
+								else Object.assign({}, action.params),
 					})
 				end
 
@@ -327,7 +327,7 @@ return function(routeArray, config)
 					params = if lastRoute.params and action.params
 						then Object.assign(table.clone(lastRoute.params), action.params)
 						elseif lastRoute.params then table.clone(lastRoute.params)
-						elseif action.params then table.clone(action.params)
+						elseif action.params then Object.assign({}, action.params)
 						else {}
 				end
 				local routes = table.clone(state.routes)

src/routers/_tests_/Routers.roblox.spec.lua

@@ -55,6 +55,74 @@ for routerName, Router in pairs(ROUTERS) do
 			expect(state1.routes[state1.index].params.foo).toBeNil()
 		end)
 
+		it("setParams using RoactNavigation.None does not keep the None value", function()
+			local state0 = router.getStateForAction(
+				NavigationActions.setParams({ params = { foo = RoactNavigation.None }, key = initRoute.key }),
+				initState
+			)
+
+			expect(state0.routes[state0.index]).toEqual(expect.objectContaining({ params = {} }))
+		end)
+
+		it("setParams to RoactNavigation.None does not set any params", function()
+			local state0 = router.getStateForAction(
+				NavigationActions.setParams({ params = RoactNavigation.None, key = initRoute.key }),
+				initState
+			)
+
+			expect(state0.routes[state0.index].params).toEqual(nil)
+		end)
+
+		it("removes params with RoactNavigation.None when navigating to the same route", function()
+			initState = router.getStateForAction(NavigationActions.init({
+				params = { a = 1 },
+			}))
+			initRoute = initState.routes[initState.index]
+			expect(initState.routes[initState.index].params).toEqual(expect.objectContaining({ a = 1 }))
+
+			local state0 = router.getStateForAction(
+				NavigationActions.navigate({
+					params = RoactNavigation.None,
+					routeName = initRoute.routeName,
+					key = initRoute.key,
+				}),
+				initState
+			)
+
+			expect(state0.routes[state0.index].params).toEqual(nil)
+		end)
+
+		it("does not leave a specific param to RoactNavigation.None when navigating to the same route", function()
+			local state0 = router.getStateForAction(
+				NavigationActions.navigate({
+					params = { a = RoactNavigation.None },
+					routeName = initRoute.routeName,
+					key = initRoute.key,
+				}),
+				initState
+			)
+
+			expect(state0.routes[state0.index].params).toEqual({})
+		end)
+
+		it("removes a specific param with RoactNavigation.None when navigating to the same route", function()
+			initState = router.getStateForAction(NavigationActions.init({
+				params = { a = 1, b = 2 },
+			}))
+			initRoute = initState.routes[initState.index]
+
+			local state0 = router.getStateForAction(
+				NavigationActions.navigate({
+					params = { a = RoactNavigation.None },
+					routeName = initRoute.routeName,
+					key = initRoute.key,
+				}),
+				initState
+			)
+
+			expect(state0.routes[state0.index].params).toEqual(expect.objectContaining({ b = 2 }))
+		end)
+
 		it("navigate clears individual params using RoactNavigation.None", function()
 			local state0 = router.getStateForAction(
 				NavigationActions.setParams({ params = { foo = 10, bar = 20 }, key = initRoute.key }),