Skip to content

F
Front-End
Unverified Commit 9cb2953e authored by Dan Field's avatar Dan Field Committed by GitHub
Browse files
Options

Fix image tests that make faulty assumptions about lifecycle of image provider (#50297)

parent 56817279
Show whitespace changes
Inline Side-by-side
Showing with 203 additions and 10 deletions
packages/flutter/test/widgets/image_test.dart
View file @ 9cb2953e
...@@ -187,7 +187,9 @@ void main() { ...@@ -187,7 +187,9 @@ void main() {
final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1'); final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1');
final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2'); final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2');
final GlobalKey imageKey = GlobalKey(debugLabel: 'image'); final GlobalKey imageKey = GlobalKey(debugLabel: 'image');
final TestImageProvider imageProvider = TestImageProvider(); final ConfigurationKeyedTestImageProvider imageProvider = ConfigurationKeyedTestImageProvider();
final Set<Object> seenKeys = <Object>{};
final DebouncingImageProvider debouncingProvider = DebouncingImageProvider(imageProvider, seenKeys);
// Of the two nested MediaQuery objects, the innermost one, // Of the two nested MediaQuery objects, the innermost one,
// mediaQuery2, should define the configuration of the imageProvider. // mediaQuery2, should define the configuration of the imageProvider.
...@@ -207,7 +209,7 @@ void main() { ...@@ -207,7 +209,7 @@ void main() {
child: Image( child: Image(
excludeFromSemantics: true, excludeFromSemantics: true,
key: imageKey, key: imageKey,
image: imageProvider, image: debouncingProvider,
), ),
), ),
), ),
...@@ -234,7 +236,7 @@ void main() { ...@@ -234,7 +236,7 @@ void main() {
child: Image( child: Image(
excludeFromSemantics: true, excludeFromSemantics: true,
key: imageKey, key: imageKey,
image: imageProvider, image: debouncingProvider,
), ),
), ),
), ),
...@@ -247,7 +249,9 @@ void main() { ...@@ -247,7 +249,9 @@ void main() {
final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1'); final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1');
final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2'); final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2');
final GlobalKey imageKey = GlobalKey(debugLabel: 'image'); final GlobalKey imageKey = GlobalKey(debugLabel: 'image');
final TestImageProvider imageProvider = TestImageProvider(); final ConfigurationKeyedTestImageProvider imageProvider = ConfigurationKeyedTestImageProvider();
final Set<Object> seenKeys = <Object>{};
final DebouncingImageProvider debouncingProvider = DebouncingImageProvider(imageProvider, seenKeys);
// This is just a variation on the previous test. In this version the location // This is just a variation on the previous test. In this version the location
// of the Image changes and the MediaQuery widgets do not. // of the Image changes and the MediaQuery widgets do not.
...@@ -264,7 +268,7 @@ void main() { ...@@ -264,7 +268,7 @@ void main() {
child: Image( child: Image(
excludeFromSemantics: true, excludeFromSemantics: true,
key: imageKey, key: imageKey,
image: imageProvider, image: debouncingProvider,
), ),
), ),
MediaQuery( MediaQuery(
...@@ -302,7 +306,7 @@ void main() { ...@@ -302,7 +306,7 @@ void main() {
child: Image( child: Image(
excludeFromSemantics: true, excludeFromSemantics: true,
key: imageKey, key: imageKey,
image: imageProvider, image: debouncingProvider,
), ),
), ),
], ],
...@@ -312,6 +316,139 @@ void main() { ...@@ -312,6 +316,139 @@ void main() {
expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 10.0); expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 10.0);
}); });
testWidgets('Verify ImageProvider does not inherit configuration when it does not key to it', (WidgetTester tester) async {
final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1');
final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2');
final GlobalKey imageKey = GlobalKey(debugLabel: 'image');
final TestImageProvider imageProvider = TestImageProvider();
final Set<Object> seenKeys = <Object>{};
final DebouncingImageProvider debouncingProvider = DebouncingImageProvider(imageProvider, seenKeys);
// Of the two nested MediaQuery objects, the innermost one,
// mediaQuery2, should define the configuration of the imageProvider.
await tester.pumpWidget(
MediaQuery(
key: mediaQueryKey1,
data: const MediaQueryData(
devicePixelRatio: 10.0,
padding: EdgeInsets.zero,
),
child: MediaQuery(
key: mediaQueryKey2,
data: const MediaQueryData(
devicePixelRatio: 5.0,
padding: EdgeInsets.zero,
),
child: Image(
excludeFromSemantics: true,
key: imageKey,
image: debouncingProvider,
),
),
),
);
expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 5.0);
// This is the same widget hierarchy as before except that the
// two MediaQuery objects have exchanged places. The imageProvider
// should not be resolved again, because it does not key to configuration.
await tester.pumpWidget(
MediaQuery(
key: mediaQueryKey2,
data: const MediaQueryData(
devicePixelRatio: 5.0,
padding: EdgeInsets.zero,
),
child: MediaQuery(
key: mediaQueryKey1,
data: const MediaQueryData(
devicePixelRatio: 10.0,
padding: EdgeInsets.zero,
),
child: Image(
excludeFromSemantics: true,
key: imageKey,
image: debouncingProvider,
),
),
),
);
expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 5.0);
});
testWidgets('Verify ImageProvider does not inherit configuration when it does not key to it again', (WidgetTester tester) async {
final GlobalKey mediaQueryKey1 = GlobalKey(debugLabel: 'mediaQueryKey1');
final GlobalKey mediaQueryKey2 = GlobalKey(debugLabel: 'mediaQueryKey2');
final GlobalKey imageKey = GlobalKey(debugLabel: 'image');
final TestImageProvider imageProvider = TestImageProvider();
final Set<Object> seenKeys = <Object>{};
final DebouncingImageProvider debouncingProvider = DebouncingImageProvider(imageProvider, seenKeys);
// This is just a variation on the previous test. In this version the location
// of the Image changes and the MediaQuery widgets do not.
await tester.pumpWidget(
Row(
textDirection: TextDirection.ltr,
children: <Widget> [
MediaQuery(
key: mediaQueryKey2,
data: const MediaQueryData(
devicePixelRatio: 5.0,
padding: EdgeInsets.zero,
),
child: Image(
excludeFromSemantics: true,
key: imageKey,
image: debouncingProvider,
),
),
MediaQuery(
key: mediaQueryKey1,
data: const MediaQueryData(
devicePixelRatio: 10.0,
padding: EdgeInsets.zero,
),
child: Container(width: 100.0),
),
],
),
);
expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 5.0);
await tester.pumpWidget(
Row(
textDirection: TextDirection.ltr,
children: <Widget> [
MediaQuery(
key: mediaQueryKey2,
data: const MediaQueryData(
devicePixelRatio: 5.0,
padding: EdgeInsets.zero,
),
child: Container(width: 100.0),
),
MediaQuery(
key: mediaQueryKey1,
data: const MediaQueryData(
devicePixelRatio: 10.0,
padding: EdgeInsets.zero,
),
child: Image(
excludeFromSemantics: true,
key: imageKey,
image: debouncingProvider,
),
),
],
),
);
expect(imageProvider._lastResolvedConfiguration.devicePixelRatio, 5.0);
});
testWidgets('Verify Image stops listening to ImageStream', (WidgetTester tester) async { testWidgets('Verify Image stops listening to ImageStream', (WidgetTester tester) async {
final TestImageProvider imageProvider = TestImageProvider(); final TestImageProvider imageProvider = TestImageProvider();
await tester.pumpWidget(Image(image: imageProvider, excludeFromSemantics: true)); await tester.pumpWidget(Image(image: imageProvider, excludeFromSemantics: true));
...@@ -1229,7 +1366,36 @@ void main() { ...@@ -1229,7 +1366,36 @@ void main() {
}); });
} }
class TestImageProvider extends ImageProvider<TestImageProvider> { class ConfigurationAwareKey {
const ConfigurationAwareKey(this.provider, this.configuration)
: assert(provider != null),
assert(configuration != null);
final ImageProvider provider;
final ImageConfiguration configuration;
@override
bool operator ==(Object other) {
if (other.runtimeType != runtimeType) {
return false;
}
return other is ConfigurationAwareKey
&& other.provider == provider
&& other.configuration == configuration;
}
@override
int get hashCode => hashValues(provider, configuration);
}
class ConfigurationKeyedTestImageProvider extends TestImageProvider {
@override
Future<ConfigurationAwareKey> obtainKey(ImageConfiguration configuration) {
return SynchronousFuture<ConfigurationAwareKey>(ConfigurationAwareKey(this, configuration));
}
}
class TestImageProvider extends ImageProvider<Object> {
TestImageProvider({ImageStreamCompleter streamCompleter}) { TestImageProvider({ImageStreamCompleter streamCompleter}) {
_streamCompleter = streamCompleter _streamCompleter = streamCompleter
?? OneFrameImageStreamCompleter(_completer.future); ?? OneFrameImageStreamCompleter(_completer.future);
...@@ -1243,18 +1409,18 @@ class TestImageProvider extends ImageProvider<TestImageProvider> { ...@@ -1243,18 +1409,18 @@ class TestImageProvider extends ImageProvider<TestImageProvider> {
bool _loadCalled = false; bool _loadCalled = false;
@override @override
Future<TestImageProvider> obtainKey(ImageConfiguration configuration) { Future<Object> obtainKey(ImageConfiguration configuration) {
return SynchronousFuture<TestImageProvider>(this); return SynchronousFuture<TestImageProvider>(this);
} }
@override @override
void resolveStreamForKey(ImageConfiguration configuration, ImageStream stream, TestImageProvider key, ImageErrorListener handleError) { void resolveStreamForKey(ImageConfiguration configuration, ImageStream stream, Object key, ImageErrorListener handleError) {
_lastResolvedConfiguration = configuration; _lastResolvedConfiguration = configuration;
super.resolveStreamForKey(configuration, stream, key, handleError); super.resolveStreamForKey(configuration, stream, key, handleError);
} }
@override @override
ImageStreamCompleter load(TestImageProvider key, DecoderCallback decode) { ImageStreamCompleter load(Object key, DecoderCallback decode) {
_loadCalled = true; _loadCalled = true;
return _streamCompleter; return _streamCompleter;
} }
...@@ -1327,3 +1493,30 @@ class TestImage implements ui.Image { ...@@ -1327,3 +1493,30 @@ class TestImage implements ui.Image {
@override @override
String toString() => '[$width\u00D7$height]'; String toString() => '[$width\u00D7$height]';
} }
class DebouncingImageProvider extends ImageProvider<Object> {
DebouncingImageProvider(this.imageProvider, this.seenKeys);
/// A set of keys that will only get resolved the _first_ time they are seen.
///
/// If an ImageProvider produces the same key for two different image
/// configurations, it should only actually resolve once using this provider.
/// However, if it does care about image configuration, it should make the
/// property or properties it cares about part of the key material it
/// produces.
final Set<Object> seenKeys;
final ImageProvider<Object> imageProvider;
@override
void resolveStreamForKey(ImageConfiguration configuration, ImageStream stream, Object key, ImageErrorListener handleError) {
if (seenKeys.add(key)) {
imageProvider.resolveStreamForKey(configuration, stream, key, handleError);
}
}
@override
Future<Object> obtainKey(ImageConfiguration configuration) => imageProvider.obtainKey(configuration);
@override
ImageStreamCompleter load(Object key, DecoderCallback decode) => imageProvider.load(key, decode);
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

HIAST - GitLab