[pigeon] Improves documentation of ProxyApi and moves helper functions to a separate file
#9756
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a great refactoring effort. Moving the ProxyAPI generation logic into a dedicated helper file (proxy_api_generator_helper.dart) significantly improves the modularity and maintainability of the Dart generator. The extensive documentation updates are also a major improvement, making the concepts around ProxyAPIs much clearer for developers.
I've found one minor point of feedback regarding the wording in the CHANGELOG.md to more accurately reflect the changes. Overall, this is a high-quality contribution.
packages/pigeon/CHANGELOG.md
Outdated
Comment on lines
3
to
4
| * Moves helper classes for generating Dart portion of ProxyAPIs. | ||
| * Improves documentation of `ProxyApi` annotation and internal Dart ProxyAPI helper classes. |
There was a problem hiding this comment.
For clarity and accuracy, it would be better to refer to the moved code as "functions" rather than "classes", as the refactoring primarily involved moving top-level helper functions.
Suggested change
| * Moves helper classes for generating Dart portion of ProxyAPIs. | |
| * Improves documentation of `ProxyApi` annotation and internal Dart ProxyAPI helper classes. | |
| * Moves helper functions for generating Dart portion of ProxyAPIs. | |
| * Improves documentation of `ProxyApi` annotation and internal Dart ProxyAPI helper functions. |
bparrishMines
changed the title
ProxyApi and moves helper functions to a separate file
bparrishMines
commented
Aug 6, 2025
| /// 3. An InstanceManager that is a global collection that handles serializable | ||
| /// references to the Dart proxy classes and the native type instances. This | ||
| /// also provides automatic garbage collection of native type instances when its | ||
| /// associated Dart proxy class instance is garbage collected. | ||
| class ProxyApi { |
There was a problem hiding this comment.
@tarrinneal @stuartmorgan-g Let me know if this explanation of "what is a ProxyAPI" makes sense.
tarrinneal
approved these changes
Aug 7, 2025
bparrishMines
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Aug 12, 2025
…per functions to a separate file (flutter/packages#9756)
github-merge-queue bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Aug 12, 2025
flutter/packages@a114ac2...08a9b2c 2025-08-11 [email protected] [in_app_purchase_storekit] Add support for quantity in consumable product purchases (#171570) (flutter/packages#9698) 2025-08-11 [email protected] [pigeon] Improves documentation of `ProxyApi` and moves helper functions to a separate file (flutter/packages#9756) 2025-08-11 [email protected] Roll Flutter from 1590543 to e2a347b (1 revision) (flutter/packages#9784) 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
CaoGiaHieu-dev
added a commit
to CaoGiaHieu-dev/packages
that referenced
this pull request
Aug 14, 2025
* main: (56 commits) [go_router_builder] Support extension types (flutter#9458) Roll Flutter from e2a347b14a18 to 34c2a3b158b2 (41 revisions) (flutter#9803) [go_router_builder] Migrate to Element2 API and update dependencies (flutter#9649) [in_app_purchase_storekit] Add support for quantity in consumable product purchases (#171570) (flutter#9698) [pigeon] Improves documentation of `ProxyApi` and moves helper functions to a separate file (flutter#9756) Roll Flutter from 1590543f6794 to e2a347b14a18 (1 revision) (flutter#9784) [camera_avfoundation] Implementation swift migration - part 11 (flutter#9690) [camera_avfoundation] Fix crash when streaming while recording (flutter#9691) Roll Flutter from 38217906e95c to 1590543f6794 (14 revisions) (flutter#9780) Roll Flutter from 92a6bfbfd6ef to 38217906e95c (17 revisions) (flutter#9778) [video_player] Improve KVO handling on iOS (flutter#9718) [dependabot]: Bump the test-dependencies group across 15 directories with 7 updates (flutter#9736) Roll Flutter from 9de63a03428f to 92a6bfbfd6ef (11 revisions) (flutter#9769) [google_maps_flutter_platform_interface] Add Advanced markers support (flutter#9737) [camera_android_camerax] Re-land "Force new Surface for each SurfaceRequest" (flutter#9760) [google_maps_flutter] Add ability to perform Google Maps SDK warmup (flutter#9674) Roll Flutter from 59fc766c6fdf to 9de63a03428f (6 revisions) (flutter#9764) [webview_flutter_wkwebview] Extended Web View API on iOS to add flexibility when working with local HTML content (flutter#8787) [local_auth] Differentiate iOS authentication errors (flutter#9705) manual roll to 59fc766c6fdfd03d0983fc95ce8b76793a300dd5 (flutter#9758) ... # Conflicts: # packages/go_router_builder/lib/src/type_helpers.dart # packages/go_router_builder/pubspec.yaml
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up to #9515 that moves Dart ProxyApi methods to a separate file.
Pre-Review Checklist
[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under1.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under1.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the
gemini-code-assistbot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2 ↩3