[MOB-3897] Welcome screen for product tour

BrowserKit/Sources/Common/Theming/EcosiaThemeColourPalette.swift

@@ -60,6 +60,7 @@ public protocol EcosiaSemanticColors {
     var textPrimary: UIColor { get }
     var textInversePrimary: UIColor { get }
     var textSecondary: UIColor { get }
+    var textStaticLight: UIColor { get }
 }
 
 public protocol EcosiaThemeColourPalette: ThemeColourPalette {
@@ -103,4 +104,5 @@ class FakeEcosiaSemanticColors: EcosiaSemanticColors {
     var textPrimary: UIColor = .systemGray
     var textInversePrimary: UIColor = .systemGray
     var textSecondary: UIColor = .systemGray
+    var textStaticLight: UIColor = .systemGray
 }

firefox-ios/Client/Application/AppDelegate.swift

@@ -84,7 +84,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             .preLaunchDependenciesComplete,
             .postLaunchDependenciesComplete,
             .accountManagerInitialized,
-            .browserIsReady
+            .browserIsReady,
+            // Ecosia: Add Feature Management dependency
+            .featureManagementInitialized
         ])
 
         // Then setup dependency container as it's needed for everything else
@@ -135,7 +137,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         EcosiaInstallType.evaluateCurrentEcosiaInstallType()
         // Ecosia: Disable BG sync //backgroundSyncUtil = BackgroundSyncUtil(profile: profile, application: application)
 
-        /* 
+        /*
          Ecosia: Feature Management fetch
          We perform the same configuration retrieval in
          `applicationDidBecomeActive(:)` and sounds redundant;
@@ -148,6 +150,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
          */
         Task {
             await FeatureManagement.fetchConfiguration()
+            // Signal that feature management initialization is complete on main thread
+            AppEventQueue.signal(event: .featureManagementInitialized)
             // Ecosia: Braze Service Initialization after feature flags are fetched for conditional initialization
             BrazeService.shared.initialize()
             // Ecosia: Lifecycle tracking. Needs to happen after Unleash start so that the flags are correctly added to the analytics context.

firefox-ios/Client/Coordinators/Browser/BrowserCoordinator.swift

@@ -98,7 +98,12 @@ class BrowserCoordinator: BaseCoordinator,
     // MARK: - LaunchCoordinatorDelegate
 
     func didFinishLaunch(from coordinator: LaunchCoordinator) {
+        /* Ecosia: Animate transition from welcome screen
         router.dismiss(animated: true, completion: nil)
+        */
+        router.dismiss(animated: true) { [weak self] in
+            self?.browserViewController.animateToolbarsIn()
+        }
         remove(child: coordinator)
 
         // Once launch is done, we check for any saved Route

firefox-ios/Client/Coordinators/Launch/LaunchCoordinator.swift

@@ -4,6 +4,7 @@
 
 import Common
 import Foundation
+import Ecosia
 
 protocol LaunchCoordinatorDelegate: AnyObject {
     func didFinishLaunch(from coordinator: LaunchCoordinator)
@@ -46,48 +47,56 @@ class LaunchCoordinator: BaseCoordinator,
     // MARK: - Intro
     private func presentIntroOnboarding(with manager: IntroScreenManager,
                                         isFullScreen: Bool) {
-        /* Ecosia: Disable old onboarding since outdated. Remove and clean up once properly updated.
-
-        let onboardingModel = NimbusOnboardingFeatureLayer().getOnboardingModel(for: .freshInstall)
-        let telemetryUtility = OnboardingTelemetryUtility(with: onboardingModel)
-        let introViewModel = IntroViewModel(introScreenManager: manager,
-                                            profile: profile,
-                                            model: onboardingModel,
-                                            telemetryUtility: telemetryUtility)
-        /* Ecosia: custom onboarding
-        let introViewController = IntroViewController(viewModel: introViewModel, windowUUID: windowUUID)
-        introViewController.qrCodeNavigationHandler = self
-        introViewController.didFinishFlow = { [weak self] in
+        // Wait for feature flags to be available since Onboarding is behind an experiment
+        AppEventQueue.wait(for: .featureManagementInitialized) { [weak self] in
             guard let self = self else { return }
-            self.parentCoordinator?.didFinishLaunch(from: self)
-        }
-         */
-        let introViewController = WelcomeNavigation(rootViewController: Welcome(delegate: self, windowUUID: windowUUID))
-        introViewController.isNavigationBarHidden = true
-        introViewController.edgesForExtendedLayout = UIRectEdge(rawValue: 0)
-        if isFullScreen {
-            introViewController.modalPresentationStyle = .fullScreen
-            router.present(introViewController, animated: false)
-        } else {
-            introViewController.preferredContentSize = CGSize(
-                width: ViewControllerConsts.PreferredSize.IntroViewController.width,
-                height: ViewControllerConsts.PreferredSize.IntroViewController.height)
-            introViewController.modalPresentationStyle = .formSheet
-            // Disables dismissing the view by tapping outside the view, based on
-            // Nimbus's configuration
-            if !introViewModel.isDismissable {
-                introViewController.isModalInPresentation = true
+
+            // Ecosia: Hide onboarding out of experiment
+            guard OnboardingProductTourExperiment.isEnabled else {
+                self.parentCoordinator?.didFinishLaunch(from: self)
+                return
             }
-            /* Ecosia: Remove completion
-            router.present(introViewController, animated: true) {
-                introViewController.closeOnboarding()
+
+            /* Ecosia: custom onboarding
+            let onboardingModel = NimbusOnboardingFeatureLayer().getOnboardingModel(for: .freshInstall)
+            let telemetryUtility = OnboardingTelemetryUtility(with: onboardingModel)
+            let introViewModel = IntroViewModel(introScreenManager: manager,
+                                                profile: profile,
+                                                model: onboardingModel,
+                                                telemetryUtility: telemetryUtility)
+
+            let introViewController = IntroViewController(viewModel: introViewModel, windowUUID: windowUUID)
+            introViewController.qrCodeNavigationHandler = self
+            introViewController.didFinishFlow = { [weak self] in
+                guard let self = self else { return }
+                self.parentCoordinator?.didFinishLaunch(from: self)
+            }
+
+            if isFullScreen {
+                introViewController.modalPresentationStyle = .fullScreen
+                router.present(introViewController, animated: false)
+            } else {
+                introViewController.preferredContentSize = CGSize(
+                    width: ViewControllerConsts.PreferredSize.IntroViewController.width,
+                    height: ViewControllerConsts.PreferredSize.IntroViewController.height)
+                introViewController.modalPresentationStyle = .formSheet
+                // Disables dismissing the view by tapping outside the view, based on
+                // Nimbus's configuration
+                if !introViewModel.isDismissable {
+                    introViewController.isModalInPresentation = true
+                }
+                router.present(introViewController, animated: true)
             }
-             */
-            router.present(introViewController, animated: true)
+            */
+            let introViewController = WelcomeNavigation(
+                rootViewController: WelcomeViewController(delegate: self, windowUUID: self.windowUUID),
+                windowUUID: self.windowUUID
+            )
+            introViewController.isNavigationBarHidden = true
+            introViewController.edgesForExtendedLayout = UIRectEdge(rawValue: 0)
+            introViewController.modalPresentationStyle = .fullScreen
+            self.router.present(introViewController, animated: false)
         }
-
-        */
-        parentCoordinator?.didFinishLaunch(from: self)
     }
 
     // MARK: - Update
@@ -186,7 +195,7 @@ class LaunchCoordinator: BaseCoordinator,
 
 // Ecosia: custom onboarding
 extension LaunchCoordinator: WelcomeDelegate {
-    func welcomeDidFinish(_ welcome: Welcome) {
+    func welcomeDidFinish(_ welcome: WelcomeViewController) {
         self.parentCoordinator?.didFinishLaunch(from: self)
     }
 }

firefox-ios/Client/Coordinators/Scene/SceneCoordinator.swift

@@ -147,8 +147,23 @@ class SceneCoordinator: BaseCoordinator, LaunchCoordinatorDelegate, LaunchFinish
     // MARK: - LaunchCoordinatorDelegate
 
     func didFinishLaunch(from coordinator: LaunchCoordinator) {
+        /* Ecosia: Custom transition
         router.dismiss(animated: true)
         remove(child: coordinator)
+        */
         startBrowser(with: nil)
+
+        // Ecosia: Animate transition from welcome screen
+        guard let browserCoordinator = childCoordinators.first(where: { $0 is BrowserCoordinator }) as? BrowserCoordinator else {
+            router.dismiss(animated: true)
+            remove(child: coordinator)
+            return
+        }
+
+        browserCoordinator.browserViewController.prepareToolbarsForWelcomeTransition()
+        router.dismiss(animated: true) {
+            browserCoordinator.browserViewController.animateToolbarsIn()
+        }
+        remove(child: coordinator)
     }
 }

firefox-ios/Client/Ecosia/Extensions/AppSettingsTableViewController+Ecosia.swift

@@ -152,7 +152,7 @@ extension AppSettingsTableViewController {
             OpenFiftyTabsDebugOption(settings: self, settingsDelegate: self),
             ToggleDefaultBrowserPromo(settings: self),
             ToggleImpactIntro(settings: self),
-            ShowTour(settings: self, windowUUID: windowUUID),
+            ShowWelcomeScreen(settings: self, windowUUID: windowUUID),
             CreateReferralCode(settings: self),
             AddReferral(settings: self),
             AddClaim(settings: self),
@@ -164,6 +164,7 @@ extension AppSettingsTableViewController {
             UnleashBrazeIntegrationSetting(settings: self),
             UnleashNativeSRPVAnalyticsSetting(settings: self),
             UnleashAISearchMVPSetting(settings: self),
+            UnleashOnboardingSetting(settings: self),
             UnleashIdentifierSetting(settings: self),
             AnalyticsIdentifierSetting(settings: self)
         ]

firefox-ios/Client/Ecosia/Extensions/Task+Sleep.swift

@@ -0,0 +1,17 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import Foundation
+
+extension Task where Success == Never, Failure == Never {
+    /// Sleep for a given duration in seconds, with iOS 15 compatibility
+    /// When iOS 16+ becomes minimum, this can be replaced with Task.sleep(for: .seconds())
+    static func sleep(duration: TimeInterval) async throws {
+        if #available(iOS 16.0, *) {
+            try await Task.sleep(for: .seconds(duration))
+        } else {
+            try await Task.sleep(nanoseconds: UInt64(duration * 1_000_000_000))
+        }
+    }
+}

firefox-ios/Client/Ecosia/Settings/EcosiaDebugSettings.swift

@@ -62,9 +62,9 @@ final class ToggleDefaultBrowserPromo: HiddenSetting {
     }
 }
 
-final class ShowTour: HiddenSetting, WelcomeDelegate {
+final class ShowWelcomeScreen: HiddenSetting, WelcomeDelegate {
     override var title: NSAttributedString? {
-        return NSAttributedString(string: "Debug: Show Intro", attributes: [:])
+        return NSAttributedString(string: "Debug: Show Welcome Screen", attributes: [:])
     }
 
     let windowUUID: WindowUUID
@@ -75,7 +75,7 @@ final class ShowTour: HiddenSetting, WelcomeDelegate {
 
     var parentPresenter: UIViewController?
     override func onClick(_ navigationController: UINavigationController?) {
-        let welcome = Welcome(delegate: self, windowUUID: windowUUID)
+        let welcome = WelcomeViewController(delegate: self, windowUUID: windowUUID)
         welcome.modalPresentationStyle = .fullScreen
         welcome.modalTransitionStyle = .coverVertical
         let presentingViewController = navigationController?.presentingViewController
@@ -84,7 +84,7 @@ final class ShowTour: HiddenSetting, WelcomeDelegate {
         }
     }
 
-    func welcomeDidFinish(_ welcome: Welcome) {
+    func welcomeDidFinish(_ welcome: WelcomeViewController) {
         if let presentedTour = welcome.presentedViewController {
             presentedTour.dismiss(animated: true) {
                 welcome.dismiss(animated: true)
@@ -289,6 +289,20 @@ final class UnleashAISearchMVPSetting: UnleashVariantResetSetting {
     }
 }
 
+final class UnleashOnboardingSetting: UnleashVariantResetSetting {
+    override var titleName: String? {
+        "Onboarding Product Tour"
+    }
+
+    override var variant: Unleash.Variant? {
+        Unleash.getVariant(.onboardingProductTour)
+    }
+
+    override var unleashEnabled: Bool? {
+        Unleash.isEnabled(.onboardingProductTour)
+    }
+}
+
 final class AnalyticsIdentifierSetting: HiddenSetting {
     override var title: NSAttributedString? {
         return NSAttributedString(string: "Debug: Analytics Identifier", attributes: [:])