Enable Xcode 16 plugin to use versioned release build #109
Conversation
| // Distributed under the MIT License | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in all | ||
| // copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| // SOFTWARE. |
There was a problem hiding this comment.
oops. this header should always have been here
dfed
force-pushed
the
dfed--install-cli-command
branch
from
5b45ac0
to
c2dd6c5
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #109 +/- ##
=======================================
Coverage 99.66% 99.66%
=======================================
Files 33 33
Lines 2710 2710
=======================================
Hits 2701 2701
Misses 9 9 |
| Diagnostics.error(""" | ||
| \(context.safediFolder.path()) exists, but there is no SafeDITool binary for this release present. | ||
|
|
||
| To download the current release SafeDITool binary, run: | ||
| \tswift package --package-path \(context.package.directoryURL.path()) --allow-network-connections all --allow-writing-to-package-directory safedi-release-install | ||
|
|
||
| To use a debug SafeDITool binary instead, remove the `.safedi` directory by running: | ||
| \trm -rf \(context.safediFolder.path()) | ||
| """) |
There was a problem hiding this comment.
what the error looks like in practice:
There was a problem hiding this comment.
If there is a .safedi/ directory at the package root, I'm taking that to mean that the user intended to be using a release version of SafeDITool. Users will likely enter this state after installing SafeDITool, then bumping the SafeDI version they are using.
| Diagnostics.warning(""" | ||
| Using a debug SafeDITool binary, which is 15x slower than a release SafeDITool binary. | ||
|
|
||
| To download the current release SafeDITool binary, run: | ||
| \tswift package --package-path \(context.package.directoryURL.path()) --allow-network-connections all --allow-writing-to-package-directory safedi-release-install | ||
| """) |
| } | ||
| switch safeDIOrigin { | ||
| case let .repository(url, displayVersion, _): | ||
| // As of Xcode 16.0 Beta 6, the display version is of the form "Optional(version)". |
There was a problem hiding this comment.
Apple... why...
Using displayVersion is clearly brittle, but it does work.
There was a problem hiding this comment.
Seemed like an oversight. We'll see swiftlang/swift-package-manager#7934
There was a problem hiding this comment.
If this ever fully breaks we can do what Apollo does and hardcode the current release version. I'd prefer to trust SPM rather than have to keep this in-sync myself, so we're starting out with this approach.
| // As of Xcode 16.0 Beta 6, the display version is of the form "Optional(version)". | ||
| // This regular expression is duplicated by SafeDIGenerateDependencyTree since plugins can not share code. | ||
| guard let versionMatch = try /Optional\((.*?)\)|^(.*?)$/.firstMatch(in: displayVersion), | ||
| let versionSubstring = versionMatch.output.1 ?? versionMatch.output.2 |
There was a problem hiding this comment.
Why checking .1 as well as .2?
There was a problem hiding this comment.
Ditto in the copied code in the other plugin
There was a problem hiding this comment.
I'm falling back to a version with no surrounding Optional(...) in case this gets fixed. .1 gets us the optional match. .2 gets us the match without the optional.
dfed
changed the title
dfed
changed the title
Xcode 16 allows for plugins to determine their own display version, which enables us to:
SafeDIToolfrom GithubThis PR does both of these things. Note that we do not touch the Swift 5.10 & Xcode 15 code-path, which still looks for an unversioned 😭 release installed via Homebrew.