Introduced `PurchasesDiagnostics` to help diagnose SDK configuration errors by NachoSoto · Pull Request #1977 · RevenueCat/purchases-ios

NachoSoto · 2022-10-10T23:38:07Z

Finishes CSDK-451.
This new small public API allows users to quickly figure out if everything in the SDK is correctly configured in a simple way:

let diagnostics = PurchasesDiagnostics.default
do {
    try await diagnostics.testSDKHealth()
} catch {
    print(error)
}

The specific underlying errors will provide information about what failed.

We can continue growing this to check for more specific things, but for now it does 4 things:

Verify API connectivity: networking issues, firewalling, etc.
Verify API key is correct
Verify Offerings are configured correctly
Verify that all products in Offerings are configured correctly and found in StoreKit

This new API is covered by:

API testers
Unit tests
Integration tests (both on SK1 and SK2)

I've taken the "shortcut" of making this async only (while still compatible with Objective-C), which means it's not compatible with iOS 12.x. But that made the implementation a lot simpler, which I think is a useful tradeoff.

This is a new API so I made sure it's documented with an example:

Depends on:

aboedo · 2022-10-17T20:08:53Z

We should be very, very explicit with our docs for this one. Perhaps @codykerns and / or the Support team can help us figure out a nice copy?
Similar thinking regarding the API: maybe we can call it something like testRevenueCatIntegration or something? Like, if it just says "test" it might IMO feel like something that's internal to the SDK, just meant for us to test it

NachoSoto · 2022-10-24T15:56:48Z

Similar thinking regarding the API: maybe we can call it something like testRevenueCatIntegration or something?

Oh yeah much better 👍🏻
I started with test as I was exploring and prototyping this and never went back to change the name 🤦🏻‍♂️

@codykerns any thoughts on the rest of the documentation in here?

codykerns · 2022-10-26T21:05:36Z

I kind of think that naming this class more like a support or diagnostics tool, like RevenueCatDiagnostics or PurchasesDiagnostics as it more indicates symptoms of a potentially broken implementation. I think it would make it less ambiguous too, as the test terminology might be confusing/ pointing toward it being an internal thing rather than publicly accessible

I like PurchasesDiagnostics 👍🏻

codykerns · 2022-10-26T21:07:26Z

Suggested change

public func testRevenueCatIntegration() async throws {

public func testBasicSDKHealth() async throws {

If we rename the class, I think it's implied that it's for RevenueCat. Let's call it something like this to give room for other potential 'tests' in the future

I like PurchasesDiagnostics.testSDKHealth 👍🏻

Finishes [CSDK-451]. This new small public API allows users to quickly figure out if everything in the SDK is correctly configured in a simple way: ```swift let tester = SDKTester.default do { try await tester.test() } catch { print(error) } ``` The specific underlying errors will provide information about what failed. We can continue growing this to check for more specific things, but for now it does 4 things: - Verify API connectivity: networking issues, firewalling, etc. - Verify API key is correct - Verify `Offerings` are configured correctly - Verify that all products in `Offerings` are configured correctly and found in `StoreKit` This new API is covered by: - API testers - Unit tests - Integration tests (both on `SK1` and `SK2`) - #1970 - #1971 - #1973 - #1974 - #1975 - #1976

NachoSoto · 2022-10-27T18:00:18Z

Updated to PurchasesDiagnostics.testSDKHealth which is much better, thanks @codykerns!

NachoSoto · 2022-10-27T18:42:39Z

Idea from @aboedo: we can expand the error descriptions with more details to help developers fix each one.
For example:

API key is not valid. You can obtain the API key for your app at https://whatever.com/. If you’re getting this message while using a key from https://whatever.com/, make sure that you’re using the key specific to this platform (i.e.: you can’t use the Android key on Apple platforms). A correct API key for this platform will look something like appl_ligarsgiajsgeasg or oiajwgeoieagoesgea if you’re using a legacy API key.

codykerns · 2022-10-27T18:45:16Z

@NachoSoto do you want me to write up the potential errors messages, etc? I think that's a great idea

NachoSoto · 2022-10-27T18:46:50Z

@codykerns that would be nice! You can see the main 4 errors (including unknown).
We can also expand the convert method to handle more ErrorCodes and provide more specific messages.

NachoSoto · 2022-10-27T18:47:06Z

We can leave that for a future PR if everyone is okay with merging this for now?

@NachoSoto

### New Features * Introduced `PurchasesDiagnostics` to help diagnose SDK configuration errors (#1977) via NachoSoto (@NachoSoto) ### Bugfixes * Avoid posting empty receipts by making`TransactionsManager` always use `SK1` implementation (#2015) via NachoSoto (@NachoSoto) * `NetworkOperation`: workaround for iOS 12 crashes (#2008) via NachoSoto (@NachoSoto) ### Other Changes * Makes hold job wait for installation tests to pass (#2017) via Cesar de la Vega (@vegaro) * Update fastlane-plugin-revenuecat_internal (#2016) via Cesar de la Vega (@vegaro) * `bug_report.md`: changed SK2 wording (#2010) via NachoSoto (@NachoSoto) * Added `Set + Set` and `Set += Set` operators (#2013) via NachoSoto (@NachoSoto) * fix the link to StoreKit Config file from watchOS purchaseTester (#2009) via Andy Boedo (@aboedo) * `PurchaseTesterSwiftUI`: combined targets into one multi-platform and fixed `macOS` (#1996) via NachoSoto (@NachoSoto) * Less Array() (#2005) via SabinaHuseinova (@SabinaHuseinova) * Docs: fixed `logIn` references (#2002) via NachoSoto (@NachoSoto) * CI: use `Xcode 14.1` (#1992) via NachoSoto (@NachoSoto) * `PurchaseTesterSwiftUI`: fixed warnings and simplified code using `async` methods (#1985) via NachoSoto (@NachoSoto)

NachoSoto added the pr:feat A new feature label Oct 10, 2022

NachoSoto requested a review from a team October 10, 2022 23:38

NachoSoto force-pushed the sdk-tester branch from 4f5d80e to 02f7a98 Compare October 11, 2022 20:10

vegaro requested changes Oct 14, 2022

View reviewed changes

NachoSoto force-pushed the sdk-tester branch from fed5c10 to 51dedb1 Compare October 14, 2022 18:44

NachoSoto changed the base branch from main to internal-api October 14, 2022 18:44

NachoSoto requested review from a team and vegaro October 14, 2022 18:47

NachoSoto force-pushed the sdk-tester branch 2 times, most recently from e8e7f4c to 18fe0a2 Compare October 14, 2022 20:09

vegaro approved these changes Oct 17, 2022

View reviewed changes

Comment thread Sources/Support/SDKTester.swift

aboedo requested a review from codykerns October 17, 2022 20:09

Base automatically changed from internal-api to main October 20, 2022 18:03

NachoSoto force-pushed the sdk-tester branch from 01b3762 to 16a4e1d Compare October 24, 2022 15:57

NachoSoto requested a review from aboedo October 24, 2022 15:58

NachoSoto force-pushed the sdk-tester branch from 5ef56d4 to cf1a38b Compare October 24, 2022 21:58

codykerns reviewed Oct 26, 2022

View reviewed changes

NachoSoto added 9 commits October 27, 2022 10:50

Fixed typo

9b70d87

Re-added #if DEBUG

3690f20

Fixed tests

0a92bbb

Fixed MockPurchases

f086a53

Fixed tests

20d99c6

Fixed tvOS

1dc9362

Renamed test method

c05a6b0

Renamed class and methods

62e324b

NachoSoto changed the title ~~Introduced SDKTester to help diagnose SDK configuration errors~~ Introduced PurchasesDiagnostics to help diagnose SDK configuration errors Oct 27, 2022

NachoSoto force-pushed the sdk-tester branch from cf1a38b to 62e324b Compare October 27, 2022 17:59

NachoSoto merged commit faf51e3 into main Oct 27, 2022

NachoSoto deleted the sdk-tester branch October 27, 2022 19:00

RCGitBot mentioned this pull request Nov 3, 2022

Release/4.14.0 #2021

Merged

	public func testRevenueCatIntegration() async throws {
	public func testBasicSDKHealth() async throws {

Conversation

NachoSoto commented Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Depends on:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aboedo commented Oct 17, 2022

Uh oh!

NachoSoto commented Oct 24, 2022

Uh oh!

codykerns Oct 26, 2022

Choose a reason for hiding this comment

Uh oh!

NachoSoto Oct 27, 2022

Choose a reason for hiding this comment

Uh oh!

codykerns Oct 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NachoSoto Oct 27, 2022

Choose a reason for hiding this comment

Uh oh!

NachoSoto commented Oct 27, 2022

Uh oh!

NachoSoto commented Oct 27, 2022

Uh oh!

codykerns commented Oct 27, 2022

Uh oh!

NachoSoto commented Oct 27, 2022

Uh oh!

NachoSoto commented Oct 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

NachoSoto commented Oct 10, 2022 •

edited

Loading

codykerns Oct 26, 2022 •

edited

Loading