Reduce complexity in ATTNSDK

Sources/ATTNInfoEvent.swift

@@ -7,6 +7,6 @@
 
 import Foundation
 
-public final class ATTNInfoEvent: NSObject, ATTNEvent {
-  public override init() {}
+final class ATTNInfoEvent: NSObject, ATTNEvent {
+  override init() {}
 }

Sources/ATTNWebViewHandling.swift

@@ -0,0 +1,237 @@
+//
+//  ATTNWebViewHandling.swift
+//  attentive-ios-sdk-framework
+//
+//  Created by Vladimir - Work on 2024-07-04.
+//
+
+import Foundation
+import WebKit
+
+protocol ATTNWebViewHandling {
+  func launchCreative(parentView view: UIView, creativeId: String?, handler: ATTNCreativeTriggerCompletionHandler?)
+  func closeCreative()
+}
+
+final class ATTNWebViewHandler: NSObject, ATTNWebViewHandling {
+  private enum Constants {
+    static var visibilityEvent: String { "document-visibility:" }
+    static var scriptMessageHandlerName: String { "log" }
+  }
+
+  private enum ScriptStatus {
+    case success
+    case timeout
+    case unknown(String)
+
+    static func getRawValue(from value: Any) -> ScriptStatus? {
+      guard let stringValue = value as? String else { return nil }
+      switch stringValue {
+      case "SUCCESS":
+        return .success
+      case "TIMED OUT":
+        return .timeout
+      default:
+        return .unknown(stringValue)
+      }
+    }
+  }
+
+  private weak var webViewProvider: ATTNWebViewProviding?
+  private var urlBuilder: ATTNCreativeUrlProviding
+
+  init(webViewProvider: ATTNWebViewProviding, creativeUrlBuilder: ATTNCreativeUrlProviding = ATTNCreativeUrlProvider()) {
+    self.webViewProvider = webViewProvider
+    self.urlBuilder = creativeUrlBuilder
+  }
+
+  func launchCreative(
+    parentView view: UIView,
+    creativeId: String? = nil,
+    handler: ATTNCreativeTriggerCompletionHandler? = nil
+  ) {
+    guard let webViewProvider = webViewProvider else {
+      Loggers.creative.debug("Not showing the Attentive creative because the iOS version is too old.")
+      webViewProvider?.triggerHandler?(ATTNCreativeTriggerStatus.notOpened)
+      return
+    }
+
+    webViewProvider.parentView = view
+    webViewProvider.triggerHandler = handler
+
+    Loggers.creative.debug("Called showWebView in creativeSDK with domain: \(self.domain, privacy: .public)")
+
+    guard !isCreativeOpen else {
+      Loggers.creative.debug("Attempted to trigger creative, but creative is currently open. Taking no action")
+      return
+    }
+
+    Loggers.creative.debug("The iOS version is new enough, continuing to show the Attentive creative.")
+
+    let creativePageUrl = urlBuilder.buildCompanyCreativeUrl(
+      configuration: ATTNCreativeUrlConfig(
+        domain: domain,
+        creativeId: creativeId,
+        skipFatigue: webViewProvider.skipFatigueOnCreative,
+        mode: mode.rawValue,
+        userIdentity: userIdentity
+      )
+    )
+
+    Loggers.creative.debug("Requesting creative page url: \(creativePageUrl)" )
+
+    guard let url = URL(string: creativePageUrl) else {
+      Loggers.creative.debug("URL could not be created.")
+      return
+    }
+
+    let request = URLRequest(url: url)
+
+    let configuration = WKWebViewConfiguration()
+    configuration.userContentController.add(self, name: Constants.scriptMessageHandlerName)
+
+    let userScriptWithEventListener = String(format: "window.addEventListener('message', (event) => {if (event.data && event.data.__attentive) {window.webkit.messageHandlers.log.postMessage(event.data.__attentive.action);}}, false);window.addEventListener('visibilitychange', (event) => {window.webkit.messageHandlers.log.postMessage(`%@ ${document.hidden}`);}, false);", Constants.visibilityEvent)
+    let userScript = WKUserScript(source: userScriptWithEventListener, injectionTime: .atDocumentStart, forMainFrameOnly: false)
+    configuration.userContentController.addUserScript(userScript)
+
+    webViewProvider.webView = WKWebView(frame: view.frame, configuration: configuration)
+
+    guard let webView = webViewProvider.webView else { return }
+
+    webView.navigationDelegate = self
+    webView.load(request)
+
+    if mode == .debug {
+      webViewProvider.parentView?.addSubview(webView)
+    } else {
+      webView.isOpaque = false
+      webView.backgroundColor = .clear
+    }
+  }
+
+  func closeCreative() {
+    webViewProvider?.webView?.removeFromSuperview()
+    webViewProvider?.webView = nil
+
+    isCreativeOpen = false
+    webViewProvider?.triggerHandler?(ATTNCreativeTriggerStatus.closed)
+    Loggers.creative.debug("Successfully closed creative")
+  }
+}
+
+extension ATTNWebViewHandler: WKNavigationDelegate {
+  func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
+    guard #available(iOS 14.0, *) else { return }
+    let asyncJs =
+        """
+        var p = new Promise(resolve => {
+            var timeoutHandle = null;
+            const interval = setInterval(function() {
+                e = document.querySelector('iframe');
+                if(e && e.id === 'attentive_creative') {
+                    clearInterval(interval);
+                    resolve('SUCCESS');
+                    if (timeoutHandle != null) {
+                        clearTimeout(timeoutHandle);
+                    }
+                }
+            }, 100);
+            timeoutHandle = setTimeout(function() {
+                clearInterval(interval);
+                resolve('TIMED OUT');
+            }, 5000);
+        });
+        var status = await p;
+        return status;
+        """
+    webView.callAsyncJavaScript(
+      asyncJs,
+      in: nil,
+      in: .defaultClient
+    ) { [weak self] result in
+      guard let self = self, let webViewProvider = self.webViewProvider else { return }
+      guard case let .success(statusAny) = result else {
+        Loggers.creative.debug("No status returned from JS. Not showing WebView.")
+        webViewProvider.triggerHandler?(ATTNCreativeTriggerStatus.notOpened)
+        return
+      }
+
+      switch ScriptStatus.getRawValue(from: statusAny) {
+      case .success:
+        Loggers.creative.debug("Found creative iframe, showing WebView.")
+        if self.mode == .production {
+          webViewProvider.parentView?.addSubview(webView)
+        }
+        webViewProvider.triggerHandler?(ATTNCreativeTriggerStatus.opened)
+      case .timeout:
+        Loggers.creative.error("Creative timed out. Not showing WebView.")
+        webViewProvider.triggerHandler?(ATTNCreativeTriggerStatus.notOpened)
+      case .unknown(let statusString):
+        Loggers.creative.error("Received unknown status: \(statusString). Not showing WebView")
+        webViewProvider.triggerHandler?(ATTNCreativeTriggerStatus.notOpened)
+      default: break
+      }
+    }
+  }
+
+  func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) {
+    guard let url = navigationAction.request.url else {
+      decisionHandler(.cancel)
+      return
+    }
+
+    if url.scheme == "sms" {
+      UIApplication.shared.open(url)
+      decisionHandler(.cancel)
+    } else if let scheme = url.scheme?.lowercased(), scheme == "http" || scheme == "https" {
+      if navigationAction.targetFrame == nil {
+        UIApplication.shared.open(url)
+        decisionHandler(.cancel)
+      } else {
+        decisionHandler(.allow)
+      }
+    } else {
+      decisionHandler(.allow)
+    }
+  }
+}
+
+extension ATTNWebViewHandler: WKScriptMessageHandler {
+  func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
+    let messageBody = message.body as? String ?? "'Empty'"
+    Loggers.creative.debug("Web event message: \(messageBody). isCreativeOpen: \(self.isCreativeOpen ? "YES" : "NO")")
+
+    if messageBody == "CLOSE" {
+      closeCreative()
+    } else if messageBody == "IMPRESSION" {
+      Loggers.creative.debug("Creative opened and generated impression event")
+      isCreativeOpen = true
+    } else if messageBody == String(format: "%@ true", Constants.visibilityEvent), isCreativeOpen {
+      Loggers.creative.debug("Nav away from creative, closing")
+      closeCreative()
+    }
+  }
+}
+
+fileprivate extension ATTNWebViewHandler {
+  var domain: String {
+    webViewProvider?.getDomain() ?? ""
+  }
+
+  var mode: ATTNSDKMode {
+    webViewProvider?.getMode() ?? .production
+  }
+
+  var userIdentity: ATTNUserIdentity {
+    webViewProvider?.getUserIdentity() ?? .init()
+  }
+
+  var skipFatigueOnCreative: Bool {
+    webViewProvider?.skipFatigueOnCreative ?? false
+  }
+
+  var isCreativeOpen: Bool {
+    get { webViewProvider?.isCreativeOpen ?? false }
+    set { webViewProvider?.isCreativeOpen = newValue }
+  }
+}

Sources/ATTNWebViewProviding.swift

@@ -0,0 +1,20 @@
+//
+//  ATTNWebViewProviding.swift
+//  attentive-ios-sdk-framework
+//
+//  Created by Vladimir - Work on 2024-07-04.
+//
+
+import WebKit
+
+protocol ATTNWebViewProviding: NSObjectProtocol {
+  var parentView: UIView? { get set }
+  var webView: WKWebView? { get set }
+  var skipFatigueOnCreative: Bool { get set }
+  var triggerHandler: ATTNCreativeTriggerCompletionHandler? { get set }
+  var isCreativeOpen: Bool { get set }
+
+  func getDomain() -> String
+  func getMode() -> ATTNSDKMode
+  func getUserIdentity() -> ATTNUserIdentity
+}