[Experimental] Web purchase redemption by tonidero · Pull Request #1889 · RevenueCat/purchases-android

tonidero · 2024-10-24T13:22:43Z

Description

This adds experimental support to redeeming anonymous web purchases performed through RCBilling. The main API changes here are:

Adds a new Purchases.parseAsDeepLink that parses the intent and returns a deep link if it needs to be handled
Adds a new Purchases.sharedInstance.redeemWebPurchase that uses a parsed deep link to perform the redemption.
Adds a new DeepLink sealed class with the types of deep links
Adds a new RedeemWebPurchaseListener to listen to the result of the redemption.
Adds a new RedeemWebPurchaseListener.Result sealed class with the result of the redemption.

All these are currently experimental APIs

…emory until configuration

… allow processing after setting the listener

tonidero · 2024-10-24T13:28:05Z

Not a fan of the developer having to handle the deep links like this... I think there is a big chance of the developer passing us the same link multiple times (which could still happen with the approach in #1880 but less likely IMO).

Can we keep track of what is already redeemed? E.g. by storing those tokens/urls on disk or something.

Yes we could... Though I guess there is also a chance it's a valid use case to redeem, as in, maybe the redemption failed the first time due to a connection error or something and they need to try again. I guess we could only "cache" it if there is a successful redemption in this case, but if we for example add deep links to display the paywall in the future, there would be valid use cases of showing the paywall multiple times.

Not to say it's not ok! This approach does provide much more flexibility to the developer, but also more responsibility :P

Yea indeed, I meant to cache successful redemptions. If only to alleviate our own backend. Paywall or other non web purchase deeplinks would indeed be excluded from this.

tonidero · 2024-10-24T13:32:57Z

+@OptIn(ExperimentalPreviewRevenueCatPurchasesAPI::class)
 class MainActivity : AppCompatActivity() {

+    internal var rcDeepLink: Purchases.DeepLink? = null


If multiple links are used continuously before redeeming each, the developer is in charge of handling each on their own... For this PoC, I'm just caching the last one used, but again, it's more logic the developer will need to handle.

I see your point, but wouldn't they need to manage the WebPurchaseRedeemer objects in the other approach?

I'm also trying to think how much of an edge case this is. Is it realistic that a user is buying multiple things, clicking on the links for each (e.g. before being logged in in the app), and then starts a login flow and expects that all purchases are then redeemed? Let me know if you have a different scenario in mind, just trying to think this through haha.

Yeah it's certainly an edge case... And yeah it might be ok to just leave it to the developer. We can always try to provide some code samples if devs start asking for them.

tonidero · 2024-10-24T13:34:09Z

    }

+    @OptIn(ExperimentalPreviewRevenueCatPurchasesAPI::class)
+    override fun onResume() {


Could have done this on the Activity, but preferred to do it in the fragment to show how it would be to handle at the UI part of the app (whether it's using compose or fragments)

tonidero · 2024-10-24T13:34:43Z


+    @ExperimentalPreviewRevenueCatPurchasesAPI
+    sealed class DeepLink {
+        class WebRedemptionLink internal constructor(internal val redemptionToken: String) : DeepLink()


Made everything internal. Devs shouldn't need to build an instance of this on their own, nor access the token directly.

Good call! What's the reason this is nested in Purchases? (Don't really have an opinion, just curious haha.)

Mostly seemed DeepLink was too generic as a top-level class 😅 So I wanted to namespace it inside the SDK.

Haha alright makes sense! (Devs can always use import aliasing of course.)

codecov · 2024-10-24T13:56:32Z

Codecov Report

Attention: Patch coverage is 73.75000% with 21 lines in your changes missing coverage. Please review.

Project coverage is 82.16%. Comparing base (dad3113) to head (019a898).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...m/revenuecat/purchases/deeplinks/DeepLinkParser.kt	0.00%	8 Missing ⚠️
.../kotlin/com/revenuecat/purchases/common/Backend.kt	80.64%	5 Missing and 1 partial ⚠️
...purchases/deeplinks/WebPurchaseRedemptionHelper.kt	85.71%	2 Missing and 1 partial ⚠️
.../purchases/interfaces/RedeemWebPurchaseListener.kt	50.00%	3 Missing ⚠️
...otlin/com/revenuecat/purchases/IntentExtensions.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1889      +/-   ##
==========================================
- Coverage   82.25%   82.16%   -0.09%     
==========================================
  Files         227      231       +4     
  Lines        7968     8048      +80     
  Branches     1121     1132      +11     
==========================================
+ Hits         6554     6613      +59     
- Misses        967      986      +19     
- Partials      447      449       +2

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

JayShortway

I do like it! Had some naming suggestions mostly. I also think it speaks to its simplicity that it's about half the additional lines vs the other approach (342 vs 767).

I think the main decision boils down to how much we want to cater to the edge case you mentioned, and how big of an edge case that is. Let me know if you have a different take!

JayShortway · 2024-10-24T16:30:11Z


+    @ExperimentalPreviewRevenueCatPurchasesAPI
+    sealed class DeepLink {
+        class WebRedemptionLink internal constructor(internal val redemptionToken: String) : DeepLink()


Good call! What's the reason this is nested in Purchases? (Don't really have an opinion, just curious haha.)

JayShortway · 2024-10-24T16:35:24Z

+@OptIn(ExperimentalPreviewRevenueCatPurchasesAPI::class)
 class MainActivity : AppCompatActivity() {

+    internal var rcDeepLink: Purchases.DeepLink? = null


I see your point, but wouldn't they need to manage the WebPurchaseRedeemer objects in the other approach?

I'm also trying to think how much of an edge case this is. Is it realistic that a user is buying multiple things, clicking on the links for each (e.g. before being logged in in the app), and then starts a login flow and expects that all purchases are then redeemed? Let me know if you have a different scenario in mind, just trying to think this through haha.

JayShortway · 2024-10-24T16:37:10Z

Can we keep track of what is already redeemed? E.g. by storing those tokens/urls on disk or something.

JayShortway

Amazing! Great job on this! Also good to see it's extensively tested. Had some minor comments / suggestions, but no blockers. Feel free to ignore at your discretion.

JayShortway · 2024-10-30T13:05:17Z

+import android.content.Intent
+
+@ExperimentalPreviewRevenueCatPurchasesAPI
+@JvmSynthetic


@tonidero

**This is an automatic release.** ## RevenueCat SDK ### ✨ New Features * [Experimental] Web purchase redemption (#1889) via Toni Rico (@tonidero) ### 🐞 Bugfixes * Keeps the org.json package. (#1891) via JayShortway (@JayShortway) ### 📦 Dependency Updates * Bump rexml from 3.3.8 to 3.3.9 (#1892) via dependabot[bot] (@dependabot[bot]) * Bump danger from 9.5.0 to 9.5.1 (#1885) via dependabot[bot] (@dependabot[bot]) * Bump fastlane from 2.224.0 to 2.225.0 (#1884) via dependabot[bot] (@dependabot[bot]) ## RevenueCatUI SDK ### 🐞 Bugfixes * Fix application of modifiers in `Markdown` component (#1893) via Toni Rico (@tonidero) ### 🔄 Other Changes * [CI] Allow publishing snapshot releases manually from branches (#1888) via Toni Rico (@tonidero) * Detekt auto-fixes (#1886) via Toni Rico (@tonidero) Co-authored-by: revenuecat-ops <ops@revenuecat.com>

### Description This adds some new result types to a web purchase redemption: - InvalidToken - AlreadyRedeemed - Expired. This one includes additional information like the obfuscated email where a new token was/will be sent and whether that email was sent. This falls behind the experimental APIs introduced in #1889 Additionally, this renames `parseAsDeepLink` to `parseAsWebPurchaseRedemption` and removes the `DeepLink` type. This is a breaking change, but should be ok since the API is marked as experimental and not usable still by any customers.

tonidero added 16 commits October 24, 2024 13:54

Add new APIs to handle deep links and process RCBilling redemption links

afc4530

Fix detekt

b82003b

Add listener to intercept and respond to redeem requests

11831ea

Add API to handle deep links before configuration and cache them in m…

6a75049

…emory until configuration

Add API tests and small API fix

57d19f0

Process only a single deep link of the same type at the same time and…

13e6b81

… allow processing after setting the listener

Fix detekt

95186fa

Make new APIs experimental

b2f4996

Improve API so it's more compatible with Java

0bbc89e

Change to actual endpoint and PR feedback

a7ce45c

Improve concurrency when processing deep links and add some tests

d3a4418

Fix tests for custom entitlement computation flavor

29ba257

Add isSuccess to redemption result sealed class

9f766f6

Use new deep link host to parse deep links

2766d56

Fix tests

b4e8c12

Change version to new snapshot temporarily

b9d7d11

tonidero added pr:feat A new feature do not merge labels Oct 24, 2024

tonidero changed the base branch from eco-1550-rcbillingmobilesdk-add-new-apis-to-read-deep-links to main October 24, 2024 13:25

[Do not merge][PoC 2] Web purchase redemption round 2

c158a87

tonidero force-pushed the eco-1550-rcbillingmobilesdk-add-new-apis-to-read-deep-links-2 branch from 306ba28 to c158a87 Compare October 24, 2024 13:30

tonidero commented Oct 24, 2024

View reviewed changes

tonidero requested a review from a team October 24, 2024 13:34

JayShortway reviewed Oct 24, 2024

View reviewed changes

Review comments and renames

0ad726f

tonidero mentioned this pull request Oct 29, 2024

[Do not merge] PoC: Add new APIs to handle deep links and process RCBilling redemption links #1880

Closed

tonidero changed the title ~~[Do not merge][PoC] Web purchase redemption (round 2)~~ [Do not merge][PoC] Web purchase redemption Oct 29, 2024

tonidero mentioned this pull request Oct 29, 2024

[Experimental] Web purchase redemption RevenueCat/purchases-ios#4381

Closed

tonidero changed the title ~~[Do not merge][PoC] Web purchase redemption~~ [Experimental] Web purchase redemption Oct 29, 2024

tonidero removed the do not merge label Oct 29, 2024

tonidero added 2 commits October 29, 2024 18:05

Add tests and some cleanup

2bbbdc6

Add some more tests

8d53a84

tonidero marked this pull request as ready for review October 29, 2024 18:10

tonidero requested review from a team and JayShortway October 29, 2024 18:10

JayShortway approved these changes Oct 30, 2024

View reviewed changes

Fixes from review

b55892d

JayShortway reviewed Oct 30, 2024

View reviewed changes

Fix compilation issues

019a898

tonidero enabled auto-merge (squash) October 30, 2024 13:15

tonidero merged commit 6354b93 into main Oct 30, 2024

tonidero deleted the eco-1550-rcbillingmobilesdk-add-new-apis-to-read-deep-links-2 branch October 30, 2024 13:35

RCGitBot mentioned this pull request Oct 30, 2024

[AUTOMATIC] Release/8.9.0 #1896

Merged

tonidero mentioned this pull request Nov 4, 2024

Add extra error cases for web purchases redemptions #1899

Merged

Uh oh!

Conversation

tonidero commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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!

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!

codecov Bot commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JayShortway left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tonidero commented Oct 24, 2024 •

edited

Loading

codecov Bot commented Oct 24, 2024 •

edited

Loading