Fix issues with CustomerSession listeners #856
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mshafrir-stripe
force-pushed
the
customer-listeners
branch
from
87f4a6c
to
0902651
Compare
mshafrir-stripe
force-pushed
the
customer-listeners
branch
from
0902651
to
401c90b
Compare
**Motivation** The previous implementation of `CustomerSession` listeners had a reference to a single `CustomerRetrievalListener` and `SourceRetrievalListener`. After a listener is called, it would be nulled out. This logic was buggy because it resulted in possible race conditions in which two calls are both in flight, and the first call that completes nulls out the listener for the second. **Summary** The solution to this issue is to associate an `operationId` (i.e. UUID) with each listener. This avoids the race condition and ambiguity about which listener is being referenced. Additionally, the listeners were being held with a strong reference, which could lead to memory leaks if the listener held a reference to an Activity. **Testing** Manually verified with samplestore and example apps.
mshafrir-stripe
force-pushed
the
customer-listeners
branch
from
401c90b
to
4107a3e
Compare
mshafrir-stripe
changed the base branch from
refactor-customer-session
to
master
aphexcx
reviewed
Apr 9, 2019
| @@ -327,19 +354,23 @@ long getCustomerCacheTime() { | |||
| private void addCustomerSource( | |||
| @NonNull final Context context, | |||
| @NonNull final CustomerEphemeralKey key, | |||
| @Nullable final String operationId, | |||
There was a problem hiding this comment.
Makes sense to me to stick this argument on the end to match the API of the other functions
| @@ -81,8 +84,10 @@ | |||
| @Nullable private Customer mCustomer; | |||
| private long mCustomerCacheTime; | |||
| @Nullable private Context mContext; | |||
| @Nullable private CustomerRetrievalListener mCustomerRetrievalListener; | |||
| @Nullable private SourceRetrievalListener mSourceRetrievalListener; | |||
| @NonNull private final Map<String, WeakReference<CustomerRetrievalListener>> | |||
There was a problem hiding this comment.
Is there really a need for weakreferences here? I'm concerned it would bring back that issue of listeners getting garbage collected, and I don't see these leaking any contexts
There was a problem hiding this comment.
These listeners can have references to Activity contexts (see PaymentMethodsActivity), so they should be WeakReferences to avoid memory leaks. We'll monitor new reports of GC issues.
jemerick-stripe
approved these changes
Apr 9, 2019
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The previous implementation of
CustomerSessionlistenershad a reference to a single
CustomerRetrievalListenerandSourceRetrievalListener. After a listener is called, itwould be nulled out.
This logic was buggy because it resulted in possible race
conditions in which two calls are both in flight, and the
first call that completes nulls out the listener for the
second.
Summary
The solution to this issue is to associate an
operationId(i.e. UUID) with each listener. This avoids the race condition
and ambiguity about which listener is being referenced.
Additionally, the listeners were being held with a strong
reference, which could lead to memory leaks if the listener
held a reference to an Activity.
Testing
Manually verified with samplestore and example apps.