cmd/gomobile: produce frameworks which follow Apple's specs per platform, fixing Xcode 15.3 compatibility issues #98

scosman · 2024-03-24T15:52:28Z

This patch updates the framework generation code to follow the Apple spec for placing content:
https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle

Previously, we setup the framework in MacOS format, and used symlinks to make it compatible with iOS format. This approach no longer works (it works locally in simulator, but causes signing issues when attempting to upload apps for distribution, or running on real hardware). We now setup the expected bundle format for each platform.

Other benefits:

Thirds the size of the xcframework and resulting app binary when distributing the xcframework by zip (common for SPM and other formats). The symlinks resulted in duplicate files after zipping, which made it into the final app.
Set MinimumOSVersion, fixing SPM compatibility issue
Eliminates the blank Info.plist
Initial testing shows this also fixes x/mobile/cmd/gomobile: unsealed contents present in the root directory of an embedded framework go#66406 (code signing issues) as a side effect of using the proper format

Testing:

Tested all 4 platforms (iOS, simulator, macOS, Catalyst) on Xcode 15.3

Fixes golang/go#66406
Fixes golang/go#66500

This change adds compatibility for Xcode 15.3 to "gomobile bind" for building xcframeworks. - New blank Info.plist in the *.framework target root - Add CFBundleExecutable and CFBundleIdentifier to the resource level Info.plist Tested locally on my framework on Xcode 15.3 (fixes issue) and 15.2 (doesn't create new issues). Would love to get some more folks to try this fix, to make sure it works broadly.

…ntion in the package). From Apple docs: "The bundle ID string must contain only alphanumeric characters (A-Z, a-z, 0-9), hyphen (-), and period (.)" - https://help.apple.com/xcode/mac/current/#/deve70ea917b

…(matches docs)

…ntion in the package). From Apple docs: "The bundle ID string must contain only alphanumeric characters (A-Z, a-z, 0-9), hyphen (-), and period (.)" - https://help.apple.com/xcode/mac/current/#/deve70ea917b

…(matches docs)

gopherbot · 2024-03-24T15:56:24Z

This PR (HEAD: 3896b12) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-24T16:02:19Z

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T16:13:43Z

Message from Hajime Hoshi:

Patch Set 1: Run-TryBot+1

(3 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T16:19:27Z

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T16:19:28Z

Message from Gopher Robot:

Patch Set 1: TryBot-Result+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T16:42:05Z

This PR (HEAD: 9d5c4a7) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-24T16:48:07Z

Message from Steve Cosman:

Patch Set 2:

(3 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T18:26:48Z

Message from Hajime Hoshi:

Patch Set 2:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

- if -> switch - Consistent relative paths (old system worked, but consistent is good)

gopherbot · 2024-03-24T21:36:51Z

This PR (HEAD: 7bb9459) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-24T21:54:53Z

Message from Steve Cosman:

Patch Set 3:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T23:42:59Z

Message from Emmanuel Odeke:

Patch Set 3: Commit-Queue+1 Run-TryBot+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-24T23:42:59Z

Message from Go LUCI:

Patch Set 3:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-03-24T23:34:43Z","revision":"7e98f75fd10d6176c8bcad1a7d0dccc655e61672"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T03:31:58Z

Message from Gopher Robot:

Patch Set 5: TryBot-Result+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T07:29:41Z

Message from Steve Cosman:

Patch Set 5:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

The placement spec has these as optional, but allowed: https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle#3875936 The open source Apple code created Headers: https://opensource.apple.com/source/CF/CF-368.28/framework.make.auto.html gomobile has historically created Modules, and it's optional, so let's keep that to minimize issues for existing users/scripts

gopherbot · 2024-03-25T14:00:13Z

This PR (HEAD: 6a0d5eb) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-25T14:06:52Z

Message from Steve Cosman:

Patch Set 6:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T14:36:45Z

Message from Hajime Hoshi:

Patch Set 6:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T14:56:11Z

Message from Hajime Hoshi:

Patch Set 6: Code-Review+1 Run-TryBot+1

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T14:56:12Z

Message from Gopher Robot:

Patch Set 6:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T15:02:47Z

Message from Gopher Robot:

Patch Set 6: TryBot-Result+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T15:48:42Z

This PR (HEAD: 2a90da2) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-25T16:01:32Z

Message from Dmitri Shuralyov:

Patch Set 7: Code-Review+2 Commit-Queue+1

(4 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:01:32Z

Message from Go LUCI:

Patch Set 7:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-03-25T15:56:14Z","revision":"d30ac7ae5ed0d6921f9fb3eb1a634a0bbb193f4b"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:01:33Z

Message from Dmitri Shuralyov:

Patch Set 7: Code-Review+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:08:10Z

Message from Dmitri Shuralyov:

Patch Set 7: -Commit-Queue

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:08:10Z

Message from Go LUCI:

Patch Set 7:

This CL has passed the run

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:08:11Z

Message from Go LUCI:

Patch Set 7: LUCI-TryBot-Result+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-25T16:46:15Z

This PR (HEAD: 28dca85) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/mobile/+/574055.

Important tips:

Don't comment on this PR. All discussion takes place in Gerrit.
You need a Gmail or other Google account to log in to Gerrit.
To change your code in response to feedback:
- Push a new commit to the branch used by your GitHub PR.
- A new "patch set" will then appear in Gerrit.
- Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
- Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
- Multiple commits in the PR will be squashed by GerritBot.
The title and description of the GitHub PR are used to construct the final commit message.
- Edit these as needed via the GitHub web interface (not via Gerrit or git).
- You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

gopherbot · 2024-03-26T09:58:00Z

Message from Hajime Hoshi:

Patch Set 8: Code-Review+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T14:24:34Z

Message from Steve Cosman:

Patch Set 8:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T15:11:01Z

Message from Dmitri Shuralyov:

Patch Set 8: Auto-Submit+1 Code-Review+2 Commit-Queue+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T15:17:36Z

Message from Go LUCI:

Patch Set 8:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-03-26T15:03:36Z","revision":"1a2476b13222299a11b6cfba8367a0c71ed48ea7"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T15:24:07Z

Message from Dmitri Shuralyov:

Patch Set 8: -Commit-Queue

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T15:24:07Z

Message from Go LUCI:

Patch Set 8:

This CL has passed the run

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

gopherbot · 2024-03-26T15:24:08Z

Message from Go LUCI:

Patch Set 8: LUCI-TryBot-Result+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/574055.
After addressing review feedback, remember to publish your drafts!

…orm, fixing Xcode 15.3 compatibility issues This patch updates the framework generation code to follow the Apple spec for placing content: https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle Previously, we setup the framework in MacOS format, and used symlinks to make it compatible with iOS format. This approach no longer works (it works locally in simulator, but causes signing issues when attempting to upload apps for distribution, or running on real hardware). We now setup the expected bundle format for each platform. Other benefits: - Thirds the size of the xcframework and resulting app binary when distributing the xcframework by zip (common for SPM and other formats). The symlinks resulted in duplicate files after zipping, which made it into the final app. - Set MinimumOSVersion, fixing SPM compatibility issue - Eliminates the blank Info.plist - Initial testing shows this also fixes golang/go#66406 (code signing issues) as a side effect of using the proper format Testing: - Tested all 4 platforms (iOS, simulator, macOS, Catalyst) on Xcode 15.3 Fixes golang/go#66406 Fixes golang/go#66500 Change-Id: I8538989efe67cb0d2d0496087dcbeca923c3dffe GitHub-Last-Rev: 28dca85 GitHub-Pull-Request: #98 Reviewed-on: https://go-review.googlesource.com/c/mobile/+/574055 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Hajime Hoshi <hajimehoshi@gmail.com> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Than McIntosh <thanm@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>

gopherbot · 2024-03-26T19:58:44Z

This PR is being closed because golang.org/cl/574055 has been merged.

…orm, fixing Xcode 15.3 compatibility issues This patch updates the framework generation code to follow the Apple spec for placing content: https://developer.apple.com/documentation/bundleresources/placing_content_in_a_bundle Previously, we setup the framework in MacOS format, and used symlinks to make it compatible with iOS format. This approach no longer works (it works locally in simulator, but causes signing issues when attempting to upload apps for distribution, or running on real hardware). We now setup the expected bundle format for each platform. Other benefits: - Thirds the size of the xcframework and resulting app binary when distributing the xcframework by zip (common for SPM and other formats). The symlinks resulted in duplicate files after zipping, which made it into the final app. - Set MinimumOSVersion, fixing SPM compatibility issue - Eliminates the blank Info.plist - Initial testing shows this also fixes golang/go#66406 (code signing issues) as a side effect of using the proper format Testing: - Tested all 4 platforms (iOS, simulator, macOS, Catalyst) on Xcode 15.3 Fixes golang/go#66406 Fixes golang/go#66500 Change-Id: I8538989efe67cb0d2d0496087dcbeca923c3dffe GitHub-Last-Rev: 28dca85 GitHub-Pull-Request: golang#98 Reviewed-on: https://go-review.googlesource.com/c/mobile/+/574055 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Hajime Hoshi <hajimehoshi@gmail.com> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Than McIntosh <thanm@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>

scosman added 16 commits March 16, 2024 16:01

Add escaping using rfc1034Label (aligns to Apple docs and prior conve…

aaa3fc2

…ntion in the package). From Apple docs: "The bundle ID string must contain only alphanumeric characters (A-Z, a-z, 0-9), hyphen (-), and period (.)" - https://help.apple.com/xcode/mac/current/#/deve70ea917b

Add XML (plist) escaping

6277c7d

Partial fix for mattn/go-sqlite3#1229

7414534

Cleanup symlink approach. Confirmed Catalyst works with MacOS format …

0e6ccfd

…(matches docs)

comments

d43994e

Remove optional info.plist entries

308b921

Remove TODO

b1404e9

Add escaping using rfc1034Label (aligns to Apple docs and prior conve…

124f27f

…ntion in the package). From Apple docs: "The bundle ID string must contain only alphanumeric characters (A-Z, a-z, 0-9), hyphen (-), and period (.)" - https://help.apple.com/xcode/mac/current/#/deve70ea917b

Add XML (plist) escaping

d647f62

Partial fix for mattn/go-sqlite3#1229

b166081

Cleanup symlink approach. Confirmed Catalyst works with MacOS format …

8b051bb

…(matches docs)

comments

e11e67d

Remove optional info.plist entries

3df1ff1

Remove TODO

8ac6998

Merge branch 'golang-master2'

3896b12

PR feedback: comment updates

9d5c4a7

PR feedback:

7bb9459

- if -> switch - Consistent relative paths (old system worked, but consistent is good)

PR feedback

2a90da2

Fix inverted var names in iterator

28dca85

gopherbot closed this Mar 26, 2024

cmd/gomobile: produce frameworks which follow Apple's specs per platform, fixing Xcode 15.3 compatibility issues #98

cmd/gomobile: produce frameworks which follow Apple's specs per platform, fixing Xcode 15.3 compatibility issues #98

Conversation

scosman commented Mar 24, 2024 • edited Loading

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 24, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 25, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

gopherbot commented Mar 26, 2024

scosman commented Mar 24, 2024 •

edited

Loading