Replace callerDestinationId with popDestination approach

Instead of passing a caller destination ID through the refund nav graph,
use popBackStack's inclusive parameter to pop the issueRefundFragment,
which removes the entire refund graph from the back stack regardless of
the caller. This makes the refund flow caller-agnostic and scales to any
future integrations.

Author: AdamGrzybkowski

WooCommerce/src/main/kotlin/com/woocommerce/android/extensions/FragmentExt.kt

@@ -31,12 +31,15 @@ import kotlin.math.abs
  * @param [key] A unique string that is the same as the one used in [handleResult]
  * @param [result] A result value to be returned
  * @param [destinationId] an optional destinationId, that can be used to navigate up to a specified destination
+ * @param [popDestination] whether to pop the destinationId from the back stack when navigating back, used only
+ *        when [destinationId] is specified
  *
  */
 fun <T> Fragment.navigateBackWithResult(
     key: String,
     result: T,
     @IdRes destinationId: Int? = null,
+    popDestination: Boolean = false,
     @IdRes navHostId: Int? = null,
 ) {
     val navController = if (navHostId != null) findNavController(navHostId) else findNavController()
@@ -49,7 +52,7 @@ fun <T> Fragment.navigateBackWithResult(
     entry?.savedStateHandle?.set(key, result)
 
     if (destinationId != null) {
-        findNavController().popBackStack(destinationId, false)
+        findNavController().popBackStack(destinationId, popDestination)
     } else {
         findNavController().navigateUp()
     }
@@ -63,7 +66,6 @@ fun <T> Fragment.navigateBackWithResult(
  * @param [key] A unique string that is the same as the one used in [handleResult]
  * @param [result] A result value to be returned
  * @param [childId] an destinationId, that used to navigate up from the specified destination
- * @param [navHostId] An optional ID of the NavHostFragment, it's useful when the fragment is used in two-pane layouts
  */
 fun <T> Fragment.navigateToParentWithResult(key: String, result: T, @IdRes childId: Int) {
     if (findNavController().currentDestination?.id != childId) {
@@ -79,14 +81,17 @@ fun <T> Fragment.navigateToParentWithResult(key: String, result: T, @IdRes child
  *
  * @param [key] A unique string that is the same as the one used in [handleNotice]
  * @param [destinationId] an optional destinationId, that can be used to navigating up to a specified destination
+ * @param [popDestination] whether to pop the destinationId from the back stack when navigating back, used only
+ *        when [destinationId] is specified
  * @param [navHostId] An optional ID of the NavHostFragment, it's useful when the fragment is used in two-pane layouts
  */
 fun Fragment.navigateBackWithNotice(
     key: String,
     @IdRes destinationId: Int? = null,
+    popDestination: Boolean = false,
     @IdRes navHostId: Int? = null,
 ) {
-    navigateBackWithResult(key, key, destinationId, navHostId)
+    navigateBackWithResult(key, key, destinationId, popDestination, navHostId)
 }
 
 /**

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/bookings/details/BookingDetailsFragment.kt

@@ -78,8 +78,7 @@ class BookingDetailsFragment : BaseFragment() {
                     findNavController().navigateSafely(
                         BookingDetailsFragmentDirections
                             .actionBookingDetailsFragmentToIssueRefund(
-                                orderId = event.orderId,
-                                callerDestinationId = R.id.bookingDetailsFragment
+                                orderId = event.orderId
                             )
                     )
                 }

WooCommerce/src/main/kotlin/com/woocommerce/android/ui/payments/refunds/RefundSummaryFragment.kt

@@ -123,11 +123,11 @@ class RefundSummaryFragment : BaseFragment(R.layout.fragment_refund_summary), Ba
             when (event) {
                 is ShowSnackbar -> uiMessageResolver.getSnack(event.message, *event.args).show()
                 is Exit -> {
-                    val callerDestId = findNavController()
-                        .getBackStackEntry(R.id.nav_graph_refunds)
-                        .arguments?.getInt("callerDestinationId", 0) ?: 0
-                    val destId = if (callerDestId != 0) callerDestId else R.id.orderDetailFragment
-                    navigateBackWithNotice(REFUND_ORDER_NOTICE_KEY, destId)
+                    navigateBackWithNotice(
+                        key = REFUND_ORDER_NOTICE_KEY,
+                        destinationId = R.id.issueRefundFragment,
+                        popDestination = true
+                    )
                 }
                 is ShowRefundConfirmation -> {
                     val action =

WooCommerce/src/main/res/navigation/nav_graph_bookings_details.xml

@@ -21,10 +21,6 @@
                 android:name="orderId"
                 android:defaultValue="0L"
                 app:argType="long" />
-            <argument
-                android:name="callerDestinationId"
-                android:defaultValue="0"
-                app:argType="integer" />
         </action>
     </fragment>
 

WooCommerce/src/main/res/navigation/nav_graph_refunds.xml

@@ -4,10 +4,6 @@
     xmlns:tools="http://schemas.android.com/tools"
     android:id="@+id/nav_graph_refunds"
     app:startDestination="@id/issueRefundFragment" >
-    <argument
-        android:name="callerDestinationId"
-        android:defaultValue="0"
-        app:argType="integer" />
     <fragment
         android:id="@+id/refundSummaryFragment"
         android:name="com.woocommerce.android.ui.payments.refunds.RefundSummaryFragment"