Skip to content

Disable SwiftPM for xcode-analyze #9666

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

Merged
merged 3 commits into from
Aug 18, 2025

Conversation

stuartmorgan-g
Copy link
Contributor

Until flutter/flutter#172427 is resolved, xcode-analyze doesn't work as desired with SwiftPM enabled (it analyzes only the test code, not the plugin code). To avoid losing analysis coverage in the meantime, this disabled SwiftPM temporarily while running analysis.

This PR also updates build-examples to use the newer pubspec-based config option to set the SwiftPM flag state instead of setting global state, to avoid future issues where we are unintentionally bleeding flag changes across different tests, and to make local runs not impact developer machine state.

To unit test this functionality, this adds a new feature to the existing process mock system that allows running an arbitrary test callback at the ponit where a process is being run, which in this case allows reading the temporarily-modified pubspec contents at the right point in the command execution.

Fixes flutter/flutter#171442

Pre-Review Checklist

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.

Footnotes

  1. 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

Until flutter/flutter#172427 is resolved,
`xcode-analyze` doesn't work as desired with SwiftPM enabled (it
analyzes only the test code, not the plugin code). To avoid losing
analysis coverage in the meantime, this disabled SwiftPM temporarily
while running analysis.

This PR also updates `build-examples` to use the newer pubspec-based
config option to set the SwiftPM flag state instead of setting global
state, to avoid future issues where we are unintentionally bleeding flag
changes across different tests, and to make local runs not impact
developer machine state.

To unit test this functionality, this adds a new feature to the existing
process mock system that allows running an arbitrary test callback at
the ponit where a process is being run, which in this case allows
reading the temporarily-modified pubspec contents at the right point in
the command execution.

Fixes flutter/flutter#171442
@stuartmorgan-g stuartmorgan-g requested a review from vashworth July 23, 2025 15:12
@@ -150,23 +144,6 @@ class BuildExamplesCommand extends PackageLoopingCommand {
'were specified. At least one platform must be provided.');
throw ToolExit(_exitNoPlatformFlags);
}

switch (_swiftPackageManagerFeatureConfig) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The change from the flag to the pubspec config does mean that we are delaying stable testing of SwiftPM in this repo longer, since the pubspec config won't do anything on current stable, but since we were already accidentally not testing it on stable anyway even though we could have been, I don't think delaying a bit longer is a big deal. And unlike the old code, this version will not require us to remember to turn it on for stable later, it'll just start working as soon as stable gets the config feature.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request improves the tooling's robustness by moving SwiftPM configuration from global state to temporary pubspec.yaml modifications, enhancing test reliability. The new runCallback in the mock process runner is a smart way to test these changes.

My review focuses on a few areas:

  • Robustness: I've suggested using try...finally blocks to ensure pubspec.yaml is always restored, even if errors occur.
  • Maintainability: I've identified opportunities to simplify the YAML editing logic and to refactor duplicated test code into helper functions.

These changes will make the tooling more resilient and easier to maintain.

@stuartmorgan-g
Copy link
Contributor Author

Hm, this is blocked on flutter/flutter#154365, unless we turn of analysis for the whole maps package (or hard-code special handling of the ios15 example apps somewhere, or build a generic system for opting specific examples out of tests rather than whole packages).

@jmagman jmagman mentioned this pull request Aug 4, 2025
@jmagman
Copy link
Member

jmagman commented Aug 6, 2025

Hm, this is blocked on flutter/flutter#154365, unless we turn of analysis for the whole maps package (or hard-code special handling of the ios15 example apps somewhere, or build a generic system for opting specific examples out of tests rather than whole packages).

Hopefully that's fixed on Flutter master once flutter/flutter#173251 rolls in.
Beta cherry-pick to cover suppression when running against stable (once beta becomes stable): flutter/flutter#173304
And reminder, stable xcode analyze isn't running in presubmit: flutter/flutter#171442

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 18, 2025
@auto-submit auto-submit bot merged commit abb2e34 into flutter:main Aug 18, 2025
80 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 18, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 18, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 18, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 19, 2025
github-merge-queue bot pushed a commit to flutter/flutter that referenced this pull request Aug 19, 2025
flutter/packages@5c52c55...953cae0

2025-08-19 magder@google.com Add com.android.tools.build:gradle to
dependabot gradle-plugin group (flutter/packages#9848)
2025-08-19 stuartmorgan@google.com [flutter_migrate] Remove source
(flutter/packages#9847)
2025-08-18 lukas.mirbt1@gmail.com [go_router]: Add `RelativeGoRouteData`
and `TypedRelativeGoRoute` (flutter/packages#9732)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter (stable) from
edada7c to 20f8274 (1474 revisions) (flutter/packages#9837)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter from
b3fb4c7 to 2265d94 (7 revisions) (flutter/packages#9845)
2025-08-18 stuartmorgan@google.com Disable SwiftPM for `xcode-analyze`
(flutter/packages#9666)
2025-08-17 engine-flutter-autoroll@skia.org Roll Flutter from
0a2906b to b3fb4c7 (5 revisions) (flutter/packages#9840)
2025-08-16 stuartmorgan@google.com Update repo for 3.35 stable release
(flutter/packages#9816)
2025-08-16 engine-flutter-autoroll@skia.org Roll Flutter from
52af7a5 to 0a2906b (16 revisions) (flutter/packages#9836)
2025-08-16 stuartmorgan@google.com [image_picker] Updates min SDK to
3.29 (flutter/packages#9830)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos (flutter/packages#9775)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos - platform implementations (flutter/packages#9818)
2025-08-16 stuartmorgan@google.com [various] Updates min SDK for
third_party/packages to 3.29 (flutter/packages#9819)
2025-08-16 stuartmorgan@google.com [vector_graphics] Updates min SDK to
3.29 (flutter/packages#9820)
2025-08-16 stuartmorgan@google.com [google_maps_flutter] Updates min SDK
to 3.29 (flutter/packages#9821)
2025-08-16 stuartmorgan@google.com [video_player] Updates min SDK to
3.29 (flutter/packages#9826)
2025-08-15 stuartmorgan@google.com [shared_preferences] Updates min SDK
to 3.29 (flutter/packages#9829)
2025-08-15 magder@google.com [image_picker_ios] Add photo to simulator
Photos library during test (flutter/packages#9759)
2025-08-15 10687576+bparrishMines@users.noreply.github.com
[interactive_media_ads] Updates `README` with information about enabling
desugaring on Android (flutter/packages#9790)
2025-08-15 stuartmorgan@google.com [in_app_purchase] Updates min SDK to
3.29 (flutter/packages#9825)
2025-08-15 engine-flutter-autoroll@skia.org Roll Flutter from
f4334d2 to 52af7a5 (29 revisions) (flutter/packages#9832)
2025-08-15 stuartmorgan@google.com [go_router] Update generated output
format (flutter/packages#9817)

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 flutter-ecosystem@google.com 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
WillBLogical pushed a commit to WillBLogical/packages that referenced this pull request Aug 20, 2025
Until flutter/flutter#172427 is resolved, `xcode-analyze` doesn't work as desired with SwiftPM enabled (it analyzes only the test code, not the plugin code). To avoid losing analysis coverage in the meantime, this disabled SwiftPM temporarily while running analysis.

This PR also updates `build-examples` to use the newer pubspec-based config option to set the SwiftPM flag state instead of setting global state, to avoid future issues where we are unintentionally bleeding flag changes across different tests, and to make local runs not impact developer machine state.

To unit test this functionality, this adds a new feature to the existing process mock system that allows running an arbitrary test callback at the ponit where a process is being run, which in this case allows reading the temporarily-modified pubspec contents at the right point in the command execution.

Fixes flutter/flutter#171442

## Pre-Review Checklist

**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.

[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
SydneyBao pushed a commit to SydneyBao/flutter that referenced this pull request Aug 22, 2025
…er#174040)

flutter/packages@5c52c55...953cae0

2025-08-19 magder@google.com Add com.android.tools.build:gradle to
dependabot gradle-plugin group (flutter/packages#9848)
2025-08-19 stuartmorgan@google.com [flutter_migrate] Remove source
(flutter/packages#9847)
2025-08-18 lukas.mirbt1@gmail.com [go_router]: Add `RelativeGoRouteData`
and `TypedRelativeGoRoute` (flutter/packages#9732)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter (stable) from
edada7c to 20f8274 (1474 revisions) (flutter/packages#9837)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter from
b3fb4c7 to 2265d94 (7 revisions) (flutter/packages#9845)
2025-08-18 stuartmorgan@google.com Disable SwiftPM for `xcode-analyze`
(flutter/packages#9666)
2025-08-17 engine-flutter-autoroll@skia.org Roll Flutter from
0a2906b to b3fb4c7 (5 revisions) (flutter/packages#9840)
2025-08-16 stuartmorgan@google.com Update repo for 3.35 stable release
(flutter/packages#9816)
2025-08-16 engine-flutter-autoroll@skia.org Roll Flutter from
52af7a5 to 0a2906b (16 revisions) (flutter/packages#9836)
2025-08-16 stuartmorgan@google.com [image_picker] Updates min SDK to
3.29 (flutter/packages#9830)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos (flutter/packages#9775)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos - platform implementations (flutter/packages#9818)
2025-08-16 stuartmorgan@google.com [various] Updates min SDK for
third_party/packages to 3.29 (flutter/packages#9819)
2025-08-16 stuartmorgan@google.com [vector_graphics] Updates min SDK to
3.29 (flutter/packages#9820)
2025-08-16 stuartmorgan@google.com [google_maps_flutter] Updates min SDK
to 3.29 (flutter/packages#9821)
2025-08-16 stuartmorgan@google.com [video_player] Updates min SDK to
3.29 (flutter/packages#9826)
2025-08-15 stuartmorgan@google.com [shared_preferences] Updates min SDK
to 3.29 (flutter/packages#9829)
2025-08-15 magder@google.com [image_picker_ios] Add photo to simulator
Photos library during test (flutter/packages#9759)
2025-08-15 10687576+bparrishMines@users.noreply.github.com
[interactive_media_ads] Updates `README` with information about enabling
desugaring on Android (flutter/packages#9790)
2025-08-15 stuartmorgan@google.com [in_app_purchase] Updates min SDK to
3.29 (flutter/packages#9825)
2025-08-15 engine-flutter-autoroll@skia.org Roll Flutter from
f4334d2 to 52af7a5 (29 revisions) (flutter/packages#9832)
2025-08-15 stuartmorgan@google.com [go_router] Update generated output
format (flutter/packages#9817)

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 flutter-ecosystem@google.com 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
SydneyBao pushed a commit to SydneyBao/flutter that referenced this pull request Aug 22, 2025
…er#174040)

flutter/packages@5c52c55...953cae0

2025-08-19 magder@google.com Add com.android.tools.build:gradle to
dependabot gradle-plugin group (flutter/packages#9848)
2025-08-19 stuartmorgan@google.com [flutter_migrate] Remove source
(flutter/packages#9847)
2025-08-18 lukas.mirbt1@gmail.com [go_router]: Add `RelativeGoRouteData`
and `TypedRelativeGoRoute` (flutter/packages#9732)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter (stable) from
edada7c to 20f8274 (1474 revisions) (flutter/packages#9837)
2025-08-18 engine-flutter-autoroll@skia.org Roll Flutter from
b3fb4c7 to 2265d94 (7 revisions) (flutter/packages#9845)
2025-08-18 stuartmorgan@google.com Disable SwiftPM for `xcode-analyze`
(flutter/packages#9666)
2025-08-17 engine-flutter-autoroll@skia.org Roll Flutter from
0a2906b to b3fb4c7 (5 revisions) (flutter/packages#9840)
2025-08-16 stuartmorgan@google.com Update repo for 3.35 stable release
(flutter/packages#9816)
2025-08-16 engine-flutter-autoroll@skia.org Roll Flutter from
52af7a5 to 0a2906b (16 revisions) (flutter/packages#9836)
2025-08-16 stuartmorgan@google.com [image_picker] Updates min SDK to
3.29 (flutter/packages#9830)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos (flutter/packages#9775)
2025-08-16 stuartmorgan@google.com [image_picker] Add the ability to
pick multiple videos - platform implementations (flutter/packages#9818)
2025-08-16 stuartmorgan@google.com [various] Updates min SDK for
third_party/packages to 3.29 (flutter/packages#9819)
2025-08-16 stuartmorgan@google.com [vector_graphics] Updates min SDK to
3.29 (flutter/packages#9820)
2025-08-16 stuartmorgan@google.com [google_maps_flutter] Updates min SDK
to 3.29 (flutter/packages#9821)
2025-08-16 stuartmorgan@google.com [video_player] Updates min SDK to
3.29 (flutter/packages#9826)
2025-08-15 stuartmorgan@google.com [shared_preferences] Updates min SDK
to 3.29 (flutter/packages#9829)
2025-08-15 magder@google.com [image_picker_ios] Add photo to simulator
Photos library during test (flutter/packages#9759)
2025-08-15 10687576+bparrishMines@users.noreply.github.com
[interactive_media_ads] Updates `README` with information about enabling
desugaring on Android (flutter/packages#9790)
2025-08-15 stuartmorgan@google.com [in_app_purchase] Updates min SDK to
3.29 (flutter/packages#9825)
2025-08-15 engine-flutter-autoroll@skia.org Roll Flutter from
f4334d2 to 52af7a5 (29 revisions) (flutter/packages#9832)
2025-08-15 stuartmorgan@google.com [go_router] Update generated output
format (flutter/packages#9817)

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 flutter-ecosystem@google.com 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[packages] Xcode analysis failing on stable only
3 participants