[CP-stable] Collect analytics about SwiftPM errors and warnings (#191746) by vashworth · Pull Request #192303 · flutter/flutter · GitHub
Skip to content

[CP-stable] Collect analytics about SwiftPM errors and warnings (#191746) - #192303

Open
vashworth wants to merge 1 commit into
flutter:flutter-3.47-candidate.0from
vashworth:cp_3.47_pr_191746
Open

[CP-stable] Collect analytics about SwiftPM errors and warnings (#191746)#192303
vashworth wants to merge 1 commit into
flutter:flutter-3.47-candidate.0from
vashworth:cp_3.47_pr_191746

Conversation

@vashworth

Copy link
Copy Markdown
Contributor

Issue Link:

#181560

Impact Description:

Flutter team is trying to improve SwiftPM migration experience by gathering more metrics.

Changelog Description:

[flutter/181560] When building iOS and macOS app, SwiftPM migration warnings and errors are not tracked in analytics.

Workaround:

None

Risk:

What is the risk level of this cherry-pick?

  • Low
  • Medium
  • High

Test Coverage:

Are you confident that your fix is well-tested by automated tests?

  • Yes
  • No

Validation Steps:

N/A

Fixes flutter#181560.

- [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
vashworth requested review from a team as code owners September 4, 2026 17:24
@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Sep 4, 2026
@flutter-dashboard

Copy link
Copy Markdown

@github-actions github-actions Bot added platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. platform-macos Building on or for macOS specifically a: desktop Running on desktop team-ios Owned by iOS platform team team-macos Owned by the macOS platform team labels Sep 4, 2026
@vashworth vashworth added cp: review Cherry-picks in the review queue and removed platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. platform-macos Building on or for macOS specifically a: desktop Running on desktop team-ios Owned by iOS platform team team-macos Owned by the macOS platform team labels Sep 4, 2026

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

Copy link
Copy Markdown
Contributor

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 integrates analytics tracking and crash reporting into the Swift Package Manager migration workflow, introducing a custom exception class to sanitize and report migration failures. The review feedback suggests converting an outstanding raw exception in the workspace detection logic to the new custom exception type to ensure comprehensive analytics coverage, and updating the corresponding unit tests with the appropriate assertions.

final XcodeProjectInfo? projectInfo = await _xcodeProject.projectInfo();
if (projectInfo == null) {
throw Exception('Unable to get Xcode project info.');
throw SwiftPackageManagerMigrationException('Unable to get Xcode project info.');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The Exception('Xcode workspace not found.') on line 354 should also be converted to SwiftPackageManagerMigrationException so that this failure is properly tracked in analytics, similar to the change made here on line 351.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

This test is missing an assertion for fakeAnalytics.sentEvents because the corresponding exception in swift_package_manager_integration_migration.dart (line 354) is thrown as a raw Exception instead of SwiftPackageManagerMigrationException, which prevents the analytics event from being sent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD cp: review Cherry-picks in the review queue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant