Migrate to enum for alternative billing only and play billing

packages/in_app_purchase/in_app_purchase_android/android/src/main/java/io/flutter/plugins/inapppurchase/BillingClientFactory.java

@@ -17,12 +17,11 @@ interface BillingClientFactory {
    *
    * @param context The context used to create the {@link BillingClient}.
    * @param channel The method channel used to create the {@link BillingClient}.
-   * @param enableAlternativeBillingOnly Enables the ability to offer alternative billing without
-   *     user choice to use Google Play billing.
+   * @param billingChoiceMode Enables the ability to offer alternative billing or Google Play billing.
    * @return The {@link BillingClient} object that is created.
    */
   BillingClient createBillingClient(
       @NonNull Context context,
       @NonNull MethodChannel channel,
-      boolean enableAlternativeBillingOnly);
+      int billingChoiceMode);
 }

packages/in_app_purchase/in_app_purchase_android/android/src/main/java/io/flutter/plugins/inapppurchase/BillingClientFactoryImpl.java

@@ -8,6 +8,7 @@
 import androidx.annotation.NonNull;
 import com.android.billingclient.api.BillingClient;
 import io.flutter.plugin.common.MethodChannel;
+import io.flutter.plugins.inapppurchase.MethodCallHandlerImpl.BillingChoiceMode;
 
 /** The implementation for {@link BillingClientFactory} for the plugin. */
 final class BillingClientFactoryImpl implements BillingClientFactory {
@@ -16,9 +17,9 @@ final class BillingClientFactoryImpl implements BillingClientFactory {
   public BillingClient createBillingClient(
       @NonNull Context context,
       @NonNull MethodChannel channel,
-      boolean enableAlternativeBillingOnly) {
+      int billingChoiceMode) {
     BillingClient.Builder builder = BillingClient.newBuilder(context).enablePendingPurchases();
-    if (enableAlternativeBillingOnly) {
+    if (billingChoiceMode == BillingChoiceMode.ALTERNATIVE_BILLING_ONLY) {
       // https://developer.android.com/google/play/billing/alternative/alternative-billing-without-user-choice-in-app
       builder.enableAlternativeBillingOnly();
     }

packages/in_app_purchase/in_app_purchase_android/android/src/main/java/io/flutter/plugins/inapppurchase/MethodCallHandlerImpl.java

@@ -35,6 +35,7 @@
 import com.android.billingclient.api.QueryPurchasesParams;
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
+import java.lang.annotation.RetentionPolicy;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -82,11 +83,16 @@ static final class MethodArgs {
     // Key for an int argument passed into startConnection
     static final String HANDLE = "handle";
     // Key for a boolean argument passed into startConnection.
-    static final String ENABLE_ALTERNATIVE_BILLING_ONLY = "enableAlternativeBillingOnly";
+    static final String BILLING_CHOICE_MODE = "billingChoiceMode";
 
     private MethodArgs() {}
   }
 
+  static final class BillingChoiceMode {
+    static final int PLAY_BILLING_ONLY = 0;
+    static final int ALTERNATIVE_BILLING_ONLY = 1;
+  }
+
   // TODO(gmackall): Replace uses of deprecated ProrationMode enum values with new
   // ReplacementMode enum values.
   // https://github.com/flutter/flutter/issues/128957.
@@ -167,12 +173,11 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull MethodChannel.Result
         break;
       case MethodNames.START_CONNECTION:
         final int handle = (int) call.argument(MethodArgs.HANDLE);
-        boolean enableAlternativeBillingOnly = false;
-        if (call.hasArgument(MethodArgs.ENABLE_ALTERNATIVE_BILLING_ONLY)
-            && (boolean) call.argument(MethodArgs.ENABLE_ALTERNATIVE_BILLING_ONLY)) {
-          enableAlternativeBillingOnly = true;
+        int billingChoiceMode = BillingChoiceMode.PLAY_BILLING_ONLY;
+        if (call.hasArgument(MethodArgs.BILLING_CHOICE_MODE)) {
+          billingChoiceMode = call.argument(MethodArgs.BILLING_CHOICE_MODE);
         }
-        startConnection(handle, result, enableAlternativeBillingOnly);
+        startConnection(handle, result, billingChoiceMode);
         break;
       case MethodNames.END_CONNECTION:
         endConnection(result);
@@ -497,11 +502,11 @@ private void getConnectionState(final MethodChannel.Result result) {
   }
 
   private void startConnection(
-      final int handle, final MethodChannel.Result result, boolean enableAlternativeBillingOnly) {
+      final int handle, final MethodChannel.Result result, int billingChoiceMode) {
     if (billingClient == null) {
       billingClient =
           billingClientFactory.createBillingClient(
-              applicationContext, methodChannel, enableAlternativeBillingOnly);
+              applicationContext, methodChannel, billingChoiceMode);
     }
 
     billingClient.startConnection(

packages/in_app_purchase/in_app_purchase_android/android/src/test/java/io/flutter/plugins/inapppurchase/MethodCallHandlerTest.java

@@ -77,6 +77,7 @@
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.MethodChannel.Result;
+import io.flutter.plugins.inapppurchase.MethodCallHandlerImpl.BillingChoiceMode;
 import io.flutter.plugins.inapppurchase.MethodCallHandlerImpl.MethodArgs;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
@@ -110,9 +111,9 @@ public class MethodCallHandlerTest {
   public void setUp() {
     MockitoAnnotations.openMocks(this);
     // Use the same client no matter if alternative billing is enabled or not.
-    when(factory.createBillingClient(context, mockMethodChannel, false))
+    when(factory.createBillingClient(context, mockMethodChannel, BillingChoiceMode.PLAY_BILLING_ONLY))
         .thenReturn(mockBillingClient);
-    when(factory.createBillingClient(context, mockMethodChannel, true))
+    when(factory.createBillingClient(context, mockMethodChannel, BillingChoiceMode.ALTERNATIVE_BILLING_ONLY))
         .thenReturn(mockBillingClient);
     methodChannelHandler = new MethodCallHandlerImpl(activity, context, mockMethodChannel, factory);
     when(mockActivityPluginBinding.getActivity()).thenReturn(activity);
@@ -157,9 +158,9 @@ public void isReady_clientDisconnected() {
 
   @Test
   public void startConnection() {
-    ArgumentCaptor<BillingClientStateListener> captor = mockStartConnection(false);
+    ArgumentCaptor<BillingClientStateListener> captor = mockStartConnection(BillingChoiceMode.PLAY_BILLING_ONLY);
     verify(result, never()).success(any());
-    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, false);
+    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, BillingChoiceMode.PLAY_BILLING_ONLY);
 
     BillingResult billingResult =
         BillingResult.newBuilder()
@@ -173,9 +174,9 @@ public void startConnection() {
 
   @Test
   public void startConnectionAlternativeBillingOnly() {
-    ArgumentCaptor<BillingClientStateListener> captor = mockStartConnection(true);
+    ArgumentCaptor<BillingClientStateListener> captor = mockStartConnection(BillingChoiceMode.ALTERNATIVE_BILLING_ONLY);
     verify(result, never()).success(any());
-    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, true);
+    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, BillingChoiceMode.ALTERNATIVE_BILLING_ONLY);
 
     BillingResult billingResult =
         BillingResult.newBuilder()
@@ -200,7 +201,7 @@ public void startConnectionAlternativeBillingUnset() {
 
     methodChannelHandler.onMethodCall(call, result);
     verify(result, never()).success(any());
-    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, false);
+    verify(factory, times(1)).createBillingClient(context, mockMethodChannel, BillingChoiceMode.PLAY_BILLING_ONLY);
 
     BillingResult billingResult =
         BillingResult.newBuilder()
@@ -1049,14 +1050,14 @@ public void isFutureSupported_false() {
   }
 
   private ArgumentCaptor<BillingClientStateListener> mockStartConnection() {
-    return mockStartConnection(false);
+    return mockStartConnection(BillingChoiceMode.PLAY_BILLING_ONLY);
   }
 
   private ArgumentCaptor<BillingClientStateListener> mockStartConnection(
-      boolean enableAlternativeBillingOnly) {
+      int billingChoiceMode) {
     Map<String, Object> arguments = new HashMap<>();
     arguments.put(MethodArgs.HANDLE, 1);
-    arguments.put(MethodArgs.ENABLE_ALTERNATIVE_BILLING_ONLY, enableAlternativeBillingOnly);
+    arguments.put(MethodArgs.BILLING_CHOICE_MODE, billingChoiceMode);
     MethodCall call = new MethodCall(START_CONNECTION, arguments);
     ArgumentCaptor<BillingClientStateListener> captor =
         ArgumentCaptor.forClass(BillingClientStateListener.class);

packages/in_app_purchase/in_app_purchase_android/example/lib/main.dart

@@ -286,7 +286,7 @@ class _MyAppState extends State<_MyApp> {
           final InAppPurchaseAndroidPlatformAddition addition =
               InAppPurchasePlatformAddition.instance!
                   as InAppPurchaseAndroidPlatformAddition;
-          unawaited(addition.setAlternativeBillingOnlyState(true));
+          unawaited(addition.setBillingChoice(BillingChoiceMode.alternativeBillingOnly));
         },
         child: const Text('setAlternativeBillingOnlyState true'),
       ),

packages/in_app_purchase/in_app_purchase_android/lib/src/billing_client_wrappers/billing_client_manager.dart

@@ -32,11 +32,8 @@ class BillingClientManager {
   /// Creates the [BillingClientManager].
   ///
   /// Immediately initializes connection to the underlying [BillingClient].
-  /// [enableAlternativeBillingOnly] if customers should only see alternitive billing.
-  ///
-  /// Callers need to check if AlternativeBillingOnly is available by calling
-  /// [BillingClientWrapper.isAlternativeBillingOnlyAvailable] first.
-  BillingClientManager() : _enableAlternativeBillingOnly = false {
+  BillingClientManager()
+      : _billingChoiceMode = BillingChoiceMode.playBillingOnly {
     _connect();
   }
 
@@ -57,7 +54,7 @@ class BillingClientManager {
   final StreamController<PurchasesResultWrapper> _purchasesUpdatedController =
       StreamController<PurchasesResultWrapper>.broadcast();
 
-  bool _enableAlternativeBillingOnly;
+  BillingChoiceMode _billingChoiceMode;
   bool _isConnecting = false;
   bool _isDisposed = false;
 
@@ -124,10 +121,14 @@ class BillingClientManager {
     _purchasesUpdatedController.close();
   }
 
-  /// Ends connection to [BillingClient] and reconnects with [alternativeBillingState].
-  Future<void> reconnectWithAlternativeBillingOnlyState(
-      bool alternativeBillingOnlyState) async {
-    _enableAlternativeBillingOnly = alternativeBillingOnlyState;
+  /// Ends connection to [BillingClient] and reconnects with [billingChoiceMode].
+  ///
+  /// Callers need to check if [BillingChoiceMode.alternativeBillingOnly] is
+  /// available by calling [BillingClientWrapper.isAlternativeBillingOnlyAvailable]
+  /// first.
+  Future<void> reconnectWithBillingChoiceMode(
+      BillingChoiceMode billingChoiceMode) async {
+    _billingChoiceMode = billingChoiceMode;
     // Ends connection and triggers OnBillingServiceDisconnected, which causes reconnect;
     await client.endConnection();
     await _connect();
@@ -147,7 +148,7 @@ class BillingClientManager {
     _readyFuture = Future<void>.sync(() async {
       await client.startConnection(
           onBillingServiceDisconnected: _connect,
-          enableAlternativeBillingOnly: _enableAlternativeBillingOnly);
+          billingChoiceMode: _billingChoiceMode);
       _isConnecting = false;
     });
     return _readyFuture;

packages/in_app_purchase/in_app_purchase_android/lib/src/billing_client_wrappers/billing_client_wrapper.dart

@@ -111,7 +111,8 @@ class BillingClient {
   /// one doesn't already exist.
   Future<BillingResultWrapper> startConnection(
       {required OnBillingServiceDisconnected onBillingServiceDisconnected,
-      bool enableAlternativeBillingOnly = false}) async {
+      BillingChoiceMode billingChoiceMode =
+          BillingChoiceMode.playBillingOnly}) async {
     final List<Function> disconnectCallbacks =
         _callbacks[_kOnBillingServiceDisconnected] ??= <Function>[];
     disconnectCallbacks.add(onBillingServiceDisconnected);
@@ -120,7 +121,7 @@ class BillingClient {
                 'BillingClient#startConnection(BillingClientStateListener)',
                 <String, dynamic>{
               'handle': disconnectCallbacks.length - 1,
-              'enableAlternativeBillingOnly': enableAlternativeBillingOnly,
+              'billingChoiceMode': billingChoiceMode,
             })) ??
         <String, dynamic>{});
   }
@@ -487,6 +488,21 @@ enum BillingResponse {
   networkError,
 }
 
+/// Plugin concept to cover billing modes.
+///
+/// [playBillingOnly] (google play billing only).
+/// [alternativeBillingOnly] (app provided billing with reporting to play).
+@JsonEnum(alwaysCreate: true)
+enum BillingChoiceMode {
+  /// Billing through google play. Default state.
+  @JsonValue(0)
+  playBillingOnly,
+
+  /// Billing through app provided flow.
+  @JsonValue(1)
+  alternativeBillingOnly,
+}
+
 /// Serializer for [BillingResponse].
 ///
 /// Use these in `@JsonSerializable()` classes by annotating them with

packages/in_app_purchase/in_app_purchase_android/lib/src/in_app_purchase_android_platform_addition.dart

@@ -183,13 +183,13 @@ class InAppPurchaseAndroidPlatformAddition
   /// Disconnects, Sets AlternativeBillingOnly to true, and recoonects to
   /// the [BillingClient].
   ///
-  /// [alternativeBillingOnlyState] true will enable alternative billing only.
+  /// [BillingChoiceMode.playBillingOnly] is the default state used.
+  /// [BillingChoiceMode.alternativeBillingOnly] will enable alternative billing only.
   ///
   /// Play apis have requirements for when this method can be called.
   /// See: https://developer.android.com/google/play/billing/alternative/alternative-billing-without-user-choice-in-app
-  Future<void> setAlternativeBillingOnlyState(
-      bool alternativeBillingOnlyState) {
+  Future<void> setBillingChoice(BillingChoiceMode billingChoiceMode) {
     return _billingClientManager
-        .reconnectWithAlternativeBillingOnlyState(alternativeBillingOnlyState);
+        .reconnectWithBillingChoiceMode(billingChoiceMode);
   }
 }

packages/in_app_purchase/in_app_purchase_android/test/billing_client_wrappers/billing_client_manager_test.dart

@@ -81,13 +81,14 @@ void main() {
       expect(stubPlatform.countPreviousCalls(startConnectionCall), equals(2));
     });
 
-    test('re-connects when host calls reconnectWithAlternativeBillingOnlyState',
+    test('re-connects when host calls reconnectWithBillingChoiceMode',
         () async {
       connectedCompleter.complete();
       // Ensures all asynchronous connected code finishes.
       await manager.runWithClientNonRetryable((_) async {});
 
-      await manager.reconnectWithAlternativeBillingOnlyState(true);
+      await manager.reconnectWithBillingChoiceMode(
+          BillingChoiceMode.alternativeBillingOnly);
       // Verify that connection was ended.
       expect(stubPlatform.countPreviousCalls(endConnectionCall), equals(1));
 

packages/in_app_purchase/in_app_purchase_android/test/billing_client_wrappers/billing_client_wrapper_test.dart

@@ -127,7 +127,7 @@ void main() {
       );
       await billingClient.startConnection(
           onBillingServiceDisconnected: () {},
-          enableAlternativeBillingOnly: true);
+          billingChoiceMode: BillingChoiceMode.alternativeBillingOnly);
       final MethodCall call = stubPlatform.previousCallMatching(methodName);
       expect(
           call.arguments,

packages/in_app_purchase/in_app_purchase_android/test/in_app_purchase_android_platform_addition_test.dart

@@ -87,15 +87,15 @@ void main() {
 
   group('setAlternativeBillingOnlyState', () {
     late Map<Object?, Object?> arguments;
-    test('setAlternativeBillingOnlyState true', () async {
+    test('setAlternativeBillingOnlyState', () async {
       stubPlatform.reset();
       stubPlatform.addResponse(
         name: startConnectionCall,
         additionalStepBeforeReturn: (dynamic value) =>
             arguments = value as Map<dynamic, dynamic>,
       );
       stubPlatform.addResponse(name: endConnectionCall);
-      await iapAndroidPlatformAddition.setAlternativeBillingOnlyState(true);
+      await iapAndroidPlatformAddition.setBillingChoice(BillingChoiceMode.alternativeBillingOnly);
 
       /// Fake the disconnect that we would expect from a endConnectionCall.
       await manager.client.callHandler(
@@ -104,18 +104,18 @@ void main() {
       );
       // Verify that after connection ended reconnect was called.
       expect(stubPlatform.countPreviousCalls(startConnectionCall), equals(2));
-      expect(arguments['enableAlternativeBillingOnly'], isTrue);
+      expect(arguments['billingChoiceMode'], BillingChoiceMode.alternativeBillingOnly);
     });
 
-    test('setAlternativeBillingOnlyState false', () async {
+    test('setPlayBillingState', () async {
       stubPlatform.reset();
       stubPlatform.addResponse(
         name: startConnectionCall,
         additionalStepBeforeReturn: (dynamic value) =>
             arguments = value as Map<dynamic, dynamic>,
       );
       stubPlatform.addResponse(name: endConnectionCall);
-      await iapAndroidPlatformAddition.setAlternativeBillingOnlyState(false);
+      await iapAndroidPlatformAddition.setBillingChoice(BillingChoiceMode.playBillingOnly);
 
       /// Fake the disconnect that we would expect from a endConnectionCall.
       await manager.client.callHandler(
@@ -124,7 +124,7 @@ void main() {
       );
       // Verify that after connection ended reconnect was called.
       expect(stubPlatform.countPreviousCalls(startConnectionCall), equals(2));
-      expect(arguments['enableAlternativeBillingOnly'], isFalse);
+      expect(arguments['billingChoiceMode'], BillingChoiceMode.playBillingOnly);
     });
   });