Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

[Windows] Allow plugins to get views #51096

Merged
auto-submit merged 2 commits into from
Mar 6, 2024
Merged

[Windows] Allow plugins to get views #51096

auto-submit merged 2 commits into from
Mar 6, 2024

Conversation

@loic-sharma
Copy link
Member

@loic-sharma loic-sharma commented Feb 29, 2024

Allow Flutter Windows plugins to get views by their ID.

Design doc: https://flutter.dev/go/desktop-multi-view-runner-apis

Part of flutter/flutter#143767
Part of flutter/flutter#142845

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 Flutter Style Guide and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@loic-sharma loic-sharma force-pushed the windows_plugin_registar_get_view branch from 01c60cb to 870b27b Compare February 29, 2024 18:50
loic-sharma
loic-sharma commented Feb 29, 2024
View reviewed changes
shell/platform/windows/client_wrapper/include/flutter/plugin_registrar_windows.h Outdated
// not destroy the underlying view.
std::shared_ptr<FlutterView> GetViewById(FlutterViewId view_id) const {
return std::make_shared<FlutterView>(
FlutterDesktopPluginRegistrarGetViewById(registrar(), view_id));
Copy link
Member Author

@loic-sharma loic-sharma Feb 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ This API returns a std::shared_ptr<FlutterView> instead of a FlutterView*. This is a change from the original design.

The original PluginRegistrarWindows::GetViewById proposal returned a FlutterView* to align with PluginRegistrarWindows::GetView. However, this would require the PluginRegistrarWindows to own/manage FlutterViews, similar to how it stores the implicit view today. We would need to introduce some other API to allow cleaning up these FlutterViews. By returning a std::shared_ptr<FlutterView>, the user can clean up the FlutterView themselves when they no longer need the view reference.

@loic-sharma loic-sharma force-pushed the windows_plugin_registar_get_view branch from 870b27b to c3a423f Compare February 29, 2024 18:55
@loic-sharma
Copy link
Member Author

loic-sharma commented Mar 5, 2024

Gentle reminder @yaakovschectman @cbracken, this is ready for review :)

yaakovschectman
yaakovschectman approved these changes Mar 5, 2024
View reviewed changes
Copy link
Contributor

@yaakovschectman yaakovschectman left a comment

Choose a reason for hiding this comment

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

LGTM

cbracken
cbracken approved these changes Mar 5, 2024
View reviewed changes
Copy link
Member

@cbracken cbracken left a comment

Choose a reason for hiding this comment

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

LGTM stamp from a Japanese personal seal

No comments other than thumbs-up to the const-ification.

@loic-sharma
Copy link
Member Author

loic-sharma commented Mar 6, 2024 •
edited
Loading

@yaakovschectman @cbracken FYI I pushed a new commit: f89609f. Before this fix, nullptr wasn't returned if the view does not exist. I also added tests.

cbracken
cbracken approved these changes Mar 6, 2024
View reviewed changes
Copy link
Member

@cbracken cbracken left a comment

Choose a reason for hiding this comment

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

re-lgtm!

@loic-sharma loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 6, 2024
@auto-submit auto-submit bot merged commit b2adf74 into flutter:main Mar 6, 2024
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Mar 6, 2024
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 6, 2024
@engine-flutter-autoroll
b2adf7471 [Windows] Allow plugins to get views (flutter/engine#51096)
4f66db2
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Mar 6, 2024
@engine-flutter-autoroll
Roll Flutter Engine from 31bbe61dfa0d to b2adf7471d3d (1 revision) (#…
1cbabd7 
…144732)

flutter/engine@31bbe61...b2adf74

2024-03-06 [email protected] [Windows] Allow plugins to get views (flutter/engine#51096)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@dkwingsmt dkwingsmt Awaiting requested review from dkwingsmt

2 more reviewers

@cbracken cbracken cbracken approved these changes

@yaakovschectman yaakovschectman yaakovschectman approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

affects: desktop autosubmit Merge PR when tree becomes green via auto submit App platform-windows

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@loic-sharma @cbracken @yaakovschectman