[PM-33849] feat: Add Premium Upgrade view

BitwardenKit/Application/TestHelpers/ServiceContainer.swift

@@ -9,8 +9,8 @@ typealias Services = HasConfigService
     & HasErrorReporter
     & HasFlightRecorder
     & HasLanguageStateService
-    & HasTimeProvider
     & HasServerCommunicationConfigClientSingleton
+    & HasTimeProvider
 
 /// A service container used for testing processors within `BitwardenKitTests`.
 ///

BitwardenResources/Localizations/en.lproj/Localizable.strings

@@ -1331,3 +1331,11 @@
 "TurnOnNow" = "Turn on now";
 "AcceptTransfer" = "Accept transfer";
 "YourPasswordAndHintCannotBeTheSamePleaseChooseADifferentHint" = "Your password and hint cannot be the same. Please choose a different hint.";
+"PerMonth" = " / month";
+"UnlockMoreAdvancedFeaturesWithPremiumPlan" = "Unlock more advanced features with a Premium plan.";
+"BuiltInAuthenticator" = "Built-in authenticator";
+"EmergencyAccess" = "Emergency access";
+"SecureFileStorage" = "Secure file storage";
+"BreachMonitoring" = "Breach monitoring";
+"UpgradeNow" = "Upgrade now";
+"YouWillGoToStripeSecureCheckoutToCompleteYourPurchase" = "You'll go to Stripe's secure checkout to complete your purchase.";

BitwardenShared/Core/Platform/Services/ServiceContainer.swift

@@ -27,6 +27,9 @@ public class ServiceContainer: Services { // swiftlint:disable:this type_body_le
     /// The service used by the application to make API requests.
     let apiService: APIService
 
+    /// An optional override for the billing API service, used for testing.
+    var billingAPIServiceOverride: BillingAPIService?
+
     /// Helper used to know app context.
     let appContextHelper: AppContextHelper
 
@@ -1172,7 +1175,7 @@ extension ServiceContainer {
     }
 
     var billingAPIService: BillingAPIService {
-        apiService
+        billingAPIServiceOverride ?? apiService
     }
 
     var configAPIService: ConfigAPIService {

BitwardenShared/Core/Platform/Services/Services.swift

@@ -13,9 +13,9 @@ typealias Services = HasAPIService
     & HasApplication
     & HasAuthAPIService
     & HasAuthRepository
-    & HasBillingAPIService
     & HasAuthService
     & HasAutofillCredentialService
+    & HasBillingAPIService
     & HasBiometricsRepository
     & HasCameraService
     & HasChangeKdfService

BitwardenShared/Core/Platform/Services/TestHelpers/ServiceContainer+Mocks.swift

@@ -22,6 +22,7 @@ extension ServiceContainer {
         authService: AuthService = MockAuthService(),
         authenticatorSyncService: AuthenticatorSyncService = MockAuthenticatorSyncService(),
         autofillCredentialService: AutofillCredentialService = MockAutofillCredentialService(),
+        billingAPIService: BillingAPIService? = nil,
         biometricsRepository: BiometricsRepository = MockBiometricsRepository(),
         biometricsService: BiometricsService = MockBiometricsService(),
         cameraService: CameraService = MockCameraService(),
@@ -90,7 +91,7 @@ extension ServiceContainer {
             actualSearchProcessorMediatorFactory = factoryMock
         }
 
-        return ServiceContainer(
+        let container = ServiceContainer(
             apiService: APIService(
                 client: httpClient,
                 environmentService: environmentService,
@@ -159,5 +160,7 @@ extension ServiceContainer {
             vaultTimeoutService: vaultTimeoutService,
             watchService: watchService,
         )
+        container.billingAPIServiceOverride = billingAPIService
+        return container
     }
 }

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeAction.swift

@@ -0,0 +1,11 @@
+// MARK: - PremiumUpgradeAction
+
+/// Actions handled by the `PremiumUpgradeProcessor`.
+///
+enum PremiumUpgradeAction: Equatable {
+    /// The cancel button was tapped.
+    case cancelTapped
+
+    /// Clear the checkout URL after it has been opened.
+    case clearURL
+}

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeCoordinator.swift

@@ -0,0 +1,71 @@
+import BitwardenKit
+import SwiftUI
+
+// MARK: - PremiumUpgradeCoordinator
+
+/// A coordinator that manages navigation for the premium upgrade view.
+///
+class PremiumUpgradeCoordinator: Coordinator, HasStackNavigator {
+    // MARK: Types
+
+    typealias Services = HasBillingAPIService
+        & HasErrorAlertServices.ErrorAlertServices
+        & HasErrorReporter
+
+    // MARK: Properties
+
+    /// The services used by this coordinator.
+    let services: Services
+
+    /// The stack navigator that is managed by this coordinator.
+    private(set) weak var stackNavigator: StackNavigator?
+
+    // MARK: Initialization
+
+    /// Creates a new `PremiumUpgradeCoordinator`.
+    ///
+    /// - Parameters:
+    ///   - services: The services used by this coordinator.
+    ///   - stackNavigator: The stack navigator that is managed by this coordinator.
+    ///
+    init(
+        services: Services,
+        stackNavigator: StackNavigator,
+    ) {
+        self.services = services
+        self.stackNavigator = stackNavigator
+    }
+
+    // MARK: Methods
+
+    func navigate(to route: PremiumUpgradeRoute, context: AnyObject?) {
+        switch route {
+        case .dismiss:
+            stackNavigator?.dismiss()
+        }
+    }
+
+    func start() {
+        showPremiumUpgrade()
+    }
+
+    // MARK: Private Methods
+
+    /// Shows the premium upgrade screen.
+    ///
+    private func showPremiumUpgrade() {
+        let processor = PremiumUpgradeProcessor(
+            coordinator: asAnyCoordinator(),
+            services: services,
+            state: PremiumUpgradeState(),
+        )
+        let view = PremiumUpgradeView(store: Store(processor: processor))
+        stackNavigator?.replace(view)
+    }
+}
+
+// MARK: - HasErrorAlertServices
+
+extension PremiumUpgradeCoordinator: HasErrorAlertServices {
+    var errorAlertServices: ErrorAlertServices { services }
+}

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeCoordinatorTests.swift

@@ -0,0 +1,55 @@
+import BitwardenKitMocks
+import SwiftUI
+import XCTest
+
+@testable import BitwardenShared
+@testable import BitwardenSharedMocks
+
+class PremiumUpgradeCoordinatorTests: BitwardenTestCase {
+    // MARK: Properties
+
+    var stackNavigator: MockStackNavigator!
+    var subject: PremiumUpgradeCoordinator!
+
+    // MARK: Setup & Teardown
+
+    override func setUp() {
+        super.setUp()
+
+        stackNavigator = MockStackNavigator()
+
+        subject = PremiumUpgradeCoordinator(
+            services: ServiceContainer.withMocks(),
+            stackNavigator: stackNavigator,
+        )
+    }
+
+    override func tearDown() {
+        super.tearDown()
+
+        stackNavigator = nil
+        subject = nil
+    }
+
+    // MARK: Tests
+
+    /// `start()` replaces the stack navigator's stack with the premium upgrade view.
+    @MainActor
+    func test_start() throws {
+        subject.start()
+
+        XCTAssertEqual(stackNavigator.actions.count, 1)
+        let action = try XCTUnwrap(stackNavigator.actions.last)
+        XCTAssertEqual(action.type, .replaced)
+        XCTAssertTrue(action.view is PremiumUpgradeView)
+    }
+
+    /// `navigate(to:)` with `.dismiss` dismisses the view.
+    @MainActor
+    func test_navigate_dismiss() throws {
+        subject.navigate(to: .dismiss)
+
+        let action = try XCTUnwrap(stackNavigator.actions.last)
+        XCTAssertEqual(action.type, .dismissed)
+    }
+}

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeEffect.swift

@@ -0,0 +1,8 @@
+// MARK: - PremiumUpgradeEffect
+
+/// Effects that can be processed by a `PremiumUpgradeProcessor`.
+///
+enum PremiumUpgradeEffect {
+    /// The upgrade now button was tapped.
+    case upgradeNowTapped
+}

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeModule.swift

@@ -0,0 +1,28 @@
+import BitwardenKit
+
+// MARK: - PremiumUpgradeModule
+
+/// An object that builds coordinators for the premium upgrade view.
+///
+@MainActor
+protocol PremiumUpgradeModule {
+    /// Initializes a coordinator for navigating between `PremiumUpgradeRoute`s.
+    ///
+    /// - Parameter stackNavigator: The stack navigator that will be used to navigate between routes.
+    /// - Returns: A coordinator that can navigate to `PremiumUpgradeRoute`s.
+    ///
+    func makePremiumUpgradeCoordinator(
+        stackNavigator: StackNavigator,
+    ) -> AnyCoordinator<PremiumUpgradeRoute, Void>
+}
+
+extension DefaultAppModule: PremiumUpgradeModule {
+    func makePremiumUpgradeCoordinator(
+        stackNavigator: StackNavigator,
+    ) -> AnyCoordinator<PremiumUpgradeRoute, Void> {
+        PremiumUpgradeCoordinator(
+            services: services,
+            stackNavigator: stackNavigator,
+        ).asAnyCoordinator()
+    }
+}

BitwardenShared/UI/Billing/PremiumUpgrade/PremiumUpgradeProcessor.swift

@@ -0,0 +1,77 @@
+import BitwardenKit
+
+// MARK: - PremiumUpgradeProcessor
+
+/// The processor used to manage state and handle actions for the `PremiumUpgradeView`.
+///
+final class PremiumUpgradeProcessor: StateProcessor<
+    PremiumUpgradeState,
+    PremiumUpgradeAction,
+    PremiumUpgradeEffect,
+> {
+    // MARK: Types
+
+    typealias Services = HasBillingAPIService
+        & HasErrorReporter
+
+    // MARK: Properties
+
+    /// The coordinator used to manage navigation.
+    private let coordinator: AnyCoordinator<PremiumUpgradeRoute, Void>
+
+    /// The services used by this processor.
+    private let services: Services
+
+    // MARK: Initialization
+
+    /// Initializes a `PremiumUpgradeProcessor`.
+    ///
+    /// - Parameters:
+    ///   - coordinator: The coordinator used for navigation.
+    ///   - services: The services used by this processor.
+    ///   - state: The initial state of the processor.
+    ///
+    init(
+        coordinator: AnyCoordinator<PremiumUpgradeRoute, Void>,
+        services: Services,
+        state: PremiumUpgradeState,
+    ) {
+        self.coordinator = coordinator
+        self.services = services
+        super.init(state: state)
+    }
+
+    // MARK: Methods
+
+    override func perform(_ effect: PremiumUpgradeEffect) async {
+        switch effect {
+        case .upgradeNowTapped:
+            await createCheckoutSession()
+        }
+    }
+
+    override func receive(_ action: PremiumUpgradeAction) {
+        switch action {
+        case .cancelTapped:
+            coordinator.navigate(to: .dismiss)
+        case .clearURL:
+            state.checkoutURL = nil
+        }
+    }
+
+    // MARK: Private Methods
+
+    /// Creates a checkout session by calling the billing API.
+    ///
+    private func createCheckoutSession() async {
+        defer { state.isLoading = false }
+        do {
+            state.isLoading = true
+            let response = try await services.billingAPIService.createCheckoutSession()
+            state.checkoutURL = response.checkoutSessionUrl
+        } catch {
+            services.errorReporter.log(error: error)
+            await coordinator.showErrorAlert(error: error)
+        }
+    }
+}