Processed feedback on pull request.

Author: mvanbeusekom

packages/in_app_purchase/in_app_purchase_storekit/example/ios/RunnerTests/FIATransactionCacheTests.m

@@ -38,19 +38,14 @@ - (void)testGetObjectsForNonExistingKey {
   XCTAssertNil([cache getObjectsForKey:TransactionCacheKeyUpdatedTransactions]);
 }
 
-- (void)testRemoveObjectsForNonExistingKey {
-  FIATransactionCache *cache = [[FIATransactionCache alloc] init];
-  [cache removeObjectsForKey:TransactionCacheKeyUpdatedTransactions];
-}
-
-- (void)testRemoveObjectsForExistingKey {
+- (void)testClear {
   NSArray *dummyArray = @[ @1, @2, @3 ];
   FIATransactionCache *cache = [[FIATransactionCache alloc] init];
   [cache addObjects:dummyArray forKey:TransactionCacheKeyUpdatedTransactions];
 
   XCTAssertEqual(dummyArray, [cache getObjectsForKey:TransactionCacheKeyUpdatedTransactions]);
 
-  [cache removeObjectsForKey:TransactionCacheKeyUpdatedTransactions];
+  [cache clear];
   XCTAssertNil([cache getObjectsForKey:TransactionCacheKeyUpdatedTransactions]);
 }
 @end

packages/in_app_purchase/in_app_purchase_storekit/example/ios/RunnerTests/PaymentQueueTests.m

@@ -297,11 +297,9 @@ - (void)testStartObservingPaymentQueueShouldProcessTransactionsForItemsInCache {
   ]
                     timeout:5];
   OCMVerify(times(1), [mockCache getObjectsForKey:TransactionCacheKeyUpdatedTransactions]);
-  OCMVerify(times(1), [mockCache removeObjectsForKey:TransactionCacheKeyUpdatedTransactions]);
   OCMVerify(times(1), [mockCache getObjectsForKey:TransactionCacheKeyUpdatedDownloads]);
-  OCMVerify(times(1), [mockCache removeObjectsForKey:TransactionCacheKeyUpdatedDownloads]);
   OCMVerify(times(1), [mockCache getObjectsForKey:TransactionCacheKeyRemovedTransactions]);
-  OCMVerify(times(1), [mockCache removeObjectsForKey:TransactionCacheKeyRemovedTransactions]);
+  OCMVerify(times(1), [mockCache clear]);
 }
 
 - (void)testTransactionsShouldBeCachedWhenNotObserving {

packages/in_app_purchase/in_app_purchase_storekit/ios/Classes/FIAPaymentQueueHandler.h

@@ -22,6 +22,27 @@ typedef void (^UpdatedDownloads)(NSArray<SKDownload *> *downloads);
 @property(NS_NONATOMIC_IOSONLY, weak, nullable) id<SKPaymentQueueDelegate> delegate API_AVAILABLE(
     ios(13.0), macos(10.15), watchos(6.2));
 
+/// Creates a new FIAPaymentQueueHandler initialized with an empty
+/// FIATransactionCache.
+///
+/// @param queue The SKPaymentQueue instance connected to the App Store and
+///              responsible for processing transactions.
+/// @param transactionsUpdated Callback method that is called each time the App
+///                            Store indicates transactions are updated.
+/// @param transactionsRemoved Callback method that is called each time the App
+///                            Store indicates transactions are removed.
+/// @param restoreTransactionFailed Callback method that is called each time
+///                                 the App Store indicates transactions failed
+///                                 to restore.
+/// @param restoreCompletedTransactionsFinished Callback method that is called
+///                                             each time the App Store
+///                                             indicates restoring of
+///                                             transactions has finished.
+/// @param shouldAddStorePayment Callback method that is called each time an
+///                              in-app purchase has been initiated from the
+///                              App Store.
+/// @param updatedDownloads Callback method that is called each time the App
+///                         Store indicates downloads are updated.
 - (instancetype)initWithQueue:(nonnull SKPaymentQueue *)queue
                      transactionsUpdated:(nullable TransactionsUpdated)transactionsUpdated
                       transactionRemoved:(nullable TransactionsRemoved)transactionsRemoved
@@ -35,6 +56,42 @@ typedef void (^UpdatedDownloads)(NSArray<SKDownload *> *downloads);
         "'initWithQueue:transactionsUpdated:transactionsRemoved:restoreTransactionsFinished:"
         "shouldAddStorePayment:updatedDownloads:transactionCache:' message instead.");
 
+/// Creates a new FIAPaymentQueueHandler.
+///
+/// The "transactionsUpdated", "transactionsRemoved" and "updatedDownloads"
+/// callbacks are only called while actively observing transactions. To start
+/// observing transactions send the "startObservingPaymentQueue" message.
+/// Sending the "stopObservingPaymentQueue" message will stop actively
+/// observing transactions. When transactions are not observed they are cached
+/// to the "transactionCache" and will be delivered via the
+/// "transactionsUpdated", "transactionsRemoved" and "updatedDownloads"
+/// callbacks as soon as the "startObservingPaymentQueue" message arrives.
+///
+/// Note: cached transactions that are not processed when the application is
+/// killed will be delivered again by the App Store as soon as the application
+/// starts again.
+///
+/// @param queue The SKPaymentQueue instance connected to the App Store and
+///              responsible for processing transactions.
+/// @param transactionsUpdated Callback method that is called each time the App
+///                            Store indicates transactions are updated.
+/// @param transactionsRemoved Callback method that is called each time the App
+///                            Store indicates transactions are removed.
+/// @param restoreTransactionFailed Callback method that is called each time
+///                                 the App Store indicates transactions failed
+///                                 to restore.
+/// @param restoreCompletedTransactionsFinished Callback method that is called
+///                                             each time the App Store
+///                                             indicates restoring of
+///                                             transactions has finished.
+/// @param shouldAddStorePayment Callback method that is called each time an
+///                              in-app purchase has been initiated from the
+///                              App Store.
+/// @param updatedDownloads Callback method that is called each time the App
+///                         Store indicates downloads are updated.
+/// @param transactionCache An empty [FIATransactionCache] instance that is
+///                         responsible for keeping track of transactions that
+///                         arrive when not actively observing transactions.
 - (instancetype)initWithQueue:(nonnull SKPaymentQueue *)queue
                      transactionsUpdated:(nullable TransactionsUpdated)transactionsUpdated
                       transactionRemoved:(nullable TransactionsRemoved)transactionsRemoved

packages/in_app_purchase/in_app_purchase_storekit/ios/Classes/FIAPaymentQueueHandler.m

@@ -45,7 +45,7 @@ @interface FIAPaymentQueueHandler ()
 /// client as soon as it starts observing. The Flutter client can start
 /// observing by sending a startObservingPaymentQueue message and stop by
 /// sending a stopObservingPaymentQueue message.
-@property(atomic, assign, readwrite) BOOL isObservingTransactions;
+@property(atomic, assign, readwrite, getter=isObservingTransactions) BOOL observingTransactions;
 
 @end
 
@@ -98,34 +98,39 @@ - (instancetype)initWithQueue:(nonnull SKPaymentQueue *)queue
 }
 
 - (void)startObservingPaymentQueue {
-  self.isObservingTransactions = true;
+  self.observingTransactions = YES;
 
   [self processCachedTransactions];
 }
 
 - (void)stopObservingPaymentQueue {
-  self.isObservingTransactions = false;
+  // Don't remove the transaction observer from the SKPaymentQueue instance as
+  // that will result in transactions being lost during the current application
+  // lifetime. Only setting the "observingTransactions" to "NO" ensures
+  // incoming transactions from the App Store are cached and delivered to the
+  // client as soon as it indicates it is ready to receive transactions by
+  // sending the "startObservingPaymentQueue" message.
+  self.observingTransactions = NO;
 }
 
 - (void)processCachedTransactions {
   NSArray *cachedObjects =
       [self.transactionCache getObjectsForKey:TransactionCacheKeyUpdatedTransactions];
   if (cachedObjects) {
     self.transactionsUpdated(cachedObjects);
-    [self.transactionCache removeObjectsForKey:TransactionCacheKeyUpdatedTransactions];
   }
 
   cachedObjects = [self.transactionCache getObjectsForKey:TransactionCacheKeyUpdatedDownloads];
   if (cachedObjects) {
     self.updatedDownloads(cachedObjects);
-    [self.transactionCache removeObjectsForKey:TransactionCacheKeyUpdatedDownloads];
   }
 
   cachedObjects = [self.transactionCache getObjectsForKey:TransactionCacheKeyRemovedTransactions];
   if (cachedObjects) {
     self.transactionsRemoved(cachedObjects);
-    [self.transactionCache removeObjectsForKey:TransactionCacheKeyRemovedTransactions];
   }
+
+  [self.transactionCache clear];
 }
 
 - (BOOL)addPayment:(SKPayment *)payment {
@@ -168,7 +173,7 @@ - (void)showPriceConsentIfNeeded {
 // state of transactions and finish as appropriate.
 - (void)paymentQueue:(SKPaymentQueue *)queue
     updatedTransactions:(NSArray<SKPaymentTransaction *> *)transactions {
-  if (!self.isObservingTransactions) {
+  if (!self.observingTransactions) {
     [_transactionCache addObjects:transactions forKey:TransactionCacheKeyUpdatedTransactions];
     return;
   }
@@ -180,7 +185,7 @@ - (void)paymentQueue:(SKPaymentQueue *)queue
 // Sent when transactions are removed from the queue (via finishTransaction:).
 - (void)paymentQueue:(SKPaymentQueue *)queue
     removedTransactions:(NSArray<SKPaymentTransaction *> *)transactions {
-  if (!self.isObservingTransactions) {
+  if (!self.observingTransactions) {
     [_transactionCache addObjects:transactions forKey:TransactionCacheKeyRemovedTransactions];
     return;
   }
@@ -202,7 +207,7 @@ - (void)paymentQueueRestoreCompletedTransactionsFinished:(SKPaymentQueue *)queue
 
 // Sent when the download state has changed.
 - (void)paymentQueue:(SKPaymentQueue *)queue updatedDownloads:(NSArray<SKDownload *> *)downloads {
-  if (!self.isObservingTransactions) {
+  if (!self.observingTransactions) {
     [_transactionCache addObjects:downloads forKey:TransactionCacheKeyUpdatedDownloads];
     return;
   }

packages/in_app_purchase/in_app_purchase_storekit/ios/Classes/FIATransactionCache.h

@@ -12,9 +12,9 @@ typedef NS_ENUM(NSUInteger, TransactionCacheKey) {
 
 @interface FIATransactionCache : NSObject
 
-/// Add objects to the transaction cache.
+/// Adds objects to the transaction cache.
 ///
-/// If the cache already contain an array of objects on the specified key, the supplied
+/// If the cache already contains an array of objects on the specified key, the supplied
 /// array will be appended to the existing array.
 - (void)addObjects:(NSArray *)objects forKey:(TransactionCacheKey)key;
 
@@ -23,8 +23,8 @@ typedef NS_ENUM(NSUInteger, TransactionCacheKey) {
 /// If there are no objects associated with the given key nil is returned.
 - (NSArray *)getObjectsForKey:(TransactionCacheKey)key;
 
-/// Remove objects to the transaction cache for the supplied key.
-- (void)removeObjectsForKey:(TransactionCacheKey)key;
+/// Removes all objects from the transaction cache.
+- (void)clear;
 
 @end
 

packages/in_app_purchase/in_app_purchase_storekit/ios/Classes/FIATransactionCache.m

@@ -33,8 +33,8 @@ - (NSArray *)getObjectsForKey:(TransactionCacheKey)key {
   return self.cache[@(key)];
 }
 
-- (void)removeObjectsForKey:(TransactionCacheKey)key {
-  [self.cache removeObjectForKey:@(key)];
+- (void)clear {
+  [self.cache removeAllObjects];
 }
 
 @end