layout_builder_mutations_test.dart 6.41 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
import 'package:flutter/rendering.dart';
import 'package:flutter/services.dart';
7 8 9
import 'package:flutter/src/widgets/basic.dart';
import 'package:flutter/src/widgets/framework.dart';
import 'package:flutter/src/widgets/layout_builder.dart';
10
import 'package:flutter/src/widgets/media_query.dart';
11
import 'package:flutter/src/widgets/scroll_view.dart';
12
import 'package:flutter/src/widgets/sliver_layout_builder.dart';
13
import 'package:flutter_test/flutter_test.dart';
14 15

class Wrapper extends StatelessWidget {
16
  const Wrapper({
17
    super.key,
18
    required this.child,
19
  }) : assert(child != null);
20 21 22 23 24 25 26 27 28

  final Widget child;

  @override
  Widget build(BuildContext context) => child;
}

void main() {
  testWidgets('Moving a global key from another LayoutBuilder at layout time', (WidgetTester tester) async {
29
    final GlobalKey victimKey = GlobalKey();
30

31
    await tester.pumpWidget(Row(
32 33
      textDirection: TextDirection.ltr,
      children: <Widget>[
34 35
        Wrapper(
          child: LayoutBuilder(builder: (BuildContext context, BoxConstraints constraints) {
36 37 38
            return const SizedBox();
          }),
        ),
39 40 41 42
        Wrapper(
          child: Wrapper(
            child: LayoutBuilder(builder: (BuildContext context, BoxConstraints constraints) {
              return Wrapper(
43
                child: SizedBox(key: victimKey),
44
              );
45 46
            }),
          ),
47 48 49 50
        ),
      ],
    ));

51
    await tester.pumpWidget(Row(
52 53
      textDirection: TextDirection.ltr,
      children: <Widget>[
54 55 56
        Wrapper(
          child: LayoutBuilder(builder: (BuildContext context, BoxConstraints constraints) {
            return Wrapper(
57
              child: SizedBox(key: victimKey),
58
            );
59
          }),
60
        ),
61 62 63
        Wrapper(
          child: Wrapper(
            child: LayoutBuilder(builder: (BuildContext context, BoxConstraints constraints) {
64
              return const SizedBox();
65 66
            }),
          ),
67 68 69
        ),
      ],
    ));
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128

    expect(tester.takeException(), null);
  });

  testWidgets('Moving a global key from another SliverLayoutBuilder at layout time', (WidgetTester tester) async {
    final GlobalKey victimKey1 = GlobalKey();
    final GlobalKey victimKey2 = GlobalKey();

    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: CustomScrollView(
          slivers: <Widget>[
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return SliverPadding(key: victimKey1, padding: const EdgeInsets.fromLTRB(1, 2, 3, 4));
              },
            ),
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return SliverPadding(key: victimKey2, padding: const EdgeInsets.fromLTRB(5, 7, 11, 13));
              },
            ),
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return const SliverPadding(padding: EdgeInsets.fromLTRB(5, 7, 11, 13));
              },
            ),
          ],
        ),
      ),
    );

    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: CustomScrollView(
          slivers: <Widget>[
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return SliverPadding(key: victimKey2, padding: const EdgeInsets.fromLTRB(1, 2, 3, 4));
              },
            ),
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return const SliverPadding(padding: EdgeInsets.fromLTRB(5, 7, 11, 13));
              },
            ),
            SliverLayoutBuilder(
              builder: (BuildContext context, SliverConstraints constraint) {
                return SliverPadding(key: victimKey1, padding: const EdgeInsets.fromLTRB(5, 7, 11, 13));
              },
            ),
          ],
        ),
      ),
    );

    expect(tester.takeException(), null);
129
  });
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

  testWidgets('LayoutBuilder does not layout twice', (WidgetTester tester) async {
    // This widget marks itself dirty when the closest MediaQuery changes.
    final _LayoutCount widget = _LayoutCount();
    late StateSetter setState;
    bool updated = false;

    await tester.pumpWidget(
      Directionality(
        textDirection: TextDirection.ltr,
        child: StatefulBuilder(
          builder: (BuildContext context, StateSetter setter) {
            setState = setter;
            return MediaQuery(
              data: updated
                ? const MediaQueryData(platformBrightness: Brightness.dark)
                : const MediaQueryData(),
              child: LayoutBuilder(
                builder: (BuildContext context, BoxConstraints constraints) {
                  return Center(
                    child: SizedBox.square(
                      dimension: 20,
                      child: Center(
                        child: SizedBox.square(
                          dimension: updated ? 10 : 20,
                          child: widget,
                        ),
                      ),
                    ),
                  );
                },
              ),
            );
          }
        ),
      ),
    );

    assert(widget._renderObject.layoutCount == 1);
    setState(() { updated = true; });

    await tester.pump();
    expect(widget._renderObject.layoutCount, 2);
  });
}

class _LayoutCount extends LeafRenderObjectWidget {
  late final _RenderLayoutCount _renderObject;

  @override
  RenderObject createRenderObject(BuildContext context) {
    return _renderObject = _RenderLayoutCount(MediaQuery.of(context));
  }

  @override
  void updateRenderObject(BuildContext context, _RenderLayoutCount renderObject) {
    renderObject.mediaQuery = MediaQuery.of(context);
  }
}

class _RenderLayoutCount extends RenderProxyBox {
  _RenderLayoutCount(this._mediaQuery);
  int layoutCount = 0;

  MediaQueryData get mediaQuery => _mediaQuery;
  MediaQueryData _mediaQuery;
  set mediaQuery(MediaQueryData newValue) {
    if (newValue != _mediaQuery) {
      _mediaQuery = newValue;
      markNeedsLayout();
    }
  }

  @override
  bool get sizedByParent => true;

  @override
  void performLayout() {
    layoutCount += 1;
  }
210
}