Skip to content

Memory Leak: _SelectableTextState does not dispose _TextSpanEditingController #135046

@ksokolovskyi

Description

@ksokolovskyi

Is there an existing issue for this?

Steps to reproduce

When a new data or textSpan is passed into SelectableText, then _SelectableTextState creates a new _TextSpanEditingController and does not dispose the old one.

Test to reveal the leak:

testWidgetsWithLeakTracking('_SelectableTextState leak', (WidgetTester tester) async {
  await tester.pumpWidget(
    const MaterialApp(
      home: Material(
        child: SelectableText('A'),
      ),
    )
  );

  await tester.pumpWidget(
    const MaterialApp(
      home: Material(
        child: SelectableText('B'),
      ),
    )
  );
}, leakTrackingTestConfig: LeakTrackingTestConfig.debugNotDisposed());
Test output
Expected: leak free
  Actual: <Instance of 'Leaks'>
   Which: contains leaks:
          # The text is generated by leak_tracker.
          # For leak troubleshooting tips open:
          # https://github.com/dart-lang/leak_tracker/blob/main/doc/TROUBLESHOOT.md
          notDisposed:
            total: 1
            objects:
              _TextSpanEditingController:
                test: _SelectableTextState leak
                identityHashCode: 607982384
                context:
                  start: >
#6_______flutterEventToLeakTracker_
test_widgets.dart:24
#7______MemoryAllocations.dispatchObjectEvent_
memory_allocations.dart:238
#8______MemoryAllocations.dispatchObjectCreated_
memory_allocations.dart:272
#9______ChangeNotifier.maybeDispatchObjectCreation_
change_notifier.dart:234
#10_____new_ValueNotifier_
change_notifier.dart:538
#11_____new_TextEditingController_
editable_text.dart:198
#12_____new__TextSpanEditingController_
selectable_text.dart:34
#13______SelectableTextState.initState_
selectable_text.dart:530
#14_____StatefulElement._firstBuild_
framework.dart:5605
#15_____ComponentElement.mount_
framework.dart:5450
#16_____Element.inflateWidget_
framework.dart:4329
#17_____Element.updateChild_
framework.dart:3840
#18_____ComponentElement.performRebuild_
framework.dart:5499
#19_____Element.rebuild_
framework.dart:5190
#20_____ComponentElement._firstBuild_
framework.dart:5456
#21_____ComponentElement.mount_
framework.dart:5450
#22_____Element.inflateWidget_
framework.dart:4329
#23_____Element.updateChild_
framework.dart:3840
#24_____ComponentElement.performRebuild_
framework.dart:5499
#25_____StatefulElement.performRebuild_
framework.dart:5637
#26_____Element.rebuild_
framework.dart:5190
#27_____ComponentElement._firstBuild_
framework.dart:5456
#28_____StatefulElement._firstBuild_
framework.dart:5628
#29_____ComponentElement.mount_
framework.dart:5450
#30_____Element.inflateWidget_
framework.dart:432

Flutter Doctor output

Doctor output
[✓] Flutter (Channel master, 3.14.0-14.0.pre.358, on macOS 13.0.1 22A400 darwin-arm64, locale en-GB)
    • Flutter version 3.14.0-14.0.pre.358 on channel master at /Users/ksokolovskyi/dev/flutter_master
    • Upstream repository [email protected]:ksokolovskyi/flutter.git
    • FLUTTER_GIT_URL = [email protected]:ksokolovskyi/flutter.git
    • Framework revision 8936504163 (12 hours ago), 2023-09-19 02:10:24 -0400
    • Engine revision 589bde9a95
    • Dart version 3.2.0 (build 3.2.0-174.0.dev)
    • DevTools version 2.28.0-dev.8

[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.1)
    • Android SDK at /Users/ksokolovskyi/Library/Android/sdk
    • Platform android-34, build-tools 33.0.1
    • ANDROID_HOME = /Users/ksokolovskyi/Library/Android/sdk
    • Java binary at: /Applications/Android Studio.app/Contents/jbr/Contents/Home/bin/java
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-17.0.6b829.9-10027231)
    • All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 14.3.1)
    • Xcode at /Applications/Xcode.app/Contents/Developer
    • Build 14E300c
    • CocoaPods version 1.11.3

[✓] Chrome - develop for the web
    • Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] Android Studio (version 2022.3)
    • Android Studio at /Applications/Android Studio.app/Contents
    • Flutter plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 17.0.6+0-17.0.6b829.9-10027231)

[✓] IntelliJ IDEA Community Edition (version 2023.2)
    • IntelliJ at /Applications/IntelliJ IDEA CE.app
    • Flutter plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
      🔨 https://plugins.jetbrains.com/plugin/6351-dart

[✓] VS Code (version 1.82.2)
    • VS Code at /Applications/Visual Studio Code.app/Contents
    • Flutter extension version 3.72.0

[✓] Connected device (2 available)
    • macOS (desktop) • macos  • darwin-arm64   • macOS 13.0.1 22A400 darwin-arm64
    • Chrome (web)    • chrome • web-javascript • Google Chrome 116.0.5845.187

[✓] Network resources
    • All expected network resources are available.

• No issues found!

Metadata

Metadata

Assignees

Labels

P2Important issues not at the top of the work lista: tests"flutter test", flutter_test, or one of our testsf: material designflutter/packages/flutter/material repository.found in release: 3.14Found to occur in 3.14frameworkflutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onr: fixedIssue is closed as already fixed in a newer versionteam-designOwned by Design Languages teamtriaged-designTriaged by Design Languages team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions