NavigateAndLoad: Cancel loading on dismiss (#757)

filblue · stephencelis · web-flow · commit dacd3de63f26 · 2021-09-01T17:25:54.000-04:00
* NavigateAndLoad: Cancel loading on dismiss

* Update Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-NavigateAndLoad.swift

Co-authored-by: Stephen Celis &lt;stephen.celis@gmail.com&gt;

* Update Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-PresentAndLoad.swift

Co-authored-by: Stephen Celis &lt;stephen.celis@gmail.com&gt;

* Add cancellation to UIKitCaseStudies/NavigateAndLoad.swift

* Add cancellation to LoadThenNavigate studies

Co-authored-by: Stephen Celis &lt;stephen.celis@gmail.com&gt;
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-LoadThenNavigate.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Lists-LoadThenNavigate.swift
@@ -26,6 +26,7 @@ struct LoadThenNavigateListState: Equatable {
 
 enum LoadThenNavigateListAction: Equatable {
   case counter(CounterAction)
+  case onDisappear
   case setNavigation(selection: UUID?)
   case setNavigationSelectionDelayCompleted(UUID)
 }
@@ -57,6 +58,9 @@ let loadThenNavigateListReducer =
       case .counter:
         return .none
 
+      case .onDisappear:
+        return .cancel(id: CancelId())
+
       case let .setNavigation(selection: .some(navigatedId)):
         for row in state.rows {
           state.rows[id: row.id]?.isActivityIndicatorVisible = row.id == navigatedId
@@ -119,6 +123,7 @@ struct LoadThenNavigateListView: View {
         }
       }
       .navigationBarTitle("Load then navigate")
+      .onDisappear { viewStore.send(.onDisappear) }
     }
   }
 }
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-LoadThenNavigate.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-LoadThenNavigate.swift
@@ -17,6 +17,7 @@ struct LoadThenNavigateState: Equatable {
 }
 
 enum LoadThenNavigateAction: Equatable {
+  case onDisappear
   case optionalCounter(CounterAction)
   case setNavigation(isActive: Bool)
   case setNavigationIsActiveDelayCompleted
@@ -38,12 +39,20 @@ let loadThenNavigateReducer =
     with: Reducer<
       LoadThenNavigateState, LoadThenNavigateAction, LoadThenNavigateEnvironment
     > { state, action, environment in
+
+      struct CancelId: Hashable {}
+
       switch action {
+
+      case .onDisappear:
+        return .cancel(id: CancelId())
+
       case .setNavigation(isActive: true):
         state.isActivityIndicatorVisible = true
         return Effect(value: .setNavigationIsActiveDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
 
       case .setNavigation(isActive: false):
         state.optionalCounter = nil
@@ -90,6 +99,7 @@ struct LoadThenNavigateView: View {
           }
         }
       }
+      .onDisappear { viewStore.send(.onDisappear) }
     }
     .navigationBarTitle("Load then navigate")
   }
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-NavigateAndLoad.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-NavigateAndLoad.swift
@@ -37,17 +37,19 @@ let navigateAndLoadReducer =
     with: Reducer<
       NavigateAndLoadState, NavigateAndLoadAction, NavigateAndLoadEnvironment
     > { state, action, environment in
+      struct CancelId: Hashable {}
       switch action {
       case .setNavigation(isActive: true):
         state.isNavigationActive = true
         return Effect(value: .setNavigationIsActiveDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
 
       case .setNavigation(isActive: false):
         state.isNavigationActive = false
         state.optionalCounter = nil
-        return .none
+        return .cancel(id: CancelId())
 
       case .setNavigationIsActiveDelayCompleted:
         state.optionalCounter = CounterState()
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-LoadThenPresent.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-LoadThenPresent.swift
@@ -17,6 +17,7 @@ struct LoadThenPresentState: Equatable {
 }
 
 enum LoadThenPresentAction {
+  case onDisappear
   case optionalCounter(CounterAction)
   case setSheet(isPresented: Bool)
   case setSheetIsPresentedDelayCompleted
@@ -38,12 +39,20 @@ let loadThenPresentReducer =
     with: Reducer<
       LoadThenPresentState, LoadThenPresentAction, LoadThenPresentEnvironment
     > { state, action, environment in
+
+      struct CancelId: Hashable {}
+
       switch action {
+
+      case .onDisappear:
+        return .cancel(id: CancelId())
+
       case .setSheet(isPresented: true):
         state.isActivityIndicatorVisible = true
         return Effect(value: .setSheetIsPresentedDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
 
       case .setSheet(isPresented: false):
         state.optionalCounter = nil
@@ -93,6 +102,7 @@ struct LoadThenPresentView: View {
         )
       }
       .navigationBarTitle("Load and present")
+      .onDisappear { viewStore.send(.onDisappear) }
     }
   }
 }
diff --git a/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-PresentAndLoad.swift b/Examples/CaseStudies/SwiftUICaseStudies/03-Navigation-Sheet-PresentAndLoad.swift
@@ -35,17 +35,19 @@ let presentAndLoadReducer =
     with: Reducer<
       PresentAndLoadState, PresentAndLoadAction, PresentAndLoadEnvironment
     > { state, action, environment in
+      struct CancelId: Hashable {}
       switch action {
       case .setSheet(isPresented: true):
         state.isSheetPresented = true
         return Effect(value: .setSheetIsPresentedDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
 
       case .setSheet(isPresented: false):
         state.isSheetPresented = false
         state.optionalCounter = nil
-        return .none
+        return .cancel(id: CancelId())
 
       case .setSheetIsPresentedDelayCompleted:
         state.optionalCounter = CounterState()
diff --git a/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift b/Examples/CaseStudies/UIKitCaseStudies/LoadThenNavigate.swift
@@ -9,6 +9,7 @@ struct LazyNavigationState: Equatable {
 }
 
 enum LazyNavigationAction: Equatable {
+  case onDisappear
   case optionalCounter(CounterAction)
   case setNavigation(isActive: Bool)
   case setNavigationIsActiveDelayCompleted
@@ -30,12 +31,16 @@ let lazyNavigationReducer =
     with: Reducer<
       LazyNavigationState, LazyNavigationAction, LazyNavigationEnvironment
     > { state, action, environment in
+      struct CancelId: Hashable {}
       switch action {
+      case .onDisappear:
+        return .cancel(id: CancelId())
       case .setNavigation(isActive: true):
         state.isActivityIndicatorHidden = false
         return Effect(value: .setNavigationIsActiveDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
       case .setNavigation(isActive: false):
         state.optionalCounter = nil
         return .none
@@ -120,6 +125,11 @@ class LazyNavigationViewController: UIViewController {
   @objc private func loadOptionalCounterTapped() {
     self.viewStore.send(.setNavigation(isActive: true))
   }
+
+  override func viewDidDisappear(_ animated: Bool) {
+    super.viewDidDisappear(animated)
+    self.viewStore.send(.onDisappear)
+  }
 }
 
 struct LazyNavigationViewController_Previews: PreviewProvider {
diff --git a/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift b/Examples/CaseStudies/UIKitCaseStudies/NavigateAndLoad.swift
@@ -30,16 +30,20 @@ let eagerNavigationReducer =
     with: Reducer<
       EagerNavigationState, EagerNavigationAction, EagerNavigationEnvironment
     > { state, action, environment in
+
+      struct CancelId: Hashable {}
+
       switch action {
       case .setNavigation(isActive: true):
         state.isNavigationActive = true
         return Effect(value: .setNavigationIsActiveDelayCompleted)
           .delay(for: 1, scheduler: environment.mainQueue)
           .eraseToEffect()
+          .cancellable(id: CancelId())
       case .setNavigation(isActive: false):
         state.isNavigationActive = false
         state.optionalCounter = nil
-        return .none
+        return .cancel(id: CancelId())
       case .setNavigationIsActiveDelayCompleted:
         state.optionalCounter = CounterState()
         return .none

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ struct LoadThenNavigateListState: Equatable {`
`26`	`26`
`27`	`27`	`enum LoadThenNavigateListAction: Equatable {`
`28`	`28`	`case counter(CounterAction)`
	`29`	`+ case onDisappear`
`29`	`30`	`case setNavigation(selection: UUID?)`
`30`	`31`	`case setNavigationSelectionDelayCompleted(UUID)`
`31`	`32`	`}`
`@@ -57,6 +58,9 @@ let loadThenNavigateListReducer =`
`57`	`58`	`case .counter:`
`58`	`59`	`return .none`
`59`	`60`
	`61`	`+ case .onDisappear:`
	`62`	`+ return .cancel(id: CancelId())`
	`63`	`+`
`60`	`64`	`case let .setNavigation(selection: .some(navigatedId)):`
`61`	`65`	`for row in state.rows {`
`62`	`66`	`state.rows[id: row.id]?.isActivityIndicatorVisible = row.id == navigatedId`
`@@ -119,6 +123,7 @@ struct LoadThenNavigateListView: View {`
`119`	`123`	`}`
`120`	`124`	`}`
`121`	`125`	`.navigationBarTitle("Load then navigate")`
	`126`	`+ .onDisappear { viewStore.send(.onDisappear) }`
`122`	`127`	`}`
`123`	`128`	`}`
`124`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ struct LoadThenNavigateState: Equatable {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`enum LoadThenNavigateAction: Equatable {`
	`20`	`+ case onDisappear`
`20`	`21`	`case optionalCounter(CounterAction)`
`21`	`22`	`case setNavigation(isActive: Bool)`
`22`	`23`	`case setNavigationIsActiveDelayCompleted`
`@@ -38,12 +39,20 @@ let loadThenNavigateReducer =`
`38`	`39`	`with: Reducer<`
`39`	`40`	`LoadThenNavigateState, LoadThenNavigateAction, LoadThenNavigateEnvironment`
`40`	`41`	`> { state, action, environment in`
	`42`	`+`
	`43`	`+ struct CancelId: Hashable {}`
	`44`	`+`
`41`	`45`	`switch action {`
	`46`	`+`
	`47`	`+ case .onDisappear:`
	`48`	`+ return .cancel(id: CancelId())`
	`49`	`+`
`42`	`50`	`case .setNavigation(isActive: true):`
`43`	`51`	`state.isActivityIndicatorVisible = true`
`44`	`52`	`return Effect(value: .setNavigationIsActiveDelayCompleted)`
`45`	`53`	`.delay(for: 1, scheduler: environment.mainQueue)`
`46`	`54`	`.eraseToEffect()`
	`55`	`+ .cancellable(id: CancelId())`
`47`	`56`
`48`	`57`	`case .setNavigation(isActive: false):`
`49`	`58`	`state.optionalCounter = nil`
`@@ -90,6 +99,7 @@ struct LoadThenNavigateView: View {`
`90`	`99`	`}`
`91`	`100`	`}`
`92`	`101`	`}`
	`102`	`+ .onDisappear { viewStore.send(.onDisappear) }`
`93`	`103`	`}`
`94`	`104`	`.navigationBarTitle("Load then navigate")`
`95`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ struct LoadThenPresentState: Equatable {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`enum LoadThenPresentAction {`
	`20`	`+ case onDisappear`
`20`	`21`	`case optionalCounter(CounterAction)`
`21`	`22`	`case setSheet(isPresented: Bool)`
`22`	`23`	`case setSheetIsPresentedDelayCompleted`
`@@ -38,12 +39,20 @@ let loadThenPresentReducer =`
`38`	`39`	`with: Reducer<`
`39`	`40`	`LoadThenPresentState, LoadThenPresentAction, LoadThenPresentEnvironment`
`40`	`41`	`> { state, action, environment in`
	`42`	`+`
	`43`	`+ struct CancelId: Hashable {}`
	`44`	`+`
`41`	`45`	`switch action {`
	`46`	`+`
	`47`	`+ case .onDisappear:`
	`48`	`+ return .cancel(id: CancelId())`
	`49`	`+`
`42`	`50`	`case .setSheet(isPresented: true):`
`43`	`51`	`state.isActivityIndicatorVisible = true`
`44`	`52`	`return Effect(value: .setSheetIsPresentedDelayCompleted)`
`45`	`53`	`.delay(for: 1, scheduler: environment.mainQueue)`
`46`	`54`	`.eraseToEffect()`
	`55`	`+ .cancellable(id: CancelId())`
`47`	`56`
`48`	`57`	`case .setSheet(isPresented: false):`
`49`	`58`	`state.optionalCounter = nil`
`@@ -93,6 +102,7 @@ struct LoadThenPresentView: View {`
`93`	`102`	`)`
`94`	`103`	`}`
`95`	`104`	`.navigationBarTitle("Load and present")`
	`105`	`+ .onDisappear { viewStore.send(.onDisappear) }`
`96`	`106`	`}`
`97`	`107`	`}`
`98`	`108`	`}`