Add plugin version to SwiftPM package symlink directory by vashworth · Pull Request #183668 · flutter/flutter

vashworth · 2026-03-13T22:00:11Z

SwiftPM caches package's Package.swift manifest in $HOME/Library/Caches/org.swift.swiftpm/manifests. Due to this caching, when pub changes versions, SwiftPM doesn't always detect the Package.manifest has changed.

This PR changes the symlink directory to use the plugin's directory basename, which has the version in it:

- .packages/plugin_a -> /$HOME/.pub-cache/hosted/pub.dev/plugin_a-1.0.0/ios/plugin_a
+ .packages/plugin_a-1.0.0 -> /$HOME/.pub-cache/hosted/pub.dev/plugin_a-1.0.0/ios/plugin_a

This forces Xcode to re-cache the manifest.

This also refactors a few places we fetch plugins by saving them to the project rather than re-finding them each time. This is currently limited to the XcodeBasedProject.

Fixes #182099
Fixes #183226

Pre-launch Checklist

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-assist bot 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.

gemini-code-assist

Code Review

This pull request addresses a SwiftPM caching issue by including the plugin version in the symlink directory name, forcing Xcode to re-cache the manifest when the version changes. It also refactors how plugins are accessed by caching the list of plugins within the XcodeBasedProject to avoid repeated lookups.

gemini-code-assist · 2026-03-16T19:30:28Z

+class FakePlugin extends Fake implements Plugin {
+  FakePlugin({required this.name, this.platforms = const <String, PluginPlatform>{}});
+
+  @override
+  final String name;
+
+  @override
+  final Map<String, PluginPlatform> platforms;
+
+  @override
+  String? pluginSwiftPackageManifestPath(FileSystem fileSystem, String platform) {
+    return 'path/to/$name/$platform/$name/Package.swift';
+  }
+
+  @override
+  String? pluginPodspecPath(FileSystem fileSystem, String platform) {
+    return 'path/to/$name/$platform/$name.podspec';
+  }
+}


There's some duplication of test fakes. The FakePlugin class is also defined in packages/flutter_tools/test/general.shard/macos/swift_package_manager_test.dart and packages/flutter_tools/test/general.shard/migrations/swift_package_manager_integration_migration_test.dart.

To improve maintainability and reduce code duplication, consider creating a single, more configurable FakePlugin in a shared test utility file, like packages/flutter_tools/test/src/fakes.dart. This shared fake could be made flexible enough to accommodate the different needs of these tests, for example by allowing customization of its path, supported platforms, and whether it has a Swift package.

stuartmorgan-g

Hm, this will break the way I had planned to do cross-plugin referencing in https://github.com/googleads/googleads-mobile-flutter/pull/1395/changes#diff-1298932cb35428e06f9cc2a3af652bb7124a352b9d74a42adfefb6d7633ae080R17, and it'll break anyone who has already done that. Not necessarily a deal-breaker since the directory layout isn't a formal API, but it is a risk. And more importantly, we'll need a way to handle that use case that we can recommend instead.

vashworth · 2026-03-16T21:52:57Z

Hm, this will break the way I had planned to do cross-plugin referencing in https://github.com/googleads/googleads-mobile-flutter/pull/1395/changes#diff-1298932cb35428e06f9cc2a3af652bb7124a352b9d74a42adfefb6d7633ae080R17, and it'll break anyone who has already done that. Not necessarily a deal-breaker since the directory layout isn't a formal API, but it is a risk. And more importantly, we'll need a way to handle that use case that we can recommend instead.

🤦‍♀️ I forgot about that and integration tests wouldn't have caught it because they use local path. Thank goodness for @stuartmorgan-g

… plugin

hellohuanlin · 2026-03-27T17:58:39Z

Hm, this will break the way I had planned to do cross-plugin referencing in https://github.com/googleads/googleads-mobile-flutter/pull/1395/changes#diff-1298932cb35428e06f9cc2a3af652bb7124a352b9d74a42adfefb6d7633ae080R17, and it'll break anyone who has already done that. Not necessarily a deal-breaker since the directory layout isn't a formal API, but it is a risk. And more importantly, we'll need a way to handle that use case that we can recommend instead.

Is this comment resolved, or was there a discussion that I didn't see? What is the solution? It'd be helpful to provide some context here.

stuartmorgan-g

LGTM with minor comments.

stuartmorgan-g · 2026-03-31T20:50:47Z

Is this comment resolved, or was there a discussion that I didn't see? What is the solution? It'd be helpful to provide some context here.

There was offline discussion; the resolution is that if a plugin has this pattern, flutter will copy the plugin's Swift package into a project-local cache and then modify it. (That behavior is in the updated PR.)

There is some risk of unexpected edge-case breakage due to this, since it will be a black-magic step from the plugin developer's perspective, but:

We couldn't find any better solution that avoided the stale SwiftPM cache problem.
This pattern is expected to be rare in the first place, so the number of developers potentially affected should be small.
Since this behavior will exist from the start of widespread use of SwiftPM in Flutter plugins, any issues should be of the form "I, a plugin developer, expected X to work and it didn't, so I'm filing an issue because it's affecting my ability to write my plugin and I need a solution" rather than "We, a bunch of plugin clients, are suddenly broken in a Flutter update."

stuartmorgan-g

I appear to have pressed the wrong button with that review.

…to_dir_name

auto-submit · 2026-04-02T17:37:03Z

auto label is removed for flutter/flutter/183668, Failed to enqueue flutter/flutter/183668 with HTTP 400: GraphQL mutate failed.

…utter/flutter#183668)

flutter/flutter@0f401ee...7245c3f 2026-04-03 [email protected] Roll Skia from c07c67045b6d to 5d847ba5c4aa (1 revision) (flutter/flutter#184570) 2026-04-03 [email protected] Roll Dart SDK from 3c7a79045b8b to 46f49142acd9 (1 revision) (flutter/flutter#184567) 2026-04-03 [email protected] Roll ICU from ee5f27adc28b to ff7995a708a1 (5 revisions) (flutter/flutter#184566) 2026-04-03 [email protected] Roll Skia from 9ae8231be181 to c07c67045b6d (4 revisions) (flutter/flutter#184562) 2026-04-03 [email protected] Roll Fuchsia Linux SDK from BFLjk6Uwd0gs_Hkdk... to PpL3Bn2YMb2h9LbdK... (flutter/flutter#184556) 2026-04-03 [email protected] Roll Skia from 0566b2f5f0d1 to 9ae8231be181 (1 revision) (flutter/flutter#184547) 2026-04-03 [email protected] Roll Dart SDK from 6008eaddd589 to 3c7a79045b8b (3 revisions) (flutter/flutter#184551) 2026-04-03 [email protected] Fix wide gamut macos integration test (flutter/flutter#184427) 2026-04-02 [email protected] forward an application name to DDS (flutter/flutter#184459) 2026-04-02 [email protected] Roll Skia from 973117cfa875 to 0566b2f5f0d1 (8 revisions) (flutter/flutter#184534) 2026-04-02 [email protected] Support different joins for stroked rects in uber_sdf, fix incorrect aa (flutter/flutter#184395) 2026-04-02 [email protected] [ Widget Preview ] Handle collections and records in custom preview annotations (flutter/flutter#184518) 2026-04-02 [email protected] Moves android_semantics_integration_test out of staging (flutter/flutter#184079) 2026-04-02 [email protected] Roll Packages from b3fcf14 to 66bf7ec (4 revisions) (flutter/flutter#184514) 2026-04-02 [email protected] Fix line breaks being lost when copying after selection gesture in SelectableRegion (flutter/flutter#184421) 2026-04-02 [email protected] Add plugin version to SwiftPM package symlink directory (flutter/flutter#183668) 2026-04-02 [email protected] Add our own wrapper for `CommonExtension` due to change in signature from 8.x->9.0 (flutter/flutter#184433) 2026-04-02 [email protected] [Android] Use EdgeToEdge.enable/WindowCompat for edge-to-edge mode instead of deprecated View flags (flutter/flutter#183072) 2026-04-02 [email protected] [data_assets] Cleanup tests (flutter/flutter#184209) 2026-04-02 [email protected] Enable SPM by default on Stable (flutter/flutter#184495) 2026-04-02 [email protected] Roll Dart SDK from d84bdfeb45eb to 6008eaddd589 (2 revisions) (flutter/flutter#184513) 2026-04-02 [email protected] Reland "Even more awaits" (flutter/flutter#184467) 2026-04-02 [email protected] Roll Skia from bb9fd8653739 to 973117cfa875 (2 revisions) (flutter/flutter#184498) 2026-04-02 [email protected] [ Widget Preview ] Use analysis server for widget preview detection (flutter/flutter#184473) 2026-04-02 [email protected] [web_ui] Fix avoid_type_to_string lint violation (flutter/flutter#184342) 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] 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

SwiftPM caches package's Package.swift manifest in `$HOME/Library/Caches/org.swift.swiftpm/manifests`. Due to this caching, when pub changes versions, SwiftPM doesn't always detect the Package.manifest has changed. This PR changes the symlink directory to use the plugin's directory basename, which has the version in it: ```diff - .packages/plugin_a -> /$HOME/.pub-cache/hosted/pub.dev/plugin_a-1.0.0/ios/plugin_a + .packages/plugin_a-1.0.0 -> /$HOME/.pub-cache/hosted/pub.dev/plugin_a-1.0.0/ios/plugin_a ``` This forces Xcode to re-cache the manifest. This also refactors a few places we fetch plugins by saving them to the project rather than re-finding them each time. This is currently limited to the `XcodeBasedProject`. Fixes flutter#182099 Fixes flutter#183226 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. 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](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot 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.  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

Add plugin version to SwiftPM package symlink directory

a4ff141

github-actions Bot added tool Affects the "flutter" command-line tool. See also t: labels. a: desktop Running on desktop team-ios Owned by iOS platform team team-macos Owned by the macOS platform team platform-macos labels Mar 13, 2026

vashworth added the CICD Run CI/CD label Mar 13, 2026

cache plugins

2c3d900

github-actions Bot added the platform-ios iOS applications specifically label Mar 14, 2026

vashworth added CICD Run CI/CD and removed CICD Run CI/CD labels Mar 16, 2026

vashworth marked this pull request as ready for review March 16, 2026 19:27

vashworth requested review from a team as code owners March 16, 2026 19:27

vashworth requested a review from stuartmorgan-g March 16, 2026 19:27

gemini-code-assist Bot reviewed Mar 16, 2026

View reviewed changes

stuartmorgan-g reviewed Mar 16, 2026

View reviewed changes

Copy plugin and update manifest when plugin has dependency on another…

2b73ec9

… plugin

github-actions Bot removed the CICD Run CI/CD label Mar 23, 2026

vashworth added the CICD Run CI/CD label Mar 23, 2026

vashworth requested a review from stuartmorgan-g March 25, 2026 20:15

stuartmorgan-g reviewed Mar 31, 2026

View reviewed changes

Comment thread packages/flutter_tools/lib/src/macos/swift_package_manager.dart Outdated

Comment thread packages/flutter_tools/lib/src/macos/swift_package_manager.dart Outdated

Comment thread packages/flutter_tools/lib/src/xcode_project.dart Outdated

stuartmorgan-g previously approved these changes Mar 31, 2026

View reviewed changes

vashworth added 2 commits April 1, 2026 16:29

Merge remote-tracking branch 'upstream/main' into add_plugin_version_…

53fe0ed

…to_dir_name

feedback

2161dd9

vashworth dismissed stuartmorgan-g’s stale review via 2161dd9 April 1, 2026 21:48

github-actions Bot removed the CICD Run CI/CD label Apr 1, 2026

missed one

9b51cc9

vashworth added the CICD Run CI/CD label Apr 1, 2026

stuartmorgan-g approved these changes Apr 2, 2026

View reviewed changes

vashworth added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 2, 2026

auto-submit Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 2, 2026

vashworth added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 2, 2026

auto-submit Bot added this pull request to the merge queue Apr 2, 2026

Merged via the queue into flutter:master with commit 07c16eb Apr 2, 2026
153 of 154 checks passed

flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Apr 2, 2026

hellohuanlin mentioned this pull request Apr 3, 2026

Fix Mac_x64 build_tests_2_4 #184550

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 3, 2026

07c16eb94 Add plugin version to SwiftPM package symlink directory (fl…

19c0347

…utter/flutter#183668)

engine-flutter-autoroll mentioned this pull request Apr 3, 2026

Roll Flutter from 0f401eea0439 to 7245c3f71104 (25 revisions) flutter/packages#11427

Merged

Piinks mentioned this pull request Apr 3, 2026

Flutter Notable Commits - 2026 #181433

Open

stuartmorgan-g added platform-macos Building on or for macOS specifically and removed platform-macos labels Apr 16, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add plugin version to SwiftPM package symlink directory#183668

Add plugin version to SwiftPM package symlink directory#183668
auto-submit[bot] merged 6 commits into
flutter:masterfrom
vashworth:add_plugin_version_to_dir_name

vashworth commented Mar 13, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Mar 16, 2026

Uh oh!

stuartmorgan-g left a comment

Uh oh!

vashworth commented Mar 16, 2026

Uh oh!

hellohuanlin commented Mar 27, 2026

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g commented Mar 31, 2026 •

edited

Loading

Uh oh!

stuartmorgan-g left a comment

Uh oh!

auto-submit Bot commented Apr 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

vashworth commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

vashworth commented Mar 16, 2026

Uh oh!

hellohuanlin commented Mar 27, 2026

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stuartmorgan-g commented Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

auto-submit Bot commented Apr 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vashworth commented Mar 13, 2026 •

edited

Loading

stuartmorgan-g commented Mar 31, 2026 •

edited

Loading