Skip to content
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.

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

[pigeon] Adds annotation options to omit shared classes used in Event Channels #8566

Merged
merged 6 commits into from
Feb 6, 2025

Conversation

tarrinneal
Copy link
Contributor

fixes flutter/flutter#161291

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the [CLA].
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes].
  • I updated CHANGELOG.md to add a description of the change, [following repository CHANGELOG style].
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • All existing and new tests are passing.

@tarrinneal
Copy link
Contributor Author

@stuartmorgan ready for review

Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

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

LGTM

if (containsEventChannelApi) {
result.add(Error(
message:
'Event Channel methods must all be included in a single EventChannelApi',
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have an issue tracking this? It's definitely low priority, but it's an unintuitive restriction.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can fix it in this pr, it's not super complex. The main issue is that naming collisions aren't managed properly, since all of the methods end up top level when generated.

Copy link
Contributor

Choose a reason for hiding this comment

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

It doesn't need to be in this PR, just seemed worth filing so we had a tracker.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 6, 2025
@auto-submit auto-submit bot merged commit cb18978 into flutter:main Feb 6, 2025
77 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 7, 2025
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Feb 7, 2025
flutter/packages@e6ce02c...625023a

2025-02-07 [email protected] [camera] Remove OCMock from
AvailableCamerasTests, CameraOrientationTests and
ThreadSafeEventChannelTests (flutter/packages#8363)
2025-02-06 [email protected] [pigeon] Adds annotation options to omit
shared classes used in Event Channels (flutter/packages#8566)
2025-02-06 [email protected] [quick_actions] Update Android Pigeon
version (flutter/packages#8580)
2025-02-05 [email protected] [ci] Move Wasm test shards out of bringup.
(flutter/packages#8572)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC [email protected] on the revert to ensure that a
human
is aware of the problem.

To file a bug in Flutter:
https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: pigeon platform-android
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[pigeon]Support EventChannelApi in multiple interface files
2 participants