Build iOS apps using Swift Packages by jmagman · Pull Request #58522 · flutter/flutter

jmagman · 2020-06-02T20:36:50Z

Description

Swift packages cannot be added to a newly created Flutter iOS app due to the Xcode project settings (not workspace) being set to the "legacy" build location. Update to the "default" Xcode build location.

Update templates, add tool migrator, let tool upgrade all examples and integration tests.

Related Issues

Fixes #57083
Related to #49654

Tests

Migrator tests
Added the basic Apple example Swift package to an existing integration test. The adds a networked dependency to integration test, but hopefully Apple never removes this (and if they do, we can replace with another one).

Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.

jmagman · 2020-06-02T20:37:16Z

...benchmarks/macrobenchmarks/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata

 <Workspace
   version = "1.0">
   <FileRef
-      location = "group:Runner.xcodeproj">


I let the tool migrate all these examples by flutter build iosing them.

jmagman · 2020-06-02T20:38:18Z

dev/integration_tests/ios_app_with_extensions/ios/Runner.xcodeproj/project.pbxproj

+/* Begin XCRemoteSwiftPackageReference section */
+		F735C5C22485E50A002BE868 /* XCRemoteSwiftPackageReference "example-package-playingcard" */ = {
+			isa = XCRemoteSwiftPackageReference;
+			repositoryURL = "https://github.com/apple/example-package-playingcard.git";


This was the most basic Apple Swift Package I could find. When we run the integration test it will check out this dependency from the GitHub repo.

sure hope that repo doesn't disappear...

This is the example package used in the Swift docs so hopefully if they every remove it they will replace it with some other example we can easily migrate. Fortunately it's not actually being used anywhere, so it will be extremely trivial to replace with some different package.

xster · 2020-06-02T21:07:17Z

@cbracken I vaguely remember you added this originally (maybe to deal with pods getting included twice or something?)

Do you have the original bug to test against again?

jmagman · 2020-06-02T21:18:54Z

@cbracken I vaguely remember you added this originally (maybe to deal with pods getting included twice or something?)

Do you have the original bug to test against again?

Added which part, originally? This "legacy" build location stuff was included in #4893.

Are you thinking of #20685? That's the Legacy Build System (different than build location) which hasn't been used since #33684. See also #20685 (comment).

christopherfujino

LGTM with a few nits

christopherfujino · 2020-06-02T20:51:58Z

dev/integration_tests/ios_app_with_extensions/ios/Runner.xcodeproj/project.pbxproj

+/* Begin XCRemoteSwiftPackageReference section */
+		F735C5C22485E50A002BE868 /* XCRemoteSwiftPackageReference "example-package-playingcard" */ = {
+			isa = XCRemoteSwiftPackageReference;
+			repositoryURL = "https://github.com/apple/example-package-playingcard.git";


sure hope that repo doesn't disappear...

packages/flutter_tools/lib/src/ios/migrations/project_build_location_migration.dart

packages/flutter_tools/test/general.shard/ios/ios_project_migration_test.dart

christopherfujino · 2020-06-02T22:22:17Z

double LGTM

xster · 2020-06-02T22:22:53Z

Added which part, originally? This "legacy" build location stuff was included in #4893.

Are you thinking of #20685? That's the Legacy Build System (different than build location) which hasn't been used since #33684. See also #20685 (comment).

ah yup, I'm totally mixed up

jmagman · 2020-06-02T22:42:17Z

Added which part, originally? This "legacy" build location stuff was included in #4893.
Are you thinking of #20685? That's the Legacy Build System (different than build location) which hasn't been used since #33684. See also #20685 (comment).

ah yup, I'm totally mixed up

Are you suggesting legacy build LOCATION and legacy build SYSTEM are easy to confuse (see my identical confusion at #44811 (comment))?! Don't worry, there are like zero docs for any of this.

This reverts commit 2054f37.

Build iOS apps using Swift Packages

f14ef87

jmagman requested a review from christopherfujino June 2, 2020 20:36

jmagman self-assigned this Jun 2, 2020

googlebot added the cla: yes label Jun 2, 2020

jmagman commented Jun 2, 2020

View reviewed changes

fluttergithubbot added d: examples Sample code and demos c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. labels Jun 2, 2020

christopherfujino approved these changes Jun 2, 2020

View reviewed changes

Review edits

663322e

Unused import

1f783c2

jmagman added the waiting for tree to go green label Jun 2, 2020

jmagman merged commit 2054f37 into flutter:master Jun 3, 2020

jmagman deleted the spm-legacy branch June 3, 2020 00:57

jmagman added a commit that referenced this pull request Jun 3, 2020

Revert "Build iOS apps using Swift Packages (#58522)"

3e67455

This reverts commit 2054f37.

jmagman mentioned this pull request Jun 3, 2020

Revert "Build iOS apps using Swift Packages" #58549

Merged

jmagman added a commit that referenced this pull request Jun 3, 2020

Revert "Build iOS apps using Swift Packages (#58522)" (#58549)

2ece1c3

This reverts commit 2054f37.

jmagman mentioned this pull request Jun 3, 2020

Crash when using Swift packages: xcodebuild: error: Packages are not supported when using legacy build locations, but the current project has them enabled #57083

Closed

jmagman added a commit to jmagman/flutter that referenced this pull request Jun 8, 2020

Build iOS apps using Swift Packages (flutter#58522)

e8684d7

jmagman mentioned this pull request Jun 8, 2020

Build iOS apps using Swift Packages #59009

Merged

10 tasks

jmagman added the platform-ios iOS applications specifically label Aug 21, 2020

github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2021

Conversation

jmagman commented Jun 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

jmagman Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

christopherfujino Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

christopherfujino Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

xster commented Jun 2, 2020

Uh oh!

jmagman commented Jun 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

christopherfujino Jun 2, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

christopherfujino commented Jun 2, 2020

Uh oh!

xster commented Jun 2, 2020

Uh oh!

jmagman commented Jun 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jmagman commented Jun 2, 2020 •

edited

Loading

jmagman commented Jun 2, 2020 •

edited

Loading