[in_app_purchase] migrate playing billing library to v3 #3636

cyanglaz · 2021-02-26T00:36:40Z

This PR migrates the play billing library to V3. Several breaking changes are introduced due to the breaking changes in PBL v3.

Fixes flutter/flutter#75204

The release note can be found here, which can be used as a reference for updated APIs in this PR. https://developer.android.com/google/play/billing/release-notes#3-0

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

cyanglaz · 2021-02-26T03:37:59Z

packages/in_app_purchase/android/build.gradle

    testImplementation 'junit:junit:4.12'
-    testImplementation 'org.mockito:mockito-core:2.17.0'
+    testImplementation 'org.mockito:mockito-core:3.6.0'


This is required to mock the objects in the new PBL.

cyanglaz · 2021-02-26T03:38:53Z

...xample/android/app/src/test/java/io/flutter/plugins/inapppurchase/MethodCallHandlerTest.java

@@ -286,7 +289,6 @@ public void launchBillingFlow_ok_null_AccountId() {
    verify(mockBillingClient).launchBillingFlow(any(), billingFlowParamsCaptor.capture());
    BillingFlowParams params = billingFlowParamsCaptor.getValue();
    assertEquals(params.getSku(), skuId);
-    assertNull(params.getAccountId());


getAccountId is not available anymore so we can't really test this value, however, we can still test if the call crashes, so ill leave the test here

Can you rename the test then, to better explain what it's doing now? (Probably needs a comment in addition to a new name.)

stuartmorgan-g

We don't need any new tests to cover new functionality related to the added arguments?

stuartmorgan-g · 2021-02-26T17:14:11Z

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

@@ -155,8 +155,13 @@ class BillingClient {
  /// The [skuDetails] needs to have already been fetched in a [querySkuDetails]
  /// call. The [accountId] is an optional hashed string associated with the user
  /// that's unique to your app. It's used by Google to detect unusual behavior.
-  /// Do not pass in a cleartext [accountId], use your developer ID, or use the
-  /// user's Google ID for this field.
+  /// Do not pass in a cleartext [accountId], Do not use this field to store any Personally Identifiable Information (PII)


Nit: s/Do not use/and do not use/

stuartmorgan-g · 2021-02-26T17:14:36Z

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

+  /// such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked.
+  /// Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play.
+  ///
+  /// Specifies an optional [obfuscatedProfileId]  that is uniquely associated with the user's profile in your app.


Nit: Fix double space after ]

stuartmorgan-g · 2021-02-26T17:17:19Z

packages/in_app_purchase/CHANGELOG.md

+
+* Migrate to Google Billing Library 3.0
+  * Add `obfuscatedProfileId`, `purchaseToken` in [BillingClientWrapper.launchBillingFlow].
+  * Removed `developerPayload` in [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase].


These aren't breaking changes?

Oh they are. Fixed

stuartmorgan-g · 2021-02-26T17:17:47Z

packages/in_app_purchase/CHANGELOG.md

+  * Add `obfuscatedProfileId`, `purchaseToken` in [BillingClientWrapper.launchBillingFlow].
+  * Removed `developerPayload` in [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase].
+  * **Breaking Change**
+    * Removed `isRewarded` from [SkuDetailsWrapper].


Is there any useful context to provide about why they are removed? E.g., link to discussion of removal in the SDK?

stuartmorgan-g · 2021-02-26T17:19:32Z

...xample/android/app/src/test/java/io/flutter/plugins/inapppurchase/MethodCallHandlerTest.java

@@ -286,7 +289,6 @@ public void launchBillingFlow_ok_null_AccountId() {
    verify(mockBillingClient).launchBillingFlow(any(), billingFlowParamsCaptor.capture());
    BillingFlowParams params = billingFlowParamsCaptor.getValue();
    assertEquals(params.getSku(), skuId);
-    assertNull(params.getAccountId());


Can you rename the test then, to better explain what it's doing now? (Probably needs a comment in addition to a new name.)

stuartmorgan-g · 2021-02-26T17:20:25Z

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

@@ -171,25 +176,31 @@ class BillingClient {
  /// [`BillingFlowParams`](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams)
  /// instance by [setting the given
  /// skuDetails](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder.html#setskudetails)
-  /// and [the given
-  /// accountId](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder.html#setAccountId(java.lang.String)).
+  /// , [the given


Nit: this is hard to read; let's put the comma on the previous line.

stuartmorgan-g · 2021-02-26T17:20:45Z

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

  ///
  /// When this method is called to purchase a subscription, an optional `oldSku`
  /// can be passed in. This will tell Google Play that rather than purchasing a new subscription,
  /// the user needs to upgrade/downgrade the existing subscription.
-  /// The [oldSku](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setoldsku) is the SKU id that the user is upgrading or downgrading from.
+  /// The [oldSku](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setoldsku) and [purchaseToken] are the SKU id and purchase token that the user is upgrading or downgrading from.
+  /// [purchaseToken] must not be `null` if [oldSku] is not `null`.


This should be asserted.

stuartmorgan-g · 2021-02-26T17:22:36Z

packages/in_app_purchase/lib/src/billing_client_wrappers/purchase_wrapper.dart

@@ -120,6 +120,8 @@ class PurchaseWrapper {
  /// The payload specified by the developer when the purchase was acknowledged or consumed.
  ///
  /// The value is `null` if it wasn't specified when the purchase was acknowledged or consumed.
+  /// The `developerPayload` is removed from [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase]
+  /// after plugin version `0.5.0`. As a result, this will be `null` for new purchases happened after `0.5.0`.


s/happened after/that happen after updating to/

stuartmorgan-g · 2021-02-26T17:23:24Z

packages/in_app_purchase/lib/src/billing_client_wrappers/sku_details_wrapper.dart

-  final String introductoryPriceCycles;
+  /// The number of subscription billing periods for which the user will be given the introductory price, such as 3.
+  /// Returns 0 if the SKU is not a subscription or doesn't have an introductory period.
+  /// Returns -1 if the value is not available.


What does "not available" mean as distinct from "doesn't have an introductory period"?

Should be the same. Fixed.

cyanglaz

@stuartmorgan Updated per your comments PTAL

cyanglaz · 2021-02-26T17:28:53Z

packages/in_app_purchase/CHANGELOG.md

+
+* Migrate to Google Billing Library 3.0
+  * Add `obfuscatedProfileId`, `purchaseToken` in [BillingClientWrapper.launchBillingFlow].
+  * Removed `developerPayload` in [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase].


Oh they are. Fixed

cyanglaz · 2021-02-26T17:36:30Z

packages/in_app_purchase/CHANGELOG.md

+  * Add `obfuscatedProfileId`, `purchaseToken` in [BillingClientWrapper.launchBillingFlow].
+  * Removed `developerPayload` in [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase].
+  * **Breaking Change**
+    * Removed `isRewarded` from [SkuDetailsWrapper].


cyanglaz · 2021-02-26T17:38:45Z

...xample/android/app/src/test/java/io/flutter/plugins/inapppurchase/MethodCallHandlerTest.java

@@ -286,7 +289,6 @@ public void launchBillingFlow_ok_null_AccountId() {
    verify(mockBillingClient).launchBillingFlow(any(), billingFlowParamsCaptor.capture());
    BillingFlowParams params = billingFlowParamsCaptor.getValue();
    assertEquals(params.getSku(), skuId);
-    assertNull(params.getAccountId());


cyanglaz · 2021-02-26T17:39:38Z

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

@@ -155,8 +155,13 @@ class BillingClient {
  /// The [skuDetails] needs to have already been fetched in a [querySkuDetails]
  /// call. The [accountId] is an optional hashed string associated with the user
  /// that's unique to your app. It's used by Google to detect unusual behavior.
-  /// Do not pass in a cleartext [accountId], use your developer ID, or use the
-  /// user's Google ID for this field.
+  /// Do not pass in a cleartext [accountId], Do not use this field to store any Personally Identifiable Information (PII)


cyanglaz · 2021-02-26T17:39:44Z

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

+  /// such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked.
+  /// Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play.
+  ///
+  /// Specifies an optional [obfuscatedProfileId]  that is uniquely associated with the user's profile in your app.


cyanglaz · 2021-02-26T17:40:39Z

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

@@ -171,25 +176,31 @@ class BillingClient {
  /// [`BillingFlowParams`](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams)
  /// instance by [setting the given
  /// skuDetails](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder.html#setskudetails)
-  /// and [the given
-  /// accountId](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder.html#setAccountId(java.lang.String)).
+  /// , [the given


cyanglaz · 2021-02-26T17:47:52Z

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

  ///
  /// When this method is called to purchase a subscription, an optional `oldSku`
  /// can be passed in. This will tell Google Play that rather than purchasing a new subscription,
  /// the user needs to upgrade/downgrade the existing subscription.
-  /// The [oldSku](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setoldsku) is the SKU id that the user is upgrading or downgrading from.
+  /// The [oldSku](https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setoldsku) and [purchaseToken] are the SKU id and purchase token that the user is upgrading or downgrading from.
+  /// [purchaseToken] must not be `null` if [oldSku] is not `null`.


cyanglaz · 2021-02-26T17:48:23Z

packages/in_app_purchase/lib/src/billing_client_wrappers/purchase_wrapper.dart

@@ -120,6 +120,8 @@ class PurchaseWrapper {
  /// The payload specified by the developer when the purchase was acknowledged or consumed.
  ///
  /// The value is `null` if it wasn't specified when the purchase was acknowledged or consumed.
+  /// The `developerPayload` is removed from [BillingClientWrapper.acknowledgePurchase], [BillingClientWrapper.consumeAsync], [InAppPurchaseConnection.completePurchase], [InAppPurchaseConnection.consumePurchase]
+  /// after plugin version `0.5.0`. As a result, this will be `null` for new purchases happened after `0.5.0`.


cyanglaz · 2021-02-26T17:50:46Z

packages/in_app_purchase/lib/src/billing_client_wrappers/sku_details_wrapper.dart

-  final String introductoryPriceCycles;
+  /// The number of subscription billing periods for which the user will be given the introductory price, such as 3.
+  /// Returns 0 if the SKU is not a subscription or doesn't have an introductory period.
+  /// Returns -1 if the value is not available.


Should be the same. Fixed.

stuartmorgan-g

LGTM with final nit.

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

…ter/plugins#3636)

…ter/plugins#3636) (#77008)

* master: Adopt Xcode 12 for podspec lints (flutter#3653) Run static analyzer during xctest (flutter#3667) [google_maps_flutter_web] update min flutter sdk version to 1.20.0 (flutter#3662) [image_picker] Run CocoaPods iOS tests in RunnerUITests target (flutter#3663) [webview_flutter] Run CocoaPods iOS tests in RunnerUITests target (flutter#3664) [device_info] Enable NNBD for unit test (flutter#3658) remove unused plugin (flutter#3661) [android_intent] move unit test to nullsafety (flutter#3659) [url_launcher] Migrate unit tests to NNBD (flutter#3657) [share] Migrate unit tests to null-safety. (flutter#3660) [connectivity_for_web] Migration to null-safety. (flutter#3652) [camera] Stable release for null safety. (flutter#3641) [in_app_purchase] fix plugin version (flutter#3654) Move plugin tool tests over (flutter#3606) [in_app_purchase] migrate playing billing library to v3 (flutter#3636) Update plugin_platform_interface min version (flutter#3650) # Conflicts: # packages/webview_flutter/CHANGELOG.md # packages/webview_flutter/example/ios/Runner.xcodeproj/project.pbxproj

Chris Yang added 4 commits February 25, 2021 16:10

initial merge

d73dcc5

auto generate

ea34ac4

remove getIntroductoryPriceCycles

d6e49d3

format

34ecb8b

cyanglaz requested a review from LHLL as a code owner February 26, 2021 00:36

google-cla bot added the cla: yes label Feb 26, 2021

github-actions bot added p: in_app_purchase platform-android labels Feb 26, 2021

revert cirrus change

65a3cbd

cyanglaz mentioned this pull request Feb 26, 2021

[in_app_purchase] Migrate Android Billing Client to 3.0.0 flutter/flutter#75204

Closed

Chris Yang added 2 commits February 25, 2021 19:35

fix tests

102d7cd

format

d6b65db

cyanglaz requested review from stuartmorgan-g and mklim and removed request for LHLL February 26, 2021 03:36

put back commented out code

df3a45b

cyanglaz commented Feb 26, 2021

View reviewed changes

Chris Yang added 2 commits February 26, 2021 09:09

fix sub changing

822e631

formatting

ac4348c

stuartmorgan-g suggested changes Feb 26, 2021

View reviewed changes

review

99b4eef

cyanglaz commented Feb 26, 2021

View reviewed changes

stuartmorgan-g approved these changes Mar 1, 2021

View reviewed changes

packages/in_app_purchase/lib/src/billing_client_wrappers/billing_client_wrapper.dart Outdated Show resolved Hide resolved

nits

763360d

cyanglaz added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Mar 1, 2021

fluttergithubbot merged commit 088bdee into flutter:master Mar 1, 2021

github-actions bot added the needs-publishing label Mar 1, 2021

engine-flutter-autoroll mentioned this pull request Mar 1, 2021

Roll Plugins from 98a90d65564e to 088bdee478d9 (1 revision) flutter/flutter#77008

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 1, 2021

088bdee [in_app_purchase] migrate playing billing library to v3 (flut…

3c92a61

…ter/plugins#3636)

fluttergithubbot pushed a commit to flutter/flutter that referenced this pull request Mar 1, 2021

088bdee [in_app_purchase] migrate playing billing library to v3 (flut…

411cf8f

…ter/plugins#3636) (#77008)

cyanglaz deleted the iap_pbl_v3 branch March 2, 2021 01:20

cyanglaz mentioned this pull request Mar 2, 2021

[in_app_purchase] fix plugin version #3654

Merged

cyanglaz removed the needs-publishing label Mar 2, 2021

[in_app_purchase] migrate playing billing library to v3 #3636

[in_app_purchase] migrate playing billing library to v3 #3636

Uh oh!

Conversation

cyanglaz commented Feb 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cyanglaz commented Feb 26, 2021 •

edited

Loading