Skip to content

Add some sanity to the ImageStream listener API #32936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tvolkert merged 1 commit into from
May 21, 2019
Merged

Add some sanity to the ImageStream listener API #32936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions dev/integration_tests/image_loading/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,17 @@ class _ImageLoaderState extends State<ImageLoader> {
// http client.
final NetworkImage image = NetworkImage('https://github.com/flutter/flutter');
final ImageStream stream = image.resolve(ImageConfiguration.empty);
stream.addListener((ImageInfo info, bool syncCall) {}, onError: (dynamic error, StackTrace stackTrace) {
print('ERROR caught by framework');
});
ImageStreamListener listener;
listener = ImageStreamListener(
(ImageInfo info, bool syncCall) {
stream.removeListener(listener);
},
onError: (dynamic error, StackTrace stackTrace) {
print('ERROR caught by framework');
stream.removeListener(listener);
},
);
stream.addListener(listener);
super.initState();
}

Expand Down
9 changes: 5 additions & 4 deletions packages/flutter/lib/src/painting/decoration_image.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,10 @@ class DecorationImagePainter {

final ImageStream newImageStream = _details.image.resolve(configuration);
if (newImageStream.key != _imageStream?.key) {
_imageStream?.removeListener(_imageListener);
final ImageStreamListener listener = ImageStreamListener(_handleImage);
_imageStream?.removeListener(listener);
_imageStream = newImageStream;
_imageStream.addListener(_imageListener);
_imageStream.addListener(listener);
}
if (_image == null)
return;
Expand Down Expand Up @@ -268,7 +269,7 @@ class DecorationImagePainter {
canvas.restore();
}

void _imageListener(ImageInfo value, bool synchronousCall) {
void _handleImage(ImageInfo value, bool synchronousCall) {
if (_image == value)
return;
_image = value;
Expand All @@ -284,7 +285,7 @@ class DecorationImagePainter {
/// After this method has been called, the object is no longer usable.
@mustCallSuper
void dispose() {
_imageStream?.removeListener(_imageListener);
_imageStream?.removeListener(ImageStreamListener(_handleImage));
}

@override
Expand Down
8 changes: 5 additions & 3 deletions packages/flutter/lib/src/painting/image_cache.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,10 @@ class ImageCache {
_checkCacheSize();
}
if (maximumSize > 0 && maximumSizeBytes > 0) {
_pendingImages[key] = _PendingImage(result, listener);
result.addListener(listener);
final ImageStreamListener streamListener = ImageStreamListener(listener);
_pendingImages[key] = _PendingImage(result, streamListener);
// Listener is removed in [_PendingImage.removeListener].
result.addListener(streamListener);
Comment thread
tvolkert marked this conversation as resolved.
Outdated
}
return result;
}
Expand Down Expand Up @@ -215,7 +217,7 @@ class _PendingImage {
_PendingImage(this.completer, this.listener);

final ImageStreamCompleter completer;
final ImageListener listener;
final ImageStreamListener listener;

void removeListener() {
completer.removeListener(listener);
Expand Down
7 changes: 4 additions & 3 deletions packages/flutter/lib/src/painting/image_provider.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,9 @@ class ImageConfiguration {
/// // If the keys are the same, then we got the same image back, and so we don't
/// // need to update the listeners. If the key changed, though, we must make sure
/// // to switch our listeners to the new image stream.
/// oldImageStream?.removeListener(_updateImage);
/// _imageStream.addListener(_updateImage);
/// final ImageStreamListener listener = ImageStreamListener(_updateImage);
/// oldImageStream?.removeListener(listener);
/// _imageStream.addListener(listener);
/// }
/// }
///
Expand All @@ -232,7 +233,7 @@ class ImageConfiguration {
///
/// @override
/// void dispose() {
/// _imageStream.removeListener(_updateImage);
/// _imageStream.removeListener(ImageStreamListener(_updateImage));
/// super.dispose();
/// }
///
Expand Down
Loading