Always start onboarding from the beginning when shown (#2117)

Task/Issue URL: https://app.asana.com/0/1177771139624306/1206434679656281/f Description: Simplify OnboardingViewModel by removing restart() function. Also make isOnboardingFinished a static property.
duckduckgo · Jan 25, 2024 · b7f0b7a · b7f0b7a
1 parent abe0591
commit b7f0b7a
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 28 deletions.
diff --git a/DuckDuckGo/HomePage/Model/HomePageContinueSetUpModel.swift b/DuckDuckGo/HomePage/Model/HomePageContinueSetUpModel.swift
@@ -322,7 +322,7 @@ extension HomePage.Models {
 #if DEBUG
             isFirstSession = false
 #endif
-            if OnboardingViewModel().onboardingFinished {
+            if OnboardingViewModel.isOnboardingFinished {
                 isFirstSession = false
             }
         }

diff --git a/DuckDuckGo/HomePage/View/HomePageViewController.swift b/DuckDuckGo/HomePage/View/HomePageViewController.swift
@@ -98,7 +98,7 @@ final class HomePageViewController: NSViewController {
     override func viewWillAppear() {
         super.viewWillAppear()
         if !PixelExperiment.isExperimentInstalled {
-            if onboardingViewModel.onboardingFinished && Pixel.isNewUser {
+            if OnboardingViewModel.isOnboardingFinished && Pixel.isNewUser {
                 Pixel.fire(.newTabInitial(), limitTo: .initial)
             }
         }

diff --git a/DuckDuckGo/MainWindow/MainWindowController.swift b/DuckDuckGo/MainWindow/MainWindowController.swift
@@ -68,7 +68,7 @@ final class MainWindowController: NSWindowController {
 #if DEBUG
         return false
 #else
-        let onboardingIsComplete = OnboardingViewModel().onboardingFinished || LocalStatisticsStore().waitlistUnlocked
+        let onboardingIsComplete = OnboardingViewModel.isOnboardingFinished || LocalStatisticsStore().waitlistUnlocked
         return !onboardingIsComplete
 #endif
     }

diff --git a/DuckDuckGo/Onboarding/ViewModel/OnboardingViewModel.swift b/DuckDuckGo/Onboarding/ViewModel/OnboardingViewModel.swift
@@ -53,14 +53,12 @@ final class OnboardingViewModel: ObservableObject {
     }
 
     @UserDefaultsWrapper(key: .onboardingFinished, defaultValue: false)
-    private(set) var onboardingFinished: Bool
+    private(set) static var isOnboardingFinished: Bool
 
     weak var delegate: OnboardingDelegate?
 
-    init(
-        delegate: OnboardingDelegate? = nil) {
+    init(delegate: OnboardingDelegate? = nil) {
         self.delegate = delegate
-        self.state = onboardingFinished ? .startBrowsing : .startFlow
     }
 
     func onSplashFinished() {
@@ -84,14 +82,14 @@ final class OnboardingViewModel: ObservableObject {
     func onSetDefaultPressed() {
         delegate?.onboardingDidRequestSetDefault { [weak self] in
             self?.state = .startBrowsing
-            self?.onboardingFinished = true
+            Self.isOnboardingFinished = true
             self?.delegate?.onboardingHasFinished()
         }
     }
 
     func onSetDefaultSkipped() {
         state = .startBrowsing
-        onboardingFinished = true
+        Self.isOnboardingFinished = true
         delegate?.onboardingHasFinished()
     }
 
@@ -100,17 +98,12 @@ final class OnboardingViewModel: ObservableObject {
     }
 
     func onboardingReshown() {
-        if onboardingFinished {
+        if Self.isOnboardingFinished {
             typingDisabled = true
             delegate?.onboardingHasFinished()
         } else {
             state = .startFlow
         }
     }
 
-    func restart() {
-        onboardingFinished = false
-        state = .startFlow
-    }
-
 }
diff --git a/DuckDuckGo/Statistics/Experiment/PixelExperiment.swift b/DuckDuckGo/Statistics/Experiment/PixelExperiment.swift
@@ -34,7 +34,7 @@ enum PixelExperiment: String, CaseIterable {
 
     static var isNoCardsExperimentOn: Bool {
         // This is to avoid the cohort is assigned before the user actually sees the new tab page (after the onboarding has been completed)
-        if isExperimentInstalled && !OnboardingViewModel().onboardingFinished {
+        if isExperimentInstalled && !OnboardingViewModel.isOnboardingFinished {
             return true
         }
         // Cohort are assigned the first time it's called

diff --git a/DuckDuckGo/Tab/Model/Tab.swift b/DuckDuckGo/Tab/Model/Tab.swift
@@ -635,9 +635,6 @@ protocol NewWindowPolicyDecisionMaker {
 
     @discardableResult
     func setUrl(_ url: URL?, source: TabContent.URLSource) -> ExpectedNavigation? {
-        if url == .welcome {
-            OnboardingViewModel().restart()
-        }
         return self.setContent(.contentFromURL(url, source: source))
     }
 

diff --git a/DuckDuckGo/Tab/View/BrowserTabViewController.swift b/DuckDuckGo/Tab/View/BrowserTabViewController.swift
@@ -501,7 +501,7 @@ final class BrowserTabViewController: NSViewController {
 
         case .onboarding:
             removeAllTabContent()
-            if !OnboardingViewModel().onboardingFinished {
+            if !OnboardingViewModel.isOnboardingFinished {
                 requestDisableUI()
             }
             showTransientTabContentController(OnboardingViewController.create(withDelegate: self))

diff --git a/UnitTests/Onboarding/OnboardingTests.swift b/UnitTests/Onboarding/OnboardingTests.swift
@@ -87,15 +87,8 @@ class OnboardingTests: XCTestCase {
         XCTAssertTrue(onboardingFinished)
     }
 
-    func testWhenOnboardingFinishedThenInitialStateIsStartBrowsing() {
+    func testThatOnboardingFinishedDoesNotInfluenceInitialState() {
         onboardingFinished = true
-        let model = OnboardingViewModel()
-        XCTAssertEqual(model.state, .startBrowsing)
-    }
-
-    func testWhenOnboardingRestartedThenInitialStateIsStartFlow() {
-        OnboardingViewModel().restart()
-
         let model = OnboardingViewModel()
         XCTAssertEqual(model.state, .startFlow)
     }