From 5c9fff041b9f3325ffd201a5227b523bb560c089 Mon Sep 17 00:00:00 2001
From: Andhika Setiadi <andhika.setiadi@tokopedia.com>
Date: Thu, 19 Oct 2023 11:26:00 +0700
Subject: [PATCH] [AnyReducer] - Implement Flag to raise runTimeWarn on
 Pullback  (#102)

* implement runWarn using flag

* update flag to assertOnInvalidAction
---
 .../Reducer/AnyReducer/AnyReducer.swift       | 67 +++++++++++--------
 1 file changed, 40 insertions(+), 27 deletions(-)

diff --git a/Sources/RxComposableArchitecture/Reducer/AnyReducer/AnyReducer.swift b/Sources/RxComposableArchitecture/Reducer/AnyReducer/AnyReducer.swift
index 46ac4ab..e6dc8b1 100644
--- a/Sources/RxComposableArchitecture/Reducer/AnyReducer/AnyReducer.swift
+++ b/Sources/RxComposableArchitecture/Reducer/AnyReducer/AnyReducer.swift
@@ -241,11 +241,19 @@ public struct AnyReducer<State, Action, Environment> {
             .map(toLocalAction.embed)
         }
     }
-
+    
+    ///
+    /// - Parameters:
+    ///   - toLocalState: A key path that can get/set `State` inside `ParentState`.
+    ///   - toLocalAction: A case path that can extract/embed `Action` from `ParentAction`.
+    ///   - toLocalEnvironment: A function that transforms `ParentEnvironment` into `Environment`.
+    ///   - assertOnInvalidAction: A flag indicate we run assertion for `invalid action` that `not match` with our current extract-ed/embed-ed `State` from `ParentState`.
+    /// - Returns: A reducer that works on `ParentState`, `ParentAction`, `ParentEnvironment`.
     public func pullback<GlobalState, GlobalAction, GlobalEnvironment, StatePath, ActionPath>(
         state toLocalState: StatePath,
         action toLocalAction: ActionPath,
         environment toLocalEnvironment: @escaping (GlobalEnvironment) -> Environment,
+        assertOnInvalidAction: Bool = true,
         file: StaticString = #file,
         fileID: StaticString = #fileID,
         line: UInt = #line
@@ -258,32 +266,37 @@ public struct AnyReducer<State, Action, Environment> {
             guard let localAction = toLocalAction.extract(from: globalAction) else { return .none }
             
             guard var localState = toLocalState.extract(from: globalState) else {
-                runtimeWarn(
-                  """
-                  A reducer pulled back from "\(fileID):\(line)" received an action when child state was \
-                  unavailable. …
-
-                    Action:
-                      \(debugCaseOutput(localAction))
-
-                  This is generally considered an application logic error, and can happen for a few \
-                  reasons:
-
-                  • The reducer for a particular case of state was combined with or run from another \
-                  reducer that set "\(typeName(GlobalState.self))" to another case before the reducer ran. \
-                  Combine or run case-specific reducers before reducers that may set their state to \
-                  another case. This ensures that case-specific reducers can handle their actions while \
-                  their state is available.
-
-                  • An in-flight effect emitted this action when state was unavailable. While it may be \
-                  perfectly reasonable to ignore this action, you may want to cancel the associated \
-                  effect before state is set to another case, especially if it is a long-living effect.
-
-                  • This action was sent to the store while state was another case. Make sure that \
-                  actions for this reducer can only be sent to a view store when state is non-"nil". \
-                  In SwiftUI applications, use "SwitchStore".
-                  """
-                )
+                #if DEBUG
+                    if assertOnInvalidAction {
+                        runtimeWarn(
+                          """
+                          A reducer pulled back from "\(fileID):\(line)" received an action when child state was \
+                          unavailable. …
+
+                            Action:
+                              \(debugCaseOutput(localAction))
+
+                          This is generally considered an application logic error, and can happen for a few \
+                          reasons:
+
+                          • The reducer for a particular case of state was combined with or run from another \
+                          reducer that set "\(typeName(GlobalState.self))" to another case before the reducer ran. \
+                          Combine or run case-specific reducers before reducers that may set their state to \
+                          another case. This ensures that case-specific reducers can handle their actions while \
+                          their state is available.
+
+                          • An in-flight effect emitted this action when state was unavailable. While it may be \
+                          perfectly reasonable to ignore this action, you may want to cancel the associated \
+                          effect before state is set to another case, especially if it is a long-living effect.
+
+                          • This action was sent to the store while state was another case. Make sure that \
+                          actions for this reducer can only be sent to a view store when state is non-"nil". \
+                          In SwiftUI applications, use "SwitchStore".
+                          """
+                        )
+                    }
+                #endif
+
                 return .none
             }