SubscriptionManager.swift 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. import AppKit
  2. import Combine
  3. import Foundation
  4. import StoreKit
  5. enum PurchaseError: Equatable {
  6. case productsLoadTimeout
  7. case subscriptionUnavailable
  8. case planUnavailable
  9. case purchaseNotVerified
  10. case purchasePending
  11. case noActiveSubscriptions
  12. case noActivePurchases
  13. case restoreSyncTimeout
  14. case generic
  15. }
  16. @MainActor
  17. final class SubscriptionManager: ObservableObject {
  18. private enum ProductLoadError: Error {
  19. case timeout
  20. }
  21. private enum StoreSyncError: Error {
  22. case timeout
  23. }
  24. private static let cachedPremiumKey = "SubscriptionManager.cachedIsPremium"
  25. private static let cachedPremiumPlanKey = "SubscriptionManager.cachedPremiumPlan"
  26. private static let cachedHasEverPurchasedKey = "SubscriptionManager.cachedHasEverPurchased"
  27. @Published private(set) var productsByID: [String: Product] = [:]
  28. @Published private(set) var isLoadingProducts = false
  29. @Published private(set) var purchasingPlan: PaywallPlan?
  30. @Published private(set) var isRestoringPurchases = false
  31. @Published private(set) var hasPremiumAccess = false
  32. @Published private(set) var hasResolvedPremiumStatus = false
  33. @Published private(set) var activePremiumPlan: PaywallPlan?
  34. @Published private(set) var productLoadError: String?
  35. @Published private(set) var hasEverPurchasedPremium = false
  36. @Published var purchaseError: PurchaseError?
  37. var availablePaywallPlans: [PaywallPlan] {
  38. PaywallPlan.allCases
  39. }
  40. var isResolvingEntitlements: Bool {
  41. !hasResolvedPremiumStatus
  42. }
  43. var hasLifetimeAccess: Bool {
  44. activePremiumPlan == .lifetime
  45. }
  46. var hasActiveSubscription: Bool {
  47. activePremiumPlan == .monthly || activePremiumPlan == .yearly
  48. }
  49. var hasAllProductsLoaded: Bool {
  50. SubscriptionProductID.all.allSatisfy { productsByID[$0] != nil }
  51. }
  52. private var inFlightProductLoad: Task<Void, Never>?
  53. private var initialEntitlementTask: Task<Void, Never>?
  54. private var entitlementRefreshTask: Task<Void, Never>?
  55. private var hasStarted = false
  56. private var cancellables = Set<AnyCancellable>()
  57. private var lastBackgroundEntitlementRefresh: Date?
  58. /// Minimum time between entitlement re-checks when the app regains focus.
  59. private static let backgroundRefreshInterval: TimeInterval = 120
  60. init() {
  61. hasEverPurchasedPremium = UserDefaults.standard.bool(forKey: Self.cachedHasEverPurchasedKey)
  62. }
  63. func start() {
  64. guard !hasStarted else { return }
  65. hasStarted = true
  66. observeAppLifecycle()
  67. Task { await listenForTransactionUpdates() }
  68. initialEntitlementTask = Task {
  69. await refreshPremiumAccess()
  70. await loadProducts(presentLoadingUI: false)
  71. }
  72. }
  73. private func observeAppLifecycle() {
  74. NotificationCenter.default.publisher(for: NSApplication.didBecomeActiveNotification)
  75. .sink { [weak self] _ in
  76. self?.refreshEntitlementsOnAppActive()
  77. }
  78. .store(in: &cancellables)
  79. }
  80. private func refreshEntitlementsOnAppActive() {
  81. guard hasStarted else { return }
  82. if let lastRefresh = lastBackgroundEntitlementRefresh,
  83. Date().timeIntervalSince(lastRefresh) < Self.backgroundRefreshInterval {
  84. return
  85. }
  86. entitlementRefreshTask?.cancel()
  87. entitlementRefreshTask = Task {
  88. // Local StoreKit entitlements only — AppStore.sync() prompts for Apple ID
  89. // and can loop in Xcode when focus returns after dismissing the dialog.
  90. await refreshPremiumAccess()
  91. lastBackgroundEntitlementRefresh = Date()
  92. }
  93. }
  94. func ensureEntitlementsResolved() async {
  95. await initialEntitlementTask?.value
  96. }
  97. func loadProducts(presentLoadingUI: Bool? = nil) async {
  98. if let existing = inFlightProductLoad {
  99. await existing.value
  100. return
  101. }
  102. let uiFlag = presentLoadingUI
  103. let task = Task { @MainActor in
  104. await performLoadProducts(presentLoadingUI: uiFlag)
  105. }
  106. inFlightProductLoad = task
  107. await task.value
  108. inFlightProductLoad = nil
  109. }
  110. func product(for plan: PaywallPlan) -> Product? {
  111. productsByID[plan.productID]
  112. }
  113. func mainPrice(for plan: PaywallPlan) -> String {
  114. let config = PaywallConfigService.shared.config
  115. return product(for: plan)?.displayPrice ?? plan.planCopy(from: config).fallbackPrice
  116. }
  117. func priceSuffix(for plan: PaywallPlan) -> String? {
  118. plan.planCopy(from: PaywallConfigService.shared.config).priceSuffix
  119. }
  120. func billingDescription(for plan: PaywallPlan) -> String {
  121. let config = PaywallConfigService.shared.config
  122. guard let product = product(for: plan) else {
  123. return plan.fallbackBillingDescription(config: config)
  124. }
  125. switch plan {
  126. case .monthly:
  127. return "Billed at \(product.displayPrice) every month"
  128. case .yearly:
  129. return "Billed at \(product.displayPrice) every year"
  130. case .lifetime:
  131. return "One-time payment of \(product.displayPrice)"
  132. }
  133. }
  134. func purchase(_ plan: PaywallPlan) async -> Bool {
  135. purchaseError = nil
  136. guard availablePaywallPlans.contains(plan) else {
  137. purchaseError = .planUnavailable
  138. return false
  139. }
  140. var product = productsByID[plan.productID]
  141. if product == nil {
  142. await loadProducts(presentLoadingUI: false)
  143. product = productsByID[plan.productID]
  144. }
  145. guard let product else {
  146. let missingProductIDs = SubscriptionProductID.all.filter { productsByID[$0] == nil }
  147. if missingProductIDs.isEmpty {
  148. purchaseError = .subscriptionUnavailable
  149. } else {
  150. purchaseError = .planUnavailable
  151. #if DEBUG
  152. print(
  153. """
  154. [SubscriptionManager] Missing StoreKit products: \(missingProductIDs.joined(separator: ", "))
  155. To test locally, attach `Paywall.storekit` in Xcode:
  156. Product > Scheme > Edit Scheme > Run > Options > StoreKit Configuration.
  157. """
  158. )
  159. #endif
  160. }
  161. return false
  162. }
  163. purchasingPlan = plan
  164. defer { purchasingPlan = nil }
  165. do {
  166. let result = try await product.purchase()
  167. switch result {
  168. case .success(let verification):
  169. guard case .verified(let transaction) = verification else {
  170. purchaseError = .purchaseNotVerified
  171. return false
  172. }
  173. let trustedPlan = planGrantingPremium(from: transaction)
  174. if let trustedPlan {
  175. applyPremiumAccess(from: transaction)
  176. }
  177. await transaction.finish()
  178. await reconcilePremiumAccess(trustedPlan: trustedPlan)
  179. return hasPremiumAccess
  180. case .userCancelled:
  181. return false
  182. case .pending:
  183. purchaseError = .purchasePending
  184. return false
  185. @unknown default:
  186. return false
  187. }
  188. } catch {
  189. purchaseError = .generic
  190. return false
  191. }
  192. }
  193. func openSubscriptionManagement() {
  194. let urlString = PaywallConfigService.shared.config.urls.manageSubscriptions
  195. guard let url = URL(string: urlString) else { return }
  196. NSWorkspace.shared.open(url)
  197. }
  198. func restorePurchases() async {
  199. purchaseError = nil
  200. isRestoringPurchases = true
  201. defer { isRestoringPurchases = false }
  202. do {
  203. try await syncAppStoreWithTimeout(seconds: 30)
  204. } catch is StoreSyncError {
  205. purchaseError = .restoreSyncTimeout
  206. return
  207. } catch {
  208. purchaseError = .generic
  209. return
  210. }
  211. await reconcilePremiumAccess(trustedPlan: nil)
  212. if !hasPremiumAccess {
  213. purchaseError = .noActivePurchases
  214. }
  215. }
  216. private func performLoadProducts(presentLoadingUI: Bool?) async {
  217. let missingAny = SubscriptionProductID.all.contains { productsByID[$0] == nil }
  218. let shouldShowLoading = presentLoadingUI ?? missingAny
  219. if !missingAny, presentLoadingUI != true {
  220. purchaseError = nil
  221. await refreshPremiumAccess()
  222. return
  223. }
  224. if shouldShowLoading {
  225. isLoadingProducts = true
  226. }
  227. defer {
  228. if shouldShowLoading {
  229. isLoadingProducts = false
  230. }
  231. }
  232. purchaseError = nil
  233. productLoadError = nil
  234. do {
  235. let loaded = try await loadProductsWithTimeout(seconds: 12)
  236. guard !loaded.isEmpty else {
  237. productLoadError = PaywallConfigService.shared.config.messages.noPlansAvailable
  238. productsByID = [:]
  239. return
  240. }
  241. var map: [String: Product] = [:]
  242. for product in loaded {
  243. map[product.id] = product
  244. }
  245. productsByID = map
  246. productLoadError = nil
  247. await refreshPremiumAccess()
  248. } catch is ProductLoadError {
  249. productLoadError = PaywallConfigService.shared.config.messages.plansLoadFailed
  250. purchaseError = .productsLoadTimeout
  251. } catch {
  252. productLoadError = PaywallConfigService.shared.config.messages.plansLoadFailed
  253. purchaseError = .generic
  254. }
  255. }
  256. private func loadProductsWithTimeout(seconds: TimeInterval) async throws -> [Product] {
  257. try await withThrowingTaskGroup(of: [Product].self) { group in
  258. group.addTask {
  259. try await Product.products(for: SubscriptionProductID.all)
  260. }
  261. group.addTask {
  262. let timeoutNanoseconds = UInt64(seconds * 1_000_000_000)
  263. try await Task.sleep(nanoseconds: timeoutNanoseconds)
  264. throw ProductLoadError.timeout
  265. }
  266. guard let first = try await group.next() else {
  267. throw ProductLoadError.timeout
  268. }
  269. group.cancelAll()
  270. return first
  271. }
  272. }
  273. private func refreshPremiumAccess(trustedPlan: PaywallPlan? = nil) async {
  274. var resolvedPlan: PaywallPlan?
  275. if let lifetimePlan = await activeLifetimePlan() {
  276. resolvedPlan = lifetimePlan
  277. }
  278. if resolvedPlan == nil {
  279. for await result in Transaction.currentEntitlements {
  280. guard case .verified(let transaction) = result else { continue }
  281. guard let plan = planGrantingPremium(from: transaction) else { continue }
  282. resolvedPlan = preferredPlan(resolvedPlan, plan)
  283. }
  284. }
  285. if resolvedPlan == nil || resolvedPlan != .lifetime {
  286. if let subscriptionPlan = await activeSubscriptionPlan() {
  287. resolvedPlan = preferredPlan(resolvedPlan, subscriptionPlan)
  288. }
  289. }
  290. let finalPlan = mergeTrustedPlan(resolvedPlan, trustedPlan)
  291. activePremiumPlan = finalPlan
  292. hasPremiumAccess = finalPlan != nil
  293. hasResolvedPremiumStatus = true
  294. persistPremiumCache()
  295. await refreshPurchaseHistory()
  296. }
  297. /// Re-reads entitlements from StoreKit, then syncs with the App Store when a
  298. /// purchase was just verified but entitlements have not caught up yet.
  299. private func reconcilePremiumAccess(trustedPlan: PaywallPlan?) async {
  300. await refreshPremiumAccess(trustedPlan: trustedPlan)
  301. guard let trustedPlan, !hasPremiumAccess else { return }
  302. do {
  303. try await syncAppStoreWithTimeout(seconds: 15)
  304. } catch {
  305. applyTrustedPlan(trustedPlan)
  306. return
  307. }
  308. await refreshPremiumAccess(trustedPlan: trustedPlan)
  309. if !hasPremiumAccess {
  310. applyTrustedPlan(trustedPlan)
  311. }
  312. }
  313. private func mergeTrustedPlan(_ resolvedPlan: PaywallPlan?, _ trustedPlan: PaywallPlan?) -> PaywallPlan? {
  314. switch (resolvedPlan, trustedPlan) {
  315. case (nil, nil):
  316. nil
  317. case (let resolved?, nil):
  318. resolved
  319. case (nil, let trusted?):
  320. trusted
  321. case (let resolved?, let trusted?):
  322. preferredPlan(resolved, trusted)
  323. }
  324. }
  325. private func applyTrustedPlan(_ plan: PaywallPlan) {
  326. activePremiumPlan = preferredPlan(activePremiumPlan, plan)
  327. hasPremiumAccess = true
  328. hasResolvedPremiumStatus = true
  329. markAsHavingPurchasedPremium()
  330. persistPremiumCache()
  331. }
  332. private func revokePremiumAccess() {
  333. activePremiumPlan = nil
  334. hasPremiumAccess = false
  335. hasResolvedPremiumStatus = true
  336. persistPremiumCache()
  337. }
  338. private func syncAppStoreWithTimeout(seconds: TimeInterval) async throws {
  339. try await withThrowingTaskGroup(of: Void.self) { group in
  340. group.addTask {
  341. try await AppStore.sync()
  342. }
  343. group.addTask {
  344. let timeoutNanoseconds = UInt64(seconds * 1_000_000_000)
  345. try await Task.sleep(nanoseconds: timeoutNanoseconds)
  346. throw StoreSyncError.timeout
  347. }
  348. try await group.next()
  349. group.cancelAll()
  350. }
  351. }
  352. private func applyPremiumAccess(from transaction: StoreKit.Transaction) {
  353. guard let plan = planGrantingPremium(from: transaction) else { return }
  354. activePremiumPlan = preferredPlan(activePremiumPlan, plan)
  355. hasPremiumAccess = true
  356. hasResolvedPremiumStatus = true
  357. markAsHavingPurchasedPremium()
  358. persistPremiumCache()
  359. }
  360. private func markAsHavingPurchasedPremium() {
  361. guard !hasEverPurchasedPremium else { return }
  362. hasEverPurchasedPremium = true
  363. UserDefaults.standard.set(true, forKey: Self.cachedHasEverPurchasedKey)
  364. }
  365. private func refreshPurchaseHistory() async {
  366. if hasEverPurchasedPremium { return }
  367. for await result in Transaction.all {
  368. guard case .verified(let transaction) = result else { continue }
  369. guard SubscriptionProductID.all.contains(transaction.productID) else { continue }
  370. markAsHavingPurchasedPremium()
  371. return
  372. }
  373. }
  374. private func persistPremiumCache() {
  375. UserDefaults.standard.set(hasPremiumAccess, forKey: Self.cachedPremiumKey)
  376. if let plan = activePremiumPlan?.rawValue {
  377. UserDefaults.standard.set(plan, forKey: Self.cachedPremiumPlanKey)
  378. } else {
  379. UserDefaults.standard.removeObject(forKey: Self.cachedPremiumPlanKey)
  380. }
  381. }
  382. private func planGrantingPremium(from transaction: StoreKit.Transaction) -> PaywallPlan? {
  383. guard transactionGrantsPremium(transaction) else { return nil }
  384. return SubscriptionProductID.plan(for: transaction.productID)
  385. }
  386. private func transactionGrantsPremium(_ transaction: StoreKit.Transaction) -> Bool {
  387. guard SubscriptionProductID.all.contains(transaction.productID) else { return false }
  388. guard transaction.revocationDate == nil else { return false }
  389. if let expirationDate = transaction.expirationDate, expirationDate < Date() {
  390. return false
  391. }
  392. return true
  393. }
  394. private func preferredPlan(_ current: PaywallPlan?, _ candidate: PaywallPlan) -> PaywallPlan {
  395. if current == .lifetime || candidate == .lifetime {
  396. return .lifetime
  397. }
  398. if current == .yearly || candidate == .yearly {
  399. return .yearly
  400. }
  401. if current == .monthly || candidate == .monthly {
  402. return .monthly
  403. }
  404. return candidate
  405. }
  406. private func activeLifetimePlan() async -> PaywallPlan? {
  407. guard let result = await Transaction.latest(for: SubscriptionProductID.lifetime) else {
  408. return nil
  409. }
  410. guard case .verified(let transaction) = result else { return nil }
  411. return planGrantingPremium(from: transaction)
  412. }
  413. private func activeSubscriptionPlan() async -> PaywallPlan? {
  414. var resolvedPlan: PaywallPlan?
  415. for await result in Transaction.currentEntitlements {
  416. guard case .verified(let transaction) = result else { continue }
  417. guard let plan = planGrantingPremium(from: transaction), plan != .lifetime else { continue }
  418. resolvedPlan = preferredPlan(resolvedPlan, plan)
  419. }
  420. return resolvedPlan
  421. }
  422. private func listenForTransactionUpdates() async {
  423. for await update in Transaction.updates {
  424. guard case .verified(let transaction) = update else { continue }
  425. if isRevokedAppTransaction(transaction) {
  426. revokePremiumAccess()
  427. await transaction.finish()
  428. await refreshPremiumAccess()
  429. continue
  430. }
  431. let trustedPlan = planGrantingPremium(from: transaction)
  432. if let trustedPlan {
  433. applyPremiumAccess(from: transaction)
  434. }
  435. await transaction.finish()
  436. if trustedPlan != nil {
  437. await reconcilePremiumAccess(trustedPlan: trustedPlan)
  438. } else {
  439. await refreshPremiumAccess()
  440. }
  441. }
  442. }
  443. private func isRevokedAppTransaction(_ transaction: StoreKit.Transaction) -> Bool {
  444. SubscriptionProductID.all.contains(transaction.productID) && transaction.revocationDate != nil
  445. }
  446. }