fix: iOS - make unowned references weak (#1443)

BREAKING CHANGE: the property controller in BeagleRenderer is now weak
ZupIT · Mar 23, 2021 · c9b8e3d · c9b8e3d
1 parent 995b720
commit c9b8e3d
Show file tree

Hide file tree

Showing 27 changed files with 148 additions and 78 deletions.
diff --git a/iOS/Example/BeagleDemo/BeagleDemo/Screens/NativeViewController.swift b/iOS/Example/BeagleDemo/BeagleDemo/Screens/NativeViewController.swift
@@ -45,7 +45,9 @@ class NativeViewController: UIViewController {
         )
     })
 
-    private lazy var serverDrivenBeagleView = BeagleView(.init(url: .textLazyComponentEndpoint)) { state in
+    private lazy var serverDrivenBeagleView = BeagleView(.init(url: .textLazyComponentEndpoint)) {
+        [weak self] state in
+        guard let self = self else { return }
         switch state {
         case .started:
             self.loadingLabel.isHidden = false

diff --git a/iOS/Sources/Beagle/Beagle.xcodeproj/project.pbxproj b/iOS/Sources/Beagle/Beagle.xcodeproj/project.pbxproj
@@ -206,6 +206,7 @@
 		A05C74DD2498162B009DBB66 /* FormValidationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A05C74DC2498162B009DBB66 /* FormValidationTests.swift */; };
 		A068234C238430C500CEE57A /* ValidatorProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = A068234B238430C500CEE57A /* ValidatorProvider.swift */; };
 		A068234E2384320000CEE57A /* Validator.swift in Sources */ = {isa = PBXBuildFile; fileRef = A068234D2384320000CEE57A /* Validator.swift */; };
+		A0C4BF152600EEEC004B0422 /* BindingConfiguratorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0C4BF142600EEEB004B0422 /* BindingConfiguratorTests.swift */; };
 		A0D608D82448DF8700F7D851 /* ScreenType.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0D608D52448DF8600F7D851 /* ScreenType.swift */; };
 		A0D608DA2448DF8700F7D851 /* BeagleNavigationController.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0D608D72448DF8700F7D851 /* BeagleNavigationController.swift */; };
 		A0EB6BD725910FC8001A3E65 /* AnalyticsRecord.swift in Sources */ = {isa = PBXBuildFile; fileRef = A0EB6BD425910FC8001A3E65 /* AnalyticsRecord.swift */; };
@@ -573,6 +574,7 @@
 		A05C74DC2498162B009DBB66 /* FormValidationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FormValidationTests.swift; sourceTree = "<group>"; };
 		A068234B238430C500CEE57A /* ValidatorProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ValidatorProvider.swift; sourceTree = "<group>"; };
 		A068234D2384320000CEE57A /* Validator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Validator.swift; sourceTree = "<group>"; };
+		A0C4BF142600EEEB004B0422 /* BindingConfiguratorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BindingConfiguratorTests.swift; sourceTree = "<group>"; };
 		A0D608D52448DF8600F7D851 /* ScreenType.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ScreenType.swift; sourceTree = "<group>"; };
 		A0D608D72448DF8700F7D851 /* BeagleNavigationController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BeagleNavigationController.swift; sourceTree = "<group>"; };
 		A0EB6BD425910FC8001A3E65 /* AnalyticsRecord.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AnalyticsRecord.swift; sourceTree = "<group>"; };
@@ -1876,6 +1878,7 @@
 				2532D5DB25099ABB001D1469 /* BeagleViewTests.swift */,
 				93D24A56251402B8005A5CBD /* AutoLayoutWrapperTests.swift */,
 				93EE0CA3252D0EE50032BE77 /* ViewConfiguratorTests.swift */,
+				A0C4BF142600EEEB004B0422 /* BindingConfiguratorTests.swift */,
 			);
 			path = Tests;
 			sourceTree = "<group>";
@@ -2568,6 +2571,7 @@
 				C08D4E3624857CBA00AAAC0A /* URLOpenerTests.swift in Sources */,
 				9398CA5A255325730003A010 /* PathTests.swift in Sources */,
 				A05C74DD2498162B009DBB66 /* FormValidationTests.swift in Sources */,
+				A0C4BF152600EEEC004B0422 /* BindingConfiguratorTests.swift in Sources */,
 				E5A7763F237DA1F3002F5515 /* FormTests.swift in Sources */,
 				C08D4E472485804D00AAAC0A /* LazyComponentTests.swift in Sources */,
 				93ADB87923FAD31D005B7CD2 /* ComposeComponentTests.swift in Sources */,

diff --git a/iOS/Sources/Beagle/Sources/Analytics/Deprecated/DeprecatedAnalytics.swift b/iOS/Sources/Beagle/Sources/Analytics/Deprecated/DeprecatedAnalytics.swift
@@ -27,7 +27,7 @@ final class EventsGestureRecognizer: UITapGestureRecognizer {
     let events: [Event]
     weak var controller: BeagleController?
 
-    init(events: [Event], controller: BeagleController) {
+    init(events: [Event], controller: BeagleController?) {
         self.events = events
         self.controller = controller
         super.init(target: nil, action: nil)

diff --git a/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/Form/Form+Extensions.swift b/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/Form/Form+Extensions.swift
@@ -34,12 +34,12 @@ extension Deprecated.Form {
 
         registerFormSubmit(view: childView)
         if !hasFormSubmit {
-            renderer.controller.dependencies.logger.log(Log.form(.submitNotFound(form: self)))
+            renderer.dependencies.logger.log(Log.form(.submitNotFound(form: self)))
         }
         return childView
     }
 
-    private func register(formView: UIView, submitView: UIView, controller: BeagleController) {
+    private func register(formView: UIView, submitView: UIView, controller: BeagleController?) {
         let gestureRecognizer = SubmitFormGestureRecognizer(
             form: self,
             formView: formView,

diff --git a/...le/Sources/Components/ServerDrivenComponent/Form/Submit/SubmitFormGestureRecognizer.swift b/...le/Sources/Components/ServerDrivenComponent/Form/Submit/SubmitFormGestureRecognizer.swift
@@ -23,7 +23,7 @@ final class SubmitFormGestureRecognizer: UITapGestureRecognizer {
     weak var formSubmitView: UIView?
     weak var controller: BeagleController?
 
-    init(form: Deprecated.Form, formView: UIView, formSubmitView: UIView, controller: BeagleController) {
+    init(form: Deprecated.Form, formView: UIView, formSubmitView: UIView, controller: BeagleController?) {
         self.form = form
         self.formView = formView
         self.formSubmitView = formSubmitView

diff --git a/...urces/Beagle/Sources/Components/ServerDrivenComponent/Lazy/LazyComponent+Extensions.swift b/...urces/Beagle/Sources/Components/ServerDrivenComponent/Lazy/LazyComponent+Extensions.swift
@@ -25,14 +25,14 @@ extension LazyComponent {
     }
 
     private func lazyLoad(initialState view: UIView, renderer: BeagleRenderer) {
-        renderer.controller.dependencies.repository.fetchComponent(url: path, additionalData: nil, useCache: false) {
+        renderer.dependencies.repository.fetchComponent(url: path, additionalData: nil, useCache: false) {
             [weak view] result in
             guard let view = view else { return }
             switch result {
             case .success(let component):
                 view.update(lazyLoaded: component, renderer: renderer)
             case .failure(let error):
-                renderer.controller.serverDrivenState = .error(
+                renderer.controller?.serverDrivenState = .error(
                     .lazyLoad(error),
                     self.retryClosure(initialState: view, renderer: renderer)
                 )
@@ -55,7 +55,7 @@ extension UIView {
     ) {
         if let updatable = self as? OnStateUpdatable,
             updatable.onUpdateState(component: lazyLoaded) {
-            renderer.controller.setNeedsLayout(component: self)
+            renderer.controller?.setNeedsLayout(component: self)
         } else {
             DispatchQueue.main.async {
                 self.replace(with: lazyLoaded, renderer: renderer)
@@ -74,9 +74,9 @@ extension UIView {
         superview.insertSubview(newView, belowSubview: self)
         removeFromSuperview()
 
-        if renderer.controller.dependencies.style(self).isFlexEnabled {
-            renderer.controller.dependencies.style(newView).isFlexEnabled = true
+        if renderer.dependencies.style(self).isFlexEnabled {
+            renderer.dependencies.style(newView).isFlexEnabled = true
         }
-        renderer.controller.setNeedsLayout(component: newView)
+        renderer.controller?.setNeedsLayout(component: newView)
     }
 }
diff --git a/...urces/Beagle/Sources/Components/ServerDrivenComponent/Lazy/Tests/LazyComponentTests.swift b/...urces/Beagle/Sources/Components/ServerDrivenComponent/Lazy/Tests/LazyComponentTests.swift
@@ -77,9 +77,8 @@ final class LazyComponentTests: XCTestCase {
             initialState: ComponentDummy(resultView: initialView)
         )
         let repository = LazyRepositoryStub()
-        let controller = BeagleControllerStub()
+        let controller = BeagleControllerStub(dependencies: BeagleScreenDependencies(repository: repository))
         let renderer = BeagleRenderer(controller: controller)
-        controller.dependencies = BeagleScreenDependencies(repository: repository)
 
         let view = sut.toView(renderer: renderer)
         repository.componentCompletion?(.success(ComponentDummy()))
@@ -97,9 +96,8 @@ final class LazyComponentTests: XCTestCase {
             initialState: ComponentDummy(resultView: initialView)
         )
         let repository = LazyRepositoryStub()
-        let controller = BeagleControllerStub()
+        let controller = BeagleControllerStub(dependencies: BeagleScreenDependencies(repository: repository))
         let renderer = BeagleRenderer(controller: controller)
-        controller.dependencies = BeagleScreenDependencies(repository: repository)
 
         // When
         let view = sut.toView(renderer: renderer)

diff --git a/...Sources/Beagle/Sources/Components/ServerDrivenComponent/ListView/ListViewController.swift b/...Sources/Beagle/Sources/Components/ServerDrivenComponent/ListView/ListViewController.swift
@@ -78,16 +78,16 @@ final class ListViewController: UIViewController {
 extension ListViewController: BeagleControllerProtocol {
 
     var dependencies: BeagleDependenciesProtocol {
-        return renderer.controller.dependencies
+        return renderer.dependencies
     }
 
     var serverDrivenState: ServerDrivenState {
-        get { return renderer.controller.serverDrivenState }
-        set { renderer.controller.serverDrivenState = newValue }
+        get { return renderer.controller?.serverDrivenState ?? .finished }
+        set { renderer.controller?.serverDrivenState = newValue }
     }
 
     var screenType: ScreenType {
-        return renderer.controller.screenType
+        return renderer.controller?.screenType ?? .declarativeText("")
     }
 
     var screen: Screen? {

diff --git a/...ources/Beagle/Sources/Components/ServerDrivenComponent/ListView/ListViewUIComponent.swift b/...ources/Beagle/Sources/Components/ServerDrivenComponent/ListView/ListViewUIComponent.swift
@@ -100,7 +100,7 @@ final class ListViewUIComponent: UIView {
         collection.showsVerticalScrollIndicator = model.isScrollIndicatorVisible
 
         let parentController = listController.renderer.controller
-        parentController.addChild(listController)
+        parentController?.addChild(listController)
         addSubview(listController.view)
         listController.view.autoresizingMask = [.flexibleWidth, .flexibleHeight]
         listController.view.frame = bounds
@@ -194,7 +194,7 @@ final class ListViewUIComponent: UIView {
 
         if items?.count == 0 || didReachScrollThreshol {
             onScrollEndExecuted = true
-            renderer.controller.execute(actions: model.onScrollEnd, event: "onScrollEnd", origin: self)
+            renderer.controller?.execute(actions: model.onScrollEnd, event: "onScrollEnd", origin: self)
         }
     }
 

diff --git a/...es/Beagle/Sources/Components/ServerDrivenComponent/PageView/ComponentHostController.swift b/...es/Beagle/Sources/Components/ServerDrivenComponent/PageView/ComponentHostController.swift
@@ -24,29 +24,29 @@ class ComponentHostController: BeagleController {
     let bindings = Bindings()
 
     var dependencies: BeagleDependenciesProtocol {
-        return renderer.controller.dependencies
+        return renderer.dependencies
     }
     var serverDrivenState: ServerDrivenState {
-        get { renderer.controller.serverDrivenState }
-        set { renderer.controller.serverDrivenState = newValue }
+        get { renderer.controller?.serverDrivenState ?? .finished }
+        set { renderer.controller?.serverDrivenState = newValue }
     }
     var screenType: ScreenType {
-        return renderer.controller.screenType
+        return renderer.controller?.screenType ?? .declarativeText("")
     }
     var screen: Screen? {
-        return renderer.controller.screen
+        return renderer.controller?.screen
     }
 
     func addOnInit(_ onInit: [Action], in view: UIView) {
-        renderer.controller.addOnInit(onInit, in: view)
+        renderer.controller?.addOnInit(onInit, in: view)
     }
 
     func execute(actions: [Action]?, event: String?, origin: UIView) {
-        renderer.controller.execute(actions: actions, event: event, origin: origin)
+        renderer.controller?.execute(actions: actions, event: event, origin: origin)
     }
 
     func execute(actions: [Action]?, with contextId: String, and contextValue: DynamicObject, origin: UIView) {
-        renderer.controller.execute(actions: actions, with: contextId, and: contextValue, origin: origin)
+        renderer.controller?.execute(actions: actions, with: contextId, and: contextValue, origin: origin)
     }
 
     public func addBinding<T: Decodable>(expression: ContextExpression, in view: UIView, update: @escaping (T?) -> Void) {

diff --git a/...ources/Beagle/Sources/Components/ServerDrivenComponent/PageView/PageView+Extensions.swift b/...ources/Beagle/Sources/Components/ServerDrivenComponent/PageView/PageView+Extensions.swift
@@ -35,8 +35,9 @@ extension PageView {
         )
 
         if let actions = onPageChange {
-            view.onPageChange = { page in
-                renderer.controller.execute(actions: actions, with: "onPageChange", and: .int(page), origin: view)
+            view.onPageChange = { [weak view] page in
+                guard let view = view else { return }
+                renderer.controller?.execute(actions: actions, with: "onPageChange", and: .int(page), origin: view)
             }
         }
 

diff --git a/...ources/Beagle/Sources/Components/ServerDrivenComponent/PageView/PageViewUIComponent.swift b/...ources/Beagle/Sources/Components/ServerDrivenComponent/PageView/PageViewUIComponent.swift
@@ -52,7 +52,7 @@ class PageViewUIComponent: UIView {
     init(
         model: Model,
         indicatorView: PageIndicatorUIView?,
-        controller: BeagleController
+        controller: BeagleController?
     ) {
         self.model = model
         self.indicatorView = indicatorView
@@ -76,8 +76,8 @@ class PageViewUIComponent: UIView {
         navigationOrientation: .horizontal
     )
 
-    private func setupLayout(controller: BeagleController) {
-        controller.addChild(pageViewController)
+    private func setupLayout(controller: BeagleController?) {
+        controller?.addChild(pageViewController)
         addSubview(pageViewController.view)
         pageViewController.didMove(toParent: controller)
 

diff --git a/...s/Beagle/Sources/Components/ServerDrivenComponent/Screen/ScreenComponent+Extensions.swift b/...s/Beagle/Sources/Components/ServerDrivenComponent/Screen/ScreenComponent+Extensions.swift
@@ -20,7 +20,7 @@ extension ScreenComponent {
 
     public func toView(renderer: BeagleRenderer) -> UIView {
 
-        prefetch(helper: renderer.controller.dependencies.preFetchHelper)
+        prefetch(helper: renderer.dependencies.preFetchHelper)
 
         return buildChildView(renderer: renderer)
     }

diff --git a/...s/Beagle/Sources/Components/ServerDrivenComponent/Screen/Tests/ScreenComponentTests.swift b/...s/Beagle/Sources/Components/ServerDrivenComponent/Screen/Tests/ScreenComponentTests.swift
@@ -134,9 +134,9 @@ final class ScreenComponentTests: XCTestCase {
 
     func test_shouldPrefetchNavigateAction() {
         let prefetch = BeaglePrefetchHelpingSpy()
-        let controller = BeagleControllerStub()
+        let dependencies = BeagleScreenDependencies(preFetchHelper: prefetch)
+        let controller = BeagleControllerStub(dependencies: dependencies)
         let renderer = BeagleRenderer(controller: controller)
-        controller.dependencies = BeagleScreenDependencies(preFetchHelper: prefetch)
 
         let navigatePath = "button-item-prefetch"
         let navigate = Navigate.pushView(.remote(.init(url: navigatePath, shouldPrefetch: true)))

diff --git a/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBar+Extensions.swift b/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBar+Extensions.swift
@@ -29,8 +29,9 @@ extension TabBar {
             }
         }
 
-        tabBarScroll.onTabSelection = { tab in
-            renderer.controller.execute(actions: self.onTabSelection, with: "onTabSelection", and: .int(tab), origin: tabBarScroll)
+        tabBarScroll.onTabSelection = { [weak tabBarScroll] tab in
+            guard let view = tabBarScroll else { return }
+            renderer.controller?.execute(actions: self.onTabSelection, with: "onTabSelection", and: .int(tab), origin: view)
         }
 
         return tabBarScroll

diff --git a/...ources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBarItemUIComponent.swift b/...ources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBarItemUIComponent.swift
@@ -124,12 +124,13 @@ final class TabBarItemUIComponent: UIView {
 
     private func handleContextOnImage(iconName: String) {
         let expression: Expression<String> = "\(iconName)"
-
-        renderer?.observe(expression, andUpdateManyIn: self) { icon in
+
+        renderer?.observe(expression, andUpdateManyIn: self) { [weak self] icon in
+            guard let self = self else { return }
             if let icon = icon {
                 self.icon.image = self.theme?.selectedIconColor == nil ?
-                    UIImage(named: icon, in: self.renderer?.controller.dependencies.appBundle, compatibleWith: nil) :
-                    UIImage(named: icon, in: self.renderer?.controller.dependencies.appBundle, compatibleWith: nil)?.withRenderingMode(.alwaysTemplate)
+                    UIImage(named: icon, in: self.renderer?.dependencies.appBundle, compatibleWith: nil) :
+                    UIImage(named: icon, in: self.renderer?.dependencies.appBundle, compatibleWith: nil)?.withRenderingMode(.alwaysTemplate)
             }
         }
     }

diff --git a/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBarUIComponent.swift b/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/TabBar/TabBarUIComponent.swift
@@ -97,7 +97,7 @@ final class TabBarUIComponent: UIScrollView {
         }
         guard let selectedTabItem = tabItemViews[model.tabIndex ?? 0] else { return }
         setupIndicatorViewStyle(for: selectedTabItem)
-        model.renderer.controller.setNeedsLayout(component: self)
+        model.renderer.controller?.setNeedsLayout(component: self)
     }
 
     private func setupScrollView() {
@@ -234,10 +234,8 @@ private extension TabBarUIComponent {
             options: .curveLinear,
             animations: {
                 self.setupIndicatorViewStyle(for: tabItem)
-
-                // TODO: setNeedLayout should call layoutIfNeeded
-                self.model.renderer.controller.setNeedsLayout(component: self)
-                self.model.renderer.controller.view.layoutIfNeeded()
+                self.model.renderer.controller?.setNeedsLayout(component: self)
+                self.model.renderer.controller?.view.layoutIfNeeded()
             }
         )
     }

diff --git a/...rces/Beagle/Sources/Components/ServerDrivenComponent/Touchable/Touchable+Extensions.swift b/...rces/Beagle/Sources/Components/ServerDrivenComponent/Touchable/Touchable+Extensions.swift
@@ -36,11 +36,11 @@ extension Touchable {
         }
 
         register(events: events, inView: childView, controller: renderer.controller)
-        prefetchComponent(helper: renderer.controller.dependencies.preFetchHelper)
+        prefetchComponent(helper: renderer.dependencies.preFetchHelper)
         return childView
     }
 
-    private func register(events: [Event], inView view: UIView, controller: BeagleController) {
+    private func register(events: [Event], inView view: UIView, controller: BeagleController?) {
         let eventsGestureRecognizer = EventsGestureRecognizer(
             events: events,
             controller: controller
@@ -49,10 +49,10 @@ extension Touchable {
         view.isUserInteractionEnabled = true
     }
 
-    private func prefetchComponent(helper: BeaglePrefetchHelping) {
+    private func prefetchComponent(helper: BeaglePrefetchHelping?) {
         onPress.forEach { action in
             guard let newPath = (action as? Navigate)?.newPath else { return }
-            helper.prefetchComponent(newPath: newPath)
+            helper?.prefetchComponent(newPath: newPath)
         }
     }
 }
diff --git a/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/WebView/WebViewUIComponent.swift b/iOS/Sources/Beagle/Sources/Components/ServerDrivenComponent/WebView/WebViewUIComponent.swift
@@ -39,7 +39,7 @@ final class WebViewUIComponent: UIView {
         didSet { updateView() }
     }
 
-    init(url: String? = nil, controller: BeagleController) {
+    init(url: String? = nil, controller: BeagleController?) {
         self.url = url
         self.controller = controller
         super.init(frame: .zero)

diff --git a/iOS/Sources/Beagle/Sources/Components/Widget/Button/Button+Extensions.swift b/iOS/Sources/Beagle/Sources/Components/Widget/Button/Button+Extensions.swift
@@ -36,7 +36,7 @@ extension Button {
             }
         }
 
-        let preFetchHelper = renderer.controller.dependencies.preFetchHelper
+        let preFetchHelper = renderer.dependencies.preFetchHelper
         onPress?
             .compactMap { ($0 as? Navigate)?.newPath }
             .forEach { preFetchHelper.prefetchComponent(newPath: $0) }
@@ -61,7 +61,7 @@ extension Button {
         required init(
             onPress: [Action]?,
             clickAnalyticsEvent: AnalyticsClick? = nil,
-            controller: BeagleController
+            controller: BeagleController?
         ) {
             super.init(frame: .zero)
             self.onPress = onPress