Create a new WebViewHelperDelegate method for slot found (#183)

github-thibaud-saintetienne · web-flow · commit 242e2c9287a4 · 2022-05-06T18:00:22.000+02:00
diff --git a/TeadsSampleApp/Controllers/InRead/Admob/WebView/InReadAdmobWebViewController.swift b/TeadsSampleApp/Controllers/InRead/Admob/WebView/InReadAdmobWebViewController.swift
@@ -38,26 +38,6 @@ class InReadAdmobWebViewController: TeadsViewController {
 
         /// init helper
         webViewHelper = TeadsWebViewHelper(webView: webView, selector: "#teads-placement-slot", delegate: self)
-
-        let adSettings = TeadsAdapterSettings { settings in
-            settings.enableDebug()
-            settings.disableLocation()
-            try? settings.registerAdView(bannerView, delegate: self)
-
-            // Needed by european regulation
-            // See https://mobile.teads.tv/sdk/documentation/ios/gdpr-consent
-            // settings.userConsent(subjectToGDPR: "1", consent: "0001100101010101")
-
-            // The article url if you are a news publisher
-            // settings.pageUrl("http://page.com/article1")
-        }
-
-        let customEventExtras = GADMAdapterTeads.customEventExtra(with: adSettings)
-
-        let request = GADRequest()
-        request.register(customEventExtras)
-
-        bannerView.load(request)
     }
 }
 
@@ -110,6 +90,28 @@ extension InReadAdmobWebViewController: TeadsWebViewHelperDelegate {
         print("webViewHelperSlotStartToHide")
     }
 
+    func webViewHelperSlotFoundSuccessfully() {
+        print("webViewHelperSlotFoundSuccessfully")
+        let adSettings = TeadsAdapterSettings { settings in
+            settings.enableDebug()
+            try? settings.registerAdView(bannerView, delegate: self)
+
+            // Needed by european regulation
+            // See https://mobile.teads.tv/sdk/documentation/ios/gdpr-consent
+            // settings.userConsent(subjectToGDPR: "1", consent: "0001100101010101")
+
+            // The article url if you are a news publisher
+            // settings.pageUrl("http://page.com/article1")
+        }
+
+        let customEventExtras = GADMAdapterTeads.customEventExtra(with: adSettings)
+
+        let request = GADRequest()
+        request.register(customEventExtras)
+
+        bannerView.load(request)
+    }
+
     func webViewHelperSlotNotFound() {
         print("webViewHelperSlotNotFound")
     }
diff --git a/TeadsSampleApp/Controllers/InRead/Direct/WebView/InReadDirectWebViewController.swift b/TeadsSampleApp/Controllers/InRead/Direct/WebView/InReadDirectWebViewController.swift
@@ -34,10 +34,6 @@ class InReadDirectWebViewController: TeadsViewController, WKNavigationDelegate {
             // settings.enableDebug()
         }
         placement = Teads.createInReadPlacement(pid: Int(pid) ?? 0, settings: pSettings, delegate: self)
-
-        placement?.requestAd(requestSettings: TeadsAdRequestSettings { settings in
-            settings.pageUrl("https://www.teads.tv")
-        })
     }
 
     // MARK: WKNavigationDelegate
@@ -110,6 +106,13 @@ extension InReadDirectWebViewController: TeadsWebViewHelperDelegate {
         print("webViewHelperSlotStartToHide")
     }
 
+    func webViewHelperSlotFoundSuccessfully() {
+        print("webViewHelperSlotFoundSuccessfully")
+        placement?.requestAd(requestSettings: TeadsAdRequestSettings { settings in
+            settings.pageUrl("https://www.teads.tv")
+        })
+    }
+
     func webViewHelperSlotNotFound() {
         print("webViewHelperSlotNotFound")
     }
diff --git a/TeadsSampleApp/WebViewHelper/TeadsWebViewHelper.swift b/TeadsSampleApp/WebViewHelper/TeadsWebViewHelper.swift
@@ -17,21 +17,26 @@ import WebKit
 /// - Note:
 /// method will be triggered on mainThread or thead from original call
 @objc public protocol TeadsWebViewHelperDelegate {
-    /// is called when the teads slot is shown
-    func webViewHelperSlotStartToShow()
+    /// This is called when the teads slot is shown.
+    @objc optional func webViewHelperSlotStartToShow()
 
-    /// is called when the teads slot is hidden
-    func webViewHelperSlotStartToHide()
+    /// This is called when the teads slot is hidden.
+    @objc optional func webViewHelperSlotStartToHide()
 
-    /// is called when no slot is found
+    /// This is called when the html element slot has been found.
     /// - Note
-    /// this indicates slot specified with `selector` on `TeadsWebViewHelper` init has not been found in webview html DOM
-    func webViewHelperSlotNotFound()
+    /// This indicates slot specified with `selector` on `TeadsWebViewHelper` init has been found in webview html DOM.
+    @objc optional func webViewHelperSlotFoundSuccessfully()
 
-    /// is called when an error occured with the reason
+    /// This is called when no slot is found.
+    /// - Note
+    /// This indicates slot specified with `selector` on `TeadsWebViewHelper` init has not been found in webview html DOM.
+    @objc optional func webViewHelperSlotNotFound()
+
+    /// This is called when an error occured with the reason.
     /// - Parameters:
-    ///   - error: description of issue encountered
-    func webViewHelperOnError(error: String)
+    ///   - error: Description of issue encountered.
+    @objc optional func webViewHelperOnError(error: String)
 }
 
 /// Helper to add TeadsInReadAd inside your webView
@@ -51,6 +56,9 @@ import WebKit
 
     // latest slot position updated
     private var slotPosition: SlotPosition?
+    private var isSlotFound: Bool {
+        return slotPosition != nil
+    }
 
     // width of element in Web content, needed to compute ratio
     public var adViewHTMLElementWidth: CGFloat = 0
@@ -102,7 +110,7 @@ import WebKit
         guard let webView = webView,
               let bootStrapURL = Bundle(for: Self.self).url(forResource: "bootstrap", withExtension: "js"),
               let data = try? Data(contentsOf: bootStrapURL) else {
-            delegate?.webViewHelperOnError(error: "Unable to load bootstrap.js file, make sure to append to bundle")
+            delegate?.webViewHelperOnError?(error: "Unable to load bootstrap.js file, make sure to append to bundle")
             return
         }
 
@@ -118,7 +126,7 @@ import WebKit
         """
         webView.evaluateJavaScript(javascript) { [weak delegate, weak self] _, error in
             if error != nil {
-                delegate?.webViewHelperOnError(error: "injection of JS failed")
+                delegate?.webViewHelperOnError?(error: "injection of JS failed")
             }
             self?.isJsReady = true
         }
@@ -130,16 +138,16 @@ import WebKit
         // add a timeout in case we are not able to find the slot
         let timer = Timer(timeInterval: 4, repeats: false) { [weak self] _ in
             self?.slotOpener = nil
-            self?.delegate?.webViewHelperSlotNotFound()
+            self?.delegate?.webViewHelperSlotNotFound?()
         }
         noSlotTimer = timer
         RunLoop.main.add(timer, forMode: .common)
 
         evaluateBootstrapInput(JSBootstrapInput.insertPlaceholder(selector)) { [weak self] _, error in
             if error != nil {
                 self?.slotOpener = nil
-                self?.delegate?.webViewHelperOnError(error: "insertSlot failed")
-                self?.delegate?.webViewHelperSlotNotFound()
+                self?.delegate?.webViewHelperOnError?(error: "insertSlot failed")
+                self?.delegate?.webViewHelperSlotNotFound?()
                 self?.noSlotTimer?.invalidate()
             } else {
                 self?.slotOpener?()
@@ -169,18 +177,19 @@ import WebKit
             // in case openSlot is called multiple times
             self.adView?.removeFromSuperview()
 
+            adView.isHidden = true
             adView.translatesAutoresizingMaskIntoConstraints = false
             self.containerView = createContainerView(topOffset: topOffset, bottomOffset: bottomOffset)
             self.containerView?.addSubview(adView)
             self.adView = adView
             self.evaluateBootstrapInput(JSBootstrapInput.showPlaceholder(0)) { [weak delegate] _, error in
                 if error != nil {
-                    delegate?.webViewHelperOnError(error: "openSlot failed")
+                    delegate?.webViewHelperOnError?(error: "openSlot failed")
                 }
             }
             self.slotOpener = nil
         }
-        if isJsReady {
+        if isSlotFound {
             slotOpener?()
         }
     }
@@ -214,7 +223,7 @@ import WebKit
         }
         guard let webView = webView,
               adRatio != .zero else {
-            delegate?.webViewHelperOnError(error: "Webview can't be nil, ratio can't be equals to zero")
+            delegate?.webViewHelperOnError?(error: "Webview can't be nil, ratio can't be equals to zero")
             return
         }
 
@@ -229,7 +238,7 @@ import WebKit
 
         evaluateBootstrapInput(JSBootstrapInput.updatePlaceholder(offsetHeight: 0, ratioVideo: ratio)) { [delegate] _, error in
             if error != nil {
-                delegate?.webViewHelperOnError(error: "updateSlot failed")
+                delegate?.webViewHelperOnError?(error: "updateSlot failed")
             }
         }
     }
@@ -246,7 +255,7 @@ import WebKit
         noSlotTimer?.invalidate()
         evaluateBootstrapInput(JSBootstrapInput.hidePlaceholder(0.25)) { [weak delegate] _, error in
             if error != nil {
-                delegate?.webViewHelperOnError(error: "closeSlot failed")
+                delegate?.webViewHelperOnError?(error: "closeSlot failed")
             }
         }
     }
@@ -262,15 +271,15 @@ import WebKit
             noSlotTimer?.invalidate()
             updateAdViewPosition(position: slotPosition)
         } else {
-            delegate?.webViewHelperOnError(error: "The json is malformed")
+            delegate?.webViewHelperOnError?(error: "The json is malformed")
         }
     }
 
     // MARK: WKScriptMessageHandler
 
     public func userContentController(_: WKUserContentController, didReceive message: WKScriptMessage) {
         guard let interface = JSBootstrapOutput(rawValue: message.name) else {
-            delegate?.webViewHelperOnError(error: "WKMessage not supported")
+            delegate?.webViewHelperOnError?(error: "WKMessage not supported")
             return
         }
         switch interface {
@@ -279,19 +288,19 @@ import WebKit
             case .onSlotStartShow:
                 adView?.isHidden = false
                 // the bootstrap calls this when the slot starts to show
-                delegate?.webViewHelperSlotStartToShow()
+                delegate?.webViewHelperSlotStartToShow?()
             case .onSlotUpdated:
                 onSlotUpdated(position: message.body as? String)
             case .onSlotStartHide:
                 adView?.isHidden = true
                 // the bootstrap calls this when the slot starts to hide
-                delegate?.webViewHelperSlotStartToHide()
+                delegate?.webViewHelperSlotStartToHide?()
             case .handleError:
                 guard let errorString = message.body as? String else {
-                    delegate?.webViewHelperOnError(error: "Unknown error occured")
+                    delegate?.webViewHelperOnError?(error: "Unknown error occured")
                     return
                 }
-                delegate?.webViewHelperOnError(error: errorString)
+                delegate?.webViewHelperOnError?(error: errorString)
         }
     }
 
@@ -300,6 +309,10 @@ import WebKit
     /// - Parameters:
     ///   - position: top/bottom/right/left position of the slot
     private func updateAdViewPosition(position: SlotPosition) {
+        if !isSlotFound {
+            delegate?.webViewHelperSlotFoundSuccessfully?()
+        }
+
         adViewHTMLElementWidth = position.right - position.left
         slotPosition = position
 

Original file line number	Diff line number	Diff line change
`@@ -34,10 +34,6 @@ class InReadDirectWebViewController: TeadsViewController, WKNavigationDelegate {`
`34`	`34`	`// settings.enableDebug()`
`35`	`35`	`}`
`36`	`36`	`placement = Teads.createInReadPlacement(pid: Int(pid) ?? 0, settings: pSettings, delegate: self)`
`37`		`-`
`38`		`- placement?.requestAd(requestSettings: TeadsAdRequestSettings { settings in`
`39`		`- settings.pageUrl("https://www.teads.tv")`
`40`		`- })`
`41`	`37`	`}`
`42`	`38`
`43`	`39`	`// MARK: WKNavigationDelegate`
`@@ -110,6 +106,13 @@ extension InReadDirectWebViewController: TeadsWebViewHelperDelegate {`
`110`	`106`	`print("webViewHelperSlotStartToHide")`
`111`	`107`	`}`
`112`	`108`
	`109`	`+ func webViewHelperSlotFoundSuccessfully() {`
	`110`	`+ print("webViewHelperSlotFoundSuccessfully")`
	`111`	`+ placement?.requestAd(requestSettings: TeadsAdRequestSettings { settings in`
	`112`	`+ settings.pageUrl("https://www.teads.tv")`
	`113`	`+ })`
	`114`	`+ }`
	`115`	`+`
`113`	`116`	`func webViewHelperSlotNotFound() {`
`114`	`117`	`print("webViewHelperSlotNotFound")`
`115`	`118`	`}`