Refactor NavOptions

- Add tests

Author: qiarie

android/quest/src/main/java/org/smartregister/fhircore/quest/util/extensions/ConfigExtensions.kt

@@ -160,21 +160,10 @@ fun ActionConfig.handleClickEvent(
         return
       }
 
-      val navOptionsBuilder = NavOptions.Builder().setLaunchSingleTop(true)
-
-      if (
-        actionConfig.popNavigationBackStack == true &&
-          navController.currentBackStackEntry?.destination?.id != MainNavigationScreen.Home.route
-      ) {
-        navController.currentBackStackEntry?.destination?.id?.let {
-          navOptionsBuilder.setPopUpTo(it, inclusive = true)
-        }
-      }
-
       navController.navigate(
         resId = MainNavigationScreen.Home.route,
         args = args,
-        navOptions = navOptionsBuilder.build(),
+        navOptions = createRegisterNavigationOptions(actionConfig, navController),
       )
     }
     ApplicationWorkflow.LAUNCH_REPORT -> {
@@ -328,3 +317,21 @@ suspend fun List<ViewProperties>.decodeImageResourcesToBitmap(
     }
   }
 }
+
+internal fun createRegisterNavigationOptions(
+  actionConfig: ActionConfig,
+  navController: NavController,
+): NavOptions {
+  val navOptionsBuilder = NavOptions.Builder().setLaunchSingleTop(true)
+
+  if (
+    actionConfig.popNavigationBackStack == true &&
+      navController.currentBackStackEntry?.destination?.id != MainNavigationScreen.Home.route
+  ) {
+    navController.currentBackStackEntry?.destination?.id?.let {
+      navOptionsBuilder.setPopUpTo(it, inclusive = true)
+    }
+  }
+
+  return navOptionsBuilder.build()
+}

android/quest/src/test/java/org/smartregister/fhircore/quest/util/extensions/ConfigExtensionsKtTest.kt

@@ -610,6 +610,151 @@ class ConfigExtensionsKtTest : RobolectricTest() {
     Assert.assertTrue(slotNavOptions.captured.shouldLaunchSingleTop())
   }
 
+  @Test
+  fun testCreateRegisterNavigationOptionsWithPopBackStackFalse() {
+    val actionConfig =
+      ActionConfig(
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        id = "registerId",
+        popNavigationBackStack = false,
+      )
+    every { navController.currentBackStackEntry } returns
+      mockk { every { destination } returns mockk { every { id } returns 1234 } }
+
+    val navOptions = createRegisterNavigationOptions(actionConfig, navController)
+
+    Assert.assertTrue(navOptions.shouldLaunchSingleTop())
+    Assert.assertFalse(navOptions.isPopUpToInclusive())
+  }
+
+  @Test
+  fun testCreateRegisterNavigationOptionsWithPopBackStackTrue() {
+    val actionConfig =
+      ActionConfig(
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        id = "registerId",
+        popNavigationBackStack = true,
+      )
+    every { navController.currentBackStackEntry } returns
+      mockk { every { destination } returns mockk { every { id } returns 1234 } }
+
+    val navOptions = createRegisterNavigationOptions(actionConfig, navController)
+
+    Assert.assertTrue(navOptions.shouldLaunchSingleTop())
+    Assert.assertTrue(navOptions.isPopUpToInclusive())
+    Assert.assertEquals(1234, navOptions.popUpToId)
+  }
+
+  @Test
+  fun testCreateRegisterNavigationOptionsWithPopBackStackNull() {
+    val actionConfig =
+      ActionConfig(
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        id = "registerId",
+        popNavigationBackStack = null,
+      )
+    every { navController.currentBackStackEntry } returns
+      mockk { every { destination } returns mockk { every { id } returns 1234 } }
+
+    val navOptions = createRegisterNavigationOptions(actionConfig, navController)
+
+    Assert.assertTrue(navOptions.shouldLaunchSingleTop())
+    Assert.assertFalse(navOptions.isPopUpToInclusive())
+  }
+
+  @Test
+  fun testCreateRegisterNavigationOptionsWithNullCurrentBackStackEntry() {
+    val actionConfig =
+      ActionConfig(
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        id = "registerId",
+        popNavigationBackStack = true,
+      )
+    every { navController.currentBackStackEntry } returns null
+
+    val navOptions = createRegisterNavigationOptions(actionConfig, navController)
+
+    Assert.assertTrue(navOptions.shouldLaunchSingleTop())
+    Assert.assertFalse(navOptions.isPopUpToInclusive())
+  }
+
+  @Test
+  fun testCreateRegisterNavigationOptionsWithNullDestinationId() {
+    val actionConfig =
+      ActionConfig(
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        id = "registerId",
+        popNavigationBackStack = true,
+      )
+    every { navController.currentBackStackEntry } returns
+      mockk { every { destination } returns mockk { every { id } returns 0 } }
+
+    val navOptions = createRegisterNavigationOptions(actionConfig, navController)
+
+    Assert.assertTrue(navOptions.shouldLaunchSingleTop())
+    Assert.assertTrue(navOptions.isPopUpToInclusive())
+    Assert.assertEquals(0, navOptions.popUpToId)
+  }
+
+  @Test
+  fun testLaunchRegisterAllowsNavigationWhenCurrentRegisterIdIsNull() {
+    val clickAction =
+      ActionConfig(
+        id = "registerId",
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        popNavigationBackStack = false,
+      )
+    every { navController.currentBackStackEntry } returns mockk { every { arguments } returns null }
+    every { navController.previousBackStackEntry } returns
+      mockk { every { arguments } returns bundleOf(NavigationArg.REGISTER_ID to "registerId") }
+    every { navController.currentDestination } returns null
+
+    listOf(clickAction).handleClickEvent(navController = navController, resourceData = resourceData)
+
+    val slotInt = slot<Int>()
+    val slotBundle = slot<Bundle>()
+    val slotNavOptions = slot<NavOptions>()
+    verify {
+      navController.navigate(capture(slotInt), capture(slotBundle), capture(slotNavOptions))
+    }
+    Assert.assertEquals(MainNavigationScreen.Home.route, slotInt.captured)
+    Assert.assertTrue(slotNavOptions.captured.shouldLaunchSingleTop())
+  }
+
+  @Test
+  fun testLaunchRegisterAllowsNavigationWhenPreviousRegisterIdIsNull() {
+    val clickAction =
+      ActionConfig(
+        id = "registerId",
+        trigger = ActionTrigger.ON_CLICK,
+        workflow = ApplicationWorkflow.LAUNCH_REGISTER.name,
+        popNavigationBackStack = false,
+      )
+    every { navController.currentBackStackEntry } returns
+      mockk {
+        every { arguments } returns bundleOf(NavigationArg.REGISTER_ID to "currentRegisterId")
+      }
+    every { navController.previousBackStackEntry } returns null
+    every { navController.currentDestination } returns null
+
+    listOf(clickAction).handleClickEvent(navController = navController, resourceData = resourceData)
+
+    val slotInt = slot<Int>()
+    val slotBundle = slot<Bundle>()
+    val slotNavOptions = slot<NavOptions>()
+    verify {
+      navController.navigate(capture(slotInt), capture(slotBundle), capture(slotNavOptions))
+    }
+    Assert.assertEquals(MainNavigationScreen.Home.route, slotInt.captured)
+    Assert.assertTrue(slotNavOptions.captured.shouldLaunchSingleTop())
+  }
+
   @Test
   fun testDeviceToDeviceSyncActionOnClick() {
     val clickAction =