[CP-beta]Fix killing wrong xcrun command#185097
Conversation
We use `pgrep` to kill any matching existing `xcrun xcodebuild -resolvePackageDependencies` command. However, we did not specify that it should match on arguments and therefore was only matching on process name, killing other xcrun` commands. Fixes flutter#184754. ## 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]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **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. <!-- Links --> [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
|
@vashworth please fill out the PR description above, afterwards the release team will review this request. |
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
There was a problem hiding this comment.
Code Review
This pull request updates the pgrep command in xcodeproj.dart to include the -f flag for matching full argument lists and adjusts the corresponding test expectations. Feedback indicates that on macOS, passing multiple arguments to pgrep results in an 'OR' match, which could lead to matching and killing unrelated processes. It is recommended to join the command arguments into a single pattern string and update all test mocks accordingly.
| final RunResult result = await _processUtils.run([ | ||
| 'pgrep', | ||
| '-n', // Select only the newest | ||
| '-f', // Match against full argument lists | ||
| ...command, | ||
| ]); |
There was a problem hiding this comment.
On macOS, pgrep treats multiple arguments as separate patterns and performs an OR match between them. Since the command list starts with common strings like xcrun and xcodebuild, passing them as separate arguments with the -f flag will match any process on the system that contains any of those strings in its command line. This is likely to match unrelated processes (e.g., another concurrent Xcode build) and kill the wrong one.\n\nTo ensure that only the specific process with the exact set of arguments is matched, the command components should be joined into a single pattern.
| final RunResult result = await _processUtils.run([ | |
| 'pgrep', | |
| '-n', // Select only the newest | |
| '-f', // Match against full argument lists | |
| ...command, | |
| ]); | |
| final RunResult result = await _processUtils.run([\n 'pgrep',\n '-n', // Select only the newest\n '-f', // Match against full argument lists\n command.join(' '),\n ]); |
|
|
||
| const kFindProcessResolvePackagesCommand = FakeCommand( | ||
| command: <String>['pgrep', '-n', ...kResolvePackagesCommandList], | ||
| command: <String>['pgrep', '-n', '-f', ...kResolvePackagesCommandList], |
There was a problem hiding this comment.
This test expectation needs to be updated to match the suggested change in xcodeproj.dart, where the command arguments are joined into a single pattern for pgrep -f.
| command: <String>['pgrep', '-n', '-f', ...kResolvePackagesCommandList], | |
| command: <String>['pgrep', '-n', '-f', kResolvePackagesCommandList.join(' ')], |
| command: <String>[ | ||
| 'pgrep', | ||
| '-n', | ||
| '-f', | ||
| 'xcrun', | ||
| 'xcodebuild', | ||
| '-clonedSourcePackagesDirPath', |
…75cd6052e2b53c5960d2d6c7
dbd49b7
into
flutter:flutter-3.44-candidate.0
|
My Codemagic build on flutter 3.44.0-1.0.pre-169 (both beta and main) get this error. |
|
Tested that by removing this it started working on Codemagic: asaarnak@3df4bdc |
|
Tested that this #185831 fixes this error for us. |
This pull request is created by automatic cherry pick workflow
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
What is the link to the issue this cherry-pick is addressing?
#184754
Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)?
Does it impact development (ex. flutter doctor crashes when Android Studio is installed),
or the shipping of production apps (the app crashes on launch).
This information is for domain experts and release engineers to understand the consequences of saying yes or no to the cherry pick.
Mac flavors_test_macos test may not pass in CI.
Changelog Description:
Explain this cherry pick:
See best practices for examples.
< Replace with changelog description here >
[flutter/184754] When building using SwiftPM for iOS or macOS apps, the build may fail due to
xcrunerror.Workaround:
Is there a workaround for this issue?
Disable SwiftPM
Risk:
What is the risk level of this cherry-pick?
Test Coverage:
Are you confident that your fix is well-tested by automated tests?
Validation Steps:
What are the steps to validate that this fix works?
Run
Mac flavors_test_macosin CI.