SubscriptionManager.swift 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649
  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. var message: String {
  16. switch self {
  17. case .productsLoadTimeout:
  18. "Couldn't load subscription products right now. Check your StoreKit configuration / internet and try again."
  19. case .subscriptionUnavailable:
  20. "This subscription is currently unavailable. Please try again in a moment."
  21. case .planUnavailable:
  22. "This plan isn't available right now. Please try again later."
  23. case .purchaseNotVerified:
  24. "Apple couldn't verify this purchase."
  25. case .purchasePending:
  26. "This purchase is waiting for approval (for example, Ask to Buy)."
  27. case .noActiveSubscriptions:
  28. "No active subscriptions were found for this Apple ID."
  29. case .noActivePurchases:
  30. "No premium purchases were found for this Apple ID."
  31. case .restoreSyncTimeout:
  32. "Couldn't reach the App Store in time. Check your connection and tap Restore Purchases again."
  33. case .generic:
  34. "Something went wrong with your subscription. Please try again."
  35. }
  36. }
  37. }
  38. @MainActor
  39. final class SubscriptionManager: ObservableObject {
  40. private enum ProductLoadError: Error {
  41. case timeout
  42. }
  43. private enum StoreSyncError: Error {
  44. case timeout
  45. }
  46. @Published private(set) var productsByID: [String: Product] = [:]
  47. @Published private(set) var isLoadingProducts = false
  48. @Published private(set) var purchasingPlan: PaywallPlan?
  49. @Published private(set) var isRestoringPurchases = false
  50. @Published private(set) var hasPremiumAccess = false
  51. @Published private(set) var hasResolvedPremiumStatus = false
  52. @Published private(set) var activePremiumPlan: PaywallPlan?
  53. @Published var purchaseError: PurchaseError?
  54. var hasLifetimeAccess: Bool {
  55. activePremiumPlan == .lifetime
  56. }
  57. var hasAllProductsLoaded: Bool {
  58. SubscriptionProductID.all.allSatisfy { productsByID[$0] != nil }
  59. }
  60. private var inFlightProductLoad: Task<Void, Never>?
  61. init() {
  62. Task { await listenForTransactionUpdates() }
  63. Task { await refreshPremiumAccess() }
  64. Task { await loadProducts(presentLoadingUI: false) }
  65. }
  66. func loadProducts(presentLoadingUI: Bool? = nil) async {
  67. if let existing = inFlightProductLoad {
  68. await existing.value
  69. return
  70. }
  71. let uiFlag = presentLoadingUI
  72. let task = Task { @MainActor in
  73. await performLoadProducts(presentLoadingUI: uiFlag)
  74. }
  75. inFlightProductLoad = task
  76. await task.value
  77. inFlightProductLoad = nil
  78. }
  79. func product(for plan: PaywallPlan) -> Product? {
  80. productsByID[plan.productID]
  81. }
  82. func mainPrice(for plan: PaywallPlan) -> String {
  83. product(for: plan)?.displayPrice ?? plan.fallbackMainPrice
  84. }
  85. func priceSuffix(for plan: PaywallPlan) -> String? {
  86. switch plan {
  87. case .monthly: "/mo"
  88. case .yearly: "/yr"
  89. case .lifetime: nil
  90. }
  91. }
  92. func billingDescription(for plan: PaywallPlan) -> String {
  93. guard let product = product(for: plan) else {
  94. return plan.fallbackBillingDescription
  95. }
  96. if let subscription = product.subscription,
  97. let intro = subscription.introductoryOffer,
  98. intro.paymentMode == .freeTrial {
  99. let trialPeriod = formattedPeriod(intro.period)
  100. let billingPeriod = formattedSubscriptionPeriod(subscription.subscriptionPeriod)
  101. return "\(trialPeriod) Free Trial, then \(product.displayPrice) per \(billingPeriod)"
  102. }
  103. switch plan {
  104. case .monthly:
  105. return "Billed at \(product.displayPrice) every month"
  106. case .yearly:
  107. return "Billed at \(product.displayPrice) every year"
  108. case .lifetime:
  109. return "One-time payment of \(product.displayPrice)"
  110. }
  111. }
  112. func purchase(_ plan: PaywallPlan) async -> Bool {
  113. purchaseError = nil
  114. var product = productsByID[plan.productID]
  115. if product == nil {
  116. await loadProducts(presentLoadingUI: false)
  117. product = productsByID[plan.productID]
  118. }
  119. guard let product else {
  120. let missingProductIDs = SubscriptionProductID.all.filter { productsByID[$0] == nil }
  121. if missingProductIDs.isEmpty {
  122. purchaseError = .subscriptionUnavailable
  123. } else {
  124. purchaseError = .planUnavailable
  125. #if DEBUG
  126. print(
  127. """
  128. [SubscriptionManager] Missing StoreKit products: \(missingProductIDs.joined(separator: ", "))
  129. To test locally, attach `Paywall.storekit` in Xcode:
  130. Product > Scheme > Edit Scheme > Run > Options > StoreKit Configuration.
  131. """
  132. )
  133. #endif
  134. }
  135. return false
  136. }
  137. purchasingPlan = plan
  138. defer { purchasingPlan = nil }
  139. do {
  140. let result = try await product.purchase()
  141. switch result {
  142. case .success(let verification):
  143. guard case .verified(let transaction) = verification else {
  144. purchaseError = .purchaseNotVerified
  145. return false
  146. }
  147. let trustedPlan = planGrantingPremium(from: transaction)
  148. if let trustedPlan {
  149. applyPremiumAccess(from: transaction)
  150. }
  151. await transaction.finish()
  152. await reconcilePremiumAccess(trustedPlan: trustedPlan)
  153. return hasPremiumAccess
  154. case .userCancelled:
  155. return false
  156. case .pending:
  157. purchaseError = .purchasePending
  158. return false
  159. @unknown default:
  160. return false
  161. }
  162. } catch {
  163. purchaseError = .generic
  164. return false
  165. }
  166. }
  167. func openSubscriptionManagement() {
  168. guard let url = URL(string: "https://apps.apple.com/account/subscriptions") else { return }
  169. NSWorkspace.shared.open(url)
  170. }
  171. func restorePurchases() async {
  172. purchaseError = nil
  173. isRestoringPurchases = true
  174. defer { isRestoringPurchases = false }
  175. do {
  176. try await syncAppStoreWithTimeout(seconds: 30)
  177. } catch is StoreSyncError {
  178. purchaseError = .restoreSyncTimeout
  179. return
  180. } catch {
  181. purchaseError = .generic
  182. return
  183. }
  184. await reconcilePremiumAccess(trustedPlan: nil)
  185. if !hasPremiumAccess {
  186. purchaseError = .noActivePurchases
  187. }
  188. }
  189. private func performLoadProducts(presentLoadingUI: Bool?) async {
  190. let missingAny = SubscriptionProductID.all.contains { productsByID[$0] == nil }
  191. let shouldShowLoading = presentLoadingUI ?? missingAny
  192. if !missingAny, presentLoadingUI != true {
  193. purchaseError = nil
  194. await refreshPremiumAccess()
  195. return
  196. }
  197. if shouldShowLoading {
  198. isLoadingProducts = true
  199. }
  200. defer {
  201. if shouldShowLoading {
  202. isLoadingProducts = false
  203. }
  204. }
  205. purchaseError = nil
  206. do {
  207. let loaded = try await loadProductsWithTimeout(seconds: 12)
  208. var map: [String: Product] = [:]
  209. for product in loaded {
  210. map[product.id] = product
  211. }
  212. productsByID = map
  213. await refreshPremiumAccess()
  214. } catch is ProductLoadError {
  215. purchaseError = .productsLoadTimeout
  216. } catch {
  217. purchaseError = .generic
  218. }
  219. }
  220. private func loadProductsWithTimeout(seconds: TimeInterval) async throws -> [Product] {
  221. try await withThrowingTaskGroup(of: [Product].self) { group in
  222. group.addTask {
  223. try await Product.products(for: SubscriptionProductID.all)
  224. }
  225. group.addTask {
  226. let timeoutNanoseconds = UInt64(seconds * 1_000_000_000)
  227. try await Task.sleep(nanoseconds: timeoutNanoseconds)
  228. throw ProductLoadError.timeout
  229. }
  230. guard let first = try await group.next() else {
  231. throw ProductLoadError.timeout
  232. }
  233. group.cancelAll()
  234. return first
  235. }
  236. }
  237. private func refreshPremiumAccess(trustedPlan: PaywallPlan? = nil) async {
  238. var resolvedPlan: PaywallPlan?
  239. if let lifetimePlan = await activeLifetimePlan() {
  240. resolvedPlan = lifetimePlan
  241. }
  242. if resolvedPlan == nil {
  243. for await result in Transaction.currentEntitlements {
  244. guard case .verified(let transaction) = result else { continue }
  245. guard let plan = planGrantingPremium(from: transaction) else { continue }
  246. resolvedPlan = preferredPlan(resolvedPlan, plan)
  247. }
  248. }
  249. if resolvedPlan == nil || resolvedPlan != .lifetime {
  250. if let subscriptionPlan = await activeSubscriptionPlan() {
  251. resolvedPlan = preferredPlan(resolvedPlan, subscriptionPlan)
  252. }
  253. }
  254. let finalPlan = mergeTrustedPlan(resolvedPlan, trustedPlan)
  255. activePremiumPlan = finalPlan
  256. hasPremiumAccess = finalPlan != nil
  257. hasResolvedPremiumStatus = true
  258. }
  259. /// Re-reads entitlements from StoreKit, then syncs with the App Store when needed.
  260. /// A verified purchase is never downgraded while the network is still catching up.
  261. private func reconcilePremiumAccess(trustedPlan: PaywallPlan?) async {
  262. await refreshPremiumAccess(trustedPlan: trustedPlan)
  263. guard let trustedPlan, !hasPremiumAccess else { return }
  264. for attempt in 1...3 {
  265. do {
  266. try await syncAppStoreWithTimeout(seconds: 15)
  267. } catch {
  268. continue
  269. }
  270. await refreshPremiumAccess(trustedPlan: trustedPlan)
  271. if hasPremiumAccess { return }
  272. let delayNanoseconds = UInt64(attempt) * 1_500_000_000
  273. try? await Task.sleep(nanoseconds: delayNanoseconds)
  274. }
  275. applyTrustedPlan(trustedPlan)
  276. }
  277. private func mergeTrustedPlan(_ resolvedPlan: PaywallPlan?, _ trustedPlan: PaywallPlan?) -> PaywallPlan? {
  278. switch (resolvedPlan, trustedPlan) {
  279. case (nil, nil):
  280. nil
  281. case (let resolved?, nil):
  282. resolved
  283. case (nil, let trusted?):
  284. trusted
  285. case (let resolved?, let trusted?):
  286. preferredPlan(resolved, trusted)
  287. }
  288. }
  289. private func applyTrustedPlan(_ plan: PaywallPlan) {
  290. activePremiumPlan = preferredPlan(activePremiumPlan, plan)
  291. hasPremiumAccess = true
  292. hasResolvedPremiumStatus = true
  293. }
  294. private func syncAppStoreWithTimeout(seconds: TimeInterval) async throws {
  295. try await withThrowingTaskGroup(of: Void.self) { group in
  296. group.addTask {
  297. try await AppStore.sync()
  298. }
  299. group.addTask {
  300. let timeoutNanoseconds = UInt64(seconds * 1_000_000_000)
  301. try await Task.sleep(nanoseconds: timeoutNanoseconds)
  302. throw StoreSyncError.timeout
  303. }
  304. try await group.next()
  305. group.cancelAll()
  306. }
  307. }
  308. private func applyPremiumAccess(from transaction: StoreKit.Transaction) {
  309. guard let plan = planGrantingPremium(from: transaction) else { return }
  310. activePremiumPlan = preferredPlan(activePremiumPlan, plan)
  311. hasPremiumAccess = true
  312. hasResolvedPremiumStatus = true
  313. }
  314. private func planGrantingPremium(from transaction: StoreKit.Transaction) -> PaywallPlan? {
  315. guard transactionGrantsPremium(transaction) else { return nil }
  316. return SubscriptionProductID.plan(for: transaction.productID)
  317. }
  318. private func transactionGrantsPremium(_ transaction: StoreKit.Transaction) -> Bool {
  319. guard SubscriptionProductID.all.contains(transaction.productID) else { return false }
  320. guard transaction.revocationDate == nil else { return false }
  321. if let expirationDate = transaction.expirationDate, expirationDate < Date() {
  322. return false
  323. }
  324. return true
  325. }
  326. private func preferredPlan(_ current: PaywallPlan?, _ candidate: PaywallPlan) -> PaywallPlan {
  327. if current == .lifetime || candidate == .lifetime {
  328. return .lifetime
  329. }
  330. if let current {
  331. if current == .yearly || candidate == .yearly {
  332. return .yearly
  333. }
  334. return .monthly
  335. }
  336. return candidate
  337. }
  338. private func activeLifetimePlan() async -> PaywallPlan? {
  339. guard let result = await Transaction.latest(for: SubscriptionProductID.lifetime) else {
  340. return nil
  341. }
  342. guard case .verified(let transaction) = result else { return nil }
  343. return planGrantingPremium(from: transaction)
  344. }
  345. private func activeSubscriptionPlan() async -> PaywallPlan? {
  346. var resolvedPlan: PaywallPlan?
  347. for await result in Transaction.currentEntitlements {
  348. guard case .verified(let transaction) = result else { continue }
  349. guard let plan = planGrantingPremium(from: transaction), plan != .lifetime else { continue }
  350. resolvedPlan = preferredPlan(resolvedPlan, plan)
  351. }
  352. if resolvedPlan == nil, await hasActiveSubscriptionStatus() {
  353. resolvedPlan = await subscriptionPlanFromProductStatus()
  354. }
  355. return resolvedPlan
  356. }
  357. private func subscriptionPlanFromProductStatus() async -> PaywallPlan? {
  358. if productsByID.isEmpty {
  359. do {
  360. let loaded = try await Product.products(for: SubscriptionProductID.all)
  361. var map: [String: Product] = [:]
  362. for product in loaded { map[product.id] = product }
  363. productsByID = map
  364. } catch {
  365. return nil
  366. }
  367. }
  368. for product in productsByID.values {
  369. guard let subscription = product.subscription else { continue }
  370. guard let plan = SubscriptionProductID.plan(for: product.id), plan != .lifetime else { continue }
  371. do {
  372. let statuses = try await subscription.status
  373. let isActive = statuses.contains { status in
  374. switch status.state {
  375. case .subscribed, .inGracePeriod, .inBillingRetryPeriod:
  376. return true
  377. case .expired, .revoked:
  378. return false
  379. default:
  380. return false
  381. }
  382. }
  383. if isActive { return plan }
  384. } catch {
  385. continue
  386. }
  387. }
  388. return nil
  389. }
  390. private func hasActiveSubscriptionStatus() async -> Bool {
  391. await subscriptionPlanFromProductStatus() != nil
  392. }
  393. private func listenForTransactionUpdates() async {
  394. for await update in Transaction.updates {
  395. guard case .verified(let transaction) = update else { continue }
  396. let trustedPlan = planGrantingPremium(from: transaction)
  397. if let trustedPlan {
  398. applyPremiumAccess(from: transaction)
  399. }
  400. await transaction.finish()
  401. await reconcilePremiumAccess(trustedPlan: trustedPlan)
  402. }
  403. }
  404. private func formattedPeriod(_ period: Product.SubscriptionPeriod) -> String {
  405. switch period.unit {
  406. case .day where period.value == 1: "1 Day"
  407. case .day: "\(period.value) Days"
  408. case .week where period.value == 1: "1 Week"
  409. case .week: "\(period.value) Weeks"
  410. case .month where period.value == 1: "1 Month"
  411. case .month: "\(period.value) Months"
  412. case .year where period.value == 1: "1 Year"
  413. case .year: "\(period.value) Years"
  414. @unknown default: "\(period.value) Days"
  415. }
  416. }
  417. private func formattedSubscriptionPeriod(_ period: Product.SubscriptionPeriod) -> String {
  418. switch period.unit {
  419. case .day: period.value == 1 ? "day" : "\(period.value) days"
  420. case .week: period.value == 1 ? "week" : "\(period.value) weeks"
  421. case .month: period.value == 1 ? "month" : "\(period.value) months"
  422. case .year: period.value == 1 ? "year" : "\(period.value) years"
  423. @unknown default: "billing period"
  424. }
  425. }
  426. }
  427. // MARK: - App Rating
  428. enum RatingPromptSource {
  429. case postPurchase
  430. case usageMilestone
  431. }
  432. @MainActor
  433. final class AppRatingManager: ObservableObject {
  434. static let hasRatedKey = "hasRatedApp"
  435. static let hasShownUsagePromptKey = "hasShownUsageRatingPrompt"
  436. private static let continuousUsageThreshold: TimeInterval = 30 * 60
  437. @Published private(set) var showRatingPrompt = false
  438. @Published private(set) var ratingPromptSource: RatingPromptSource?
  439. private let defaults: UserDefaults
  440. private var isPremium = false
  441. private var continuousSessionStart: Date?
  442. private var usageTimerTask: Task<Void, Never>?
  443. private var cancellables = Set<AnyCancellable>()
  444. private var hasRatedApp: Bool {
  445. defaults.bool(forKey: Self.hasRatedKey)
  446. }
  447. private var hasShownUsagePrompt: Bool {
  448. defaults.bool(forKey: Self.hasShownUsagePromptKey)
  449. }
  450. init(defaults: UserDefaults = .standard) {
  451. self.defaults = defaults
  452. observeAppLifecycle()
  453. }
  454. func updatePremiumStatus(_ isPremium: Bool) {
  455. self.isPremium = isPremium
  456. guard isPremium, !hasRatedApp, !hasShownUsagePrompt else {
  457. pauseUsageTracking()
  458. return
  459. }
  460. if NSApplication.shared.isActive {
  461. beginContinuousUsageSession()
  462. }
  463. }
  464. func handleSubscriptionPurchased() {
  465. guard !hasRatedApp else { return }
  466. pauseUsageTracking()
  467. ratingPromptSource = .postPurchase
  468. showRatingPrompt = true
  469. }
  470. func userAcceptedRating() {
  471. showRatingPrompt = false
  472. ratingPromptSource = nil
  473. defaults.set(true, forKey: Self.hasRatedKey)
  474. pauseUsageTracking()
  475. requestAppStoreReview()
  476. }
  477. func userDeclinedRating() {
  478. let source = ratingPromptSource
  479. showRatingPrompt = false
  480. ratingPromptSource = nil
  481. if source == .usageMilestone {
  482. defaults.set(true, forKey: Self.hasShownUsagePromptKey)
  483. pauseUsageTracking()
  484. return
  485. }
  486. guard isPremium, !hasRatedApp, !hasShownUsagePrompt else { return }
  487. if NSApplication.shared.isActive {
  488. beginContinuousUsageSession()
  489. }
  490. }
  491. private func observeAppLifecycle() {
  492. NotificationCenter.default.publisher(for: NSApplication.didBecomeActiveNotification)
  493. .sink { [weak self] _ in
  494. self?.appDidBecomeActive()
  495. }
  496. .store(in: &cancellables)
  497. NotificationCenter.default.publisher(for: NSApplication.willResignActiveNotification)
  498. .sink { [weak self] _ in
  499. self?.appDidResignActive()
  500. }
  501. .store(in: &cancellables)
  502. }
  503. private func appDidBecomeActive() {
  504. guard isPremium, !hasRatedApp, !hasShownUsagePrompt, !showRatingPrompt else { return }
  505. beginContinuousUsageSession()
  506. }
  507. private func appDidResignActive() {
  508. pauseUsageTracking()
  509. }
  510. private func beginContinuousUsageSession() {
  511. guard isPremium, !hasRatedApp, !hasShownUsagePrompt, !showRatingPrompt else { return }
  512. continuousSessionStart = Date()
  513. startUsageTimer()
  514. }
  515. private func pauseUsageTracking() {
  516. continuousSessionStart = nil
  517. usageTimerTask?.cancel()
  518. usageTimerTask = nil
  519. }
  520. private func startUsageTimer() {
  521. usageTimerTask?.cancel()
  522. usageTimerTask = Task { [weak self] in
  523. while !Task.isCancelled {
  524. try? await Task.sleep(nanoseconds: 1_000_000_000)
  525. guard !Task.isCancelled else { break }
  526. self?.checkContinuousUsageThreshold()
  527. }
  528. }
  529. }
  530. private func checkContinuousUsageThreshold() {
  531. guard
  532. let sessionStart = continuousSessionStart,
  533. isPremium,
  534. !hasRatedApp,
  535. !hasShownUsagePrompt,
  536. !showRatingPrompt
  537. else {
  538. return
  539. }
  540. let elapsed = Date().timeIntervalSince(sessionStart)
  541. guard elapsed >= Self.continuousUsageThreshold else { return }
  542. pauseUsageTracking()
  543. defaults.set(true, forKey: Self.hasShownUsagePromptKey)
  544. ratingPromptSource = .usageMilestone
  545. showRatingPrompt = true
  546. }
  547. private func requestAppStoreReview() {
  548. SKStoreReviewController.requestReview()
  549. }
  550. }