[In_App_Purchase]queryPastPurchases() shouldn't block transaction updates. (#2834)

* Allow all transactions except for purchasing ones to be passed back to the Flutter side.

* Restore transactions shouldn't block transaction updates

Author: LHLL

packages/in_app_purchase/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.4+1
+
+* iOS: Fix the bug that `SKPaymentQueueWrapper.transactions` doesn't return all transactions.
+* iOS: Fix the app crashes  if `InAppPurchaseConnection.instance` is called in the `main()`.
+
 ## 0.3.4
 
 * Expose SKError code to client apps.

packages/in_app_purchase/ios/Classes/FIAPaymentQueueHandler.m

@@ -75,7 +75,7 @@ - (void)restoreTransactions:(nullable NSString *)applicationName {
 - (void)paymentQueue:(SKPaymentQueue *)queue
     updatedTransactions:(NSArray<SKPaymentTransaction *> *)transactions {
   for (SKPaymentTransaction *transaction in transactions) {
-    if (transaction.transactionIdentifier) {
+    if (transaction.transactionState != SKPaymentTransactionStatePurchasing) {
       // Use product identifier instead of transaction identifier for few reasons:
       // 1. Only transactions with purchased state and failed state will have a transaction id, it
       //    will become impossible for clients to finish deferred transactions when needed.
@@ -92,9 +92,7 @@ - (void)paymentQueue:(SKPaymentQueue *)queue
 - (void)paymentQueue:(SKPaymentQueue *)queue
     removedTransactions:(NSArray<SKPaymentTransaction *> *)transactions {
   for (SKPaymentTransaction *transaction in transactions) {
-    if (transaction.transactionIdentifier) {
-      [self.transactionsSetter removeObjectForKey:transaction.payment.productIdentifier];
-    }
+    [self.transactionsSetter removeObjectForKey:transaction.payment.productIdentifier];
   }
   self.transactionsRemoved(transactions);
 }

packages/in_app_purchase/ios/Tests/InAppPurchasePluginTest.m

@@ -121,6 +121,7 @@ - (void)testAddPaymentWithSameProductIDWillFail {
                                           @"simulatesAskToBuyInSandBox" : @YES,
                                         }];
   SKPaymentQueueStub* queue = [SKPaymentQueueStub new];
+  queue.testState = SKPaymentTransactionStatePurchased;
   self.plugin.paymentQueueHandler = [[FIAPaymentQueueHandler alloc] initWithQueue:queue
       transactionsUpdated:^(NSArray<SKPaymentTransaction*>* _Nonnull transactions) {
       }

packages/in_app_purchase/ios/Tests/PaymentQueueTest.m

@@ -66,6 +66,7 @@ - (void)testTransactionPurchased {
   [handler addPayment:payment];
   [self waitForExpectations:@[ expectation ] timeout:5];
   XCTAssertEqual(tran.transactionState, SKPaymentTransactionStatePurchased);
+  XCTAssertEqual(tran.transactionIdentifier, @"fakeID");
 }
 
 - (void)testDuplicateTransactionsWillTriggerAnError {
@@ -113,6 +114,7 @@ - (void)testTransactionFailed {
   [handler addPayment:payment];
   [self waitForExpectations:@[ expectation ] timeout:5];
   XCTAssertEqual(tran.transactionState, SKPaymentTransactionStateFailed);
+  XCTAssertEqual(tran.transactionIdentifier, nil);
 }
 
 - (void)testTransactionRestored {
@@ -140,6 +142,7 @@ - (void)testTransactionRestored {
   [handler addPayment:payment];
   [self waitForExpectations:@[ expectation ] timeout:5];
   XCTAssertEqual(tran.transactionState, SKPaymentTransactionStateRestored);
+  XCTAssertEqual(tran.transactionIdentifier, @"fakeID");
 }
 
 - (void)testTransactionPurchasing {
@@ -167,6 +170,7 @@ - (void)testTransactionPurchasing {
   [handler addPayment:payment];
   [self waitForExpectations:@[ expectation ] timeout:5];
   XCTAssertEqual(tran.transactionState, SKPaymentTransactionStatePurchasing);
+  XCTAssertEqual(tran.transactionIdentifier, nil);
 }
 
 - (void)testTransactionDeferred {
@@ -194,6 +198,7 @@ - (void)testTransactionDeferred {
   [handler addPayment:payment];
   [self waitForExpectations:@[ expectation ] timeout:5];
   XCTAssertEqual(tran.transactionState, SKPaymentTransactionStateDeferred);
+  XCTAssertEqual(tran.transactionIdentifier, nil);
 }
 
 - (void)testFinishTransaction {

packages/in_app_purchase/ios/Tests/Stubs.m

@@ -215,7 +215,11 @@ - (instancetype)initWithMap:(NSDictionary *)map {
 - (instancetype)initWithState:(SKPaymentTransactionState)state {
   self = [super init];
   if (self) {
-    [self setValue:@"fakeID" forKey:@"transactionIdentifier"];
+    // Only purchased and restored transactions have transactionIdentifier:
+    // https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier?language=objc
+    if (state == SKPaymentTransactionStatePurchased || state == SKPaymentTransactionStateRestored) {
+      [self setValue:@"fakeID" forKey:@"transactionIdentifier"];
+    }
     [self setValue:@(state) forKey:@"transactionState"];
   }
   return self;
@@ -224,7 +228,11 @@ - (instancetype)initWithState:(SKPaymentTransactionState)state {
 - (instancetype)initWithState:(SKPaymentTransactionState)state payment:(SKPayment *)payment {
   self = [super init];
   if (self) {
-    [self setValue:@"fakeID" forKey:@"transactionIdentifier"];
+    // Only purchased and restored transactions have transactionIdentifier:
+    // https://developer.apple.com/documentation/storekit/skpaymenttransaction/1411288-transactionidentifier?language=objc
+    if (state == SKPaymentTransactionStatePurchased || state == SKPaymentTransactionStateRestored) {
+      [self setValue:@"fakeID" forKey:@"transactionIdentifier"];
+    }
     [self setValue:@(state) forKey:@"transactionState"];
     _payment = payment;
   }

packages/in_app_purchase/lib/src/in_app_purchase/app_store_connection.dart

@@ -208,12 +208,14 @@ class _TransactionObserver implements SKTransactionObserverWrapper {
         return wrapper.transactionState ==
             SKPaymentTransactionStateWrapper.restored;
       }).map((SKPaymentTransactionWrapper wrapper) => wrapper));
-      return;
     }
 
     String receiptData = await getReceiptData();
     purchaseUpdatedController
-        .add(transactions.map((SKPaymentTransactionWrapper transaction) {
+        .add(transactions.where((SKPaymentTransactionWrapper wrapper) {
+      return wrapper.transactionState !=
+          SKPaymentTransactionStateWrapper.restored;
+    }).map((SKPaymentTransactionWrapper transaction) {
       PurchaseDetails purchaseDetails =
           PurchaseDetails.fromSKTransaction(transaction, receiptData);
       return purchaseDetails;

packages/in_app_purchase/lib/src/in_app_purchase/in_app_purchase_connection.dart

@@ -71,7 +71,7 @@ abstract class InAppPurchaseConnection {
 
   /// Enable the [InAppPurchaseConnection] to handle pending purchases.
   ///
-  /// Android Only: This method is required to be called when initialize the application.
+  /// This method is required to be called when initialize the application.
   /// It is to acknowledge your application has been updated to support pending purchases.
   /// See [Support pending transactions](https://developer.android.com/google/play/billing/billing_library_overview#pending)
   /// for more details.

packages/in_app_purchase/lib/src/store_kit_wrappers/sk_payment_queue_wrapper.dart

@@ -37,9 +37,7 @@ class SKPaymentQueueWrapper {
 
   static final SKPaymentQueueWrapper _singleton = SKPaymentQueueWrapper._();
 
-  SKPaymentQueueWrapper._() {
-    callbackChannel.setMethodCallHandler(_handleObserverCallbacks);
-  }
+  SKPaymentQueueWrapper._();
 
   /// Calls [`-[SKPaymentQueue transactions]`](https://developer.apple.com/documentation/storekit/skpaymentqueue/1506026-transactions?language=objc)
   Future<List<SKPaymentTransactionWrapper>> transactions() async {
@@ -59,6 +57,7 @@ class SKPaymentQueueWrapper {
   /// addTransactionObserver:]`](https://developer.apple.com/documentation/storekit/skpaymentqueue/1506042-addtransactionobserver?language=objc).
   void setTransactionObserver(SKTransactionObserverWrapper observer) {
     _observer = observer;
+    callbackChannel.setMethodCallHandler(_handleObserverCallbacks);
   }
 
   /// Posts a payment to the queue.

packages/in_app_purchase/pubspec.yaml

@@ -1,7 +1,7 @@
 name: in_app_purchase
 description: A Flutter plugin for in-app purchases. Exposes APIs for making in-app purchases through the App Store and Google Play.
 homepage: https://github.com/flutter/plugins/tree/master/packages/in_app_purchase
-version: 0.3.4
+version: 0.3.4+1
 
 dependencies:
   async: ^2.0.8

packages/in_app_purchase/test/in_app_purchase_connection/app_store_connection_test.dart

@@ -90,6 +90,28 @@ void main() {
       expect(response.error, isNull);
     });
 
+    test('queryPastPurchases should not block transaction updates', () async {
+      fakeIOSPlatform.transactions
+          .add(fakeIOSPlatform.createPurchasedTransactionWithProductID('foo'));
+      Completer completer = Completer();
+      Stream<List<PurchaseDetails>> stream =
+          AppStoreConnection.instance.purchaseUpdatedStream;
+
+      StreamSubscription subscription;
+      subscription = stream.listen((purchaseDetailsList) {
+        if (purchaseDetailsList.first.status == PurchaseStatus.purchased) {
+          completer.complete(purchaseDetailsList);
+          subscription.cancel();
+        }
+      });
+      QueryPurchaseDetailsResponse response =
+          await AppStoreConnection.instance.queryPastPurchases();
+      List<PurchaseDetails> result = await completer.future;
+      expect(result.length, 1);
+      expect(result.first.productID, 'foo');
+      expect(response.error, isNull);
+    });
+
     test('should get empty result if there is no restored transactions',
         () async {
       fakeIOSPlatform.testRestoredTransactionsNull = true;
@@ -328,10 +350,10 @@ class FakeIOSPlatform {
 
   SKPaymentTransactionWrapper createPendingTransactionWithProductID(String id) {
     return SKPaymentTransactionWrapper(
+        transactionIdentifier: null,
         payment: SKPaymentWrapper(productIdentifier: id),
         transactionState: SKPaymentTransactionStateWrapper.purchasing,
         transactionTimeStamp: 123123.121,
-        transactionIdentifier: id,
         error: null,
         originalTransaction: null);
   }
@@ -349,10 +371,10 @@ class FakeIOSPlatform {
 
   SKPaymentTransactionWrapper createFailedTransactionWithProductID(String id) {
     return SKPaymentTransactionWrapper(
+        transactionIdentifier: null,
         payment: SKPaymentWrapper(productIdentifier: id),
         transactionState: SKPaymentTransactionStateWrapper.failed,
         transactionTimeStamp: 123123.121,
-        transactionIdentifier: id,
         error: SKError(
             code: 0,
             domain: 'ios_domain',