Prevent memory leak of Callback in ImageStream, update README

brendan-fahy commented 4 years ago

Description

The Callback class's Javadoc says that direct references to it should be managed by clients, because ResolveUriTask uses a WeakReference for its Callback.

Unfortunately, our README didn't accurately reflect this important part of its usage (the code snippets showed anonymous inner Callback classes), and our ImageStream implementation also was not handling it properly.

Changes

Update code snippets in README to show intended usage.
Update ImageStream to keep a strong reference to Callback.
Bump patch version (considering this code change to be a fix of broken/unintended behaviour).

Reviewers

@zendesk/adventure-android @zendesk/two-brothers-android @zendesk/ogham-android

FYI

@schlan

References

89

Risks

Very low, as far as I can tell. I did some checking with LeakCanary to ensure I wasn't getting a memory leak on ImageStream with this implementation.

schlan commented 4 years ago

I can't :(

schlan commented 4 years ago

🙍‍♂

zendesk / belvedere