➕ Add the success/failure handling from Dart side for Apple Pay

pay/example/ios/Podfile.lock

@@ -19,10 +19,10 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/pay_ios/ios"
 
 SPEC CHECKSUMS:
-  Flutter: 50d75fe2f02b26cc09d224853bb45737f8b3214a
-  integration_test: a1e7d09bd98eca2fc37aefd79d4f41ad37bdbbe5
+  Flutter: f04841e97a9d0b0a8025694d0796dd46242b2854
+  integration_test: 13825b8a9334a850581300559b8839134b124670
   pay_ios: 8c7beb9c61d885f3f51b61f75f8793023fc8843a
 
-PODFILE CHECKSUM: fc81e398f362bae88bdf55239bd5cf842faad39f
+PODFILE CHECKSUM: ef19549a9bc3046e7bb7d2fab4d021637c0c58a3
 
-COCOAPODS: 1.11.3
+COCOAPODS: 1.12.1

pay/example/ios/Runner/Info.plist

@@ -43,5 +43,7 @@
 	<false/>
 	<key>CADisableMinimumFrameDurationOnPhone</key>
 	<true/>
+	<key>UIApplicationSupportsIndirectInputEvents</key>
+	<true/>
 </dict>
 </plist>

pay/example/lib/main.dart

@@ -12,6 +12,7 @@
 /// See the License for the specific language governing permissions and
 /// limitations under the License.
 
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_localizations/flutter_localizations.dart';
 import 'package:pay/pay.dart';
@@ -44,6 +45,8 @@ class PayMaterialApp extends StatelessWidget {
         const Locale('es', ''),
         const Locale('de', ''),
       ],
+      theme: ThemeData.light(),
+      darkTheme: ThemeData.dark(),
       home: PaySampleApp(),
     );
   }
@@ -57,21 +60,32 @@ class PaySampleApp extends StatefulWidget {
 }
 
 class _PaySampleAppState extends State<PaySampleApp> {
+  final _applePayConfig = PaymentConfiguration.fromJsonString(
+    payment_configurations.defaultApplePay,
+  );
   late final Future<PaymentConfiguration> _googlePayConfigFuture;
+  late Pay _pay;
+
+  bool shouldPaymentSucceedOnIos = true;
 
   @override
   void initState() {
     super.initState();
-    _googlePayConfigFuture =
-        PaymentConfiguration.fromAsset('default_google_pay_config.json');
+    _googlePayConfigFuture = PaymentConfiguration.fromAsset(
+      'default_google_pay_config.json',
+    );
+    _pay = Pay({
+      PayProvider.apple_pay: _applePayConfig,
+    });
   }
 
   void onGooglePayResult(paymentResult) {
     debugPrint(paymentResult.toString());
   }
 
-  void onApplePayResult(paymentResult) {
+  void onApplePayResult(paymentResult) async {
     debugPrint(paymentResult.toString());
+    await _pay.updatePaymentStatus(shouldPaymentSucceedOnIos);
   }
 
   @override
@@ -126,23 +140,25 @@ class _PaySampleAppState extends State<PaySampleApp> {
           ),
           // Example pay button configured using an asset
           FutureBuilder<PaymentConfiguration>(
-              future: _googlePayConfigFuture,
-              builder: (context, snapshot) => snapshot.hasData
-                  ? GooglePayButton(
-                      paymentConfiguration: snapshot.data!,
-                      paymentItems: _paymentItems,
-                      type: GooglePayButtonType.buy,
-                      margin: const EdgeInsets.only(top: 15.0),
-                      onPaymentResult: onGooglePayResult,
-                      loadingIndicator: const Center(
-                        child: CircularProgressIndicator(),
-                      ),
-                    )
-                  : const SizedBox.shrink()),
+            future: _googlePayConfigFuture,
+            builder: (context, snapshot) => snapshot.hasData
+                ? GooglePayButton(
+                    paymentConfiguration: snapshot.data!,
+                    paymentItems: _paymentItems,
+                    type: GooglePayButtonType.buy,
+                    margin: const EdgeInsets.only(top: 15.0),
+                    onPaymentResult: onGooglePayResult,
+                    loadingIndicator: const Center(
+                      child: CircularProgressIndicator(),
+                    ),
+                  )
+                : const SizedBox.shrink(),
+          ),
           // Example pay button configured using a string
           ApplePayButton(
             paymentConfiguration: PaymentConfiguration.fromJsonString(
-                payment_configurations.defaultApplePay),
+              payment_configurations.defaultApplePay,
+            ),
             paymentItems: _paymentItems,
             style: ApplePayButtonStyle.black,
             type: ApplePayButtonType.buy,
@@ -152,6 +168,25 @@ class _PaySampleAppState extends State<PaySampleApp> {
               child: CircularProgressIndicator(),
             ),
           ),
+          // This allows you to control whether the payment shall succeed or not.
+          // This is only available on iOS.
+          // Usually you would want to wait for your backend to return a value,
+          // before you update the payment status.
+          if (defaultTargetPlatform == TargetPlatform.iOS)
+            Row(
+              mainAxisAlignment: MainAxisAlignment.spaceBetween,
+              children: [
+                Text('Should the payment succeed?'),
+                Switch.adaptive(
+                  value: shouldPaymentSucceedOnIos,
+                  onChanged: (value) {
+                    setState(() {
+                      shouldPaymentSucceedOnIos = value;
+                    });
+                  },
+                ),
+              ],
+            ),
           const SizedBox(height: 15)
         ],
       ),

pay/lib/src/pay.dart

@@ -31,14 +31,19 @@ class Pay {
 
   /// Creates an instance with a dictionary of [_configurations] and
   /// instantiates the [_payPlatform] to communicate with the native platforms.
-  Pay(this._configurations) : _payPlatform = PayMethodChannel();
+  Pay(this._configurations)
+      : _payPlatform = defaultTargetPlatform == TargetPlatform.iOS
+            ? IOSPayMethodChannel()
+            : PayMethodChannel();
 
   /// Alternative constructor to create a [Pay] object with a list of
   /// configurations in [String] format.
   @Deprecated(
       'Prefer to use [Pay({ [PayProvider]: [PaymentConfiguration] })]. Take a look at the readme to see examples')
   Pay.withAssets(List<String> configAssets)
-      : _payPlatform = PayMethodChannel() {
+      : _payPlatform = defaultTargetPlatform == TargetPlatform.iOS
+            ? IOSPayMethodChannel()
+            : PayMethodChannel() {
     _assetInitializationFuture = _loadConfigAssets(configAssets);
   }
 
@@ -76,6 +81,16 @@ class Pay {
         _configurations![provider]!, paymentItems);
   }
 
+  /// Update the payment status with the native platform.
+  /// Works only on iOS.
+  Future<void> updatePaymentStatus(bool isSuccess) async {
+    if (_payPlatform is IOSPayMethodChannel) {
+      await _assetInitializationFuture;
+      final iosPayPlatform = _payPlatform as IOSPayMethodChannel;
+      return iosPayPlatform.updatePaymentStatus(isSuccess);
+    }
+  }
+
   /// Verifies that the selected provider has been previously configured or
   /// throws otherwise.
   Future throwIfProviderIsNotDefined(PayProvider provider) async {

pay_ios/ios/Classes/PayPlugin.swift

@@ -23,6 +23,7 @@ public class PayPlugin: NSObject, FlutterPlugin {
   private static let methodChannelName = "plugins.flutter.io/pay_channel"
   private let methodUserCanPay = "userCanPay"
   private let methodShowPaymentSelector = "showPaymentSelector"
+  private let methodUpdatePaymentStatus = "updatePaymentStatus"
 
   private let paymentHandler = PaymentHandler()
 
@@ -48,6 +49,10 @@ public class PayPlugin: NSObject, FlutterPlugin {
         paymentConfiguration: arguments["payment_profile"] as! String,
         paymentItems: arguments["payment_items"] as! [[String: Any?]])
 
+    case methodUpdatePaymentStatus:
+      let isSuccess = call.arguments as! Bool
+      paymentHandler.updatePaymentStatus(isSuccess: isSuccess)
+
     default:
       result(FlutterMethodNotImplemented)
     }

pay_ios/ios/Classes/PaymentHandler.swift

@@ -36,6 +36,9 @@ enum PaymentHandlerStatus {
 /// paymentHandler.canMakePayments(stringArguments)
 /// ```
 class PaymentHandler: NSObject {
+
+  /// Holds the completion handler so it can be updated later on from the Flutter side.
+  var completionHandler: PaymentCompletionHandler?
 
   /// Holds the current status of the payment process.
   var paymentHandlerStatus: PaymentHandlerStatus!
@@ -169,6 +172,12 @@ class PaymentHandler: NSObject {
 
     return paymentRequest
   }
+
+  func updatePaymentStatus(isSuccess: Bool) {
+    // Call completion handler with the given success status
+    completionHandler?(isSuccess)
+    completionHandler = nil
+  }
 }
 
 /// Extension that implements the completion methods in the delegate to respond to user selection.
@@ -179,6 +188,11 @@ extension PaymentHandler: PKPaymentAuthorizationControllerDelegate {
   }
 
   func paymentAuthorizationController(_: PKPaymentAuthorizationController, didAuthorizePayment payment: PKPayment, handler completion: @escaping (PKPaymentAuthorizationResult) -> Void) {
+    // Store completion handler
+    completionHandler = { isSuccess in
+      let status: PKPaymentAuthorizationStatus = isSuccess ? .success : .failure
+      completion(PKPaymentAuthorizationResult(status: status, errors: nil))
+    }
 
     // Collect payment result or error and return if no payment was selected
     guard let paymentResultData = try? JSONSerialization.data(withJSONObject: payment.toDictionary()) else {
@@ -190,7 +204,6 @@ extension PaymentHandler: PKPaymentAuthorizationControllerDelegate {
     self.paymentResult(String(decoding: paymentResultData, as: UTF8.self))
 
     paymentHandlerStatus = .authorized
-    completion(PKPaymentAuthorizationResult(status: PKPaymentAuthorizationStatus.success, errors: nil))
   }
 
   func paymentAuthorizationControllerDidFinish(_ controller: PKPaymentAuthorizationController) {

pay_ios/lib/pay_ios.dart

@@ -5,4 +5,6 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 
+export 'src/ios_pay_channel.dart';
+
 part 'src/widgets/apple_pay_button.dart';

pay_ios/lib/src/ios_pay_channel.dart

@@ -0,0 +1,12 @@
+/// Copyright 2023 Google LLC.
+/// SPDX-License-Identifier: Apache-2.0
+
+import 'package:pay_platform_interface/pay_channel.dart';
+
+/// This implements the iOS specific functionality of the Pay plugin.
+class IOSPayMethodChannel extends PayMethodChannel {
+  /// Update the payment status with the native platform.
+  Future<void> updatePaymentStatus(bool isSuccess) async {
+    return channel.invokeMethod('updatePaymentStatus', isSuccess);
+  }
+}

pay_ios/test/src/ios_pay_channel_test.dart

@@ -0,0 +1,57 @@
+/// Copyright 2023 Google LLC
+///
+/// Licensed under the Apache License, Version 2.0 (the "License");
+/// you may not use this file except in compliance with the License.
+/// You may obtain a copy of the License at
+///
+///     https://www.apache.org/licenses/LICENSE-2.0
+///
+/// Unless required by applicable law or agreed to in writing, software
+/// distributed under the License is distributed on an "AS IS" BASIS,
+/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+/// See the License for the specific language governing permissions and
+/// limitations under the License.
+
+import 'package:flutter/services.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:pay_ios/pay_ios.dart';
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  late final IOSPayMethodChannel _payChannel;
+
+  setUpAll(() async {
+    _payChannel = IOSPayMethodChannel();
+  });
+
+  group('Verify channel I/O for', () {
+    final log = <MethodCall>[];
+    const testResponses = <String, Object?>{
+      'updatePaymentStatus': null,
+    };
+
+    setUp(() {
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
+          .setMockMethodCallHandler(
+        _payChannel.channel,
+        (MethodCall methodCall) async {
+          log.add(methodCall);
+          final response = testResponses[methodCall.method];
+          if (response is Exception) {
+            return Future<Object?>.error(response);
+          }
+          return Future<Object?>.value(response);
+        },
+      );
+    });
+
+    test('updatePaymentStatus', () async {
+      await _payChannel.updatePaymentStatus(true);
+      expect(
+        log,
+        <Matcher>[isMethodCall('updatePaymentStatus', arguments: true)],
+      );
+    });
+  });
+}

pay_platform_interface/lib/pay_channel.dart

@@ -34,7 +34,7 @@ import 'pay_platform_interface.dart';
 /// ```
 class PayMethodChannel extends PayPlatform {
   // The channel used to send messages down the native pipe.
-  final MethodChannel _channel =
+  final MethodChannel channel =
       const MethodChannel('plugins.flutter.io/pay_channel');
 
   /// Determines whether a user can pay with the provider in the configuration.
@@ -43,7 +43,7 @@ class PayMethodChannel extends PayPlatform {
   /// returns a boolean for the [paymentConfiguration] specified.
   @override
   Future<bool> userCanPay(PaymentConfiguration paymentConfiguration) async {
-    return await _channel.invokeMethod(
+    return await channel.invokeMethod(
         'userCanPay', jsonEncode(await paymentConfiguration.parameterMap()));
   }
 
@@ -58,7 +58,7 @@ class PayMethodChannel extends PayPlatform {
     PaymentConfiguration paymentConfiguration,
     List<PaymentItem> paymentItems,
   ) async {
-    final paymentResult = await _channel.invokeMethod('showPaymentSelector', {
+    final paymentResult = await channel.invokeMethod('showPaymentSelector', {
       'payment_profile': jsonEncode(await paymentConfiguration.parameterMap()),
       'payment_items': paymentItems.map((item) => item.toMap()).toList(),
     });

pay_platform_interface/test/pay_channel_test.dart

@@ -17,14 +17,12 @@
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:pay_platform_interface/core/payment_configuration.dart';
-
 import 'package:pay_platform_interface/pay_channel.dart';
 
 void main() {
   TestWidgetsFlutterBinding.ensureInitialized();
 
   late final PayMethodChannel _mobilePlatform;
-  const channel = MethodChannel('plugins.flutter.io/pay_channel');
 
   const _providerApplePay = PayProvider.apple_pay;
   final _payConfigString =
@@ -43,14 +41,18 @@ void main() {
     };
 
     setUp(() {
-      channel.setMockMethodCallHandler((MethodCall methodCall) async {
-        log.add(methodCall);
-        final response = testResponses[methodCall.method];
-        if (response is Exception) {
-          return Future<Object>.error(response);
-        }
-        return Future<Object>.value(response);
-      });
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
+          .setMockMethodCallHandler(
+        _mobilePlatform.channel,
+        (MethodCall methodCall) async {
+          log.add(methodCall);
+          final response = testResponses[methodCall.method];
+          if (response is Exception) {
+            return Future<Object>.error(response);
+          }
+          return Future<Object>.value(response);
+        },
+      );
     });
 
     test('userCanPay', () async {
@@ -75,7 +77,8 @@ void main() {
     });
 
     tearDown(() async {
-      channel.setMockMethodCallHandler(null);
+      TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
+          .setMockMethodCallHandler(_mobilePlatform.channel, null);
       log.clear();
     });
   });