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

Jump to bottom
Merged
tvolkert merged 1 commit into from
May 21, 2019
Merged

Add some sanity to the ImageStream listener API #32936

tvolkert merged 1 commit into from
May 21, 2019

Conversation

@tvolkert
Copy link
Contributor

@tvolkert tvolkert commented May 17, 2019 •
edited
Loading

Description

The current API was broken in that you registered multiple
callbacks at once, but when you removed listeners, only the
primary listener was used to determine what was removed.
This led to unintuitive cases where the caller could get
unexpected behavior.

This updates the API to add and remove listeners using a
newly introduced [ImageStreamListener] object, a value
object that has references to the individual callbacks that
may fire.

Related Issues

Tests

I updated all affected tests to match the new API/behavior.

Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I signed the [CLA].
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require Flutter developers to manually update their apps to accommodate your change?

@tvolkert tvolkert requested review from Hixie and goderbauer May 17, 2019 23:04
Hixie
Hixie reviewed May 17, 2019
View reviewed changes
Hixie
Hixie reviewed May 17, 2019
View reviewed changes
Hixie
Hixie reviewed May 17, 2019
View reviewed changes
Hixie
Hixie reviewed May 17, 2019
View reviewed changes
@Hixie
Copy link
Contributor

Hixie commented May 17, 2019

Your claim that this is not a breaking change is entertaining. :-P

The direction looks good.

cc @xster who wrote this initially.
cc @goderbauer for framework review.

@Piinks Piinks added a: images Loading, displaying, rendering images framework flutter/packages/flutter repository. See also f: labels. labels May 17, 2019
@tvolkert tvolkert mentioned this pull request May 18, 2019
Closed
9 tasks
goderbauer
goderbauer approved these changes May 20, 2019
View reviewed changes
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tvolkert
Add some sanity to the ImageStream listener API
40da9f5 
The current API was broken in that you registered multiple
callbacks at once, but when you removed listeners, only the
primary listener was used to determine what was removed.
This led to unintuitive cases where the caller could get
unexpected behavior.

This updates the API to add and remove listeners using
a newly introduced [ImageStreamListener] object, a value
object that has references to the individual callbacks
that may fire.

#24722
#32374
#32935
@tvolkert tvolkert merged commit 592f81e into flutter:master May 21, 2019
@tvolkert tvolkert deleted the listeners branch May 21, 2019 00:40
@tvolkert tvolkert mentioned this pull request May 21, 2019
Closed
mollywoodnini added a commit to mollywoodnini/flutter_plugin_pdf_viewer that referenced this pull request May 22, 2019
@mollywoodnini
Update page.dart
5e9e9fd 
updated listener handling due to new flutter version: flutter/flutter#32936
DavBfr added a commit to DavBfr/dart_pdf that referenced this pull request May 28, 2019
@DavBfr
Update listener handling flutter/flutter#32936
6c3d958
@amirh amirh mentioned this pull request May 28, 2019
Closed
amirh added a commit to amirh/plugins that referenced this pull request May 28, 2019
@amirh
Update and comment out the 'set marker icon' sample.
6331b4b 
This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

As we cannot use the new API before it makes it to stable I'm commenting
out the sample for now(if we update it now it won't compile on stable,
and if we leave it as is it breaks CI on master).
amirh added a commit to amirh/plugins that referenced this pull request May 28, 2019
@amirh
Update and comment out the 'set marker icon' sample.
f12ca58 
This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

As we cannot use the new API before it makes it to stable I'm commenting
out the sample for now(if we update it now it won't compile on stable,
and if we leave it as is it breaks CI on master).
@amirh amirh mentioned this pull request May 28, 2019
Merged
13 tasks
amirh added a commit to flutter/plugins that referenced this pull request May 28, 2019
@amirh
[google_maps_flutter] Update and comment out the 'set marker icon' sa…
607ecf0 
…mple. (#1640)

This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

As we cannot use the new API before it makes it to stable I'm commenting
out the sample for now(if we update it now it won't compile on stable,
and if we leave it as is it breaks CI on master).
@amirh amirh mentioned this pull request May 28, 2019
Merged
13 tasks
amirh added a commit to flutter/plugins that referenced this pull request May 28, 2019
@amirh
[firebase_ml_vision] Update sample to use new ImageStreamListener API
d1dc420 
This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

This is similar to the change we did to Google Maps in #1640, unfortunately in the firebase_ml_vision case where we commented out the sample that used the ImageStream listener API. Unfortunately in the firebase_ml_vision case, there's no point in the sample without the ImageStream listener(you need it to pick an image), so I'm just updating the sample to the new API knowing that it won't compile on stable until the breaking change makes it there.
DavBfr added a commit to DavBfr/dart_pdf that referenced this pull request Jun 15, 2019
@DavBfr
Update listener handling flutter/flutter#32936
26eea82
DavBfr added a commit to DavBfr/dart_pdf that referenced this pull request Jun 15, 2019
@DavBfr
Update listener handling flutter/flutter#32936
07e93be
collinjackson pushed a commit to collinjackson/flutterfire-old2 that referenced this pull request Jun 24, 2019
@amirh
[firebase_ml_vision] Update sample to use new ImageStreamListener API
1847a95 
This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

This is similar to the change we did to Google Maps in #1640, unfortunately in the firebase_ml_vision case where we commented out the sample that used the ImageStream listener API. Unfortunately in the firebase_ml_vision case, there's no point in the sample without the ImageStream listener(you need it to pick an image), so I'm just updating the sample to the new API knowing that it won't compile on stable until the breaking change makes it there.
DavBfr added a commit to DavBfr/dart_pdf that referenced this pull request Jul 11, 2019
@DavBfr
Update listener handling flutter/flutter#32936
c30ba0d
collinjackson pushed a commit to firebase/flutterfire that referenced this pull request Aug 14, 2019
@amirh
[firebase_ml_vision] Update sample to use new ImageStreamListener API
dc3947c 
This updates the sample to adapt to the ImageStream listener API changes
in flutter/flutter#32936

This is similar to the change we did to Google Maps in #1640, unfortunately in the firebase_ml_vision case where we commented out the sample that used the ImageStream listener API. Unfortunately in the firebase_ml_vision case, there's no point in the sample without the ImageStream listener(you need it to pick an image), so I'm just updating the sample to the new API knowing that it won't compile on stable until the breaking change makes it there.
@renovate renovate bot mentioned this pull request Jun 6, 2021
Open
1 task
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Hixie Hixie Hixie left review comments

@goderbauer goderbauer goderbauer approved these changes

Assignees

No one assigned

Labels

a: images Loading, displaying, rendering images framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tvolkert @Hixie @goderbauer @googlebot @Piinks