Skip to content

Memory Leak: RenderSliverEdgeInsetsPadding does not dispose OffsetLayer when testing with TestClipPaintingContext #134575

@ksokolovskyi

Description

@ksokolovskyi

Is there an existing issue for this?

PR which marks this leak: #134576

Steps to reproduce

It happens that RenderSliverEdgeInsetsPadding does not dispose OffsetLayer when testing with TestClipPaintingContext .

  1. When running the following text with TestClipPaintingContext leak_tracker detects leak:
testWidgetsWithLeakTracking('OffsetLayer leak', (WidgetTester tester) async {
  await tester.pumpWidget(
    Directionality(
      textDirection: TextDirection.ltr,
      child: GridView(
        gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(crossAxisCount: 3),
        children: <Widget>[
          Container(height: 200.0),
        ],
      ),
    ),
  );

  // 1st, check that the render object has received the default clip behavior.
  final RenderViewport renderObject = tester.allRenderObjects.whereType<RenderViewport>().first;
  expect(renderObject.clipBehavior, equals(Clip.hardEdge));

  // The context will get Clip.none because there is no actual visual overflow.
  final TestClipPaintingContext context = TestClipPaintingContext();
  renderObject.paint(context, Offset.zero);
  expect(context.clipBehavior, equals(Clip.none));
}, 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: 2
              objects:
                OffsetLayer:
                  test: OffsetLayer leak
                  identityHashCode: 259643724
                  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_OffsetLayer_(package:flutter/src/rendering/layer.dart)
                      #12_____RenderObject.updateCompositedLayer_(package:flutter/src/rendering/object.dart:2743:24)
                      #13_____PaintingContext._repaintCompositedChild_(package:flutter/src/rendering/object.dart:138:39)
                      #14_____PaintingContext.repaintCompositedChild_(package:flutter/src/rendering/object.dart:109:5)
                      #15_____PaintingContext._compositeChild_(package:flutter/src/rendering/object.dart:261:7)
                      #16_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:242:7)
                      #17_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #18_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #19_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #20_____RenderSliverMultiBoxAdaptor.paint_(package:flutter/src/rendering/sliver_multi_box_adaptor.dart:649:17)
                      #21_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #22_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #23_____RenderSliverEdgeInsetsPadding.paint_(package:flutter/src/rendering/sliver_padding.dart:263:15)
                      #24_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #25_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #26_____RenderViewportBase._paintContents_(package:flutter/src/rendering/viewport.dart:690:17)
                      #27_____RenderViewportBase.paint_(package:flutter/src/rendering/viewport.dart:675:7)
                      #28_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #29_____PaintingContext._repaintCompositedChild_(package:flutter/src/rendering/object.dart:166:11)
                      #30_____PaintingContext.repaintCompositedChild_(package:flutter/src/rendering/object.dart:109:5)
                      #31_____PaintingContext._compositeChild_(package:flutter/src/rendering/object.dart:261:7)
                      #32_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:242:7)
                      #33_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #34_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #35_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #36_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #37_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #38_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #39_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #40_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #41_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #42_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #43_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #44_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #45_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #46_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #47_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #48_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #49_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #50_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #51_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #52_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #53_____PaintingContext._repaintCompositedChild_(package:flutter/src/rendering/object.dart:166:11)
                      #54_____PaintingContext.repaintCompositedChild_(package:flutter/src/rendering/object.dart:109:5)
                      #55_____PaintingContext._compositeChild_(package:flutter/src/rendering/object.dart:261:7)
                      #56_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:242:7)
                      #57_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #58_____RenderCustomPaint.paint_(package:flutter/src/rendering/custom_paint.dart:635:11)
                      #59_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #60_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:250:13)
                      #61_____RenderProxyBoxMixin.paint_(package:flutter/src/rendering/proxy_box.dart:129:13)
                      #62_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #63_____PaintingContext._repaintCompositedChild_(package:flutter/src/rendering/object.dart:166:11)
                      #64_____PaintingContext.repaintCompositedChild_(package:flutter/src/rendering/object.dart:109:5)
                      #65_____PaintingContext._compositeChild_(package:flutter/src/rendering/object.dart:261:7)
                      #66_____PaintingContext.paintChild_(package:flutter/src/rendering/object.dart:242:7)
                      #67_____RenderView.paint_(package:flutter/src/rendering/view.dart:223:15)
                      #68_____RenderObject._paintWithContext_(package:flutter/src/rendering/object.dart:3210:7)
                      #69_____PaintingContext._repaintCompositedChild_(package:flutter/src/rendering/object.dart:166:11)
                      #70_____PaintingContext.repaintCompositedChild_(package:flutter/src/rendering/object.dart:109:5)
                      #71_____PipelineOwner.flushPaint_(package:flutter/src/rendering/object.dart:1158:31)
                      #72_____PipelineOwner.flushPaint_(package:flutter/src/rendering/object.dart:1168:15)
                      #73_____AutomatedTestWidgetsFlutterBinding.drawFrame_(package:flutter_test/src/binding.dart:1415:31)
                      #74_____RendererBinding._handlePersistentFrameCallback_(package:flutter/src/rendering/binding.dart:457:5)
                      #75_____SchedulerBinding._invokeFrameCallback_(package:flutter/src/scheduler/binding.dart:1325:15)
                      #76_____SchedulerBinding.handleDrawFrame_(package:flutter/src/scheduler/binding.dart:1255:9)
                      #77_____AutomatedTestWidgetsFlutterBinding.pump.<anonymous_closure>_(package:flutter_test/src/binding.dart:1264:9)
                      #78______rootRun_(dart:async/zone.dart:1399:13)
                      #79______CustomZone.run_(dart:async/zone.dart:1301:19)
                      #80_____TestAsyncUtils.guard_(package:flutter_test/src/test_async_utils.dart:71:41)
                      #81_____AutomatedTestWidgetsFlutterBinding.pump_(package:flutter_test/src/binding.dart:1251:27)
                      #82_____WidgetTester.pumpWidget.<anonymous_closure>_(package:flutter_test/src/widget_tester.dart:578:22)
                      #83______rootRun_(dart:async/zone.dart:1399:13)
                      #84______CustomZone.run_(dart:async/zone.dart:1301:19)
                      #85_____TestAsyncUtils.guard_(package:flutter_test/src/test_async_utils.dart:71:41)
                      #86_____WidgetTester.pumpWidget_(package:flutter_test/src/widget_tester.dart:575:27)
                      #87_____main.<anonymous_closure>_(file:///Users/ksokolovskyi/dev/flutter_master/packages/flutter/test/widgets/grid_view_test.dart:679:16)
                      #88_____testWidgetsWithLeakTracking.wrappedCallBack_(package:leak_tracker_flutter_testing/src/test_widgets.dart:126:19)
                      #89_____testWidgets.<anonymous_closure>.<anonymous_closure>_(package:flutter_test/src/widget_tester.dart:168:29)
                      <asynchronous_suspension>
                      #90_____TestWidgetsFlutterBinding._runTestBody_(package:flutter_test/src/binding.dart:1013:5)
                      <asynchronous_suspension>
                      #91_____StackZoneSpecification._registerCallback.<anonymous_closure>_(package:stack_trace/src/stack_zone_specification.dart:114:42)
                      <asynchronous_suspension>
                ContainerLayer:
                  test: OffsetLayer leak
                  identityHashCode: 567331306
                  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_TestClipPaintingContext_(file:///Users/ksokolovskyi/dev/flutter_master/packages/flutter/test/rendering/rendering_tester.dart:384:37)
                      #12_____main.<anonymous_closure>_(file:///Users/ksokolovskyi/dev/flutter_master/packages/flutter/test/widgets/grid_view_test.dart:696:43)
                      <asynchronous_suspension>
                      #13_____testWidgetsWithLeakTracking.wrappedCallBack_(package:leak_tracker_flutter_testing/src/test_widgets.dart:126:5)
                      <asynchronous_suspension>
                      #14_____testWidgets.<anonymous_closure>.<anonymous_closure>_(package:flutter_test/src/widget_tester.dart:168:15)
                      <asynchronous_suspension>
                      #15_____TestWidgetsFlutterBinding._runTestBody_(package:flutter_test/src/binding.dart:1013:5)
                      <asynchronous_suspension>
                      #16_____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 TestClipPaintingContext commentedleak_tracker does not detect leak:
testWidgetsWithLeakTracking('OffsetLayer leak', (WidgetTester tester) async {
  await tester.pumpWidget(
    Directionality(
      textDirection: TextDirection.ltr,
      child: GridView(
        gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(crossAxisCount: 3),
        children: <Widget>[
          Container(height: 200.0),
        ],
      ),
    ),
  );

  // 1st, check that the render object has received the default clip behavior.
  final RenderViewport renderObject = tester.allRenderObjects.whereType<RenderViewport>().first;
  expect(renderObject.clipBehavior, equals(Clip.hardEdge));

  // The context will get Clip.none because there is no actual visual overflow.
  // final TestClipPaintingContext context = TestClipPaintingContext();
  // renderObject.paint(context, Offset.zero);
  // expect(context.clipBehavior, equals(Clip.none));
}, leakTrackingTestConfig: LeakTrackingTestConfig.debugNotDisposed());

Flutter Doctor output

Doctor output
[✓] Flutter (Channel master, 3.14.0-14.0.pre.249, on macOS 13.0.1 22A400 darwin-arm64, locale en-GB)
    • Flutter version 3.14.0-14.0.pre.249 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 05733402f7 (70 minutes ago), 2023-09-12 11:42:01 -0700
    • Engine revision d4698c65aa
    • 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.1)
    • 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: tests"flutter test", flutter_test, or one of our testsfound 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-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