@bigcrunch/react-native-ads 0.3.1 → 0.5.0

package/ios/BigCrunchAds/Sources/Core/AdOrchestrator.swift

@@ -0,0 +1,514 @@
+import Foundation
+import UIKit
+import GoogleMobileAds
+
+/**
+ * Callback protocol for banner ad events
+ */
+public protocol BannerCallback: AnyObject {
+    func onAdLoaded()
+    func onAdFailedToLoad(error: String)
+    func onAdClicked()
+    func onAdImpression()
+}
+
+/**
+ * Callback protocol for interstitial ad events
+ */
+public protocol InterstitialCallback: AnyObject {
+    func onAdLoaded()
+    func onAdFailedToLoad(error: String)
+    func onAdShowed()
+    func onAdDismissed()
+    func onAdClicked()
+}
+
+/**
+ * AdOrchestrator - Central orchestration for ad loading lifecycle
+ *
+ * Coordinates the flow between ConfigManager, BidRequestClient, GoogleAdsAdapter,
+ * and AnalyticsClient to load and display ads.
+ *
+ * Flow:
+ * 1. Get PlacementConfig from ConfigManager
+ * 2. Track ad request via AnalyticsClient
+ * 3. Fetch S2S demand via BidRequestClient
+ * 4. Load Google ad via GoogleAdsAdapter (with targeting from S2S)
+ * 5. Wire up all callbacks for analytics
+ */
+internal class AdOrchestrator {
+
+    private static let TAG = "AdOrchestrator"
+
+    private let configManager: ConfigManager
+    private let analyticsClient: AnalyticsClient
+    private let bidRequestClient: BidRequestClient
+    private let googleAdsAdapter: GoogleAdsAdapter
+
+    // Cache for preloaded interstitial ads
+    private var interstitialCache: [String: GoogleMobileAds.InterstitialAd] = [:]
+    private let interstitialLock = NSLock()
+
+    // Track active banner views for cleanup
+    private var activeBanners: [String: GoogleMobileAds.BannerView] = [:]
+    private let bannerLock = NSLock()
+
+    // Store callback wrappers to prevent deallocation
+    private var bannerCallbackWrappers: [String: BannerCallbackWrapper] = [:]
+    private var interstitialCallbackWrappers: [String: InterstitialCallbackWrapper] = [:]
+
+    init(
+        configManager: ConfigManager,
+        analyticsClient: AnalyticsClient,
+        bidRequestClient: BidRequestClient,
+        googleAdsAdapter: GoogleAdsAdapter
+    ) {
+        self.configManager = configManager
+        self.analyticsClient = analyticsClient
+        self.bidRequestClient = bidRequestClient
+        self.googleAdsAdapter = googleAdsAdapter
+    }
+
+    /**
+     * Load a banner ad
+     *
+     * - Parameters:
+     *   - placementId: The placement ID from the BigCrunch dashboard
+     *   - rootViewController: The view controller for presenting ad click actions
+     *   - callback: Callback for ad events
+     *   - adSizeOverride: Optional size override (takes precedence over backend config)
+     *   - bannerViewSetter: Closure to set the banner view on the container
+     * - Returns: The GoogleMobileAds.BannerView if loading was initiated, nil if placement not found
+     */
+    func loadBannerAd(
+        placementId: String,
+        rootViewController: UIViewController,
+        callback: BannerCallback,
+        refreshCount: Int = 0,
+        adSizeOverride: AdSize? = nil,
+        bannerViewSetter: ((GoogleMobileAds.BannerView) -> Void)? = nil
+    ) -> GoogleMobileAds.BannerView? {
+        BCLogger.debug("\(AdOrchestrator.TAG): Loading banner ad: \(placementId) (refreshCount: \(refreshCount))")
+
+        // 1. Get placement config
+        guard let placement = configManager.getPlacement(placementId) else {
+            BCLogger.error("\(AdOrchestrator.TAG): Placement not found: \(placementId)")
+            callback.onAdFailedToLoad(error: "Placement not found: \(placementId)")
+            return nil
+        }
+
+        guard placement.format == "banner" else {
+            BCLogger.error("\(AdOrchestrator.TAG): Invalid format for banner: \(placement.format)")
+            callback.onAdFailedToLoad(error: "Invalid placement format: \(placement.format)")
+            return nil
+        }
+
+        // 2. Track ad request
+        analyticsClient.trackAdRequest(placementId: placementId, format: placement.format)
+
+        // 3. Create callback wrapper and store it
+        let callbackWrapper = BannerCallbackWrapper(
+            placementId: placementId,
+            callback: callback
+        )
+        bannerCallbackWrappers[placementId] = callbackWrapper
+
+        // 4. Start async ad loading
+        Task {
+            await loadBannerAsync(
+                placement: placement,
+                rootViewController: rootViewController,
+                callbackWrapper: callbackWrapper,
+                refreshCount: refreshCount,
+                adSizeOverride: adSizeOverride,
+                bannerViewSetter: bannerViewSetter
+            )
+        }
+
+        // Return nil initially - the banner view will be created by GoogleAdsAdapter
+        return nil
+    }
+
+    private func loadBannerAsync(
+        placement: PlacementConfig,
+        rootViewController: UIViewController,
+        callbackWrapper: BannerCallbackWrapper,
+        refreshCount: Int,
+        adSizeOverride: AdSize?,
+        bannerViewSetter: ((GoogleMobileAds.BannerView) -> Void)?
+    ) async {
+        // Get GAM network code from config
+        guard let gamNetworkCode = configManager.getGamNetworkCode() else {
+            BCLogger.error("\(AdOrchestrator.TAG): GAM network code not available")
+            callbackWrapper.callback?.onAdFailedToLoad(error: "Config not loaded")
+            return
+        }
+
+        // Resolve effective size for S2S bid request (adaptive → concrete dimensions)
+        let effectiveSize = adSizeOverride ?? placement.sizes?.first
+        let resolvedSize: AdSize?
+        if let eff = effectiveSize, eff.isAdaptive {
+            let width: CGFloat = eff.width > 0 ? CGFloat(eff.width) : UIScreen.main.bounds.width
+            let googleAdSize = GoogleMobileAds.currentOrientationAnchoredAdaptiveBanner(width: width)
+            BCLogger.debug("\(AdOrchestrator.TAG): Resolved adaptive size to \(Int(googleAdSize.size.width))x\(Int(googleAdSize.size.height))")
+            resolvedSize = AdSize(width: Int(googleAdSize.size.width), height: Int(googleAdSize.size.height))
+        } else {
+            resolvedSize = effectiveSize
+        }
+
+        // Create ad request
+        let adRequest = GoogleMobileAds.Request()
+
+        // 3. Fetch S2S demand (even if it fails, continue with Google)
+        let targeting = await bidRequestClient.fetchDemand(placement: placement)
+        if let targeting = targeting, !targeting.isEmpty {
+            var customTargeting = adRequest.customTargeting ?? [:]
+            for (key, value) in targeting {
+                customTargeting[key] = value
+            }
+            adRequest.customTargeting = customTargeting
+            BCLogger.debug("\(AdOrchestrator.TAG): S2S demand fetched for: \(placement.placementId) (\(targeting.count) keys)")
+        } else {
+            BCLogger.warning("\(AdOrchestrator.TAG): S2S demand fetch returned no targeting, continuing with Google only")
+        }
+
+        // 4. Load Google ad with the (possibly enriched) ad request
+        let delegateWrapper = BannerDelegateAdapterWrapper(
+            placementId: placement.placementId,
+            callbackWrapper: callbackWrapper
+        )
+
+        // Check if we should use test ad units
+        let useTestAds = configManager.shouldUseTestAds()
+
+        let bannerView = await googleAdsAdapter.loadBannerAd(
+            placementConfig: placement,
+            gamNetworkCode: gamNetworkCode,
+            request: adRequest,
+            rootViewController: rootViewController,
+            delegate: delegateWrapper,
+            useTestAds: useTestAds,
+            adSizeOverride: adSizeOverride,
+            refreshCount: refreshCount
+        )
+
+        // Set the banner view on the container (on main thread)
+        await MainActor.run {
+            bannerViewSetter?(bannerView)
+        }
+
+        // Track the active banner for cleanup
+        bannerLock.lock()
+        activeBanners[placement.placementId] = bannerView
+        bannerLock.unlock()
+
+        // Store the delegate wrapper to prevent deallocation
+        callbackWrapper.delegateWrapper = delegateWrapper
+    }
+
+    /**
+     * Destroy a banner ad
+     *
+     * - Parameter placementId: The placement ID of the banner to destroy
+     */
+    func destroyBannerAd(placementId: String) {
+        BCLogger.debug("\(AdOrchestrator.TAG): Destroying banner ad: \(placementId)")
+
+        bannerLock.lock()
+        if let bannerView = activeBanners.removeValue(forKey: placementId) {
+            googleAdsAdapter.destroyBannerAd(bannerView)
+        }
+        bannerLock.unlock()
+
+        // Clean up callback wrapper
+        bannerCallbackWrappers.removeValue(forKey: placementId)
+    }
+
+    /**
+     * Preload an interstitial ad
+     *
+     * - Parameters:
+     *   - placementId: The placement ID from the BigCrunch dashboard
+     *   - callback: Callback for ad events
+     */
+    func preloadInterstitialAd(
+        placementId: String,
+        callback: InterstitialCallback
+    ) {
+        BCLogger.debug("\(AdOrchestrator.TAG): Preloading interstitial ad: \(placementId)")
+
+        // 1. Get placement config
+        guard let placement = configManager.getPlacement(placementId) else {
+            BCLogger.error("\(AdOrchestrator.TAG): Placement not found: \(placementId)")
+            callback.onAdFailedToLoad(error: "Placement not found: \(placementId)")
+            return
+        }
+
+        guard placement.format == "interstitial" else {
+            BCLogger.error("\(AdOrchestrator.TAG): Invalid format for interstitial: \(placement.format)")
+            callback.onAdFailedToLoad(error: "Invalid placement format: \(placement.format)")
+            return
+        }
+
+        // 2. Track ad request
+        analyticsClient.trackAdRequest(placementId: placementId, format: placement.format)
+
+        // 3. Start async ad loading
+        Task {
+            await preloadInterstitialAsync(placement: placement, callback: callback)
+        }
+    }
+
+    private func preloadInterstitialAsync(
+        placement: PlacementConfig,
+        callback: InterstitialCallback
+    ) async {
+        interstitialLock.lock()
+        // Check if already cached
+        if interstitialCache[placement.placementId] != nil {
+            interstitialLock.unlock()
+            BCLogger.debug("\(AdOrchestrator.TAG): Interstitial already cached: \(placement.placementId)")
+            callback.onAdLoaded()
+            return
+        }
+        interstitialLock.unlock()
+
+        // Get GAM network code from config
+        guard let gamNetworkCode = configManager.getGamNetworkCode() else {
+            BCLogger.error("\(AdOrchestrator.TAG): GAM network code not available")
+            callback.onAdFailedToLoad(error: "Config not loaded")
+            return
+        }
+
+        // Create ad request
+        let adRequest = GoogleMobileAds.Request()
+
+        // 3. Fetch S2S demand
+        let targeting = await bidRequestClient.fetchDemand(placement: placement)
+        if let targeting = targeting, !targeting.isEmpty {
+            var customTargeting = adRequest.customTargeting ?? [:]
+            for (key, value) in targeting {
+                customTargeting[key] = value
+            }
+            adRequest.customTargeting = customTargeting
+            BCLogger.debug("\(AdOrchestrator.TAG): S2S demand fetched for: \(placement.placementId) (\(targeting.count) keys)")
+        } else {
+            BCLogger.warning("\(AdOrchestrator.TAG): S2S demand fetch returned no targeting, continuing with Google only")
+        }
+
+        // Check if we should use test ad units
+        let useTestAds = configManager.shouldUseTestAds()
+
+        // 4. Load Google interstitial ad
+        let result = await googleAdsAdapter.loadInterstitialAd(
+            placementConfig: placement,
+            gamNetworkCode: gamNetworkCode,
+            request: adRequest,
+            useTestAds: useTestAds
+        )
+
+        switch result {
+        case .success(let interstitialAd):
+            interstitialLock.lock()
+            interstitialCache[placement.placementId] = interstitialAd
+            interstitialLock.unlock()
+            BCLogger.debug("\(AdOrchestrator.TAG): Interstitial ad preloaded: \(placement.placementId)")
+            callback.onAdLoaded()
+
+        case .failure(let error):
+            BCLogger.warning("\(AdOrchestrator.TAG): Interstitial ad failed to load: \(placement.placementId) - \(error.localizedDescription)")
+            callback.onAdFailedToLoad(error: error.localizedDescription)
+        }
+    }
+
+    /**
+     * Show an interstitial ad
+     *
+     * - Parameters:
+     *   - viewController: The view controller to present the interstitial from
+     *   - placementId: The placement ID from the BigCrunch dashboard
+     *   - callback: Callback for ad events
+     * - Returns: true if an ad was available and shown, false otherwise
+     */
+    func showInterstitialAd(
+        from viewController: UIViewController,
+        placementId: String,
+        callback: InterstitialCallback
+    ) -> Bool {
+        BCLogger.debug("\(AdOrchestrator.TAG): Showing interstitial ad: \(placementId)")
+
+        // Get placement config
+        guard let placement = configManager.getPlacement(placementId) else {
+            BCLogger.error("\(AdOrchestrator.TAG): Placement not found: \(placementId)")
+            callback.onAdFailedToLoad(error: "Placement not found: \(placementId)")
+            return false
+        }
+
+        // Get cached interstitial
+        interstitialLock.lock()
+        guard let interstitialAd = interstitialCache.removeValue(forKey: placementId) else {
+            interstitialLock.unlock()
+            BCLogger.warning("\(AdOrchestrator.TAG): No preloaded interstitial for: \(placementId)")
+            callback.onAdFailedToLoad(error: "No preloaded ad available")
+            return false
+        }
+        interstitialLock.unlock()
+
+        // Create callback wrapper and store it
+        let callbackWrapper = InterstitialCallbackWrapper(
+            placementId: placementId,
+            callback: callback
+        )
+        interstitialCallbackWrappers[placementId] = callbackWrapper
+
+        // Create adapter delegate wrapper
+        let delegateWrapper = InterstitialDelegateAdapterWrapper(
+            placementId: placementId,
+            callbackWrapper: callbackWrapper
+        )
+        callbackWrapper.delegateWrapper = delegateWrapper
+
+        // Show the ad
+        googleAdsAdapter.showInterstitialAd(
+            interstitialAd,
+            from: viewController,
+            placementConfig: placement,
+            delegate: delegateWrapper
+        )
+
+        return true
+    }
+
+    /**
+     * Check if an interstitial ad is ready to show
+     *
+     * - Parameter placementId: The placement ID to check
+     * - Returns: true if an ad is preloaded and ready
+     */
+    func isInterstitialReady(placementId: String) -> Bool {
+        interstitialLock.lock()
+        defer { interstitialLock.unlock() }
+        return interstitialCache[placementId] != nil
+    }
+
+    /**
+     * Clear all cached ads
+     */
+    func clearCache() {
+        BCLogger.debug("\(AdOrchestrator.TAG): Clearing ad cache")
+
+        interstitialLock.lock()
+        interstitialCache.removeAll()
+        interstitialLock.unlock()
+
+        // Destroy all active banners
+        bannerLock.lock()
+        for bannerView in activeBanners.values {
+            googleAdsAdapter.destroyBannerAd(bannerView)
+        }
+        activeBanners.removeAll()
+        bannerLock.unlock()
+
+        // Clear callback wrappers
+        bannerCallbackWrappers.removeAll()
+        interstitialCallbackWrappers.removeAll()
+    }
+}
+
+// MARK: - Callback Wrapper Classes
+
+/**
+ * Wrapper to hold banner callback and prevent deallocation
+ */
+private class BannerCallbackWrapper {
+    let placementId: String
+    weak var callback: BannerCallback?
+    var delegateWrapper: BannerDelegateAdapterWrapper?
+
+    init(placementId: String, callback: BannerCallback) {
+        self.placementId = placementId
+        self.callback = callback
+    }
+}
+
+/**
+ * Wrapper to hold interstitial callback and prevent deallocation
+ */
+private class InterstitialCallbackWrapper {
+    let placementId: String
+    weak var callback: InterstitialCallback?
+    var delegateWrapper: InterstitialDelegateAdapterWrapper?
+
+    init(placementId: String, callback: InterstitialCallback) {
+        self.placementId = placementId
+        self.callback = callback
+    }
+}
+
+// MARK: - Delegate Adapter Wrappers
+
+/**
+ * Adapts BannerAdDelegate to BannerCallback
+ */
+private class BannerDelegateAdapterWrapper: BannerAdDelegate {
+    let placementId: String
+    weak var callbackWrapper: BannerCallbackWrapper?
+
+    init(placementId: String, callbackWrapper: BannerCallbackWrapper) {
+        self.placementId = placementId
+        self.callbackWrapper = callbackWrapper
+    }
+
+    func bannerAdDidLoad(_ bannerView: GoogleMobileAds.BannerView) {
+        callbackWrapper?.callback?.onAdLoaded()
+    }
+
+    func bannerAd(_ bannerView: GoogleMobileAds.BannerView, didFailToLoadWithError error: Error) {
+        callbackWrapper?.callback?.onAdFailedToLoad(error: error.localizedDescription)
+    }
+
+    func bannerAdDidRecordClick(_ bannerView: GoogleMobileAds.BannerView) {
+        callbackWrapper?.callback?.onAdClicked()
+    }
+
+    func bannerAdDidRecordImpression(_ bannerView: GoogleMobileAds.BannerView) {
+        callbackWrapper?.callback?.onAdImpression()
+    }
+}
+
+/**
+ * Adapts InterstitialAdDelegate to InterstitialCallback
+ */
+private class InterstitialDelegateAdapterWrapper: InterstitialAdDelegate {
+    let placementId: String
+    weak var callbackWrapper: InterstitialCallbackWrapper?
+
+    init(placementId: String, callbackWrapper: InterstitialCallbackWrapper) {
+        self.placementId = placementId
+        self.callbackWrapper = callbackWrapper
+    }
+
+    func interstitialAdDidLoad(_ interstitialAd: GoogleMobileAds.InterstitialAd) {
+        callbackWrapper?.callback?.onAdLoaded()
+    }
+
+    func interstitialAd(didFailToLoadWithError error: Error) {
+        callbackWrapper?.callback?.onAdFailedToLoad(error: error.localizedDescription)
+    }
+
+    func interstitialAdDidPresent(_ interstitialAd: GoogleMobileAds.InterstitialAd) {
+        callbackWrapper?.callback?.onAdShowed()
+    }
+
+    func interstitialAdDidDismiss(_ interstitialAd: GoogleMobileAds.InterstitialAd) {
+        callbackWrapper?.callback?.onAdDismissed()
+    }
+
+    func interstitialAdDidRecordClick(_ interstitialAd: GoogleMobileAds.InterstitialAd) {
+        callbackWrapper?.callback?.onAdClicked()
+    }
+
+    func interstitialAdDidRecordImpression(_ interstitialAd: GoogleMobileAds.InterstitialAd) {
+        // Impression tracked by GoogleAdsAdapter
+    }
+}