Refactor FXIOS-7853 [v122] Redux pattern protocol improvements (backport #17542)

BrowserKit/Sources/Redux/StoreSubscriber.swift

@@ -5,6 +5,8 @@
 import Foundation
 
 public protocol AnyStoreSubscriber: AnyObject {
+    func subscribeToRedux()
+    func unsubscribeFromRedux()
     func newState(state: Any)
 }
 

BrowserKit/Tests/ReduxTests/Utilities/FakeReduxViewController.swift

@@ -12,15 +12,32 @@ class FakeReduxViewController: UIViewController, StoreSubscriber {
 
     override func viewDidLoad() {
         super.viewDidLoad()
+        subscribeToRedux()
+        view.addSubview(label)
+    }
+
+    override func viewDidDisappear(_ animated: Bool) {
+        super.viewDidDisappear(animated)
+        unsubscribeFromRedux()
+    }
+
+    // MARK: - Redux
+
+    func subscribeToRedux() {
         store.subscribe(self)
         store.dispatch(FakeReduxAction.requestInitialValue)
-        view.addSubview(label)
+    }
+
+    func unsubscribeFromRedux() {
+        store.unsubscribe(self)
     }
 
     func newState(state: FakeReduxState) {
         label.text = "\(state.counter)"
     }
 
+    // MARK: - Helper functions
+
     func increaseCounter() {
         store.dispatch(FakeReduxAction.increaseCounter)
     }

Client/Frontend/Browser/BrowserViewController.swift

@@ -208,9 +208,7 @@ class BrowserViewController: UIViewController,
     }
 
     deinit {
-        if isReduxIntegrationEnabled {
-            store.unsubscribe(self)
-        }
+        unsubscribeFromRedux()
     }
 
     override var prefersStatusBarHidden: Bool {
@@ -467,7 +465,7 @@ class BrowserViewController: UIViewController,
 
     // MARK: - Redux
 
-    private func subscribeRedux() {
+    func subscribeToRedux() {
         guard isReduxIntegrationEnabled else { return }
         store.dispatch(ActiveScreensStateAction.showScreen(.fakespot))
 
@@ -476,6 +474,12 @@ class BrowserViewController: UIViewController,
         })
     }
 
+    func unsubscribeFromRedux() {
+        if isReduxIntegrationEnabled {
+            store.unsubscribe(self)
+        }
+    }
+
     func newState(state: FakespotState) {
         ensureMainThread { [weak self] in
             guard let self else { return }
@@ -550,7 +554,7 @@ class BrowserViewController: UIViewController,
         // Send settings telemetry for Fakespot
         FakespotUtils().addSettingTelemetry()
 
-        subscribeRedux()
+        subscribeToRedux()
     }
 
     private func setupAccessibleActions() {

Client/Frontend/Browser/Tabs/RemoteTabs/RemoteTabsPanel.swift

@@ -47,10 +47,7 @@ class RemoteTabsPanel: UIViewController,
     required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") }
 
     deinit {
-        if isReduxIntegrationEnabled {
-            store.dispatch(ActiveScreensStateAction.closeScreen(.remoteTabsPanel))
-            store.unsubscribe(self)
-        }
+        unsubscribeFromRedux()
     }
 
     // MARK: - Actions
@@ -96,7 +93,7 @@ class RemoteTabsPanel: UIViewController,
 
         listenForThemeChange(view)
         setupLayout()
-        subscribeRedux()
+        subscribeToRedux()
         applyTheme()
     }
 
@@ -128,7 +125,7 @@ class RemoteTabsPanel: UIViewController,
 
     // MARK: - Redux
 
-    private func subscribeRedux() {
+    func subscribeToRedux() {
         guard isReduxIntegrationEnabled else { return }
         store.dispatch(ActiveScreensStateAction.showScreen(.remoteTabsPanel))
         store.dispatch(RemoteTabsPanelAction.panelDidAppear)
@@ -137,6 +134,13 @@ class RemoteTabsPanel: UIViewController,
         })
     }
 
+    func unsubscribeFromRedux() {
+        if isReduxIntegrationEnabled {
+            store.dispatch(ActiveScreensStateAction.closeScreen(.remoteTabsPanel))
+            store.unsubscribe(self)
+        }
+    }
+
     func newState(state: RemoteTabsPanelState) {
         ensureMainThread { [weak self] in
             guard let self else { return }

Client/Frontend/Browser/Tabs/TabDisplayViewController.swift

@@ -25,7 +25,6 @@ class TabDisplayViewController: UIViewController,
     private var backgroundPrivacyOverlay: UIView = .build()
     private lazy var emptyPrivateTabsView: EmptyPrivateTabsView = .build()
 
-    // MARK: Redux state
     var tabsState: TabsState
 
     init(isPrivateMode: Bool,
@@ -43,30 +42,15 @@ class TabDisplayViewController: UIViewController,
     }
 
     deinit {
-        store.dispatch(ActiveScreensStateAction.closeScreen(.tabsPanel))
-        store.unsubscribe(self)
+        unsubscribeFromRedux()
     }
 
     override func viewDidLoad() {
         super.viewDidLoad()
         setupView()
         listenForThemeChange(view)
         applyTheme()
-        subscribeRedux()
-    }
-
-    private func subscribeRedux() {
-        store.dispatch(ActiveScreensStateAction.showScreen(.tabsPanel))
-        store.dispatch(TabPanelAction.tabPanelDidLoad(tabsState.isPrivateMode))
-        store.subscribe(self, transform: {
-            return $0.select(TabsState.init)
-        })
-    }
-
-    func newState(state: TabsState) {
-        tabsState = state
-        tabDisplayView.newState(state: tabsState)
-        shouldShowEmptyView(tabsState.isPrivateTabsEmpty)
+        subscribeToRedux()
     }
 
     func setupView() {
@@ -116,6 +100,27 @@ class TabDisplayViewController: UIViewController,
         tabDisplayView.applyTheme(theme: themeManager.currentTheme)
     }
 
+    // MARK: - Redux
+
+    func subscribeToRedux() {
+        store.dispatch(ActiveScreensStateAction.showScreen(.tabsPanel))
+        store.dispatch(TabPanelAction.tabPanelDidLoad(tabsState.isPrivateMode))
+        store.subscribe(self, transform: {
+            return $0.select(TabsState.init)
+        })
+    }
+
+    func unsubscribeFromRedux() {
+        store.dispatch(ActiveScreensStateAction.closeScreen(.tabsPanel))
+        store.unsubscribe(self)
+    }
+
+    func newState(state: TabsState) {
+        tabsState = state
+        tabDisplayView.newState(state: tabsState)
+        shouldShowEmptyView(tabsState.isPrivateTabsEmpty)
+    }
+
     // MARK: EmptyPrivateTabsViewDelegate
     func didTapLearnMore(urlRequest: URLRequest) {}
 }

Client/Frontend/Browser/Tabs/TabTrayViewController.swift

@@ -199,7 +199,7 @@ class TabTrayViewController: UIViewController,
     override func viewDidLoad() {
         super.viewDidLoad()
         setupView()
-        subscribeRedux()
+        subscribeToRedux()
         listenForThemeChange(view)
         updateToolbarItems()
     }
@@ -229,20 +229,7 @@ class TabTrayViewController: UIViewController,
         super.viewDidDisappear(animated)
         delegate?.didFinish()
 
-        store.dispatch(ActiveScreensStateAction.closeScreen(.tabsTray))
-        store.unsubscribe(self)
-    }
-
-    private func subscribeRedux() {
-        store.dispatch(ActiveScreensStateAction.showScreen(.tabsTray))
-        store.dispatch(TabTrayAction.tabTrayDidLoad(tabTrayState.selectedPanel))
-        store.subscribe(self, transform: {
-            return $0.select(TabTrayState.init)
-        })
-    }
-
-    func newState(state: TabTrayState) {
-        tabTrayState = state
+        unsubscribeFromRedux()
     }
 
     private func updateLayout() {
@@ -260,6 +247,24 @@ class TabTrayViewController: UIViewController,
         updateToolbarItems()
     }
 
+    // MARK: - Redux
+
+    func subscribeToRedux() {
+        store.dispatch(ActiveScreensStateAction.showScreen(.tabsTray))
+        store.dispatch(TabTrayAction.tabTrayDidLoad(tabTrayState.selectedPanel))
+        store.subscribe(self, transform: {
+            return $0.select(TabTrayState.init)
+        })
+    }
+
+    func unsubscribeFromRedux() {
+        store.dispatch(ActiveScreensStateAction.closeScreen(.tabsTray))
+        store.unsubscribe(self)
+    }
+
+    func newState(state: TabTrayState) {
+    }
+
     // MARK: Themeable
     func applyTheme() {
         view.backgroundColor = themeManager.currentTheme.colors.layer1

Client/Frontend/Settings/ThemeSettings/ThemeSettingsController.swift

@@ -55,12 +55,7 @@ class ThemeSettingsController: ThemedTableViewController, StoreSubscriber {
 
     override func viewDidLoad() {
         super.viewDidLoad()
-        if isReduxIntegrationEnabled {
-            store.dispatch(ThemeSettingsAction.themeSettingsDidAppear)
-            store.subscribe(self, transform: {
-                $0.select(ThemeSettingsState.init)
-            })
-        }
+        subscribeToRedux()
 
         title = .SettingsDisplayThemeTitle
         tableView.accessibilityIdentifier = "DisplayTheme.Setting.Options"
@@ -76,6 +71,21 @@ class ThemeSettingsController: ThemedTableViewController, StoreSubscriber {
 
     override func viewDidDisappear(_ animated: Bool) {
         super.viewDidDisappear(animated)
+        unsubscribeFromRedux()
+    }
+
+    // MARK: - Redux
+
+    func subscribeToRedux() {
+        if isReduxIntegrationEnabled {
+            store.dispatch(ThemeSettingsAction.themeSettingsDidAppear)
+            store.subscribe(self, transform: {
+                $0.select(ThemeSettingsState.init)
+            })
+        }
+    }
+
+    func unsubscribeFromRedux() {
         if isReduxIntegrationEnabled {
             store.dispatch(ActiveScreensStateAction.closeScreen(.themeSettings))
             store.unsubscribe(self)