Merge pull request #506 from superwall/fix/subscription-status-anti-downgrade

Keep subscribers active through empty StoreKit reads and empty web polls

Author: yusuftor

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 The changelog for `SuperwallKit`. Also see the [releases](https://github.com/superwall/Superwall-iOS/releases) on GitHub.
 
+## 4.16.4
+
+### Fixes
+
+- Fixes subscribers with an unexpired subscription being reported as `inactive` on cold launch when the App Store has no purchases to report. Refunded and expired App Store subscriptions still deactivate immediately.
+- Fixes issue where paying web users could end up having a temporary inactive subscription status if the server temporarily returns no entitlement data for them.
+
 ## 4.16.3
 
 ### Fixes

CLAUDE.md

@@ -72,6 +72,10 @@ When bumping the version, update all three files:
 3. `CHANGELOG.md` (add new version entry at top)
 
 - Follows semantic versioning
+- **Never use an `## Unreleased` heading in `CHANGELOG.md`.** Unreleased changes always live under the next concrete version number (e.g. `## 4.16.4`).
+- To pick that number, compare the version on `develop` with the version on `master`:
+  - If develop's version is **above** master's, a release is already staged — add your entries to that existing top section. Do not bump again.
+  - If develop's version **equals** master's, start the next release: add a new version section and bump all three files together (patch/minor/major per the change).
 
 ### Testing
 

Sources/SuperwallKit/Misc/Constants.swift

@@ -18,5 +18,5 @@ let sdkVersion = """
 */
 
 let sdkVersion = """
-4.16.3
+4.16.4
 """

Sources/SuperwallKit/StoreKit/Products/Receipt Manager/Receipt Manager/SK1ReceiptManager.swift

@@ -72,6 +72,7 @@ final class SK1ReceiptManager: ReceiptManagerType {
 
     // Build map of active product IDs for quick lookup
     let activeProductIds = Set(purchases.filter { $0.isActive }.map { $0.id })
+    let purchasedProductIds = Set(purchases.map { $0.id })
 
     // Process all entitlements from config, enhancing them with active status
     // For SK1, we collect all product IDs per entitlement, then mark as active if ANY product is active
@@ -92,12 +93,22 @@ final class SK1ReceiptManager: ReceiptManagerType {
       // Entitlement is active if ANY of its products is active
       let isActive = productIds.contains { activeProductIds.contains($0) }
 
+      // A receipt transaction for any of the entitlement's products makes
+      // it an App Store entitlement, matching the StoreKit 2 path. Without
+      // one the store stays nil, per the `Entitlement.store` contract. The
+      // anti-downgrade guard relies on active device-derived entitlements
+      // carrying `.appStore`: a device read may only refute those, and a
+      // nil store marks a grant from outside the App Store (web, manual).
+      let store: EntitlementStore? =
+        productIds.contains { purchasedProductIds.contains($0) } ? .appStore : nil
+
       entitlements.append(
         Entitlement(
           id: entitlementId,
           type: entitlementTypes[entitlementId] ?? .serviceLevel,
           isActive: isActive,
-          productIds: productIds
+          productIds: productIds,
+          store: store
         )
       )
     }

Sources/SuperwallKit/StoreKit/Purchase Controller/AutomaticPurchaseController.swift

@@ -20,7 +20,10 @@ final class AutomaticPurchaseController {
     self.entitlementsInfo = entitlementsInfo
   }
 
-  func syncSubscriptionStatus(withPurchases purchases: Set<Purchase>) async {
+  func syncSubscriptionStatus(
+    withPurchases purchases: Set<Purchase>,
+    superwall: Superwall? = nil
+  ) async {
     let activePurchases = purchases.filter { $0.isActive }
     var entitlements: Set<Entitlement> = []
 
@@ -29,11 +32,62 @@ final class AutomaticPurchaseController {
       entitlements = entitlements.union(purchaseEntitlements)
     }
 
+    let activeProductIds = Set(activePurchases.map { $0.id })
+
     await MainActor.run { [entitlements] in
+      let superwall = superwall ?? Superwall.shared
       if entitlements.isEmpty {
-        Superwall.shared.internallySetSubscriptionStatus(to: .inactive)
+        // A device read with no entitlements can mean different things,
+        // and only one of them may demote a subscriber:
+        //
+        // - Purchases exist but none is active: an authoritative answer.
+        //   Refunded and expired transactions stay in the set as inactive
+        //   (SK2 reads `Transaction.all`; the SK1 receipt keeps cancelled
+        //   purchases), so this downgrades immediately.
+        // - The purchases set is completely empty: a non-answer. StoreKit
+        //   returns nothing at cold launch before it hydrates, the SK1
+        //   receipt can be missing, and web/Stripe subscribers have no App
+        //   Store purchases at all.
+        // - A purchase is still active but maps to no entitlement: a
+        //   mapping failure (the config no longer knows the product), not
+        //   an authoritative answer for the entitlement it unlocks.
+        //
+        // On a non-answer, keep an `.active` status while one of its
+        // entitlements is within its expiry date. A device read also has no
+        // authority over entitlements not granted by the App Store, so those
+        // hold the status even when unrelated inactive purchases exist. A
+        // nil store means no App Store transaction unlocks the entitlement
+        // (web or manual grant — both receipt managers stamp `.appStore` on
+        // entitlements a receipt transaction unlocks, so active
+        // device-derived entitlements always carry it), so nil is protected
+        // too. Entitlements with no expiry date never hold the status, so a
+        // revoked lifetime purchase can still deactivate here.
+        if case .active(let currentEntitlements) = superwall.subscriptionStatus {
+          let holdsStatus = currentEntitlements.contains { entitlement in
+            guard entitlement.isActive,
+              (entitlement.expiresAt ?? .distantPast) > Date() else {
+              return false
+            }
+            if purchases.isEmpty || entitlement.store != .appStore {
+              return true
+            }
+            // A still-active purchase that unlocks this entitlement means
+            // the empty entitlement set is a mapping failure. With the
+            // mapping missing, SK2's subscription-level correction of
+            // `Purchase.isActive` is disabled too, so this is the raw
+            // transaction-level value and can miss a revocation that sets
+            // no `revocationDate`. The hold is still bounded by the expiry
+            // gate above, which beats locking out a paying subscriber over
+            // a lost product mapping.
+            return entitlement.productIds.contains { activeProductIds.contains($0) }
+          }
+          if holdsStatus {
+            return
+          }
+        }
+        superwall.internallySetSubscriptionStatus(to: .inactive, superwall: superwall)
       } else {
-        Superwall.shared.internallySetSubscriptionStatus(to: .active(entitlements))
+        superwall.internallySetSubscriptionStatus(to: .active(entitlements), superwall: superwall)
       }
     }
   }

Sources/SuperwallKit/Web/WebEntitlementRedeemer.swift

@@ -920,6 +920,31 @@ actor WebEntitlementRedeemer {
         deviceId: factory.makeDeviceId()
       )
 
+      // A response with zero entitlements must not replace cached web
+      // entitlements that are still within their expiry date. The server
+      // reports a revocation by returning the entitlement as inactive —
+      // and it enumerates every config-mapped entitlement even for users
+      // with no purchases — so a fully empty array is a backend or config
+      // artifact (alias mismatch, failed upstream lookup), not a
+      // revocation. Real revocations arrive non-empty and apply
+      // immediately through the save below. If an empty response replaced
+      // the cache, the next cold launch would read the user as inactive
+      // until a network poll recovered them. Entitlements with no expiry
+      // date are not protected by this guard. We skip saving the fetch
+      // date so the next poll retries without waiting out
+      // `entitlementsMaxAge`.
+      let hasUnexpiredWebEntitlements = existingWebEntitlements.contains {
+        $0.isActive && ($0.expiresAt ?? .distantPast) > Date()
+      }
+      if response.customerInfo.entitlements.isEmpty && hasUnexpiredWebEntitlements {
+        Logger.debug(
+          logLevel: .warn,
+          scope: .webEntitlements,
+          message: "Ignoring empty web entitlements response because unexpired web entitlements are cached."
+        )
+        return
+      }
+
       // Update the latest redeem response with the entitlements and customer info from the response.
       if var latestRedeemResponse = storage.get(LatestRedeemResponse.self) {
         latestRedeemResponse.customerInfo = response.customerInfo

SuperwallKit.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
 	s.name         = "SuperwallKit"
-  s.version      = "4.16.3"
+  s.version      = "4.16.4"
 	s.summary      = "Superwall: In-App Paywalls Made Easy"
 	s.description  = "Paywall infrastructure for mobile apps :) we make things like editing your paywall and running price tests as easy as clicking a few buttons. superwall.com"
 

SuperwallKit.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 54;
+	objectVersion = 77;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -474,6 +474,7 @@
 		D506526569FAA54E3220A02A /* PurchaseSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = F67A5C0CA15AF645709A2545 /* PurchaseSource.swift */; };
 		D56F32CB484F74EC7E49E581 /* PaywallViewControllerCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8BAEECE2DBFEB8817E6C36DA /* PaywallViewControllerCache.swift */; };
 		D5A1334579BE0B0A207B0BF7 /* TestModeModalViewController+TableView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C0D4F9888B5827992153F5F /* TestModeModalViewController+TableView.swift */; };
+		D5C9A71CFB166225C082CAFB /* AutomaticPurchaseControllerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F2F3523491EC638DBBBD2133 /* AutomaticPurchaseControllerTests.swift */; };
 		D66461863D54A56BE9C29310 /* Publisher+Async.swift in Sources */ = {isa = PBXBuildFile; fileRef = AF5A8FFFC23826AD113D525A /* Publisher+Async.swift */; };
 		D6CA719D79BAA6369D1C01C3 /* AudienceLogic.swift in Sources */ = {isa = PBXBuildFile; fileRef = 71CF4BE5D2A6CEA9F8993C81 /* AudienceLogic.swift */; };
 		D77DB3187C62B91E3D55DF80 /* ArchiveRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = F4300EBF7463A42D2FB89371 /* ArchiveRequest.swift */; };
@@ -1167,6 +1168,7 @@
 		F13CC9902419E7D68B47C184 /* PopupTransitionDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PopupTransitionDelegate.swift; sourceTree = "<group>"; };
 		F16AFE9C93A441CFB6A95F10 /* String+CamelCase.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+CamelCase.swift"; sourceTree = "<group>"; };
 		F2A2A54314BAEAF65B46D322 /* NetworkTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkTests.swift; sourceTree = "<group>"; };
+		F2F3523491EC638DBBBD2133 /* AutomaticPurchaseControllerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AutomaticPurchaseControllerTests.swift; sourceTree = "<group>"; };
 		F338AF233A9EF2A20B1AC5A5 /* MockPurchaseController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockPurchaseController.swift; sourceTree = "<group>"; };
 		F34468E3988E779132CE101A /* BundleHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BundleHelper.swift; sourceTree = "<group>"; };
 		F36CB341B28F250F5252A8DF /* Transaction+LatestSince.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Transaction+LatestSince.swift"; sourceTree = "<group>"; };
@@ -1298,6 +1300,7 @@
 				054FCADFEF560A1A736DEFE4 /* StoreKitManagerTests.swift */,
 				C0D3F44546D33F8AA71A79B9 /* Mocks */,
 				2C05828E18C52F510F7CDFA2 /* Products */,
+				42F8F9824C94A7946BD46450 /* Purchase Controller */,
 				357496424A62506BB5B92AB9 /* Transactions */,
 			);
 			path = StoreKit;
@@ -1799,6 +1802,14 @@
 			path = Certificates;
 			sourceTree = "<group>";
 		};
+		42F8F9824C94A7946BD46450 /* Purchase Controller */ = {
+			isa = PBXGroup;
+			children = (
+				F2F3523491EC638DBBBD2133 /* AutomaticPurchaseControllerTests.swift */,
+			);
+			path = "Purchase Controller";
+			sourceTree = "<group>";
+		};
 		43AE802CA13E36803E2FF13E /* Popup Transition */ = {
 			isa = PBXGroup;
 			children = (
@@ -3148,6 +3159,8 @@
 				8F41784FB73AC60BED81E582 /* PBXTargetDependency */,
 			);
 			name = SuperwallKitTests;
+			packageProductDependencies = (
+			);
 			productName = SuperwallKitTests;
 			productReference = 92001AC11F099F7B03AF338A /* SuperwallKitTests.xctest */;
 			productType = "com.apple.product-type.bundle.unit-test";
@@ -3160,8 +3173,6 @@
 			attributes = {
 				BuildIndependentTargetsInParallel = YES;
 				LastUpgradeCheck = 1430;
-				TargetAttributes = {
-				};
 			};
 			buildConfigurationList = B7BB212B66F694F1FDA2FA4F /* Build configuration list for PBXProject "SuperwallKit" */;
 			compatibilityVersion = "Xcode 14.0";
@@ -3212,9 +3223,11 @@
 				zh_Hant,
 			);
 			mainGroup = 5CE8CEF97A892FFF3D0D8F06;
+			minimizedProjectReferenceProxies = 1;
 			packageReferences = (
 				89F17188BC665EFC6FE5CEFA /* XCRemoteSwiftPackageReference "superscript-ios-next" */,
 			);
+			preferredProjectObjectVersion = 77;
 			projectDirPath = "";
 			projectRoot = "";
 			targets = (
@@ -3252,6 +3265,7 @@
 				59685CE55D34FA6A96A8F890 /* AssignmentLogicTests.swift in Sources */,
 				BC8A62869C7BACE6D0867195 /* AssignmentTests.swift in Sources */,
 				3CD2C23BAC2EA11174237785 /* AttributionTests.swift in Sources */,
+				D5C9A71CFB166225C082CAFB /* AutomaticPurchaseControllerTests.swift in Sources */,
 				B0DC8290B081B74CC65E9305 /* CELEvaluatorTests.swift in Sources */,
 				E984458E465D5A834CC52302 /* CacheMock.swift in Sources */,
 				CBFC0D2DCA996A5FF7E5174B /* CacheTests.swift in Sources */,