Merge pull request #15 from OutSystems/feat/RMET-4122/navigation-completed-event

RMET-4122 ::: Add onBrowserPageNavigationCompleted event

Author: andredestro

OSInAppBrowserLib/RouterAdapters/OSIABApplicationRouterAdapter.swift

@@ -9,7 +9,7 @@ public protocol OSIABApplicationDelegate: AnyObject {
 
 /// Provide a default implementations that abstracts the options parameter.
 extension OSIABApplicationDelegate {
-    func open(_ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any] = [:], completionHandler completion: ((Bool) -> Void)?) {
+    public func open(_ url: URL, options: [UIApplication.OpenExternalURLOptionsKey: Any] = [:], completionHandler completion: ((Bool) -> Void)?) {
         self.open(url, options: options, completionHandler: completion)
     }
 }

OSInAppBrowserLib/WebView/OSIABWebViewCallbackHandler.swift

@@ -10,7 +10,9 @@ public struct OSIABWebViewCallbackHandler {
     let onBrowserPageLoad: () -> Void
     /// Callback to trigger when the browser is closed. The boolean arguments indicates if the browser was already close or still needs to be.
     let onBrowserClosed: (Bool) -> Void
-    
+    /// Callback to trigger when the browser finishes navigation. The argument is the current URL.
+    let onBrowserPageNavigationCompleted: (String?) -> Void
+
     /// Constructor method.
     /// - Parameters:
     ///   - onDelegateURL: Callback to trigger when the an URL needs to be delegates to its callers.
@@ -21,11 +23,13 @@ public struct OSIABWebViewCallbackHandler {
         onDelegateURL: @escaping (URL) -> Void,
         onDelegateAlertController: @escaping (UIAlertController) -> Void,
         onBrowserPageLoad: @escaping () -> Void,
-        onBrowserClosed: @escaping (Bool) -> Void // boolean indicates if the browser is already closed.
+        onBrowserClosed: @escaping (Bool) -> Void, // boolean indicates if the browser is already closed.
+        onBrowserPageNavigationCompleted: @escaping (String?) -> Void
     ) {
         self.onDelegateURL = onDelegateURL
         self.onDelegateAlertController = onDelegateAlertController
         self.onBrowserPageLoad = onBrowserPageLoad
         self.onBrowserClosed = onBrowserClosed
+        self.onBrowserPageNavigationCompleted = onBrowserPageNavigationCompleted
     }
 }

OSInAppBrowserLib/WebView/OSIABWebViewModel.swift

@@ -182,6 +182,8 @@ extension OSIABWebViewModel: WKNavigationDelegate {
         if !self.firstLoadDone {
             self.callbackHandler.onBrowserPageLoad()
             self.firstLoadDone = true
+        } else {
+            self.callbackHandler.onBrowserPageNavigationCompleted(url.absoluteString)
         }
         error = nil
     }

OSInAppBrowserLib/WebView/Views/OSIABWebView.swift

@@ -96,7 +96,8 @@ private extension OSIABWebViewModel {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: onBrowserClosed
+                onBrowserClosed: onBrowserClosed,
+                onBrowserPageNavigationCompleted: { _ in }
             )
         )
     }

OSInAppBrowserLib/WebView/Views/OSIABWebView13WrapperView.swift

@@ -58,7 +58,8 @@ private extension OSIABWebViewModel {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: { _ in }
+                onBrowserClosed: { _ in },
+                onBrowserPageNavigationCompleted: { _ in }
             )
         )
     }
@@ -73,7 +74,8 @@ private extension OSIABWebViewModel {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: { _ in }
+                onBrowserClosed: { _ in },
+                onBrowserPageNavigationCompleted:  { _ in }
             )
         )
     }

OSInAppBrowserLib/WebView/Views/OSIABWebViewWrapperView.swift

@@ -35,7 +35,8 @@ private extension OSIABWebViewModel {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: { _ in }
+                onBrowserClosed: { _ in },
+                onBrowserPageNavigationCompleted: { _ in }
             )
         )
     }
@@ -50,7 +51,8 @@ private extension OSIABWebViewModel {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: { _ in }
+                onBrowserClosed: { _ in },
+                onBrowserPageNavigationCompleted: { _ in }
             )
         )
     }

OSInAppBrowserLibTests/OSIABViewModelTests.swift

@@ -181,6 +181,20 @@ final class OSIABViewModelTests: XCTestCase {
         XCTAssertEqual(resultAction, .allow)
     }
 
+    func test_navigateToNewPage_onBrowserPageNavigationCompletedEventShouldBeTrigged() {
+        var result: String? = nil
+        let expectation = self.expectation(description: "Trigger onBrowserPageNavigationCompleted Event")
+
+        let sut = makeSUT(url, onBrowserPageNavigationCompleted: { data in
+            result = data
+            expectation.fulfill()
+        })
+        sut.webView(sut.webView, didFinish: nil)
+        sut.webView(sut.webView, didFinish: nil)
+        waitForExpectations(timeout: 1)
+        XCTAssertEqual(url.absoluteString, result)
+    }
+    
     // MARK: Browser Page Load Event Tests
 
     func test_navigateToURL_whenFinished_triggerPageLoadEventOnFirstTime() {
@@ -275,7 +289,8 @@ private extension OSIABViewModelTests {
         onDelegateURL: @escaping (URL) -> Void = { _ in },
         onDelegateAlertController: @escaping (UIAlertController) -> Void = { _ in },
         onBrowserPageLoad: @escaping () -> Void = {},
-        onBrowserClosed: @escaping (Bool) -> Void = { _ in }
+        onBrowserClosed: @escaping (Bool) -> Void = { _ in },
+        onBrowserPageNavigationCompleted: @escaping (String?) -> Void = { _ in }
     ) -> OSIABWebViewModel {
         let configurationModel = OSIABWebViewConfigurationModel(
             mediaTypesRequiringUserActionForPlayback, ignoresViewportScaleLimits, allowsInlineMediaPlayback, surpressesIncrementalRendering
@@ -297,7 +312,8 @@ private extension OSIABViewModelTests {
                 onDelegateURL: onDelegateURL,
                 onDelegateAlertController: onDelegateAlertController,
                 onBrowserPageLoad: onBrowserPageLoad,
-                onBrowserClosed: onBrowserClosed
+                onBrowserClosed: onBrowserClosed,
+                onBrowserPageNavigationCompleted: onBrowserPageNavigationCompleted
             )
         )
     }

OSInAppBrowserLibTests/OSIABWebViewRouterAdapterTests.swift

@@ -141,7 +141,8 @@ private extension OSIABWebViewRouterAdapterTests {
                 onDelegateURL: { _ in },
                 onDelegateAlertController: { _ in },
                 onBrowserPageLoad: {},
-                onBrowserClosed: onBrowserClosed
+                onBrowserClosed: onBrowserClosed,
+                onBrowserPageNavigationCompleted: { _ in }
             )
         )
     }