Alert bug exploration (#249)

* wip

* Fix

* revert

* Fix tests

* Better debug output

* organize

* alphabetize

* Fix mac

Co-authored-by: Brandon Williams <[email protected]>

Author: stephencelis

Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-AlertsAndActionSheets.swift

@@ -27,8 +27,10 @@ struct AlertAndSheetState: Equatable {
 enum AlertAndSheetAction: Equatable {
   case actionSheetButtonTapped
   case actionSheetCancelTapped
+  case actionSheetDismissed
   case alertButtonTapped
   case alertCancelTapped
+  case alertDismissed
   case decrementButtonTapped
   case incrementButtonTapped
 }
@@ -53,6 +55,9 @@ let alertAndSheetReducer = Reducer<
     return .none
 
   case .actionSheetCancelTapped:
+    return .none
+
+  case .actionSheetDismissed:
     state.actionSheet = nil
     return .none
 
@@ -66,21 +71,24 @@ let alertAndSheetReducer = Reducer<
     return .none
 
   case .alertCancelTapped:
+    return .none
+
+  case .alertDismissed:
     state.alert = nil
     return .none
 
   case .decrementButtonTapped:
-    state.actionSheet = nil
+    state.alert = .init(title: "Decremented!")
     state.count -= 1
     return .none
 
   case .incrementButtonTapped:
-    state.actionSheet = nil
-    state.alert = nil
+    state.alert = .init(title: "Incremented!")
     state.count += 1
     return .none
   }
 }
+.debug()
 
 struct AlertAndSheetView: View {
   let store: Store<AlertAndSheetState, AlertAndSheetAction>
@@ -94,13 +102,13 @@ struct AlertAndSheetView: View {
           Button("Alert") { viewStore.send(.alertButtonTapped) }
             .alert(
               self.store.scope(state: { $0.alert }),
-              dismiss: .alertCancelTapped
+              dismiss: .alertDismissed
             )
 
           Button("Action sheet") { viewStore.send(.actionSheetButtonTapped) }
             .actionSheet(
               self.store.scope(state: { $0.actionSheet }),
-              dismiss: .actionSheetCancelTapped
+              dismiss: .actionSheetDismissed
             )
         }
       }

Examples/CaseStudies/SwiftUICaseStudiesTests/01-GettingStarted-AlertsAndActionSheetsTests.swift

@@ -23,8 +23,11 @@ class AlertsAndActionSheetsTests: XCTestCase {
         )
       },
       .send(.incrementButtonTapped) {
-        $0.alert = nil
+        $0.alert = .init(title: "Incremented!")
         $0.count = 1
+      },
+      .send(.alertDismissed) {
+        $0.alert = nil
       }
     )
   }
@@ -49,8 +52,11 @@ class AlertsAndActionSheetsTests: XCTestCase {
         )
       },
       .send(.incrementButtonTapped) {
-        $0.actionSheet = nil
+        $0.alert = .init(title: "Incremented!")
         $0.count = 1
+      },
+      .send(.actionSheetDismissed) {
+        $0.actionSheet = nil
       }
     )
   }

Sources/ComposableArchitecture/SwiftUI/ActionSheet.swift

@@ -105,6 +105,7 @@ import SwiftUI
 @available(tvOS 13, *)
 @available(watchOS 6, *)
 public struct ActionSheetState<Action> {
+  public let id = UUID()
   public var buttons: [Button]
   public var message: String?
   public var title: String
@@ -127,32 +128,59 @@ public struct ActionSheetState<Action> {
 @available(macOS, unavailable)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Equatable where Action: Equatable {}
+extension ActionSheetState: CustomDebugOutputConvertible {
+  public var debugOutput: String {
+    let fields = (
+      title: self.title,
+      message: self.message,
+      buttons: self.buttons
+    )
+    return "\(Self.self)\(ComposableArchitecture.debugOutput(fields))"
+  }
+}
 
 @available(iOS 13, *)
 @available(macCatalyst 13, *)
 @available(macOS, unavailable)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Hashable where Action: Hashable {}
+extension ActionSheetState: Equatable where Action: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    lhs.title == rhs.title
+      && lhs.message == rhs.message
+      && lhs.buttons == rhs.buttons
+  }
+}
 
 @available(iOS 13, *)
 @available(macCatalyst 13, *)
 @available(macOS, unavailable)
 @available(tvOS 13, *)
 @available(watchOS 6, *)
-extension ActionSheetState: Identifiable where Action: Hashable {
-  public var id: Self { self }
+extension ActionSheetState: Hashable where Action: Hashable {
+  public func hash(into hasher: inout Hasher) {
+    hasher.combine(self.title)
+    hasher.combine(self.message)
+    hasher.combine(self.buttons)
+  }
 }
 
+@available(iOS 13, *)
+@available(macCatalyst 13, *)
+@available(macOS, unavailable)
+@available(tvOS 13, *)
+@available(watchOS 6, *)
+extension ActionSheetState: Identifiable {}
+
 extension View {
   /// Displays an action sheet when the store's state becomes non-`nil`, and dismisses it when it
   /// becomes `nil`.
   ///
   /// - Parameters:
   ///   - store: A store that describes if the action sheet is shown or dismissed.
   ///   - dismissal: An action to send when the action sheet is dismissed through non-user actions,
-  ///     such as when an action sheet is automatically dismissed by the system.
+  ///     such as when an action sheet is automatically dismissed by the system. Use this action to
+  ///     `nil` out the associated action sheet state.
   @available(iOS 13, *)
   @available(macCatalyst 13, *)
   @available(macOS, unavailable)
@@ -163,16 +191,11 @@ extension View {
     dismiss: Action
   ) -> some View {
 
-    let viewStore = ViewStore(store, removeDuplicates: { ($0 == nil) != ($1 == nil) })
-    return self.actionSheet(
-      isPresented: Binding(
-        get: { viewStore.state != nil },
-        set: {
-          guard !$0 else { return }
-          viewStore.send(dismiss)
-        }),
-      content: { viewStore.state?.toSwiftUI(send: viewStore.send) ?? ActionSheet(title: Text("")) }
-    )
+    WithViewStore(store, removeDuplicates: { $0?.id == $1?.id }) { viewStore in
+      self.actionSheet(item: viewStore.binding(send: dismiss)) { state in
+        state.toSwiftUI(send: viewStore.send)
+      }
+    }
   }
 }
 

Sources/ComposableArchitecture/SwiftUI/Alert.swift

@@ -91,6 +91,7 @@ import SwiftUI
 ///     )
 ///
 public struct AlertState<Action> {
+  public let id = UUID()
   public var message: String?
   public var primaryButton: Button?
   public var secondaryButton: Button?
@@ -164,34 +165,54 @@ extension View {
   /// - Parameters:
   ///   - store: A store that describes if the alert is shown or dismissed.
   ///   - dismissal: An action to send when the alert is dismissed through non-user actions, such
-  ///     as when an alert is automatically dismissed by the system.
+  ///     as when an alert is automatically dismissed by the system. Use this action to `nil` out
+  ///     the associated alert state.
   public func alert<Action>(
     _ store: Store<AlertState<Action>?, Action>,
     dismiss: Action
   ) -> some View {
 
-    let viewStore = ViewStore(store, removeDuplicates: { ($0 == nil) != ($1 == nil) })
-    return self.alert(
-      isPresented: Binding(
-        get: { viewStore.state != nil },
-        set: {
-          guard !$0 else { return }
-          viewStore.send(dismiss)
-        }),
-      content: { viewStore.state?.toSwiftUI(send: viewStore.send) ?? Alert(title: Text("")) }
+    WithViewStore(store, removeDuplicates: { $0?.id == $1?.id }) { viewStore in
+      self.alert(item: viewStore.binding(send: dismiss)) { state in
+        state.toSwiftUI(send: viewStore.send)
+      }
+    }
+  }
+}
+
+extension AlertState: CustomDebugOutputConvertible {
+  public var debugOutput: String {
+    let fields = (
+      title: self.title,
+      message: self.message,
+      primaryButton: self.primaryButton,
+      secondaryButton: self.secondaryButton
     )
+    return "\(Self.self)\(ComposableArchitecture.debugOutput(fields))"
   }
 }
 
-extension AlertState: Equatable where Action: Equatable {}
-extension AlertState: Hashable where Action: Hashable {}
+extension AlertState: Equatable where Action: Equatable {
+  public static func == (lhs: Self, rhs: Self) -> Bool {
+    lhs.title == rhs.title
+      && lhs.message == rhs.message
+      && lhs.primaryButton == rhs.primaryButton
+      && lhs.secondaryButton == rhs.secondaryButton
+  }
+}
+extension AlertState: Hashable where Action: Hashable {
+  public func hash(into hasher: inout Hasher) {
+    hasher.combine(self.title)
+    hasher.combine(self.message)
+    hasher.combine(self.primaryButton)
+    hasher.combine(self.secondaryButton)
+  }
+}
+extension AlertState: Identifiable {}
+
 extension AlertState.Button: Equatable where Action: Equatable {}
 extension AlertState.Button: Hashable where Action: Hashable {}
 
-extension AlertState: Identifiable where Action: Hashable {
-  public var id: Self { self }
-}
-
 extension AlertState.Button {
   func toSwiftUI(send: @escaping (Action) -> Void) -> SwiftUI.Alert.Button {
     let action = { if let action = self.action { send(action) } }