Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes the PurchasesDelegate being deallocated on iOS #214

Merged
merged 3 commits into from
Sep 20, 2024
Merged

Fixes the PurchasesDelegate being deallocated on iOS #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ce099
Keeps a strong reference to the RCPurchasesDelegateProtocol, to avoid…
JayShortway Sep 19, 2024
cc4f72b
Clears the delegate in close().
JayShortway Sep 20, 2024
1810b44
Keeps a strong reference to the delegate wrapper inside Purchases.
JayShortway Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions core/src/commonMain/kotlin/com/revenuecat/purchases/kmp/Purchases.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ public expect class Purchases {
/**
* The delegate is responsible for handling promotional product purchases (App Store only) and
* changes to customer information.
*
* **Note:** If your delegate is not a singleton, make sure you set this back to null when
* you're done to avoid memory leaks. For instance, if your delegate is tied to a screen, set
* this to null when the user navigates away from the screen.
Comment on lines +111 to +113
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This already applied to Android, so would already have been useful to call out, but now it applies to both platforms.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm it's true that in iOS delegates are much more commonly held weakly... But yeah, since this is KMP, I think this makes sense 👍

*/
public var delegate: PurchasesDelegate?

Expand Down
14 changes: 12 additions & 2 deletions core/src/iosMain/kotlin/com/revenuecat/purchases/kmp/Purchases.ios.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.revenuecat.purchases.kmp

import cocoapods.PurchasesHybridCommon.RCCommonFunctionality
import cocoapods.PurchasesHybridCommon.RCPurchasesDelegateProtocol
import cocoapods.PurchasesHybridCommon.RCStoreProduct
import cocoapods.PurchasesHybridCommon.configureWithAPIKey
import cocoapods.PurchasesHybridCommon.recordPurchaseForProductID
Expand Down Expand Up @@ -117,9 +118,18 @@ public actual class Purchases private constructor(private val iosPurchases: IosP
public actual val appUserID: String
get() = iosPurchases.appUserID()

/**
* Making sure we keep a strong reference to our delegate wrapper, as iosPurchases only keeps
* a weak one. This avoids the wrapper from being deallocated the first chance it gets. This
* behavior matches the Android platform behavior.
*/
private var _delegateWrapper: RCPurchasesDelegateProtocol? = null
public actual var delegate: PurchasesDelegate?
get() = iosPurchases.delegate()?.toPurchasesDelegate()
set(value) = iosPurchases.setDelegate(value?.toRcPurchasesDelegate())
set(value) {
_delegateWrapper = value.toRcPurchasesDelegate()
iosPurchases.setDelegate(_delegateWrapper)
}

public actual val isAnonymous: Boolean
get() = iosPurchases.isAnonymous()
Expand Down Expand Up @@ -340,7 +350,7 @@ public actual class Purchases private constructor(private val iosPurchases: IosP
}

public actual fun close() {
iosPurchases.setDelegate(null)
delegate = null
}

public actual fun getCustomerInfo(
Expand Down
4 changes: 2 additions & 2 deletions core/src/iosMain/kotlin/com/revenuecat/purchases/kmp/PurchasesDelegate.ios.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import platform.darwin.NSObject
internal fun RCPurchasesDelegateProtocol.toPurchasesDelegate(): PurchasesDelegate =
(this as PurchasesDelegateWrapper).wrapped

internal fun PurchasesDelegate.toRcPurchasesDelegate(): RCPurchasesDelegateProtocol =
PurchasesDelegateWrapper(this)
internal fun PurchasesDelegate?.toRcPurchasesDelegate(): RCPurchasesDelegateProtocol? =
this?.let { PurchasesDelegateWrapper(it) }

private class PurchasesDelegateWrapper(val wrapped: PurchasesDelegate) :
RCPurchasesDelegateProtocol,
Expand Down