[DX-457] Log the SDK configuration report on every `#DEBUG` run #5317

polpielladev · 2025-06-23T13:23:46Z

In another effort to reduce the amount of 'Empty Offerings' reports that we get, we want to let users know of configuration issues whenever they run a DEBUG build.

For this reason, we would like to run the SDK Health Check on debug builds.

Examples

✅ Successful configuration (No Warnings)

✅ Successful configuration (Warnings)

❌ Failed configuration

Checklist

If applicable, unit tests
If applicable, create follow-up issues for purchases-android and hybrids

polpielladev · 2025-06-23T16:29:39Z

@aboedo @ajpallares One question that I still haven't fully decided on is how we should configure it.

What I think we should definitely do (and I have already added in this PR) is to allow the user to control whether we do the health check or not.

What I am still unsure about is whether to enable it by default or not? Maybe we soft launch by making it false by default or we enable the SDK configuration value by default and we control with a BE FF that gets sent along with the report (more complex).

What do you think?

ajpallares

Such a nice addition! It's going to be extremely useful, not only for developers, but also for us internally. It's looking great so far. Great job!

I have some comments, mostly about ENABLE_CUSTOM_ENTITLEMENT_COMPUTATION mode and another about dependency injection.

What I am still unsure about is whether to enable it by default or not? Maybe we soft launch by making it false by default or we enable the SDK configuration value by default and we control with a BE FF that gets sent along with the report (more complex).

I'm not really sure about this either. I don't know if it makes sense to build something more complex around this. But it surely feels like doing it on every run is too much (especially if the health check is successful) and not doing it by default seems like a waste of this wonderful feature. I don't know if having a middle ground by default would make sense or would overcomplicate things and make it less expectable...

Sources/Purchasing/Configuration.swift

Sources/Purchasing/Purchases/Purchases.swift

Sources/Support/SDKHealthManager.swift

Sources/Purchasing/Configuration.swift

Sources/Purchasing/Purchases/Purchases.swift

polpielladev · 2025-06-25T16:32:51Z

I'm not really sure about this either. I don't know if it makes sense to build something more complex around this. But it surely feels like doing it on every run is too much (especially if the health check is successful) and not doing it by default seems like a waste of this wonderful feature. I don't know if having a middle ground by default would make sense or would overcomplicate things and make it less expectable...

I agree, especially because we have to query App Store Connect for this, and it is highly likely that this will only come in handy for people that are either starting out or that have issues with configuration.

That's the reason why I decided to turn it off by default, so that users can actually just run it when they need it with a configuration value, but it would potentially hurt discoverability. I keep going back and forth about this, as I want the experience to be as seamless as possible while still keeping in mind that this is going to come in handy in very specific situations only.

The other thing that I thought was to potentially introduce some caching (serverside probably), but that is just a bit risky as we might miss changes in configuration?

What do you think @aboedo @ajpallares @vegaro?

emerge-tools · 2025-06-27T10:36:32Z

1 build increased size

Name	Version	Download	Change	Install	Change	Approval
RevenueCat com.revenuecat.PaywallsTester	1.0 (1)	12.3 MB	⬆️ 33.2 kB (0.27%)	46.9 MB	⬆️ 139.7 kB (0.3%)	N/A

RevenueCat 1.0 (1)
com.revenuecat.PaywallsTester

⚖️ Compare build
⏱️ Analyze build performance

Total install size change: ⬆️ 139.7 kB (0.3%)
Total download size change: ⬆️ 33.2 kB (0.27%)

Largest size changes

Item	Install Size Change
DYLD.String Table	⬆️ 53.7 kB
RevenueCat.Purchases.Purchases	⬇️ -9.1 kB
RCPurchases.Objc Metadata	⬆️ 6.8 kB
Code Signature	⬆️ 3.2 kB
DYLD.Exports	⬆️ 2.1 kB

View Treemap

🛸 Powered by Emerge Tools

Comment trigger: Size diff threshold of 100.00kB exceeded

JayShortway

This is such a huge improvement, that my only real comment is: wen Android? 🚀 😄

Sources/Purchasing/Configuration.swift

Sources/Networking/Operations/HealthReportAvailabilityOperation.swift

Sources/Networking/Responses/HealthReportAvailabilityResponse.swift

tonidero

Looking great!! I think this will be really useful indeed!

Sources/Networking/Backend.swift

Sources/Purchasing/Purchases/Purchases.swift

…bug builds

polpielladev · 2025-06-30T13:17:32Z

@tonidero @JayShortway Addressed all of the feedback now, let me know if you are happy with it 👍

ajpallares

I have more comments! Looking better and better though!

Sources/Support/SDKHealthManager.swift

…ery-debug-build

ajpallares

Looking great! Thanks for addressing all the comments so throughly!! Amazing job!

There's one small issue, which I think would prevent the SDK from compiling in Custom entitlement computation mode. But other than that, I think it looks great!

Sources/Support/PurchasesDiagnostics.swift

…ery-debug-build

JayShortway

Thanks for making the changes! 🙏 Really excited about this!

…un (#5317)" This reverts commit 21f226d.

* Revert "fix `Purchases` temporary leak when running SDK health check (#5350)" This reverts commit 26de543. * Revert "[DX-457] Log the SDK configuration report on every `#DEBUG` run (#5317)" This reverts commit 21f226d.

polpielladev added the pr:other label Jun 23, 2025

polpielladev changed the title ~~[DX-457] Log the SDK configuration report on every #DEBUG run~~ [DX-457] Log the SDK configuration report on every #DEBUG run Jun 23, 2025

polpielladev marked this pull request as ready for review June 23, 2025 16:29

polpielladev requested review from aboedo and ajpallares June 23, 2025 16:29

ajpallares reviewed Jun 24, 2025

View reviewed changes

vegaro reviewed Jun 24, 2025

View reviewed changes

Sources/Purchasing/Configuration.swift Outdated Show resolved Hide resolved

facumenzella reviewed Jun 25, 2025

View reviewed changes

Sources/Purchasing/Purchases/Purchases.swift Outdated Show resolved Hide resolved

polpielladev requested review from ajpallares, facumenzella and vegaro June 27, 2025 14:50

aboedo requested a review from a team June 27, 2025 18:17

JayShortway reviewed Jun 30, 2025

View reviewed changes

Sources/Purchasing/Configuration.swift Outdated Show resolved Hide resolved

Sources/Networking/Operations/HealthReportAvailabilityOperation.swift Outdated Show resolved Hide resolved

Sources/Networking/Responses/HealthReportAvailabilityResponse.swift Show resolved Hide resolved

tonidero reviewed Jun 30, 2025

View reviewed changes

Sources/Networking/Backend.swift Show resolved Hide resolved

Sources/Purchasing/Purchases/Purchases.swift Show resolved Hide resolved

polpielladev added 13 commits June 30, 2025 14:15

Creates a brand new SDK Manager to reuse logic across different classes

1aaa6e0

Updates to use the new manager

5253307

Adds a new method to log the health report to the console only for de…

7d0984d

…bug builds

Run health check for debug builds

8932b76

Fixes sendable warnings that got introduced with new manager

09b076d

Fixes swiftlint violations

1ba8755

Adds unit tests for the new SDK Health manager

4a80fa8

Creates a new authorization provider

2e8d456

Injects the new authorization provider

4e9269d

Tidies and cleans up unit tests

97c0b6b

Adds a new configuration value

65a3431

Updates configuration unit tests

ebfb8a1

Makes sure that values are only set on DEBUG configuration

d4a1fdc

polpielladev added 7 commits June 30, 2025 14:15

Handles no credentials case more gracefully

45458f3

Adds new unit tests for the new No ASC credentials warning

dd32d56

Updates the file's header comment

7fdda93

Adds documentation

0faa9d1

Wraps calls in necessary compiler directives

e5a7622

Hide all report-related content behind compiler directives

f457965

Makes more health-related functionality DEBUG only

50ecfcf

polpielladev force-pushed the dx-457-run-the-check-sdk-health-method-on-every-debug-build branch from f370f2e to 50ecfcf Compare June 30, 2025 13:15

polpielladev requested review from tonidero and JayShortway June 30, 2025 13:17

ajpallares reviewed Jun 30, 2025

View reviewed changes

Sources/Support/SDKHealthManager.swift Outdated Show resolved Hide resolved

polpielladev added 3 commits July 1, 2025 09:59

Addresses PR comments

c73d6a3

Updates all unit test build failures

0975190

Merge branch 'main' into dx-457-run-the-check-sdk-health-method-on-ev…

d2a5f76

…ery-debug-build

polpielladev requested a review from ajpallares July 1, 2025 09:50

ajpallares approved these changes Jul 1, 2025

View reviewed changes

Sources/Support/PurchasesDiagnostics.swift Show resolved Hide resolved

polpielladev and others added 3 commits July 1, 2025 12:52

Gets it back to compile on CUSTOM_ENTITLEMENT_COMPUTATION

55ba169

Removes configuration value

40e27b5

Merge branch 'main' into dx-457-run-the-check-sdk-health-method-on-ev…

68cb631

…ery-debug-build

JayShortway approved these changes Jul 1, 2025

View reviewed changes

polpielladev added 2 commits July 2, 2025 10:27

Updates logging to only include issues

f2f93f7

Adds a mock method for the health report availability request

619223b

polpielladev merged commit 21f226d into main Jul 2, 2025
12 checks passed

polpielladev deleted the dx-457-run-the-check-sdk-health-method-on-every-debug-build branch July 2, 2025 13:00

RCGitBot mentioned this pull request Jul 2, 2025

[AUTOMATIC] Release/5.31.0 #5348

Closed

polpielladev added a commit that referenced this pull request Jul 3, 2025

Revert "[DX-457] Log the SDK configuration report on every #DEBUG r…

e665ca3

…un (#5317)" This reverts commit 21f226d.

RCGitBot mentioned this pull request Jul 3, 2025

[AUTOMATIC] Release/5.31.0 #5354

Closed

RCGitBot mentioned this pull request Jul 3, 2025

[AUTOMATIC] Release/5.31.0 #5355

Merged

[DX-457] Log the SDK configuration report on every #DEBUG run #5317

[DX-457] Log the SDK configuration report on every #DEBUG run #5317

Uh oh!

Conversation

polpielladev commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples

Checklist

Uh oh!

polpielladev commented Jun 23, 2025

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

polpielladev commented Jun 25, 2025

Uh oh!

emerge-tools bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

1 build increased size

RevenueCat 1.0 (1)com.revenuecat.PaywallsTester

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tonidero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

polpielladev commented Jun 30, 2025

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ajpallares left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[DX-457] Log the SDK configuration report on every `#DEBUG` run #5317

[DX-457] Log the SDK configuration report on every `#DEBUG` run #5317

polpielladev commented Jun 23, 2025 •

edited

Loading

emerge-tools bot commented Jun 27, 2025 •

edited

Loading

RevenueCat 1.0 (1)
com.revenuecat.PaywallsTester