passepartout-apple/Library/Sources/UILibrary/Business/AppContext.swift

//
//  AppContext.swift
//  Passepartout
//
//  Created by Davide De Rosa on 8/29/24.
//  Copyright (c) 2024 Davide De Rosa. All rights reserved.
//
//  https://github.com/passepartoutvpn
//
//  This file is part of Passepartout.
//
//  Passepartout is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  Passepartout is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with Passepartout.  If not, see <http://www.gnu.org/licenses/>.
//

import Combine
import CommonLibrary
import CommonUtils
import Foundation
import PassepartoutKit
import UITesting

@MainActor
public final class AppContext: ObservableObject, Sendable {
    public let iapManager: IAPManager

    public let migrationManager: MigrationManager

    public let profileManager: ProfileManager

    public let providerManager: ProviderManager

    public let preferencesManager: PreferencesManager

    public let registry: Registry

    public let tunnel: ExtendedTunnel

    private let tunnelReceiptURL: URL

    private var launchTask: Task<Void, Error>?

    private var pendingTask: Task<Void, Never>?

    private var subscriptions: Set<AnyCancellable>

    public init(
        iapManager: IAPManager,
        migrationManager: MigrationManager,
        profileManager: ProfileManager,
        providerManager: ProviderManager,
        preferencesManager: PreferencesManager,
        registry: Registry,
        tunnel: ExtendedTunnel,
        tunnelReceiptURL: URL
    ) {
        self.iapManager = iapManager
        self.migrationManager = migrationManager
        self.profileManager = profileManager
        self.providerManager = providerManager
        self.preferencesManager = preferencesManager
        self.registry = registry
        self.tunnel = tunnel
        self.tunnelReceiptURL = tunnelReceiptURL
        subscriptions = []
    }
}

// MARK: - Observation

// invoked by AppDelegate
extension AppContext {
    public func onApplicationActive() {
        Task {
            // TODO: ###, should handle AppError.couldNotLaunch (although extremely rare)
            try await onForeground()
        }
    }
}

// invoked on internal events
private extension AppContext {
    func onLaunch() async throws {
        pp_log(.app, .notice, "Application did launch")

        pp_log(.App.profiles, .info, "\tRead and observe local profiles...")
        try await profileManager.observeLocal()

        pp_log(.App.profiles, .info, "\tObserve in-app events...")
        iapManager.observeObjects()
        await iapManager.reloadReceipt()

        pp_log(.App.profiles, .info, "\tObserve eligible features...")
        iapManager
            .$eligibleFeatures
            .removeDuplicates()
            .sink { [weak self] eligible in
                Task {
                    try await self?.onEligibleFeatures(eligible)
                }
            }
            .store(in: &subscriptions)

        pp_log(.App.profiles, .info, "\tObserve changes in ProfileManager...")
        profileManager
            .didChange
            .sink { [weak self] event in
                switch event {
                case .save(let profile):
                    Task {
                        try await self?.onSaveProfile(profile)
                    }

                default:
                    break
                }
            }
            .store(in: &subscriptions)

        // copy release receipt to tunnel for TestFlight eligibility (once is enough, it won't change)
        if let appReceiptURL = Bundle.main.appStoreProductionReceiptURL {
            do {
                pp_log(.App.iap, .info, "\tCopy release receipt to tunnel...")
                try? FileManager.default.removeItem(at: tunnelReceiptURL)
                try FileManager.default.copyItem(at: appReceiptURL, to: tunnelReceiptURL)
            } catch {
                pp_log(.App.iap, .error, "\tUnable to copy release receipt to tunnel: \(error)")
            }
        }

        do {
            pp_log(.app, .info, "\tFetch providers index...")
            try await providerManager.fetchIndex(from: API.shared)
        } catch {
            pp_log(.app, .error, "\tUnable to fetch providers index: \(error)")
        }
    }

    func onForeground() async throws {
        let didLaunch = try await waitForTasks()
        guard !didLaunch else {
            return // foreground is redundant after launch
        }

        pp_log(.app, .notice, "Application did enter foreground")
        pendingTask = Task {
            do {
                pp_log(.App.profiles, .info, "\tRefresh local profiles observers...")
                try await profileManager.observeLocal()
            } catch {
                pp_log(.App.profiles, .error, "\tUnable to re-observe local profiles: \(error)")
            }

            await iapManager.reloadReceipt()
        }
        await pendingTask?.value
        pendingTask = nil
    }

    func onEligibleFeatures(_ features: Set<AppFeature>) async throws {
        try await waitForTasks()

        pp_log(.app, .notice, "Application did update eligible features")
        pendingTask = Task {

            // toggle sync based on .sharing eligibility
            let isEligibleForSharing = features.contains(.sharing)
            do {
                pp_log(.App.profiles, .info, "\tRefresh remote profiles observers (eligible=\(isEligibleForSharing), CloudKit=\(isCloudKitEnabled))...")
                try await profileManager.observeRemote(isEligibleForSharing && isCloudKitEnabled)
            } catch {
                pp_log(.App.profiles, .error, "\tUnable to re-observe remote profiles: \(error)")
            }

            // refresh required profile features
            pp_log(.App.profiles, .info, "\tReload profiles required features...")
            profileManager.reloadRequiredFeatures()
        }
        await pendingTask?.value
        pendingTask = nil
    }

    func onSaveProfile(_ profile: Profile) async throws {
        try await waitForTasks()

        pp_log(.app, .notice, "Application did save profile (\(profile.id))")
        guard profile.id == tunnel.currentProfile?.id else {
            pp_log(.app, .debug, "\tProfile \(profile.id) is not current, do nothing")
            return
        }
        guard [.active, .activating].contains(tunnel.status) else {
            pp_log(.app, .debug, "\tConnection is not active (\(tunnel.status)), do nothing")
            return
        }
        pendingTask = Task {
            do {
                do {
                    pp_log(.app, .info, "\tReconnect profile \(profile.id)")
                    try await tunnel.connect(with: profile)
                } catch AppError.interactiveLogin {
                    pp_log(.app, .info, "\tProfile \(profile.id) is interactive, disconnect")
                    try await tunnel.disconnect()
                } catch {
                    pp_log(.app, .error, "\tUnable to reconnect profile \(profile.id), disconnect: \(error)")
                    try await tunnel.disconnect()
                }
            } catch {
                pp_log(.app, .error, "\tUnable to reinstate connection on save profile \(profile.id): \(error)")
            }
        }
        await pendingTask?.value
        pendingTask = nil
    }

    @discardableResult
    func waitForTasks() async throws -> Bool {
        var didLaunch = false

        // must launch once before anything else
        if launchTask == nil {
            launchTask = Task {
                do {
                    try await onLaunch()
                } catch {
                    launchTask = nil // redo launch
                    throw AppError.couldNotLaunch(reason: error)
                }
            }
            didLaunch = true
        }

        // will throw on .couldNotLaunch
        // next wait will re-attempt launch (launchTask == nil)
        try await launchTask?.value

        // wait for pending task if any
        await pendingTask?.value
        pendingTask = nil

        return didLaunch
    }
}

// MARK: - Helpers

private extension AppContext {
    var isCloudKitEnabled: Bool {
#if os(tvOS)
        true
#else
        if AppCommandLine.contains(.uiTesting) {
            return true
        }
        return FileManager.default.ubiquityIdentityToken != nil
#endif
    }
}