Introduce Metalava for tracking the public API surfaces #2370

skydoves · 2025-04-22T02:22:08Z

Motivation

As Toni mentioned earlier, the binary-compatibility-validator still has limitations on Android projects, particularly with support for multiple build flavors. As an alternative, we could consider using Metalava, a tool developed and maintained by Google. Fortunately, there's also a community-supported Gradle plugin available metalava-gradle which is widely adopted in popular libraries like Accompanist.

To generate Metalava signature files, you can use the base command:

./gradlew metalavaGenerateSignature

However, since our project includes multiple flavors, we need to target a specific one. For example:

metalavaGenerateSignatureDefaultsRelease
metalavaGenerateSignatureCustomEntitlementComputationRelease

For compatibility checks in CI, we can use:

metalavaCheckCompatibilityDefaultsRelease
metalavaCheckCompatibilityCustomEntitlementComputationRelease

In this PR, I ran metalavaGenerateSignatureDefaultsRelease to generate the default signature files for both the purchases and purchases-ui modules.

RevenueCat-Danger-Bot · 2025-04-22T02:22:47Z

	2 Warnings
⚠️	Size check is being bypassed due to the presence of the label "danger-bypass-size-limit"
⚠️	Size increase: 407.20 KB

Generated by 🚫 Danger

JayShortway

TIL about Metalava! I think this is great! Just some suggestions.

JayShortway · 2025-04-22T09:52:28Z

purchases/api.txt

+  @com.revenuecat.purchases.InternalRevenueCatAPI @kotlin.jvm.JvmInline @kotlinx.serialization.Serializable public final value class ColorAlias {
+    ctor public ColorAlias(String value);
+  }


Would it be possible to ignore anything annotated with @InternalRevenueCatAPI?

In the Metalava docs I read:

hide code intended to be implementation only, driven by javadoc comments like @hide, @doconly, @removed, etc, as well as various annotations.

But maybe we can somehow automate that, so @InternalRevenueCatAPI is automatically ignored?

That makes sense. I just hid all the public classes and methods that are marked with @InternalRevenueCatAPI .

Nice, I love that it's just hiddenAnnotations.add("com.revenuecat.purchases.InternalRevenueCatAPI")!

build.gradle.kts

JayShortway · 2025-04-22T10:01:48Z

build.gradle.kts

@@ -12,6 +12,7 @@ plugins {
    alias(libs.plugins.kover) apply false
    alias(libs.plugins.emerge) apply false
    alias(libs.plugins.poko) apply false
+    alias(libs.plugins.metalava) apply false


Could you try adding this to our CircleCI config? We could have a new validate-binary-compatibility job that does something like:

- run: name: Validate binary compatibility (Defaults) command: ./gradlew metalavaCheckCompatibilityDefaultsRelease - run: name: Validate binary compatibility (CustomEntitlementComputation) command: ./gradlew metalavaCheckCompatibilityCustomEntitlementComputationRelease

This can be added to the existing build-test-deploy workflow. Let me know if you have any questions!

(This comment also has nothing to do with this line.)

I just added a CI configuration for checking metalava here: 220c979, and would love to get your double-check 😄

I believe you just need to add the matalava job to the build-test-deploy workflow at the end of that file and it should be good! It should appear as one of the jobs running in this PR when configured properly.

That looks good now and I see the new job passing now 🙌 Thanks!

tonidero

Oh nice! Me too TIL about Metalava! I think this looks good, other than Jay's comments. Thanks for doing this!

…ternalRevenueCatAPI

codecov · 2025-04-23T06:12:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.92%. Comparing base (be4ef49) to head (9ce2226).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2370   +/-   ##
=======================================
  Coverage   79.92%   79.92%           
=======================================
  Files         284      284           
  Lines       10151    10151           
  Branches     1433     1433           
=======================================
  Hits         8113     8113           
  Misses       1422     1422           
  Partials      616      616

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tonidero

I believe the APIs re getting mixed for both flavors. But this is close!

purchases/build.gradle.kts

tonidero · 2025-04-23T07:57:10Z

purchases/api-entitlement.txt

+    method @kotlin.jvm.JvmSynthetic @kotlin.jvm.Throws(exceptionClasses=PurchasesException::class) public static suspend Object? awaitCustomerInfo(com.revenuecat.purchases.Purchases, optional com.revenuecat.purchases.CacheFetchPolicy fetchPolicy, kotlin.coroutines.Continuation<? super com.revenuecat.purchases.CustomerInfo>);
+    method @kotlin.jvm.JvmSynthetic @kotlin.jvm.Throws(exceptionClasses=PurchasesTransactionException::class) public static suspend Object? awaitLogIn(com.revenuecat.purchases.Purchases, String appUserID, kotlin.coroutines.Continuation<? super com.revenuecat.purchases.data.LogInResult>);
+    method @kotlin.jvm.JvmSynthetic @kotlin.jvm.Throws(exceptionClasses=PurchasesTransactionException::class) public static suspend Object? awaitLogOut(com.revenuecat.purchases.Purchases, kotlin.coroutines.Continuation<? super com.revenuecat.purchases.CustomerInfo>);
+    method public static suspend Object? awaitStorefrontCountryCode(com.revenuecat.purchases.Purchases, kotlin.coroutines.Continuation<? super java.lang.String>);


Hmm seems this is also including API elements from the defaults flavor? For example, this method is only available there

Nice catch! I just added a filter for the product flavors and now it seems to work well: 925f0c1

purchases/api-defauts.txt

tonidero

I 🫶 this! I think only thing left is to include it to our CircleCI config

## Description Super quick follow-up to #2370. Otherwise this typo will live forever 😅

skydoves added 2 commits April 22, 2025 10:46

Add metalava dependency and apply it to the purchases

8db03b2

Generate metalava binaries for purchases and purchases-ui modules

db766e8

skydoves requested a review from a team April 22, 2025 02:22

skydoves self-assigned this Apr 22, 2025

skydoves added the pr:other label Apr 22, 2025

skydoves added the danger-bypass-size-limit label Apr 22, 2025

JayShortway reviewed Apr 22, 2025

View reviewed changes

tonidero reviewed Apr 22, 2025

View reviewed changes

skydoves added 2 commits April 23, 2025 14:07

Ignore the test classes and hide all public classes annotated with In…

5ab9003

…ternalRevenueCatAPI

Rename the api binary file names to depend on the variant name

9ce8396

tonidero reviewed Apr 23, 2025

View reviewed changes

skydoves added 2 commits April 23, 2025 18:48

Exclude each different flavours api

0475232

Fix typo

925f0c1

tonidero reviewed Apr 23, 2025

View reviewed changes

skydoves added 2 commits April 24, 2025 09:35

Add ci configuration for matalava

220c979

Add metalava task for the build-test-deploy

9ce2226

tonidero approved these changes Apr 24, 2025

View reviewed changes

skydoves added this pull request to the merge queue Apr 24, 2025

Merged via the queue into main with commit 2c98ad8 Apr 24, 2025
14 checks passed

skydoves deleted the feature/metalava branch April 24, 2025 06:48

JayShortway mentioned this pull request Apr 24, 2025

Fixes a typo: matalava -> metalava. #2375

Merged

github-merge-queue bot pushed a commit that referenced this pull request Apr 24, 2025

Fixes a typo: matalava -> metalava. (#2375)

3ac40f1

## Description Super quick follow-up to #2370. Otherwise this typo will live forever 😅

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Metalava for tracking the public API surfaces #2370

Introduce Metalava for tracking the public API surfaces #2370

skydoves commented Apr 22, 2025

RevenueCat-Danger-Bot commented Apr 22, 2025 •

edited

Loading

JayShortway left a comment

JayShortway Apr 22, 2025

skydoves Apr 23, 2025

JayShortway Apr 23, 2025

JayShortway Apr 22, 2025

skydoves Apr 24, 2025

tonidero Apr 24, 2025

tonidero Apr 24, 2025

tonidero left a comment

codecov bot commented Apr 23, 2025 •

edited

Loading

tonidero left a comment

tonidero Apr 23, 2025

skydoves Apr 23, 2025 •

edited

Loading

tonidero left a comment

Introduce Metalava for tracking the public API surfaces #2370

Introduce Metalava for tracking the public API surfaces #2370

Conversation

skydoves commented Apr 22, 2025

Motivation

RevenueCat-Danger-Bot commented Apr 22, 2025 • edited Loading

JayShortway left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 23, 2025 • edited Loading

Codecov Report

tonidero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skydoves Apr 23, 2025 • edited Loading

Choose a reason for hiding this comment

tonidero left a comment

Choose a reason for hiding this comment

RevenueCat-Danger-Bot commented Apr 22, 2025 •

edited

Loading

codecov bot commented Apr 23, 2025 •

edited

Loading

skydoves Apr 23, 2025 •

edited

Loading