GrenderG/Toasty

Memory leak when allowQueue=false

Open

#128 opened on Nov 12, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (6,535 stars) (822 forks)batch import
bughelp wanted

Description

If allowQueue parameter set to false Toasty uses lastToast static variable to save previous Toast object which holds reference to Context causing memory leak. Leak is reported by com.squareup.leakcanary library.

You need to set allowQueue to true to eliminate leak (no static reference to Context).

// Causing leak
            Toasty.custom(_context, _text,
                    ContextCompat.getDrawable(_context, R.drawable.ic_alert_white_36dp),
                    ContextCompat.getColor(_context, R.color.warn_background),
                    ContextCompat.getColor(_context, R.color.defaultTextColor),
                    _duration, true, true).show();

// No leak
Toasty.Config.getInstance().allowQueue(true).apply();
Toasty.custom(_context, _text,
                    ContextCompat.getDrawable(_context, R.drawable.ic_alert_white_36dp),
                    ContextCompat.getColor(_context, R.color.warn_background),
                    ContextCompat.getColor(_context, R.color.defaultTextColor),
                    _duration, true, true).show();

Contributor guide

Tech stack
java
Domain
mobileperformance
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Java basicsAndroid context handlingMemory leak concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The memory leak originates from the static `lastToast` field in the `Toasty` class. Investigate how `allowQueue` affects the assignment and clearing of this field. A potential fix is to replace the static reference with a WeakReference or to clear it after the toast is dismissed. Review the `Toasty.custom()` method and the `Config` class to understand the logic. Ensure unit tests are added to verify no memory leak occurs.