Skip to content

Memory Leak: RenderEditable does not dispose LeaderLayer when testing with _TestRecordingCanvasMatcher #134386

@ksokolovskyi

Description

@ksokolovskyi

Is there an existing issue for this?

PR which marks this leak: #134387

Steps to reproduce

It happens that RenderEditable does not dispose LeaderLayer when testing with _TestRecordingCanvasMatcher.

  1. When running the following text with paints matcher leak_tracker detects leak:
testWidgetsWithLeakTracking('RenderEditable leak', (WidgetTester tester) async {
  final controller = TextEditingController(text: '');
  addTearDown(controller.dispose);
  final focusNode = FocusNode();
  addTearDown(focusNode.dispose);

  await tester.pumpWidget(
    MaterialApp(
      home: EditableText(
        backgroundCursorColor: Colors.grey,
        controller: controller,
        focusNode: focusNode,
        style: const TextStyle(),
        cursorColor: Colors.blue,
        showCursor: false,
        onEditingComplete: () {},
      ),
    ),
  );

  await tester.tap(find.byType(EditableText));
  await tester.pump();

  final EditableTextState editableTextState = tester.firstState(find.byType(EditableText));
  final RenderEditable renderEditable = editableTextState.renderEditable;

  expect(renderEditable, paints..paragraph());
}, leakTrackingTestConfig: LeakTrackingTestConfig.debugNotDisposed());
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:
              LeaderLayer:
                test: EditableText leak
                identityHashCode: 419152782
                context:
                  start: >
                    #6_______flutterEventToLeakTracker_(package:leak_tracker_flutter_testing/src/test_widgets.dart:24:23)
                    #7______MemoryAllocations.dispatchObjectEvent_(package:flutter/src/foundation/memory_allocations.dart:238:23)
                    #8______MemoryAllocations.dispatchObjectCreated_(package:flutter/src/foundation/memory_allocations.dart:272:5)
                    #9______new_Layer_(package:flutter/src/rendering/layer.dart:143:34)
                    #10_____new_ContainerLayer_(package:flutter/src/rendering/layer.dart)
                    #11_____new_LeaderLayer_(package:flutter/src/rendering/layer.dart)
                    #12_____RenderEditable._paintHandleLayers_(package:flutter/src/rendering/editable.dart:2489:7)
                    #13_____RenderEditable.paint_(package:flutter/src/rendering/editable.dart:2533:7)
                    #14______evaluatePainter_(package:flutter_test/src/mock_canvas.dart:537:20)
                    #15______TestRecordingCanvasMatcher.matches_(package:flutter_test/src/mock_canvas.dart:554:12)
                    #16______expect_(package:matcher/src/expect/expect.dart:138:30)
                    #17_____expect_(package:matcher/src/expect/expect.dart:56:3)
                    #18_____expect_(package:flutter_test/src/widget_tester.dart:458:18)
                    #19_____main.<anonymous_closure>_(file:///Users/ksokolovskyi/dev/flutter_master/packages/flutter/test/widgets/editable_text_cursor_test.dart:1435:3)
                    <asynchronous_suspension>
                    #20_____testWidgetsWithLeakTracking.wrappedCallBack_(package:leak_tracker_flutter_testing/src/test_widgets.dart:126:5)
                    <asynchronous_suspension>
                    #21_____testWidgets.<anonymous_closure>.<anonymous_closure>_(package:flutter_test/src/widget_tester.dart:168:15)
                    <asynchronous_suspension>
                    #22_____TestWidgetsFlutterBinding._runTestBody_(package:flutter_test/src/binding.dart:1013:5)
                    <asynchronous_suspension>
                    #23_____StackZoneSpecification._registerCallback.<anonymous_closure>_(package:stack_trace/src/stack_zone_specification.dart:114:42)
                    <asynchronous_suspension>
package:matcher                                                  expect
package:flutter_test/src/widget_tester.dart 458:18               expect
package:leak_tracker_flutter_testing/src/test_widgets.dart 81:5  _tearDownTestingWithLeakTracking
===== asynchronous gap ===========================
dart:async                                                       _CustomZone.registerBinaryCallback
package:leak_tracker_flutter_testing/src/test_widgets.dart 59:9  configureLeakTrackingTearDown.<fn>
  1. When running the following text with paints matcher is commentedleak_tracker does not detect leak:
testWidgetsWithLeakTracking('RenderEditable leak', (WidgetTester tester) async {
  final controller = TextEditingController(text: '');
  addTearDown(controller.dispose);
  final focusNode = FocusNode();
  addTearDown(focusNode.dispose);

  await tester.pumpWidget(
    MaterialApp(
      home: EditableText(
        backgroundCursorColor: Colors.grey,
        controller: controller,
        focusNode: focusNode,
        style: const TextStyle(),
        cursorColor: Colors.blue,
        showCursor: false,
        onEditingComplete: () {},
      ),
    ),
  );

  await tester.tap(find.byType(EditableText));
  await tester.pump();

  final EditableTextState editableTextState = tester.firstState(find.byType(EditableText));
  final RenderEditable renderEditable = editableTextState.renderEditable;

  // expect(renderEditable, paints..paragraph());
}, leakTrackingTestConfig: LeakTrackingTestConfig.debugNotDisposed());

Flutter Doctor output

Doctor output
[✓] Flutter (Channel master, 3.14.0-14.0.pre.206, on macOS 13.0.1 22A400 darwin-arm64, locale en-GB)
    • Flutter version 3.14.0-14.0.pre.206 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 aa36db1d29 (9 hours ago), 2023-09-10 10:07:13 +0200
    • Engine revision 47d1a045d1
    • Dart version 3.2.0 (build 3.2.0-134.0.dev)
    • DevTools version 2.27.0

[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.1)
    • Android SDK at /Users/ksokolovskyi/Library/Android/sdk
    • Platform android-33, 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.0)
    • 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.179

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

• No issues found!

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issues not at the top of the work lista: leak trackingIssues and PRs related to memory leaks detected by leak_trackera: text inputEntering text in a text field or keyboard related problemsframeworkflutter/packages/flutter repository. See also f: labels.team-frameworkOwned by Framework teamtriaged-frameworkTriaged by Framework team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions