Change result of purchase methods to PurchaseResult #1408

tonidero · 2025-07-17T15:57:19Z

This changes the result type of the purchase methods. Instead of returning just a CustomerInfo, now we will return a PurchaseResult, which includes a CustomerInfo and a StoreTransaction

tonidero · 2025-07-17T15:58:07Z

lib/models/purchase_result.dart

+  /// RevenueCat's servers.
+  final CustomerInfo customerInfo;
+  /// The [StoreTransaction] for this purchase.
+  final StoreTransaction storeTransaction;


I see that in the web platforms (RN and capacitor) we also have the productIdentifier here... but seemed redundant since it's already part of the PurchaseResult.

I'm guessing you mean that it's part of the StoreTransaction, right? So yeah, totally not needed to add the redundancy 👍

tonidero · 2025-07-17T15:58:30Z

lib/web/purchases_flutter_web.dart

@@ -12,7 +12,7 @@ import '../purchases_flutter.dart';
 class PurchasesFlutterPlugin {
  static final _unknownErrorCode = '${PurchasesErrorCode.unknownError.index}';
  static final _configurationErrorCode = '${PurchasesErrorCode.configurationError.index}';
-  static const _purchasesHybridMappingsVersion = '13.29.0';
+  static const _purchasesHybridMappingsVersion = '15.0.0';


This was super outdated 😬

tonidero · 2025-07-17T15:59:59Z

lib/web/purchases_flutter_web.dart

+    final appUserId = arguments['appUserId'] as String?;
+
+    if(appUserId != null && appUserId.isNotEmpty) {
+      options['appUserId'] = appUserId;


Had to change this to be added like this since some changes in the underlying JS libraries made it break without this because we were passing null as the appUserId. A proper fix might be better in purchases-js-hybrid-mappings... but I thought to fix it here for now to avoid another release.

ajpallares · 2025-07-18T07:45:49Z

api_tester/lib/api_tests/models/purchase_result_api_test.dart

+  void _checkConstructor(
+      CustomerInfo customerInfo,
+      StoreTransaction storeTransaction) {
+    PurchaseResult purchaseResult =
+    PurchaseResult(customerInfo, storeTransaction);
+  }


I don't quite understand why we need to test the constructor's API.
Is the constructor public? If so, if we ever need to add an extra property to PurchaseResult, it would be a breaking change since the constructor would also change. Or am I missing something? (note that I know null about Dart 😅)

That's a good question! So the constructors for all our classes are currently public in dart (they were public before removing freezed as well). If we need to add new fields in the future, we would need to add multiple constructors, falling back to some default when no value is passed. This can indeed be problematic if no good default can be set though...

We could try to make the constructors package private... we haven't really been doing that until now, but I guess that now that we have removed freezed, we have more control. I might just want to leave it like this for now so we dedicate more time to study our options moving forward. Wdyt @RevenueCat/coresdk?

Thanks for the explanation! Exactly, it might be problematic if we need to add new fields in the future.

We could try to make the constructors package private...

Yes, I think this should be our end goal. But I agree that, for now, we can leave it like this and think about this in the future 👍

Agreed, I like non-public constructors, but doing that now would be a breaking change right?

Yup... though having said that, it would be "ok" since we're releasing this on a major anyway. My main concern is over delaying the release for this, since I'm not sure of the best way to do this.

Hah I'm not sure either. It's not just adding visibility modifiers? 😅

I think for package private you need to define each file as part of a library, and prepend any method with an _: https://medium.com/@simplemanderson/dart-libraries-and-visibility-and-how-they-caught-me-by-surprise-d98ba7868fde.

I just need to test that it works 😅 (I'm focusing on returning the StoreTransaction in purchases-unity after a purchase but I can test this in a bit)

I was just testing this for a bit and it's not straightforward... We would need to define a library and make all models a part of that library... I wouldn't make that change right now without more testing, so I would prefer to keep it as is for this major. Wdyt @JayShortway @ajpallares ?

Thanks for explaining and testing! 🙏 In that case I'd be okay keeping it as is.

Thank you for the investigation Toni! Sure, let's go with what we have right now, as it involves way deeper changes 👍

ajpallares

Looks good so far but I have one question about some methods that could potentially be needed to migrate as well

ajpallares · 2025-07-18T09:58:55Z

lib/models/purchase_result.dart

+  /// RevenueCat's servers.
+  final CustomerInfo customerInfo;
+  /// The [StoreTransaction] for this purchase.
+  final StoreTransaction storeTransaction;


I'm guessing you mean that it's part of the StoreTransaction, right? So yeah, totally not needed to add the redundancy 👍

lib/purchases_flutter.dart

ajpallares

Great job Toni!!!

ajpallares · 2025-07-18T10:41:59Z

revenuecat_examples/purchase_tester/lib/src/upsell.dart

+      final purchaseResult = await Purchases.purchasePackage(package);
+      final isPro = purchaseResult.customerInfo.entitlements
+        .active.containsKey(entitlementKey);
+      print("StoreTransaction: ${purchaseResult.storeTransaction}");


Just to confirm. Is this print intended to be commited?

I would like to leave it as I think it can be useful... This is the test app in any case so I think it's ok

@tonidero

## RevenueCat SDK ### 💥 Breaking Changes * Play Billing Library 8 update This release updates the SDK to use Google Play Billing Library 8. This version of the Billing Library removed APIs to query for expired subscriptions and consumed one-time products, aside from other improvements. You can check the full list of changes here: https://developer.android.com/google/play/billing/release-notes#8-0-0 #### No expired subscriptions or consumed one-time products Note: the following is only relevant if you recently integrated RevenueCat, and do not (yet) have all your transactions imported. Play Billing Library 8 removed functionality to query expired subscriptions or consumed one-time products. This means that, for users migrating from a non-RevenueCat implementation of the Play Billing Library, the SDK will not be able to send purchase information from these purchases. We can still ingest historical data from these purchases through a backend historical import. See [docs](https://www.revenuecat.com/docs/migrating-to-revenuecat/migrating-existing-subscriptions). This doesn't affect developers that have all transactions in RevenueCat, which is true for the vast majority. #### Using the SDK with your own IAP code (previously Observer Mode) Using the SDK with your own IAP code is still supported in v9. Other than updating the SDK version, there are no changes required. Just make sure the version of the Play Billing Library is also version 8.0.0+. * Increased min Flutter SDK to 3.22.0 and Dart min SDK to 3.4.0 * Remove freezed in favor of manually parsed models (#1368) via Toni Rico (@tonidero) * This removed some APIs like `toJson`, `StoreTransaction.revenueCatIdentifier` * This also modified our APIs to use WebPurchaseRedemptionResult. Now you will need to do: ``` WebPurchaseRedemptionResult result; switch (result) { case WebPurchaseRedemptionSuccess(:final customerInfo): // Handle successful redemption break; case WebPurchaseRedemptionError(:final error): // Handle error in redemption break; case WebPurchaseRedemptionPurchaseBelongsToOtherUser(): // Handle case where the purchase belongs to another user break; case WebPurchaseRedemptionInvalidToken(): // Handle case where the token is invalid break; case WebPurchaseRedemptionExpired(:final obfuscatedEmail): // Handle case where the redemption link has expired break; }; ``` * Change result of purchase methods to PurchaseResult (#1408) via Toni Rico (@tonidero) * The result of the purchase methods is now a `PurchaseResult` object instead of a `CustomerInfo` object. The `PurchaseResult` object contains a `CustomerInfo` object updated with the latest customer information after the purchase is made, and the `StoreTransaction` object created by the purchase. ### New features * Flutter Web (#1407) via Toni Rico (@tonidero) * Now, the SDK supports Flutter Web! This means you can create an app that works on iOS, Android, and Web with the same codebase. The web support makes use of RevenueCat's [Web Billing](https://www.revenuecat.com/docs/web/web-billing/overview) engine, so please report any issues you find. ### List of changes * [AUTOMATIC BUMP] Updates purchases-hybrid-common to 15.0.0 (#1406) via RevenueCat Git Bot (@RCGitBot) * [Android 9.1.0](https://github.com/RevenueCat/purchases-android/releases/tag/9.1.0) * [Android 9.0.1](https://github.com/RevenueCat/purchases-android/releases/tag/9.0.1) * [Android 9.0.0](https://github.com/RevenueCat/purchases-android/releases/tag/9.0.0) * [iOS 5.33.0](https://github.com/RevenueCat/purchases-ios/releases/tag/5.33.0) * Flutter Web + Remove freezed dependency (#1407) via Toni Rico (@tonidero) ### 📦 Dependency Updates * [RENOVATE] Update build-dependencies to v8.11.1 (#1402) via RevenueCat Git Bot (@RCGitBot) ### 🔄 Other Changes * Bump fastlane from 2.227.2 to 2.228.0 (#1360) via dependabot[bot] (@dependabot[bot]) * Bump fastlane-plugin-revenuecat_internal from `05ef095` to `7d97553` (#1381) via dependabot[bot] (@dependabot[bot]) --------- Co-authored-by: Antonio Pallares <[email protected]>

Change result of purchase methods to PurchaseResult

eb49155

tonidero added pr:breaking Changes that are breaking pr:feat A new feature labels Jul 17, 2025

tonidero commented Jul 17, 2025

View reviewed changes

Fix tests

0d3dde9

tonidero marked this pull request as ready for review July 17, 2025 16:08

tonidero requested a review from a team July 17, 2025 16:08

Fix api tests

ce152ff

ajpallares reviewed Jul 18, 2025

View reviewed changes

Change winback purchase methods return type

649d72a

tonidero requested review from ajpallares and JayShortway July 18, 2025 10:37

Fix api tests

8e8944b

ajpallares approved these changes Jul 18, 2025

View reviewed changes

Remove unused method

ac72a62

tonidero force-pushed the change-purchase-result-type-to-purchase-result branch from 0e0a1a7 to ac72a62 Compare July 18, 2025 11:03

tonidero enabled auto-merge (squash) July 18, 2025 11:13

tonidero merged commit 2a5a081 into main Jul 18, 2025
9 checks passed

tonidero deleted the change-purchase-result-type-to-purchase-result branch July 18, 2025 11:17

tonidero mentioned this pull request Jul 18, 2025

Release/9.0.0 #1409

Merged

Change result of purchase methods to PurchaseResult #1408

Change result of purchase methods to PurchaseResult #1408

Uh oh!

Conversation

tonidero commented Jul 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!