Convert startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon by LouiseHsu · Pull Request #6032 · flutter/packages

LouiseHsu · 2024-02-02T00:38:25Z

This PR converts startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon, as well as add all remaining converts to and from pigeons for SK objects.

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I signed the [CLA].
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is [test-exempt].
All existing and new tests are passing.

packages/in_app_purchase/in_app_purchase_storekit/example/ios/Runner.xcodeproj/project.pbxproj

…o iap_pigeon_part_2

gaaclarke

Looking good, the only major thing is the missing short circuiting and potentially missing tests for all these extra converters.

gaaclarke · 2024-02-08T22:52:49Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/FIAObjectTranslator.m

+
+  NSArray<SKProductDiscount *> *skProductDiscounts = product.discounts;
+  NSMutableArray<SKProductDiscountMessage *> *pigeonProductDiscounts =
+      [[NSMutableArray alloc] init];


Nit: you know the size here. It's more efficient to create the array of the proper size.

Suggested change

[[NSMutableArray alloc] init];

[NSMutableArray arrayWithCapacity: skProductDiscounts.count];

gaaclarke · 2024-02-08T22:54:08Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/FIAObjectTranslator.m

+    return nil;
+  }
+  NSArray<SKProduct *> *skProducts = productsResponse.products;
+  NSMutableArray<SKProductMessage *> *pigeonProducts = [[NSMutableArray alloc] init];


nit: same here

Suggested change

NSMutableArray<SKProductMessage *> *pigeonProducts = [[NSMutableArray alloc] init];

NSMutableArray<SKProductMessage *> *pigeonProducts = [NSMutableArray arrayWithCapacity: skProducts.count];

gaaclarke · 2024-02-08T22:55:58Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/InAppPurchasePlugin.m

-      result([FlutterError errorWithCode:@"storekit_getproductrequest_platform_error"
-                                 message:error.localizedDescription
-                                 details:error.description]);
-      return;


This return got lost. You'll want to short circuit any of the following logic. In order to do that you'll have to call the completion handler then return.

gaaclarke · 2024-02-08T23:00:48Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/InAppPurchasePlugin.m

-                                 message:@"Failed to get SKProductResponse in startRequest "
-                                         @"call. Error occured on iOS platform"
-                                 details:call.arguments]);
-      return;


gaaclarke · 2024-02-08T23:05:03Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/InAppPurchasePlugin.m

 #if TARGET_OS_IOS
- (void)presentCodeRedemptionSheet:(FlutterMethodCall *)call result:(FlutterResult)result {
  [self.paymentQueueHandler presentCodeRedemptionSheet];
-  result(nil);


I just want to call out how these calls have disappears now. In the past, failing to call these created bugs, you've eliminated that risk now 👍

gaaclarke · 2024-02-08T23:15:53Z

.../in_app_purchase/in_app_purchase_storekit/lib/src/store_kit_wrappers/sk_product_wrapper.dart

+  }
+
+  @visibleForTesting
+


gaaclarke · 2024-02-08T23:17:51Z

.../in_app_purchase/in_app_purchase_storekit/lib/src/store_kit_wrappers/sk_product_wrapper.dart

      discounts);
+
+  /// Convert from [SKProductMessage] to [SKProductWrapper]
+  static SKProductWrapper convertFromPigeon(SKProductMessage msg) {


No action required: These are all a pain. I guess if pigeon had been used from day one, the generated classes could have been been used. We also talked about letting pigeon use existing classes too. That would have really helped here.

gaaclarke · 2024-02-08T23:20:17Z

packages/in_app_purchase/in_app_purchase_storekit/pigeons/messages.dart

+
+enum SKSubscriptionPeriodUnitMessage {
+  day,
+


remove newlines please

gaaclarke · 2024-02-08T23:21:40Z

packages/in_app_purchase/in_app_purchase_storekit/test/fakes/fake_storekit_platform.dart

+
+  @override
+  void presentCodeRedemptionSheet() {
+    return;


Suggested change

return;

gaaclarke · 2024-02-08T23:22:54Z

.../in_app_purchase/in_app_purchase_storekit/lib/src/store_kit_wrappers/sk_product_wrapper.dart

+  }
+
+  /// Convert from [SKProductWrapper] to [SKProductMessage]
+  static SKProductMessage convertToPigeon(SKProductWrapper wrapper) {


Do all of these have tests?

gaaclarke · 2024-02-09T22:24:17Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/FIAObjectTranslator.m

  NSArray<SKProductDiscount *> *skProductDiscounts = product.discounts;
  NSMutableArray<SKProductDiscountMessage *> *pigeonProductDiscounts =
-      [[NSMutableArray alloc] init];
+      [[NSMutableArray arrayWithCapacity:skProductDiscounts.count] init];


You don't want to call init when using arrayWithCapacity:, that's already taken care for you. You just need that when you are using alloc.

gaaclarke

LGTM! Don't forget to manually test it with the example app before merging.

hellohuanlin

just briefly skimmed through since Aaron already reviewed it

hellohuanlin · 2024-02-12T22:56:50Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/FIAObjectTranslator.m

@@ -307,6 +307,10 @@ + (nullable SKPaymentTransactionMessage *)convertTransactionToPigeon:
 }

 + (nullable SKErrorMessage *)convertSKErrorToPigeon:(NSError *)error {


nit: mark error as nullable

hellohuanlin · 2024-02-12T22:58:55Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/InAppPurchasePlugin.m

-    [self presentCodeRedemptionSheet:call result:result];
-#endif
-  } else if ([@"-[InAppPurchasePlugin retrieveReceiptData:result:]" isEqualToString:call.method]) {
+  if ([@"-[InAppPurchasePlugin retrieveReceiptData:result:]" isEqualToString:call.method]) {


this is probably not related to your PR - is this format iOS only? It's very objc-specific. do we intend to change that after migrating to swift?

this entire code block/fcn will be removed after the pigeon migration so it should be fine

hellohuanlin · 2024-02-12T23:01:35Z

packages/in_app_purchase/in_app_purchase_storekit/darwin/Classes/InAppPurchasePlugin.m

-                                   details:e.description]);
+        *error = [FlutterError errorWithCode:@"storekit_finish_transaction_exception"
+                                     message:e.name
+                                     details:e.description];


where is this error used?

all generated pigeon functions have like an extra "error" param, I think it gets passed back to the dart side automatically

gaaclarke · 2024-02-13T01:53:00Z

I'm not sure why that CI step keeps failing, it's an infra failure so it's likely not caused by this PR. You can try updating your branch by merging in main or rebasing against main.

…o iap_pigeon_part_2

…ansactions(), presentCodeRedemptionSheet() to pigeon (flutter/packages#6032)

flutter/packages@0a69259...9385bbb 2024-02-13 louisehsu@google.com Convert startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon (flutter/packages#6032) 2024-02-13 49699333+dependabot[bot]@users.noreply.github.com [in_app_pur]: Bump org.json:json from 20231013 to 20240205 in /packages/in_app_purchase/in_app_purchase/example/android/app (flutter/packages#6096) 2024-02-12 stuartmorgan@google.com [local_auth] Rename iOS classes (flutter/packages#6108) 2024-02-12 jakubwalusiak@gmail.com [video_player_android] Handle BehindLiveWindowException (flutter/packages#5869) 2024-02-12 reidbaker@google.com [in_app_purchase] Add alternative billing apis for android (flutter/packages#6056) 2024-02-12 stuartmorgan@google.com [webview_flutter] Update compileSdk to 34 (flutter/packages#6106) 2024-02-12 37270954+foxtrotravi@users.noreply.github.com [cupertino_icons] Add example to cupertino icons (flutter/packages#5312) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

all dart pigeon types and converters created for startProductRequest

cabdcf4

github-actions bot added p: in_app_purchase platform-ios platform-macos labels Feb 2, 2024

conversions working

55f3524

hellohuanlin reviewed Feb 7, 2024

View reviewed changes

packages/in_app_purchase/in_app_purchase_storekit/example/ios/Runner.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved

LouiseHsu added 5 commits February 7, 2024 15:07

fix tests + formatting

751b034

remove development team >:(

50fe53a

Merge branch 'main' into iap_pigeon_part_2

bab76ff

adding converters TO pigeon for test, fix dart tests

214cc93

Merge branch 'iap_pigeon_part_2' of github.com:LouiseHsu/packages int…

b0d16e1

…o iap_pigeon_part_2

LouiseHsu changed the title ~~all dart pigeon types and converters created for startProductRequest~~ Converts startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon Feb 8, 2024

LouiseHsu changed the title ~~Converts startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon~~ Convert startProductRequest(), finishTransaction(), restoreTransactions(), presentCodeRedemptionSheet() to pigeon Feb 8, 2024

LouiseHsu added 5 commits February 7, 2024 16:26

remove unused imports and fcns.

7524ba8

pubspec/license

1374433

add translator tests, add null check for coverters

a3a7439

Merge branch 'main' into iap_pigeon_part_2

f7e0c4a

format

569abc2

LouiseHsu requested a review from gaaclarke February 8, 2024 21:56

LouiseHsu marked this pull request as ready for review February 8, 2024 21:56

gaaclarke reviewed Feb 8, 2024

View reviewed changes

jmagman mentioned this pull request Feb 9, 2024

[in_app_purchase] Use StoreKit 2 APIs flutter/flutter#116383

Closed

PR comments

0aadf34

gaaclarke reviewed Feb 9, 2024

View reviewed changes

LouiseHsu added 2 commits February 9, 2024 14:47

remove init

26681aa

Merge branch 'main' into iap_pigeon_part_2

7b011be

gaaclarke approved these changes Feb 12, 2024

View reviewed changes

hellohuanlin reviewed Feb 12, 2024

View reviewed changes

add nullable to skerror

0cb73cf

Merge branch 'iap_pigeon_part_2' of github.com:LouiseHsu/packages int…

2247065

…o iap_pigeon_part_2

LouiseHsu merged commit 9385bbb into flutter:main Feb 13, 2024

engine-flutter-autoroll mentioned this pull request Feb 13, 2024

Roll Packages from 0a692590a885 to 9385bbb3cf46 (7 revisions) flutter/flutter#143366

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 13, 2024

9385bbb Convert startProductRequest(), finishTransaction(), restoreTr…

799a140

…ansactions(), presentCodeRedemptionSheet() to pigeon (flutter/packages#6032)

LouiseHsu mentioned this pull request Feb 14, 2024

[in_app_purchase_store_kit] 'Null check operator used on a null value' is thrown on calling SKPaymentQueueWrapper.transactions(). flutter/flutter#143177

Closed

reidbaker mentioned this pull request Feb 19, 2024

[in_app_purchase_android] Add UserChoiceBilling mode. #6162

Merged

16 tasks

jmagman mentioned this pull request Apr 4, 2024

macos_platform_tests package build times out when built for all packages flutter/flutter#146254

Closed

	[[NSMutableArray alloc] init];
	[NSMutableArray arrayWithCapacity: skProductDiscounts.count];

	NSMutableArray<SKProductMessage > pigeonProducts = [[NSMutableArray alloc] init];
	NSMutableArray<SKProductMessage > pigeonProducts = [NSMutableArray arrayWithCapacity: skProducts.count];

		@@ -307,6 +307,10 @@ + (nullable SKPaymentTransactionMessage *)convertTransactionToPigeon:
		}

		+ (nullable SKErrorMessage )convertSKErrorToPigeon:(NSError )error {

Conversation

LouiseHsu commented Feb 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

gaaclarke 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!

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!

gaaclarke left a comment

Choose a reason for hiding this comment

Uh oh!

hellohuanlin 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!

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!

gaaclarke commented Feb 13, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LouiseHsu commented Feb 2, 2024 •

edited

Loading