flutter/packages/flutter/test/widget/inherited_test.dart
Ian Hickson 7020e6cb93 Fix Inherited bugs (#3657)
Fixes https://github.com/flutter/flutter/issues/3493

 - rebuild stateless widgets that have dependencies when their ancestors change but they don't

Fixes https://github.com/flutter/flutter/issues/3120

 - rebuild widgets that tried to inherit from a widget that didn't exist, when the widget is added

This adds a pointer and a bool to Element, which isn't great. It also adds a more or less complete tree walk when you add a new Inherited widget at the top of your tree, which isn't cheap.
2016-05-03 00:06:29 -07:00

442 lines
11 KiB
Dart

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter/material.dart';
import 'package:test/test.dart';
import 'test_widgets.dart';
class TestInherited extends InheritedWidget {
TestInherited({ Key key, Widget child, this.shouldNotify: true })
: super(key: key, child: child);
final bool shouldNotify;
@override
bool updateShouldNotify(InheritedWidget oldWidget) {
return shouldNotify;
}
}
class ValueInherited extends InheritedWidget {
ValueInherited({ Key key, Widget child, this.value })
: super(key: key, child: child);
final int value;
@override
bool updateShouldNotify(ValueInherited oldWidget) => value != oldWidget.value;
}
void main() {
testWidgets('Inherited notifies dependents', (WidgetTester tester) {
List<TestInherited> log = <TestInherited>[];
Builder builder = new Builder(
builder: (BuildContext context) {
log.add(context.inheritFromWidgetOfExactType(TestInherited));
return new Container();
}
);
TestInherited first = new TestInherited(child: builder);
tester.pumpWidget(first);
expect(log, equals([first]));
TestInherited second = new TestInherited(child: builder, shouldNotify: false);
tester.pumpWidget(second);
expect(log, equals([first]));
TestInherited third = new TestInherited(child: builder, shouldNotify: true);
tester.pumpWidget(third);
expect(log, equals([first, third]));
});
testWidgets('Update inherited when reparenting state', (WidgetTester tester) {
GlobalKey globalKey = new GlobalKey();
List<TestInherited> log = <TestInherited>[];
TestInherited build() {
return new TestInherited(
key: new UniqueKey(),
child: new Container(
key: globalKey,
child: new Builder(
builder: (BuildContext context) {
log.add(context.inheritFromWidgetOfExactType(TestInherited));
return new Container();
}
)
)
);
}
TestInherited first = build();
tester.pumpWidget(first);
expect(log, equals([first]));
TestInherited second = build();
tester.pumpWidget(second);
expect(log, equals([first, second]));
});
testWidgets('Update inherited when removing node', (WidgetTester tester) {
final List<String> log = <String>[];
tester.pumpWidget(
new Container(
child: new ValueInherited(
value: 1,
child: new Container(
child: new FlipWidget(
left: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new ValueInherited(
value: 3,
child: new Container(
child: new Builder(
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add('a: ${v.value}');
return new Text('');
}
)
)
)
)
)
),
right: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new Container(
child: new Builder(
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add('b: ${v.value}');
return new Text('');
}
)
)
)
)
)
)
)
)
)
);
expect(log, equals(<String>['a: 3']));
log.clear();
tester.pump();
expect(log, equals(<String>[]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<String>['b: 2']));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<String>['a: 3']));
log.clear();
});
testWidgets('Update inherited when removing node and child has global key', (WidgetTester tester) {
final List<String> log = <String>[];
Key key = new GlobalKey();
tester.pumpWidget(
new Container(
child: new ValueInherited(
value: 1,
child: new Container(
child: new FlipWidget(
left: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new ValueInherited(
value: 3,
child: new Container(
key: key,
child: new Builder(
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add('a: ${v.value}');
return new Text('');
}
)
)
)
)
)
),
right: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new Container(
key: key,
child: new Builder(
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add('b: ${v.value}');
return new Text('');
}
)
)
)
)
)
)
)
)
)
);
expect(log, equals(<String>['a: 3']));
log.clear();
tester.pump();
expect(log, equals(<String>[]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<String>['b: 2']));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<String>['a: 3']));
log.clear();
});
testWidgets('Update inherited when removing node and child has global key with constant child', (WidgetTester tester) {
final List<int> log = <int>[];
Key key = new GlobalKey();
Widget child = new Builder(
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add(v.value);
return new Text('');
}
);
tester.pumpWidget(
new Container(
child: new ValueInherited(
value: 1,
child: new Container(
child: new FlipWidget(
left: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new ValueInherited(
value: 3,
child: new Container(
key: key,
child: child
)
)
)
)
),
right: new Container(
child: new ValueInherited(
value: 2,
child: new Container(
child: new Container(
key: key,
child: child
)
)
)
)
)
)
)
)
);
expect(log, equals(<int>[3]));
log.clear();
tester.pump();
expect(log, equals(<int>[]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<int>[2]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<int>[3]));
log.clear();
});
testWidgets('Update inherited when removing node and child has global key with constant child, minimised', (WidgetTester tester) {
final List<int> log = <int>[];
Widget child = new Builder(
key: new GlobalKey(),
builder: (BuildContext context) {
ValueInherited v = context.inheritFromWidgetOfExactType(ValueInherited);
log.add(v.value);
return new Text('');
}
);
tester.pumpWidget(
new ValueInherited(
value: 2,
child: new FlipWidget(
left: new ValueInherited(
value: 3,
child: child
),
right: child
)
)
);
expect(log, equals(<int>[3]));
log.clear();
tester.pump();
expect(log, equals(<int>[]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<int>[2]));
log.clear();
flipStatefulWidget(tester);
tester.pump();
expect(log, equals(<int>[3]));
log.clear();
});
testWidgets('Inherited widget notifies descendants when descendant previously failed to find a match', (WidgetTester tester) {
int inheritedValue = -1;
final Widget inner = new Container(
key: new GlobalKey(),
child: new Builder(
builder: (BuildContext context) {
ValueInherited widget = context.inheritFromWidgetOfExactType(ValueInherited);
inheritedValue = widget?.value;
return new Container();
}
)
);
tester.pumpWidget(
inner
);
expect(inheritedValue, isNull);
inheritedValue = -2;
tester.pumpWidget(
new ValueInherited(
value: 3,
child: inner
)
);
expect(inheritedValue, equals(3));
});
testWidgets('Inherited widget doesn\'t notify descendants when descendant did not previously fail to find a match and had no dependencies', (WidgetTester tester) {
int buildCount = 0;
final Widget inner = new Container(
key: new GlobalKey(),
child: new Builder(
builder: (BuildContext context) {
buildCount += 1;
return new Container();
}
)
);
tester.pumpWidget(
inner
);
expect(buildCount, equals(1));
tester.pumpWidget(
new ValueInherited(
value: 3,
child: inner
)
);
expect(buildCount, equals(1));
});
testWidgets('Inherited widget does notify descendants when descendant did not previously fail to find a match but did have other dependencies', (WidgetTester tester) {
int buildCount = 0;
final Widget inner = new Container(
key: new GlobalKey(),
child: new TestInherited(
shouldNotify: false,
child: new Builder(
builder: (BuildContext context) {
context.inheritFromWidgetOfExactType(TestInherited);
buildCount += 1;
return new Container();
}
)
)
);
tester.pumpWidget(
inner
);
expect(buildCount, equals(1));
tester.pumpWidget(
new ValueInherited(
value: 3,
child: inner
)
);
expect(buildCount, equals(2));
});
}