[tool] Add `dartFileName` setting for platform plugins by Sameri11 · Pull Request #153099 · flutter/flutter

Sameri11 · 2024-08-08T15:27:41Z

This PR introduces the dartFileName parameter for platform plugin configurations with Dart platform implementations. This new parameter allows plugin developers to specify a custom path to the file where the dartPluginClass is defined.

Implementation is opt-in. dartFileName is completely optional and is taken in account only with dartClassName. Possibility to set dartClassName without dartFileName remains.

Implementation is backward compatible – existing configurations using only dartClassName remain fully supported. If dartFileName is omitted, the system falls back to the previous behavior of deriving the file name from the plugin name.

Example

flutter:
  plugin:
    platforms:
      some_platform:
        dartPluginClass: MyPlugin
        dartFileName: 'src/my_plugin_implementation.dart'

fixes #152833

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, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
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.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

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

Sameri11 · 2024-08-26T18:28:11Z

@christopherfujino, given your recent reviews to PR's with files affected here, would you kindly review this PR when you have a moment? Thank you!

packages/flutter_tools/lib/src/flutter_plugins.dart

packages/flutter_tools/lib/src/plugins.dart

packages/flutter_tools/test/general.shard/plugin_parsing_test.dart

stuartmorgan-g

LGTM with one nit.

packages/flutter_tools/lib/src/platform_plugins.dart

…ith Dart implementation

christopherfujino

LGTM

auto-submit · 2024-09-06T18:05:11Z

auto label is removed for flutter/flutter/153099, due to - The status or check suite Windows build_tests_5_7 has failed. Please fix the issues identified (or deflake) before re-applying this label.

…er/flutter#153099)

flutter/flutter@45ef8f3...2e221e7 2024-09-06 [email protected] Fix DropdownMenu focused item styles (flutter/flutter#153159) 2024-09-06 [email protected] Support custom transition duration for `DialogRoute`, `CupertinoDialogRoute` and show dialog methods. (flutter/flutter#154048) 2024-09-06 [email protected] [tool] Add `dartFileName` setting for platform plugins (flutter/flutter#153099) 2024-09-06 [email protected] [Conductor] Add ability to override mirror, add tests for default arg parsing and custom arg parsing (flutter/flutter#154363) 2024-09-06 [email protected] Improve CupertinoPopupSurface appearance (flutter/flutter#151430) 2024-09-06 [email protected] Roll Packages from 71e827e to 56df73e (1 revision) (flutter/flutter#154725) 2024-09-06 [email protected] Quick access to style guide (flutter/flutter#154689) 2024-09-06 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from c50eb8a65097 to 015f3b1dec53 (2 revisions) (#154691)" (flutter/flutter#154726) 2024-09-05 [email protected] Improve iOS unpack target's error messages (flutter/flutter#154649) 2024-09-05 [email protected] Made some pixel tests fuzzy (flutter/flutter#154680) 2024-09-05 [email protected] Roll Flutter Engine from c50eb8a65097 to 015f3b1dec53 (2 revisions) (flutter/flutter#154691) 2024-09-05 49699333+dependabot[bot]@users.noreply.github.com Bump peter-evans/create-pull-request from 7.0.0 to 7.0.1 (flutter/flutter#154690) 2024-09-05 [email protected] Normalize Dialog theme (flutter/flutter#153982) 2024-09-05 [email protected] iOS,macOS: Do not copy unsigned_binaries.txt to build outputs (flutter/flutter#154684) 2024-09-05 [email protected] Roll Flutter Engine from e042ff5df7af to c50eb8a65097 (1 revision) (flutter/flutter#154679) 2024-09-05 [email protected] Add proguard rule to keep the class for all implementations of FlutterPlugin (flutter/flutter#154677) 2024-09-05 [email protected] Fix DropdownMenu menu does not follow the text field (flutter/flutter#154667) 2024-09-05 [email protected] Roll Flutter Engine from a156e713f4dc to e042ff5df7af (1 revision) (flutter/flutter#154678) 2024-09-05 [email protected] Fix ZoomPageTransitionsBuilder hardcoded fill color (flutter/flutter#154057) 2024-09-05 [email protected] Roll Flutter Engine from 34b61eb53b99 to a156e713f4dc (1 revision) (flutter/flutter#154672) 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 Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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

…er/flutter#153099)

Honor the "dartFileName" key when generating the Dart plugin registrant so plugins can specify a non-default entrypoint file.\n\nRefs: flutter/flutter#153099\nhttps://github.com/flutter/flutter/pull/153099

…metadata - Exclude dev_dependency Dart plugins from integration test entrypoint wrappers. - Honor dartFileName when generating plugin imports. - Avoid forcing buildInfo to be non-null; fall back to debuggingOptions.buildInfo. Refs: flutter/flutter#153099, flutter/flutter#161828 flutter/flutter#153099 flutter/flutter#161828

When generating integration_test wrapper files, prefer package URIs (via package_config) over file URIs for mainImport to better match upstream registrant generation. Refs: flutter/flutter#153099 flutter/flutter#153099

@pragma

Generate integration_test entrypoint wrappers with a @pragma('vm:entry-point') plugin registrant class and import dart_plugin_registrant, matching upstream patterns used for Dart plugin registration. Refs: flutter/flutter#153099 flutter/flutter#153099

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Aug 8, 2024

Sameri11 changed the title ~~first try~~ add dartFileName setting to platform plugins Aug 8, 2024

Sameri11 force-pushed the fix-issue-152833 branch from 3998959 to dd46c0b Compare August 8, 2024 15:45

github-actions bot added the a: desktop Running on desktop label Aug 8, 2024

Sameri11 force-pushed the fix-issue-152833 branch 3 times, most recently from 76f6b29 to 3f40418 Compare August 11, 2024 13:03

Sameri11 changed the title ~~add dartFileName setting to platform plugins~~ [tool] Add dartFileName setting for platform plugins Aug 11, 2024

Sameri11 marked this pull request as ready for review August 11, 2024 13:43

Sameri11 mentioned this pull request Aug 11, 2024

dartPluginClass forces to export implementation of platform interface as public api #152833

Closed

Sameri11 force-pushed the fix-issue-152833 branch 3 times, most recently from c9c89ad to 47ecf83 Compare August 13, 2024 14:52

andrewkolos requested a review from stuartmorgan-g August 15, 2024 21:00

Sameri11 force-pushed the fix-issue-152833 branch 3 times, most recently from 4c28892 to 54b0708 Compare August 19, 2024 11:12

Sameri11 force-pushed the fix-issue-152833 branch from 54b0708 to 536b0cf Compare August 26, 2024 17:54

stuartmorgan-g requested changes Aug 27, 2024

View reviewed changes

Sameri11 force-pushed the fix-issue-152833 branch from 536b0cf to ef12b3d Compare August 27, 2024 18:07

Sameri11 requested a review from stuartmorgan-g August 28, 2024 16:49

stuartmorgan-g approved these changes Sep 5, 2024

View reviewed changes

packages/flutter_tools/lib/src/platform_plugins.dart Outdated Show resolved Hide resolved

stuartmorgan-g requested a review from christopherfujino September 5, 2024 17:13

Sameri11 added 5 commits September 6, 2024 14:09

introduce dartFileName configuration parameter for platform plugins w…

e34f5e3

…ith Dart implementation

fix existing tests

daf4c88

add new tests for dartFileName yaml parameter

c069084

style fixes

9b97297

code review fixes

deb7b6f

Sameri11 force-pushed the fix-issue-152833 branch from ef12b3d to deb7b6f Compare September 6, 2024 09:09

christopherfujino approved these changes Sep 6, 2024

View reviewed changes

christopherfujino added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 6, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 6, 2024

christopherfujino added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 6, 2024

auto-submit bot merged commit d932115 into flutter:master Sep 6, 2024

engine-flutter-autoroll mentioned this pull request Sep 6, 2024

Roll Flutter from 45ef8f36ff41 to d9321159bfa6 (18 revisions) flutter/packages#7598

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 6, 2024

d932115 [tool] Add dartFileName setting for platform plugins (flutt…

3646df8

…er/flutter#153099)

engine-flutter-autoroll mentioned this pull request Sep 6, 2024

Roll Flutter from 45ef8f36ff41 to 2e221e7308ba (20 revisions) flutter/packages#7599

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 6, 2024

d932115 [tool] Add dartFileName setting for platform plugins (flutt…

fb1aee9

…er/flutter#153099)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 11, 2024

d932115 [tool] Add dartFileName setting for platform plugins (flutt…

0d5f6c8

…er/flutter#153099)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Dec 12, 2024

d932115 [tool] Add dartFileName setting for platform plugins (flutt…

2ae17a6

…er/flutter#153099)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tool] Add `dartFileName` setting for platform plugins #153099

[tool] Add `dartFileName` setting for platform plugins #153099
auto-submit[bot] merged 5 commits intoflutter:masterfrom
Sameri11:fix-issue-152833

Sameri11 commented Aug 8, 2024 •

edited

Loading

Uh oh!

Sameri11 commented Aug 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

christopherfujino left a comment

Uh oh!

auto-submit bot commented Sep 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Sameri11 commented Aug 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example

Pre-launch Checklist

Uh oh!

Sameri11 commented Aug 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Sep 6, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sameri11 commented Aug 8, 2024 •

edited

Loading