[in_app_purchase] payment queue dart ios

packages/in_app_purchase/example/ios/in_app_purchase_pluginTests/InAppPurchasePluginTest.m

@@ -70,38 +70,15 @@ - (void)testGetProductResponse {
   XCTAssertTrue([resultArray.firstObject[@"productIdentifier"] isEqualToString:@"123"]);
 }
 
-- (void)testCreatePaymentWithProduct {
-  XCTestExpectation* expectation = [self expectationWithDescription:@"must return a payment"];
-  FlutterMethodCall* call = [FlutterMethodCall
-      methodCallWithMethodName:@"-[InAppPurchasePlugin startProductRequest:result:]"
-                     arguments:@[ @"123" ]];
-  FlutterMethodCall* createPaymentCall = [FlutterMethodCall
-      methodCallWithMethodName:@"-[InAppPurchasePlugin createPaymentWithProductID:result:]"
-                     arguments:@"123"];
-  __block NSDictionary* result;
-  __weak typeof(self) weakSelf = self;
-  [self.plugin handleMethodCall:call
-                         result:^(id queryResult) {
-                           [weakSelf.plugin handleMethodCall:createPaymentCall
-                                                      result:^(id _Nullable r) {
-                                                        result = r;
-                                                        [expectation fulfill];
-                                                      }];
-                         }];
-  [self waitForExpectations:@[ expectation ] timeout:5];
-  XCTAssertTrue([result[@"productIdentifier"] isEqualToString:@"123"]);
-}
-
 - (void)testAddPaymentFailure {
   XCTestExpectation* expectation =
       [self expectationWithDescription:@"result should return failed state"];
   FlutterMethodCall* call =
       [FlutterMethodCall methodCallWithMethodName:@"-[InAppPurchasePlugin addPayment:result:]"
                                         arguments:@{
-                                          @"productID" : @"123",
+                                          @"productIdentifier" : @"123",
                                           @"quantity" : @(1),
                                           @"simulatesAskToBuyInSandBox" : @YES,
-                                          @"usePaymentObject" : @YES
                                         }];
   SKPaymentQueueStub* queue = [SKPaymentQueueStub new];
   queue.testState = SKPaymentTransactionStateFailed;
@@ -135,10 +112,9 @@ - (void)testAddPaymentSuccessWithMockQueue {
   FlutterMethodCall* call =
       [FlutterMethodCall methodCallWithMethodName:@"-[InAppPurchasePlugin addPayment:result:]"
                                         arguments:@{
-                                          @"productID" : @"123",
+                                          @"productIdentifier" : @"123",
                                           @"quantity" : @(1),
                                           @"simulatesAskToBuyInSandBox" : @YES,
-                                          @"usePaymentObject" : @YES
                                         }];
   SKPaymentQueueStub* queue = [SKPaymentQueueStub new];
   queue.testState = SKPaymentTransactionStatePurchased;

packages/in_app_purchase/example/ios/in_app_purchase_pluginTests/Stubs.m

@@ -130,6 +130,10 @@ - (SKProductRequestStub *)getProductRequestWithIdentifiers:(NSSet *)identifiers
   return [[SKProductRequestStub alloc] initWithProductIdentifiers:identifiers];
 }
 
+- (SKProduct *)getProduct:(NSString *)productID {
+  return [SKProduct new];
+}
+
 @end
 
 @interface SKPaymentQueueStub ()

packages/in_app_purchase/ios/Classes/FIAPaymentQueueHandler.m

@@ -39,6 +39,7 @@ - (instancetype)initWithQueue:(nonnull SKPaymentQueue *)queue
     self.shouldAddStorePayment = shouldAddStorePayment;
     self.updatedDownloads = updatedDownloads;
     self.transactionsSetter = [NSMutableDictionary new];
+    [queue addTransactionObserver:self];
   }
   return self;
 }
@@ -57,7 +58,9 @@ - (void)finishTransaction:(SKPaymentTransaction *)transaction {
 - (void)paymentQueue:(SKPaymentQueue *)queue
     updatedTransactions:(NSArray<SKPaymentTransaction *> *)transactions {
   for (SKPaymentTransaction *transaction in transactions) {
-    [self.transactionsSetter setObject:transaction forKey:transaction.transactionIdentifier];
+    if (transaction.transactionIdentifier) {
+      [self.transactionsSetter setObject:transaction forKey:transaction.transactionIdentifier];
+    }
   }
   // notify dart through callbacks.
   self.transactionsUpdated(transactions);

packages/in_app_purchase/ios/Classes/InAppPurchasePlugin.m

@@ -17,9 +17,6 @@ @interface InAppPurchasePlugin ()
 // After querying the product, the available products will be saved in the map to be used
 // for purchase.
 @property(copy, nonatomic) NSMutableDictionary *productsCache;
-// Saved payment object used for resume payments;
-@property(copy, nonatomic) NSMutableDictionary *paymentsCache;
-;
 
 // Call back channel to dart used for when a listener function is triggered.
 @property(strong, nonatomic) FlutterMethodChannel *callbackChannel;
@@ -35,27 +32,10 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
   FlutterMethodChannel *channel =
       [FlutterMethodChannel methodChannelWithName:@"plugins.flutter.io/in_app_purchase"
                                   binaryMessenger:[registrar messenger]];
-  InAppPurchasePlugin *instance = [[InAppPurchasePlugin alloc] init];
+  InAppPurchasePlugin *instance = [[InAppPurchasePlugin alloc] initWithRegistrar:registrar];
   [registrar addMethodCallDelegate:instance channel:channel];
 }
 
-- (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result {
-  if ([@"-[SKPaymentQueue canMakePayments:]" isEqualToString:call.method]) {
-    [self canMakePayments:result];
-  } else if ([@"-[InAppPurchasePlugin startProductRequest:result:]" isEqualToString:call.method]) {
-    [self handleProductRequestMethodCall:call result:result];
-  } else if ([@"-[InAppPurchasePlugin createPaymentWithProductID:result:]"
-                 isEqualToString:call.method]) {
-    [self createPaymentWithProductID:call result:result];
-  } else if ([@"-[InAppPurchasePlugin addPayment:result:]" isEqualToString:call.method]) {
-    [self addPayment:call result:result];
-  } else if ([@"-[InAppPurchasePlugin finishTransaction:result:]" isEqualToString:call.method]) {
-    [self finishTransaction:call result:result];
-  } else {
-    result(FlutterMethodNotImplemented);
-  }
-}
-
 - (instancetype)initWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
   self = [self init];
   self.registrar = registrar;
@@ -88,6 +68,20 @@ - (instancetype)initWithRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar
   return self;
 }
 
+- (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result {
+  if ([@"-[SKPaymentQueue canMakePayments:]" isEqualToString:call.method]) {
+    [self canMakePayments:result];
+  } else if ([@"-[InAppPurchasePlugin startProductRequest:result:]" isEqualToString:call.method]) {
+    [self handleProductRequestMethodCall:call result:result];
+  } else if ([@"-[InAppPurchasePlugin addPayment:result:]" isEqualToString:call.method]) {
+    [self addPayment:call result:result];
+  } else if ([@"-[InAppPurchasePlugin finishTransaction:result:]" isEqualToString:call.method]) {
+    [self finishTransaction:call result:result];
+  } else {
+    result(FlutterMethodNotImplemented);
+  }
+}
+
 - (void)canMakePayments:(FlutterResult)result {
   result([NSNumber numberWithBool:[SKPaymentQueue canMakePayments]]);
 }
@@ -131,83 +125,36 @@ - (void)handleProductRequestMethodCall:(FlutterMethodCall *)call result:(Flutter
   }];
 }
 
-- (void)createPaymentWithProductID:(FlutterMethodCall *)call result:(FlutterResult)result {
-  if (![call.arguments isKindOfClass:[NSString class]]) {
-    result([FlutterError
-        errorWithCode:@"storekit_invalid_argument"
-              message:@"Argument type of createPaymentWithProductID is not a string."
-              details:call.arguments]);
-    return;
-  }
-  NSString *productID = call.arguments;
-  SKProduct *product = [self.productsCache objectForKey:productID];
-  if (!product) {
-    result([FlutterError
-        errorWithCode:@"storekit_product_not_found"
-              message:@"Cannot find the product. To create a payment of a product, you must query "
-                      @"the product with SKProductRequestMaker.startProductRequest first."
-              details:call.arguments]);
-    return;
-  }
-  SKPayment *payment = [SKPayment paymentWithProduct:product];
-  [self.paymentsCache setObject:payment forKey:productID];
-  result([FIAObjectTranslator getMapFromSKPayment:payment]);
-}
-
 - (void)addPayment:(FlutterMethodCall *)call result:(FlutterResult)result {
   if (![call.arguments isKindOfClass:[NSDictionary class]]) {
     result([FlutterError errorWithCode:@"storekit_invalid_argument"
-                               message:@"Argument type of addPayment is not a map"
+                               message:@"Argument type of addPayment is not a Dictionary"
                                details:call.arguments]);
     return;
   }
   NSDictionary *paymentMap = (NSDictionary *)call.arguments;
-  NSString *productID = [paymentMap objectForKey:@"productID"];
-  SKPayment *payment = [self.paymentsCache objectForKey:productID];
-  // Use the payment object if we find a cached payment object associate with the productID. (Used
-  // for App Store payment flow
-  // https://developer.apple.com/documentation/storekit/skpaymenttransactionobserver/2877502-paymentqueue?language=objc)
-  if (payment) {
-    [self.paymentQueueHandler addPayment:payment];
-    result(nil);
-    return;
-  }
-  // The regular payment flow: when a product is already fetched, we create a payment object with
+  NSString *productID = [paymentMap objectForKey:@"productIdentifier"];
+  // When a product is already fetched, we create a payment object with
   // the product to process the payment.
-  SKProduct *product = [self.productsCache objectForKey:productID];
+  SKProduct *product = [self getProduct:productID];
   if (product) {
-    payment = [SKPayment paymentWithProduct:product];
-    [self.paymentQueueHandler addPayment:payment];
-    result(nil);
-    return;
-  }
-  // User can also use payment object with usePaymentObject = true and add
-  // simulatesAskToBuyInSandBox = true to test the payment flow.
-  if ([paymentMap[@"usePaymentObject"] boolValue] == YES) {
-    SKMutablePayment *mutablePayment = [[SKMutablePayment alloc] init];
-    mutablePayment.productIdentifier = productID;
+    SKMutablePayment *payment = [SKMutablePayment paymentWithProduct:product];
+    payment.applicationUsername = [paymentMap objectForKey:@"applicationUsername"];
     NSNumber *quantity = [paymentMap objectForKey:@"quantity"];
-    mutablePayment.quantity = quantity ? quantity.integerValue : 1;
-    NSString *applicationUsername = [paymentMap objectForKey:@"applicationUsername"];
-    mutablePayment.applicationUsername = applicationUsername;
+    payment.quantity = quantity ? quantity.integerValue : 1;
     if (@available(iOS 8.3, *)) {
-      mutablePayment.simulatesAskToBuyInSandbox =
+      payment.simulatesAskToBuyInSandbox =
           [[paymentMap objectForKey:@"simulatesAskToBuyInSandBox"] boolValue];
     }
-    [self.paymentQueueHandler addPayment:mutablePayment];
+    [self.paymentQueueHandler addPayment:payment];
     result(nil);
     return;
   }
   result([FlutterError
       errorWithCode:@"storekit_invalid_payment_object"
-            message:
-                @"You have requested a payment with an invalid payment object. A valid payment "
-                @"object should be one of the following: 1. Payment object that is automatically "
-                @"handled when the user starts an in-app purchase in the App Store and you "
-                @"returned true to the `shouldAddStorePayment` method or manually requested a "
-                @"payment with the productID that is provided in the `shouldAddStorePayment` "
-                @"method. 2. A payment requested for a product that has been fetched. 3. A custom "
-                @"payment object. This is not an error for a payment failure."
+            message:@"You have requested a payment for an invalid product. Either the "
+                    @"`productIdentifier` of the payment is not valid or the product has not been "
+                    @"fetched before adding the payment to the payment queue."
             details:call.arguments]);
 }
 
@@ -222,9 +169,15 @@ - (void)finishTransaction:(FlutterMethodCall *)call result:(FlutterResult)result
   SKPaymentTransaction *transaction =
       [self.paymentQueueHandler.transactions objectForKey:identifier];
   if (!transaction) {
-    result([FlutterError errorWithCode:@"storekit_platform_invalid_transaction"
-                               message:@"Invalid transaction ID is used."
-                               details:call.arguments]);
+    result([FlutterError
+        errorWithCode:@"storekit_platform_invalid_transaction"
+              message:[NSString
+                          stringWithFormat:@"The transaction with transactionIdentifer:%@ does not "
+                                           @"exist. Note that if the transactionState is "
+                                           @"purchasing, the transactionIdentifier will be "
+                                           @"nil(null).",
+                                           transaction.transactionIdentifier]
+              details:call.arguments]);
     return;
   }
   @try {
@@ -283,7 +236,6 @@ - (BOOL)shouldAddStorePayment:(SKPayment *)payment product:(SKProduct *)product
   // have a interception method that deciding if the payment should be processed (implemented by the
   // programmer).
   [self.productsCache setObject:product forKey:product.productIdentifier];
-  [self.paymentsCache setObject:payment forKey:payment.productIdentifier];
   [self.callbackChannel invokeMethod:@"shouldAddStorePayment"
                            arguments:@{
                              @"payment" : [FIAObjectTranslator getMapFromSKPayment:payment],
@@ -298,6 +250,10 @@ - (SKProductsRequest *)getProductRequestWithIdentifiers:(NSSet *)identifiers {
   return [[SKProductsRequest alloc] initWithProductIdentifiers:identifiers];
 }
 
+- (SKProduct *)getProduct:(NSString *)productID {
+  return [self.productsCache objectForKey:productID];
+}
+
 #pragma mark - getter
 
 - (NSSet *)requestHandlers {
@@ -314,11 +270,4 @@ - (NSMutableDictionary *)productsCache {
   return _productsCache;
 }
 
-- (NSMutableDictionary *)paymentsCache {
-  if (!_paymentsCache) {
-    _paymentsCache = [NSMutableDictionary new];
-  }
-  return _paymentsCache;
-}
-
 @end

packages/in_app_purchase/lib/src/channel.dart

@@ -6,3 +6,6 @@ import 'package:flutter/services.dart';
 
 const MethodChannel channel =
     MethodChannel('plugins.flutter.io/in_app_purchase');
+
+const MethodChannel callbackChannel =
+    MethodChannel('plugins.flutter.io/in_app_purchase_callback');