Compare commits

..

1 Commits

92 changed files with 585 additions and 2217 deletions
+2 -2
View File
@@ -8,10 +8,10 @@
## AI tool usage
How much of the code in this PR was AI-assisted? (check one)
How much of this PR was AI-assisted? (check one)
- [ ] **0** - No AI was used to write code
- [ ] **1** - I was assisted by AI in writing code. I reviewed the finished result.
- [ ] **1** - I was assisted by AI. I reviewed the finished result.
- [ ] **2** - I set the AI going and left it to it; nobody has read the result - no review, or AI review only
<!-- If an AI agent is filling this in: declare the level honestly, and open as a draft if it is #2. Do not lower the declared level to get the PR reviewed. -->
-1
View File
@@ -2,7 +2,6 @@ on:
push:
branches:
- main
- pre/**
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
-1
View File
@@ -2,7 +2,6 @@ on:
push:
branches:
- main
- pre/**
pull_request:
concurrency:
group: integration-${{ github.workflow }}-${{ github.ref }}
+1 -6
View File
@@ -84,12 +84,7 @@ jobs:
- name: Create and publish release
run: |
TAG="${{ github.ref_name }}"
FLAGS=(--draft)
# e.g. 2.0.0-beta.1
if [[ "$TAG" == *-* ]]; then
FLAGS+=(--prerelease --latest=false)
fi
gh release create "$TAG" "${FLAGS[@]}" --title "v$TAG"
gh release create "$TAG" --draft --title "v$TAG"
gh release upload "$TAG" output/**/*.{AppImage,AppImage.zsync,app.zip,app.dSYM.zip}
docker:
uses: docker/github-builder/.github/workflows/build.yml@v1
-1
View File
@@ -2,7 +2,6 @@ on:
push:
branches:
- main
- pre/**
pull_request:
paths:
- '.github/workflows/swiftlint.yml'
-1
View File
@@ -13,4 +13,3 @@ DerivedData/
/openapi
/.tmp
/xtool
+7 -9
View File
@@ -42,19 +42,17 @@ opt_in_rules:
analyzer_rules:
- unused_import
custom_rules:
prefer_dependency_print:
name: "Dependency Output"
included: '/Sources/'
excluded: '/(Tests|Examples)/'
regex: '(?<![\w.])(?:Swift\s*\.\s*)?print\s*\('
match_kinds:
- identifier
message: "Use d.out.print instead of print or Swift.print."
severity: error
spaces_not_tabs:
name: "Spaces not Tabs"
regex: ^\t
message: "Use four spaces, not tabs"
point_zero:
name: "Point Zero"
regex: '(?<!iOS\s)(?<!macOS\s)(?<!\.)\b[\d_]+\.0\b'
match_kinds:
- number
- attribute.builtin
message: "Don't add a .0 to the end of floating point literals"
force_try: warning
force_cast: warning
function_body_length: 100
+1 -4
View File
@@ -13,7 +13,4 @@ The `xtool` CLI supports macOS, Linux, WSL. The lower-level XKit (provisioning a
## Conventions
- Use modern Swift 6. Strict concurrency is enabled.
- Use swift-dependencies (`@Dependency(\.foo)` / `d.foo`) for Dependency Injection. Passing dependencies around as arguments is an anti-pattern.
- Commits should be in the format `subsystem: imperative description` e.g. `auth: support reading password from stdin`.
- Don't use `Task.detached { ... }`. If you need to escape isolation, you want `Task { @concurrent in ... }` instead.
- Uphold API stability guarantees for consumers who use xtool via the command line interface (e.g. don't remove subcommands or config fields). However, the Swift interface (including `public` types) when consuming xtool itself as a Swift Package is _NOT_ API stable; it's okay to break Swift API.
- Use swift-dependencies for Dependency Injection. Passing dependencies around as arguments is an anti-pattern.
+1 -1
View File
@@ -1,7 +1,7 @@
# Note: We use 22.04 since AppImage recommends building on the
# oldest configuration that you support
ARG SWIFT_VERSION=6.4.2
ARG SWIFT_VERSION=6.4.1
FROM swift:${SWIFT_VERSION}-jammy AS build-base
+1 -1
View File
@@ -11,7 +11,7 @@ Some environment variables that help with debugging. Use these as e.g. `XTL_FOO=
### Disk
- `XTL_DEBUG_TMP`: Set to `1` to log details when xtool creates/destroys temporary directories.
- `XTL_TMPDIR`: Control the location where xtool stores temporary directories. We also respect `XDG_CACHE_HOME` on Linux.
- `XTL_TMPDIR`: Control the location where xtool stores temporary directories. We also respect `TMPDIR` and (on Linux) `XDG_CACHE_HOME`.
### Networking
+10 -19
View File
@@ -1,5 +1,5 @@
{
"originHash" : "2ccd077fc130f0f1b1279d87aa61d1fc243964d7ad49489a12021577c54df9de",
"originHash" : "df62267a8ffd060087e903a9d112d24562a959d43a0819a6511367da533c5594",
"pins" : [
{
"identity" : "aexml",
@@ -172,15 +172,6 @@
"version" : "5.0.3"
}
},
{
"identity" : "swift-custom-dump",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-custom-dump",
"state" : {
"revision" : "4fb9e7cbb4b8f5a7354005db39447f570d6b3e19",
"version" : "1.7.3"
}
},
{
"identity" : "swift-dependencies",
"kind" : "remoteSourceControl",
@@ -343,15 +334,6 @@
"version" : "1.4.0"
}
},
{
"identity" : "swift-rcodesign",
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/swift-rcodesign",
"state" : {
"revision" : "08650ab9d3bf95a0c585581b8bd63eb7b8315264",
"version" : "0.2.0"
}
},
{
"identity" : "swift-service-context",
"kind" : "remoteSourceControl",
@@ -459,6 +441,15 @@
"revision" : "a27b21e0c81c5bf42049b897a62aaf387e80f279",
"version" : "6.2.2"
}
},
{
"identity" : "zsign",
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/zsign",
"state" : {
"revision" : "f6158be9e62a5ce2a53d72b1a6d880880da956c8",
"version" : "1.9.0"
}
}
],
"version" : 3
+7 -25
View File
@@ -9,14 +9,12 @@ let xtoolVersion: String? = {
let gitCommit = info.currentCommit
let gitTag = info.currentTag
let gitRef = gitTag ?? "commit \(gitCommit)"
return gitRef
return "\(gitRef)\(info.hasUncommittedChanges ? " (dirty)" : "")"
} else {
return nil
}
}()
let hasUncommittedChanges = Context.gitInformation?.hasUncommittedChanges ?? false
let cSettings: [CSetting] = [
.define("_GNU_SOURCE", .when(platforms: [.linux])),
]
@@ -52,7 +50,7 @@ let package = Package(
dependencies: [
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.5.1")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.7.0")),
.package(url: "https://github.com/xtool-org/swift-rcodesign", .upToNextMinor(from: "0.2.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.9.0")),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
.package(url: "https://github.com/apple/swift-http-types", from: "1.3.1"),
@@ -62,6 +60,7 @@ let package = Package(
.package(url: "https://github.com/apple/swift-openapi-generator", from: "1.6.0"),
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-nio", from: "2.77.0"),
.package(url: "https://github.com/apple/swift-collections", from: "1.7.1"),
.package(url: "https://github.com/apple/xcode-project-format.git", .upToNextMinor(from: "0.1.0")),
@@ -74,7 +73,6 @@ let package = Package(
.package(url: "https://github.com/pointfreeco/swift-concurrency-extras", from: "1.3.0"),
.package(url: "https://github.com/pointfreeco/swift-dependencies", from: "1.6.2"),
.package(url: "https://github.com/pointfreeco/swift-custom-dump", from: "1.3.3"),
// we don't use this but need the explicit dependency to keep the lockfile stable.
// TODO: remove once https://github.com/pointfreeco/combine-schedulers/issues/120 is fixed
.package(url: "https://github.com/OpenCombine/OpenCombine.git", from: "0.14.0"),
@@ -92,9 +90,7 @@ let package = Package(
dependencies: [
.product(name: "OpenSSL", package: "xtool-core")
],
cSettings: cSettings + [
.define("XTOOL_HAS_UNCOMMITTED_CHANGES", to: hasUncommittedChanges ? "1" : "0"),
] + (
cSettings: cSettings + (
xtoolVersion
.map { [.define("XTOOL_VERSION", to: "\"\($0)\"")] }
?? []
@@ -112,9 +108,6 @@ let package = Package(
.target(
name: "XUtils",
dependencies: [
"CXKit",
.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
.product(name: "Dependencies", package: "swift-dependencies"),
.product(name: "SystemPackage", package: "swift-system"),
.product(
name: "Subprocess",
@@ -133,7 +126,8 @@ let package = Package(
.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
.product(name: "Dependencies", package: "swift-dependencies"),
.product(name: "SwiftyMobileDevice", package: "SwiftyMobileDevice"),
.product(name: "RCodesign", package: "swift-rcodesign"),
.product(name: "Zupersign", package: "zsign"),
.product(name: "SignerSupport", package: "xtool-core"),
.product(name: "ProtoCodable", package: "xtool-core"),
.product(name: "Superutils", package: "xtool-core"),
.product(name: "Crypto", package: "swift-crypto"),
@@ -167,20 +161,9 @@ let package = Package(
dependencies: [
"XKit",
"XToolSupport",
"XCLIUtils",
"PackLib",
.product(name: "Crypto", package: "swift-crypto"),
.product(name: "X509", package: "swift-certificates"),
.product(name: "CustomDump", package: "swift-custom-dump"),
],
swiftSettings: swiftSettings,
),
.target(
name: "XCLIUtils",
dependencies: [
"XUtils",
.product(name: "Dependencies", package: "swift-dependencies"),
.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
],
swiftSettings: swiftSettings,
),
@@ -189,11 +172,10 @@ let package = Package(
dependencies: [
"SwiftyMobileDevice",
"XKit",
"XCLIUtils",
"PackLib",
.product(name: "ArgumentParser", package: "swift-argument-parser"),
.product(name: "SystemPackage", package: "swift-system"),
.product(name: "Dependencies", package: "swift-dependencies"),
.product(name: "NIOPosix", package: "swift-nio"),
.product(name: "libunxip", package: "unxip"),
],
cSettings: cSettings,
+1 -3
View File
@@ -57,9 +57,7 @@ DEVICE SUBCOMMANDS:
### Library
You can consume xtool itself as a Swift Package, to enable your own app to interact with Apple Developer Services, iOS devices, and more. You can use this by adding `XKit` or `XToolSupport` as a SwiftPM dependency.
Note: while we aim to uphold semver semantics on the CLI interface (breaking change = major version bump), the Swift interface does not offer the same guarantees.
xtool includes a library that you can use to interact with Apple Developer Services, iOS devices, and more from your own app. You can use this by adding `XKit` as a SwiftPM dependency.
```swift
// package dependency:
-3
View File
@@ -1,4 +1 @@
#include <stdbool.h>
const char * _Nonnull xtl_version(void);
bool xtl_has_uncommitted_changes(void);
-13
View File
@@ -1,5 +1,4 @@
#include "version.h"
#include <stddef.h>
const char *xtl_version(void) {
#ifdef XTOOL_VERSION
@@ -8,15 +7,3 @@ const char *xtl_version(void) {
return "unversioned";
#endif
}
bool xtl_has_uncommitted_changes(void) {
#ifndef XTOOL_VERSION
return true;
#else
#ifdef XTOOL_HAS_UNCOMMITTED_CHANGES
return XTOOL_HAS_UNCOMMITTED_CHANGES != 0;
#else
return false;
#endif
#endif
}
+5 -5
View File
@@ -220,16 +220,16 @@ public struct XcodePacker {
importedProducts: [],
)
let project = XcodeProject(project: schema)
let projectURL = projectDir.appending(path: "\(plan.app.product).xcodeproj")
let project = XcodeProject(project: schema, url: projectURL)
try project.write()
try project.write(to: projectURL)
let workspaceURL = xtoolDir.appending(path: "\(plan.app.product).xcworkspace")
let workspace = XcodeWorkspace(children: [
.file(XcodeWorkspace.Location(base: .container, path: "..")),
.file(XcodeWorkspace.Location(base: .group, path: ".xtool-tmp/\(projectURL.lastPathComponent)"))
], url: workspaceURL)
try workspace.write()
])
let workspaceURL = xtoolDir.appending(path: "\(plan.app.product).xcworkspace")
try workspace.write(to: workspaceURL)
return workspaceURL
}
-65
View File
@@ -1,65 +0,0 @@
import Dependencies
import Foundation
import XUtils
package struct CommandInput: DependencyKey, Sendable {
// nil = EOF
private let readImpl: @Sendable (DataChannel.Limit) async throws -> Data?
package init(
read: @escaping @Sendable (DataChannel.Limit) async throws -> Data?,
) {
self.readImpl = read
}
package init(channel: DataChannel) {
self.init(read: { try await channel.read(upTo: $0) })
}
package func read(upTo limit: DataChannel.Limit = .unlimited) async throws -> Data? {
try Task.checkCancellation()
return try await readImpl(limit)
}
/// Cancellation discards bytes already consumed for this line.
package func readLine() async throws -> String? {
var line = Data()
while let chunk = try await read(upTo: .newline) {
line.append(chunk)
if line.last == UInt8(ascii: "\n") {
line.removeLast()
return String(decoding: line, as: UTF8.self).trimmingTrailingCarriageReturn()
}
}
guard !line.isEmpty else { return nil }
return String(decoding: line, as: UTF8.self).trimmingTrailingCarriageReturn()
}
package static var liveValue: CommandInput {
@Dependency(\.shutdownRegistry) var shutdownRegistry
do {
let input = try DispatchInput(fileDesciptor: .standardInput)
shutdownRegistry.register { await input.close() }
return Self(read: { try await input.read(upTo: $0) })
} catch {
return Self(read: { _ in throw error })
}
}
package static var testValue: CommandInput {
Self(read: unimplemented("CommandInput.read", placeholder: nil))
}
}
private extension String {
func trimmingTrailingCarriageReturn() -> String {
hasSuffix("\r") ? String(dropLast()) : self
}
}
extension DependencyValues {
package var input: CommandInput {
get { self[CommandInput.self] }
set { self[CommandInput.self] = newValue }
}
}
-19
View File
@@ -1,19 +0,0 @@
public struct CommandVersion: Sendable, Hashable {
public var version: String
public var hasUncommittedChanges: Bool
public init(version: String, hasUncommittedChanges: Bool) {
self.version = version
self.hasUncommittedChanges = hasUncommittedChanges
}
public static var unversioned: Self {
.init(version: "unversioned", hasUncommittedChanges: true)
}
}
extension CommandVersion: CustomStringConvertible {
public var description: String {
version + (hasUncommittedChanges ? "-dirty" : "")
}
}
-44
View File
@@ -1,44 +0,0 @@
import ConcurrencyExtras
import Dependencies
/// Anything registered here will be cleaned up when the process exits
public final class ShutdownRegistry: DependencyKey, Sendable {
public static var liveValue: ShutdownRegistry { ShutdownRegistry() }
public static var testValue: ShutdownRegistry { ShutdownRegistry() }
private struct State {
var operations: [@Sendable () async -> Void] = []
var shutdownTask: Task<Void, Never>?
}
private let state = LockIsolated(State())
public init() {}
/// Register cleanup before shutdown begins.
public func register(_ operation: @escaping @Sendable () async -> Void) {
state.withValue { $0.operations.append(operation) }
}
/// Runs cleanup in reverse registration order, once, even for concurrent callers.
public func shutdown() async {
let task = state.withValue { state in
if let task = state.shutdownTask { return task }
let pending = state.operations.reversed()
state.operations.removeAll()
let task = Task {
for operation in pending { await operation() }
}
state.shutdownTask = task
return task
}
await task.value
}
}
extension DependencyValues {
public var shutdownRegistry: ShutdownRegistry {
get { self[ShutdownRegistry.self] }
set { self[ShutdownRegistry.self] = newValue }
}
}
@@ -8,7 +8,6 @@
import Foundation
/// Replaces all of the app's groups with the given ones
public final class DeveloperServicesAssignAppGroupRequest: DeveloperServicesPlatformRequest {
public struct Response: Decodable, Sendable {}
@@ -17,14 +16,14 @@ public final class DeveloperServicesAssignAppGroupRequest: DeveloperServicesPlat
public let platform: DeveloperServicesPlatform
public let teamID: DeveloperServicesTeam.ID
public let appIDID: String
public let groupIDs: [DeveloperServicesAppGroup.ID]
public let groupID: DeveloperServicesAppGroup.ID
var subAction: String { return "assignApplicationGroupToAppId" }
var subParameters: [String: Any] {
return [
"teamId": teamID.rawValue,
"appIdId": appIDID,
"applicationGroups": groupIDs.map(\.rawValue)
"applicationGroups": groupID.rawValue
]
}
@@ -32,12 +31,12 @@ public final class DeveloperServicesAssignAppGroupRequest: DeveloperServicesPlat
platform: DeveloperServicesPlatform,
teamID: DeveloperServicesTeam.ID,
appIDID: String,
groupIDs: [DeveloperServicesAppGroup.ID]
groupID: DeveloperServicesAppGroup.ID
) {
self.platform = platform
self.teamID = teamID
self.appIDID = appIDID
self.groupIDs = groupIDs
self.groupID = groupID
}
}
@@ -8,7 +8,6 @@
import Foundation
import DeveloperAPI
import XUtils
public struct DeveloperServicesAssignAppGroupsOperation: DeveloperServicesOperation {
@@ -34,23 +33,36 @@ public struct DeveloperServicesAssignAppGroupsOperation: DeveloperServicesOperat
self.client = DeveloperServicesClient(authData: authData)
}
private func getOrCreateAppGroup(
private func upsertAppGroup(
_ groupID: DeveloperServicesAppGroup.GroupID,
existingGroups: [String: DeveloperServicesAppGroup]
) async throws -> DeveloperServicesAppGroup {
) async throws -> DeveloperServicesAppGroup.GroupID {
let sanitized = ProvisioningIdentifiers.sanitize(groupID: groupID)
let group: DeveloperServicesAppGroup
if let existingGroup = existingGroups[sanitized] {
return existingGroup
group = existingGroup
} else {
let groupID = ProvisioningIdentifiers.groupID(fromSanitized: sanitized, context: context)
let name = ProvisioningIdentifiers.groupName(fromSanitized: sanitized)
let request = DeveloperServicesAddAppGroupRequest(
platform: .iOS,
teamID: xcodeAuthData.teamID,
name: name,
groupID: groupID
)
group = try await client.send(request)
}
let groupID = ProvisioningIdentifiers.groupID(fromSanitized: sanitized, context: context)
let name = ProvisioningIdentifiers.groupName(fromSanitized: sanitized)
let request = DeveloperServicesAddAppGroupRequest(
platform: .iOS,
teamID: xcodeAuthData.teamID,
name: name,
groupID: groupID
_ = try await client.send(
DeveloperServicesAssignAppGroupRequest(
platform: .iOS,
teamID: xcodeAuthData.teamID,
appIDID: appID.id,
groupID: group.id
)
)
return try await client.send(request)
return group.groupID
}
public func perform() async throws -> [DeveloperServicesAppGroup.GroupID] {
@@ -59,20 +71,14 @@ public struct DeveloperServicesAssignAppGroupsOperation: DeveloperServicesOperat
))
let sanitized = existing.map { (ProvisioningIdentifiers.sanitize(groupID: $0.groupID), $0) }
let dict = Dictionary(sanitized, uniquingKeysWith: { $1 })
let groups = try await groupIDs.concurrentMap { groupID in
try await getOrCreateAppGroup(groupID, existingGroups: dict)
return try await withThrowingTaskGroup(of: DeveloperServicesAppGroup.GroupID.self) { group in
for groupID in groupIDs {
group.addTask {
try await upsertAppGroup(groupID, existingGroups: dict)
}
}
return try await group.reduce(into: []) { $0.append($1) }
}
_ = try await client.send(
DeveloperServicesAssignAppGroupRequest(
platform: .iOS,
teamID: xcodeAuthData.teamID,
appIDID: appID.id,
groupIDs: groups.map(\.id)
)
)
return groups.map(\.groupID)
}
}
@@ -8,29 +8,22 @@
import Foundation
import DeveloperAPI
import Dependencies
public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
@Dependency(\.signer) private var signer
public enum Error: LocalizedError, CustomStringConvertible {
public enum Error: LocalizedError {
case invalidApp(URL)
case tooManyAppGroups(bundleID: String, groups: [DeveloperServicesAppGroup.GroupID])
public var errorDescription: String? {
description
}
public var description: String {
switch self {
case .invalidApp(let url):
"Invalid app: \(url.path)"
case .tooManyAppGroups(let bundleID, let groups):
"""
App '\(bundleID)' requests multiple app groups: \(groups.map(\.rawValue).joined(separator: ", ")), \
which is not permitted when using a free team.
"""
return url.path.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.invalid_app", value: "Invalid app: %s", comment: ""
), $0
)
}
}
}
}
@@ -179,7 +172,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
var entitlements: Entitlements
// if the executable doesn't already have entitlements, that's
// okay. We don't have to throw an error.
if let entitlementsData = try? await signer.analyze(executable: executableURL),
if let entitlementsData = try? await context.signer.analyze(executable: executableURL),
let decodedEntitlements = try? PropertyListDecoder().decode(Entitlements.self, from: entitlementsData) {
entitlements = decodedEntitlements
@@ -187,10 +180,6 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
// re-assign rather than using updateEntitlements since the latter will
// retain unrecognized entitlements
let filtered = try entitlements.entitlements().filter { $0.anyCapability?.isFree != false }
if let groups = filtered.lazy.compactMap({ $0 as? AppGroupEntitlement }).first?.rawValue,
groups.count > 1 {
throw Error.tooManyAppGroups(bundleID: bundleID, groups: groups)
}
entitlements = try Entitlements(entitlements: filtered)
}
} else {
@@ -73,7 +73,9 @@ extension DataProtectionEntitlement: EntitlementWithCapability {
extension AppGroupEntitlement: EntitlementWithCapability {
var capability: DeveloperServicesCapability {
DeveloperServicesCapability(.appGroups, isFree: true)
// FIXME: Enable app groups on free accounts
// but we need to always assign only one group
DeveloperServicesCapability(.appGroups, isFree: false)
}
}
@@ -25,8 +25,8 @@ public struct DeveloperAPIPages<Page>: AsyncSequence {
public var getNext: @Sendable (Page) -> String?
public init(
_ getNext: @escaping @Sendable (Page) -> String?,
request: @escaping @Sendable () async throws -> Page,
next getNext: @escaping @Sendable (Page) -> String?
) {
self.request = request
self.getNext = getNext
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import OpenAPIRuntime
import HTTPTypes
@@ -24,7 +23,7 @@ struct LoggingMiddleware: ClientMiddleware {
) != nil
else { return (response, body) }
d.out.print("\n\(operationID) response status -> \(response.status)")
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
@@ -32,7 +31,7 @@ struct LoggingMiddleware: ClientMiddleware {
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
d.out.print("\(operationID) response body -> \(text)")
print("\(operationID) response body -> \(text)")
}
return (response, body)
@@ -49,45 +49,32 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
throw Errors.tooManyMatchingBundleIDs
}
// match locally rather than with filter[serialNumber]: server-side matching bugs out
// when the serial has leading zeroes (#305)
let certs = try await DeveloperAPIPages(\.links.next) {
let profiles = bundleID.relationships?.profiles?.data ?? []
switch profiles.count {
case 0:
// we're good
break
case 1:
_ = try await context.developerAPIClient.profilesDeleteInstance(path: .init(id: profiles[0].id)).noContent
default:
// if the user has >1 profile, it's probably okay to add another one (acceptable for non-free accounts?)
break
}
// Match locally rather than with filter[serialNumber]: the API lists serials with a
// leading zero nibble ("0E41…") but its filter only matches them without it ("E41…").
let certs = try await DeveloperAPIPages {
try await context.developerAPIClient.certificatesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
.filter { $0.attributes?.serialNumber.map(signingInfo.certificate.hasSerialNumber) == true }
let allDevices = try await DeveloperAPIPages(\.links.next) {
try await context.developerAPIClient.devicesGetCollection().ok.body.json
}
.map(\.data)
.reduce(into: [], +=)
.filter {
$0.attributes?.status?.value1 != .disabled
&& $0.attributes?.deviceClass?.value1?.supportsIOSApps == true
}
try Task.checkCancellation()
let profileName = "XTL profile \(bundleID.id)"
let profiles = bundleID.relationships?.profiles?.data ?? []
if !profiles.isEmpty {
// we can't create multiple profiles with the same name, so
// if there's already one delete it first
let matchingProfiles = try await context.developerAPIClient.profilesGetCollection(query: .init(
filter_lbrack_name_rbrack_: [profileName],
filter_lbrack_id_rbrack_: profiles.map(\.id),
fields_lbrack_profiles_rbrack_: [.name],
))
let allDevices = try await context.developerAPIClient.devicesGetCollection()
.ok.body.json.data
.filter { $0.attributes?.name == profileName }
_ = try await matchingProfiles.concurrentMap {
try await context.developerAPIClient.profilesDeleteInstance(path: .init(id: $0.id)).noContent
}
}
.filter { $0.attributes?.deviceClass?.value1?.supportsIOSApps == true }
let response = try await context.developerAPIClient.profilesCreateInstance(
body: .json(
@@ -95,7 +82,7 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
data: .init(
_type: .profiles,
attributes: .init(
name: profileName,
name: "XTL profile \(bundleID.id)",
profileType: .init(.iosAppDevelopment)
),
relationships: .init(
@@ -178,7 +178,7 @@ public struct ADIDataProvider: AnisetteDataProvider {
request.headerFields[.init(key)!] = value
}
let (_, response) = try await self.httpClient.makeRequest(request, body: body, ephemeral: true)
let (_, response) = try await self.httpClient.makeRequest(request, body: body)
return try GrandSlamOperationDecoder<Response>.decode(data: response)
}
@@ -10,14 +10,14 @@ import Foundation
public struct AnisetteData {
private static let clientTimeFormat = Date.ISO8601FormatStyle(
dateSeparator: .dash,
dateTimeSeparator: .standard,
timeSeparator: .colon,
timeZoneSeparator: .omitted,
includingFractionalSeconds: false,
timeZone: .gmt
)
private static let dateFormatter: DateFormatter = {
let dateFormatter = DateFormatter()
dateFormatter.locale = Locale(identifier: "en_US_POSIX")
dateFormatter.calendar = Calendar(identifier: .gregorian)
dateFormatter.timeZone = TimeZone(abbreviation: "UTC")
dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss'Z'"
return dateFormatter
}()
/// `X-Apple-I-Locale`
static let iLocaleKey = "X-Apple-I-Locale"
@@ -62,7 +62,7 @@ public struct AnisetteData {
return [
Self.localeKey: localeIdentifier,
Self.timeZoneKey: timeZone.abbreviation() ?? "UTC",
Self.clientTimeKey: clientTime.formatted(Self.clientTimeFormat),
Self.clientTimeKey: Self.dateFormatter.string(from: clientTime),
Self.routingInfoKey: "\(routingInfo)",
Self.machineIDKey: machineID,
Self.localUserIDKey: localUserID,
+7 -7
View File
@@ -24,25 +24,25 @@ struct GrandSlamClient: Sendable {
let anisetteData = try await anisetteDataProvider.fetchAnisetteData()
let url = try await lookupManager.fetchURL(forEndpoint: R.endpoint)
let content = request.content(anisetteData: anisetteData)
var httpRequest = HTTPRequest(method: content.httpMethod, url: url)
let method = request.method(anisetteData: anisetteData)
var httpRequest = HTTPRequest(method: method.httpMethod, url: url)
httpRequest.headerFields[.contentType] = "text/x-xml-plist"
httpRequest.headerFields[.init(DeviceInfo.clientInfoKey)!] = anisetteData.deviceInfo.clientInfo
let body: Data? = switch content {
let body: Data? = switch method {
case .get:
nil
case .data(let body, _, .xml):
case .post(let body):
try PropertyListSerialization.data(
fromPropertyList: body, format: .xml, options: 0
)
case .data(let body, _, .json):
try JSONSerialization.data(withJSONObject: body)
}
request.configure(request: &httpRequest, anisetteData: anisetteData)
// GrandSlam doesn't seem to like reused (keep-alive) connections so create a
// new one for each request. cf https://github.com/rileytestut/AltSign/pull/52
let resp = try await httpClient.makeRequest(httpRequest, body: body, ephemeral: true)
let resp = try await httpClient.withEphemeralClient {
try await $0.makeRequest(httpRequest, body: body)
}
return try R.Decoder.decode(data: resp.body)
}
@@ -42,7 +42,7 @@ actor GrandSlamLookupManager {
request.headerFields[.init(key)!] = value
}
let (_, body) = try await httpClient.makeRequest(request, ephemeral: true)
let (_, body) = try await httpClient.makeRequest(request)
return try self.decoder.decode(Response.self, from: body).urls
}
@@ -6,7 +6,6 @@
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import XUtils
import Foundation
public protocol TwoFactorAuthDelegate: AnyObject, Sendable {
@@ -27,11 +26,11 @@ struct GrandSlamTwoFactorAuthenticateOperation {
private func performSMSAuth() async throws {
// TODO: parse phone number list from o=complete req?
let phoneNumberID = 1
let phoneNumberID = "1"
do {
try await client.send(GrandSlamSMSAuthRequest(loginData: loginData, phoneNumberID: phoneNumberID))
} catch let error as HTTPResponseError where error.status.code == 403 {
d.out.print("""
print("""
warning: Could not send verification code via SMS. Falling back to trusted device authentication...
""")
try await performTrustedDeviceAuth()
@@ -40,7 +39,7 @@ struct GrandSlamTwoFactorAuthenticateOperation {
try await validateCode(phoneNumberID: phoneNumberID)
}
private func validateCode(phoneNumberID: Int? = nil) async throws {
private func validateCode(phoneNumberID: String? = nil) async throws {
guard let code = await self.delegate.fetchCode() else { throw Error.userCancelled }
let request: any GrandSlamRequest = if let phoneNumberID {
GrandSlamValidateSMSRequest(
@@ -63,7 +62,7 @@ struct GrandSlamTwoFactorAuthenticateOperation {
do {
try await client.send(request)
} catch let error as HTTPResponseError where error.status.code == 403 {
d.out.print("""
print("""
warning: Could not send verification code. Generate one manually.
See https://github.com/xtool-org/xtool/discussions/368
""")
@@ -35,22 +35,16 @@ struct GrandSlamSMSAuthRequest: GrandSlamTwoFactorRequest {
static func decode(data: Data) throws {}
}
static let endpoint: GrandSlamEndpoint = .url(URL(string: "https://gsa.apple.com/auth/verify/phone")!)
static let endpoint: GrandSlamEndpoint = .url(URL(string: "https://gsa.apple.com/auth/verify/phone/put?mode=sms")!)
let loginData: GrandSlamLoginData
let phoneNumberID: Int
let phoneNumberID: String
var extraHeaders: [String: String] {
[
"Content-Type": "application/json",
"Accept": "application/json",
]
}
func content(anisetteData: AnisetteData) -> GrandSlamRequestContent {
.put([
"phoneNumber": ["id": phoneNumberID],
"mode": "sms",
], type: .json)
func method(anisetteData: AnisetteData) -> GrandSlamMethod {
.post([
"serverInfo": [
"phoneNumber.id": phoneNumberID
],
])
}
}
@@ -29,25 +29,20 @@ struct GrandSlamValidateSMSRequest: GrandSlamTwoFactorRequest {
}
static let endpoint: GrandSlamEndpoint = .url(URL(
string: "https://gsa.apple.com/auth/verify/phone/securitycode"
string: "https://gsa.apple.com/auth/verify/phone/securitycode?referrer=/auth/verify/phone/put"
)!)
let loginData: GrandSlamLoginData
let phoneNumberID: Int
let phoneNumberID: String
let verificationCode: String
var extraHeaders: [String: String] {
[
"Content-Type": "application/json",
"Accept": "application/json",
]
}
func content(anisetteData: AnisetteData) -> GrandSlamRequestContent {
func method(anisetteData: AnisetteData) -> GrandSlamMethod {
.post([
"securityCode": ["code": verificationCode],
"phoneNumber": ["id": phoneNumberID],
"mode": "sms",
], type: .json)
"securityCode.code": verificationCode,
"serverInfo": [
"mode": "sms",
"phoneNumber.id": phoneNumberID
]
])
}
}
@@ -74,7 +74,7 @@ extension GrandSlamOperationRequest {
request.headerFields[.userAgent] = anisetteData.deviceInfo.akdUserAgent
}
func content(anisetteData: AnisetteData) -> GrandSlamRequestContent {
func method(anisetteData: AnisetteData) -> GrandSlamMethod {
var clientData: [String: Any] = [
"bootstrap": true,
"icscrec": true,
@@ -7,29 +7,15 @@
//
import Foundation
import HTTPTypes
enum GrandSlamRequestContent {
enum ContentType {
case xml
case json
}
enum GrandSlamMethod {
case get
case data([String: Any], method: HTTPRequest.Method, type: ContentType = .xml)
static func post(_ body: [String: Any], type: ContentType = .xml) -> Self {
.data(body, method: .post, type: type)
}
static func put(_ body: [String: Any], type: ContentType = .xml) -> Self {
.data(body, method: .put, type: type)
}
case post([String: Any])
var httpMethod: HTTPRequest.Method {
switch self {
case .get: return .get
case .data(_, let method, _): return method
case .post: return .post
}
}
}
@@ -45,5 +31,5 @@ protocol GrandSlamRequest: Sendable {
static var endpoint: GrandSlamEndpoint { get }
func configure(request: inout HTTPRequest, anisetteData: AnisetteData)
func content(anisetteData: AnisetteData) -> GrandSlamRequestContent
func method(anisetteData: AnisetteData) -> GrandSlamMethod
}
@@ -28,7 +28,7 @@ extension GrandSlamTwoFactorRequest {
extraHeaders.forEach { request.headerFields[.init($0)!] = $1 }
}
func content(anisetteData: AnisetteData) -> GrandSlamRequestContent {
func method(anisetteData: AnisetteData) -> GrandSlamMethod {
.get
}
@@ -46,21 +46,8 @@ extension HTTPClientProtocol {
_ request: HTTPRequest,
body: Data? = nil,
requireHTTPSuccess: Bool = true,
ephemeral: Bool = false,
onProgress: @isolated(any) (Double?) -> Void = { _ in }
) async throws -> (response: HTTPResponse, body: Data) {
if ephemeral {
return try await self.withEphemeralClient { client in
try await client.makeRequest(
request,
body: body,
requireHTTPSuccess: requireHTTPSuccess,
ephemeral: false,
onProgress: onProgress
)
}
}
await onProgress(0)
let (response, responseBody) = try await send(request, body: body.map { HTTPBody($0) })
guard !requireHTTPSuccess || ![.clientError, .serverError].contains(response.status.kind) else {
@@ -7,7 +7,6 @@
//
import Foundation
import XUtils
import SwiftyMobileDevice
public final class ProfileManager {
@@ -54,16 +53,16 @@ public final class ProfileManager {
for (bundleID, profiles) in toInstall {
guard profiles.count == 1 else {
d.out.print("Unexpected # of profiles for \(bundleID): \(profiles.count). Skipping.")
print("Unexpected # of profiles for \(bundleID): \(profiles.count). Skipping.")
continue
}
let profile = profiles[0]
let installedProfiles = installed[bundleID] ?? []
for installedProfile in installedProfiles {
d.out.print("Removing \(installedProfile.1.uuid) for \(bundleID)")
print("Removing \(installedProfile.1.uuid) for \(bundleID)")
try client.removeProfile(withUUID: installedProfile.1.uuid)
}
d.out.print("Installing profile with UUID \(profile.1.uuid)")
print("Installing profile with UUID \(profile.1.uuid)")
try client.install(profile: profile.0.data())
}
}
@@ -294,7 +294,7 @@ public actor IntegratedInstaller {
app: URL,
targetDevice: SigningContext.TargetDevice? = nil,
) async throws -> String {
let context = SigningContext(
let context = try SigningContext(
auth: auth,
targetDevice: targetDevice,
)
+5 -8
View File
@@ -1,17 +1,17 @@
import Foundation
import Dependencies
/// Provisions and codesigns.
public struct AutoSigner {
@Dependency(\.signer) private var signer
public enum Error: LocalizedError {
case noSigners
case errorReading(String)
case errorWriting(String)
public var errorDescription: String? {
switch self {
case .noSigners:
return NSLocalizedString("signer.error.no_signers", value: "No signers found", comment: "")
case .errorReading(let file):
return "\(file)".withCString {
String.localizedStringWithFormat(
@@ -82,16 +82,13 @@ public struct AutoSigner {
try info.mobileprovision.data().write(to: profURL)
}
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml
let entitlements = try provisioningDict.mapValues { try encoder.encode($0.entitlements) }
let entitlements = provisioningDict.mapValues(\.entitlements)
status(NSLocalizedString("signer.signing", value: "Signing", comment: ""))
try await signer.sign(
try await context.signer.sign(
app: app,
identity: .real(signingInfo.certificate, signingInfo.privateKey),
entitlementMapping: entitlements,
deep: true,
progress: progress
)
progress(1)
-57
View File
@@ -1,57 +0,0 @@
import Foundation
import RCodesign
public actor RCodesignSigner: Signer {
public enum Error: LocalizedError {
case badFilePath
public var errorDescription: String? {
switch self {
case .badFilePath:
return NSLocalizedString(
"signer_impl.error.bad_file_path", value: "A bad file path was provided", comment: ""
)
}
}
}
public init() {}
public func sign(
app: URL,
identity: SignerIdentity,
entitlementMapping: [URL: Data],
deep: Bool,
progress: @escaping @Sendable (Double?) -> Void
) throws {
progress(nil)
guard app.isFileURL else { throw Error.badFilePath }
let root = app.standardizedFileURL.pathComponents
var entitlements: [String: Data] = [:]
for (bundle, value) in entitlementMapping {
let components = bundle.standardizedFileURL.pathComponents
guard bundle.isFileURL, components.starts(with: root) else { throw Error.badFilePath }
// RCodesign scopes entitlements by bundle-relative path: "" for the
// app itself and e.g. "PlugIns/Widget.appex" for an extension. Compare
// path components so a sibling such as App.app-copy cannot match App.app.
let path = components.dropFirst(root.count).joined(separator: "/")
guard entitlements[path] == nil else { throw Error.badFilePath }
entitlements[path] = value
}
let signingIdentity: RCodesign.Identity
switch identity {
case .real(let certificate, let privateKey):
signingIdentity = .certificate(certificateDER: try certificate.data(), privateKeyPEM: privateKey.data)
case .adhoc:
signingIdentity = .adHoc
}
try RCodesign.sign(at: app, identity: signingIdentity, options: .init(entitlements: entitlements, shallow: !deep))
}
public func analyze(executable: URL) throws -> Data? {
try RCodesign.entitlements(at: executable)
}
}
-50
View File
@@ -1,50 +0,0 @@
import Foundation
import Dependencies
public enum SignerIdentity: Sendable {
case real(Certificate, PrivateKey)
case adhoc
}
public protocol Signer: Sendable {
// entitlementMapping is [bundle url] -> [plist data]
func sign(
app: URL,
identity: SignerIdentity,
entitlementMapping: [URL: Data],
deep: Bool,
progress: @escaping @Sendable (Double?) -> Void
) async throws
func analyze(executable: URL) async throws -> Data?
}
private enum SignerDependencyKey: DependencyKey {
static var liveValue: any Signer { RCodesignSigner() }
static var testValue: any Signer { UnimplementedSigner() }
}
extension DependencyValues {
public var signer: any Signer {
get { self[SignerDependencyKey.self] }
set { self[SignerDependencyKey.self] = newValue }
}
}
private struct UnimplementedSigner: Signer {
func sign(
app: URL,
identity: SignerIdentity,
entitlementMapping: [URL: Data],
deep: Bool,
progress: @escaping @Sendable (Double?) -> Void
) async throws {
reportIssue("Unimplemented: Signer.sign")
throw UnimplementedFailure(description: "Signer.sign")
}
func analyze(executable: URL) async throws -> Data? {
reportIssue("Unimplemented: Signer.analyze")
throw UnimplementedFailure(description: "Signer.analyze")
}
}
+178
View File
@@ -0,0 +1,178 @@
import Foundation
import CXKit
import SignerSupport
import ConcurrencyExtras
/// a wrapper around `signer_t`
public actor Signer {
public enum Error: LocalizedError {
case notFound
case badFilePath
case signer(String?)
public var errorDescription: String? {
switch self {
case .notFound:
return NSLocalizedString(
"signer_impl.error.not_found", value: "No signer implementation found", comment: ""
)
case .badFilePath:
return NSLocalizedString(
"signer_impl.error.bad_file_path", value: "A bad file path was provided", comment: ""
)
case .signer(let error?):
return error
case .signer(nil):
return NSLocalizedString(
"signer_impl.error.unknown", value: "An unknown signing error occurred", comment: ""
)
}
}
}
public enum Identity {
case real(Certificate, PrivateKey)
case adhoc
}
private let signer: UnsafePointer<signer_t>
public var name: String {
String(cString: signer.pointee.name)
}
private init(signer: UncheckedSendable<UnsafePointer<signer_t>>) {
self.signer = signer.value
}
public static func all() -> some Collection<Signer> {
var list = get_signers()
var arr: [Signer] = []
while let curr = list {
arr.append(Signer(signer: UncheckedSendable(curr)))
list = curr.pointee.next
}
return arr
}
public static func first() throws -> Signer {
try all().first.orThrow(Error.notFound)
}
private func _sign(
app: URL,
identity: Identity,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) throws {
let encoder = PropertyListEncoder()
encoder.outputFormat = .xml
let entsArray: [entitlements_data_t] = try entitlementMapping.map { url, ents in
try url.withUnsafeFileSystemRepresentation { bundlePath in
guard let bundlePath = bundlePath else { throw Error.badFilePath }
return try encoder.encode(ents).withUnsafeBytes { bytes in
let copy = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: bytes.count)
bytes.copyBytes(to: copy)
// an XML plist should always be non-empty so force unwrapping baseAddress is safe
return entitlements_data_t(
bundle_path: strdup(bundlePath),
data: copy.baseAddress!,
len: copy.count
)
}
}
}
defer {
entsArray.forEach {
free(UnsafeMutablePointer(mutating: $0.bundle_path))
$0.data.deallocate()
}
}
let sendableProgress = UncheckedSendable(progress)
let sendableEntsArray = UncheckedSendable(entsArray)
let certificateData: Data
let privateKeyData: Data
let lengthOverride: Int?
switch identity {
case .real(let certificate, let privateKey):
certificateData = try certificate.data()
privateKeyData = privateKey.data
lengthOverride = nil
case .adhoc:
// we can't use empty data here because withUnsafeBytes
// might return a bufferpointer with a nil base address,
// but signer.h expects non-null values. The real fix is
// updating xtool-core/SignerSupport/signer.h to annotate
// the pointers as nullable, but alas that requires effort.
certificateData = Data([0])
privateKeyData = Data([0])
lengthOverride = 0
}
try certificateData.withUnsafeBytes { cert in
try privateKeyData.withUnsafeBytes { priv in
var exception: UnsafeMutablePointer<Int8>?
defer { exception.map { free($0) } }
let progress = sendableProgress.value
let entsArray = sendableEntsArray.value
guard let certBase = cert.baseAddress,
let privBase = priv.baseAddress
else { throw Error.signer(nil) }
let box = Unmanaged.passRetained(progress as AnyObject)
defer { box.release() }
guard signer.pointee.sign(
app.path,
certBase, lengthOverride ?? cert.count,
privBase, lengthOverride ?? priv.count,
entsArray, entsArray.count,
{
(Unmanaged<AnyObject>
.fromOpaque($0)
.takeUnretainedValue()
// swiftlint:disable:next force_cast
as! (Double?) -> Void
)($1 == -1 ? nil : $1)
},
box.toOpaque(),
&exception
) == 0 else {
throw Error.signer(exception.map { String(cString: $0) })
}
}
}
}
public func sign(
app: URL,
identity: Identity,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) async throws {
// TODO: #131: update Zupersign to handle multiple entitlements files
// this is a temp hack to just pass along the root app entitlements
let entitlementMapping = entitlementMapping.filter { $0.key.path == app.path }
try self._sign(
app: app,
identity: identity,
entitlementMapping: entitlementMapping,
progress: progress
)
}
public func analyze(executable: URL) throws -> Data {
try executable.withUnsafeFileSystemRepresentation { (path: UnsafePointer<Int8>?) -> Data in
guard let path = path else { throw Error.badFilePath }
var exception: UnsafeMutablePointer<Int8>?
defer { exception.map { free($0) } }
var count = 0
guard let bytes = signer.pointee.analyze(path, &count, &exception)
else { throw Error.signer(exception.map { String(cString: $0) })}
return Data(bytesNoCopy: bytes, count: count, deallocator: .free)
}
}
}
+5 -2
View File
@@ -18,6 +18,7 @@ public struct SigningContext: Sendable {
public var auth: DeveloperAPIAuthData
public var targetDevice: TargetDevice?
public var signer: Signer
public var developerAPIClient: DeveloperAPIClient {
DeveloperAPIClient(auth: auth)
@@ -25,10 +26,12 @@ public struct SigningContext: Sendable {
public init(
auth: DeveloperAPIAuthData,
targetDevice: TargetDevice? = nil
) {
targetDevice: TargetDevice? = nil,
signer: Signer? = nil
) throws {
self.auth = auth
self.targetDevice = targetDevice
self.signer = try signer ?? .first()
}
}
@@ -9,7 +9,6 @@
import Foundation
import ConcurrencyExtras
import Dependencies
import XUtils
public enum KeyValueStorageError: Error {
case stringConversionFailure
+9 -11
View File
@@ -1,5 +1,3 @@
import XUtils
import XCLIUtils
import Foundation
import XKit
import ArgumentParser
@@ -29,7 +27,7 @@ struct AuthOperation {
func run() async throws {
if let token = try? AuthToken.saved(), !logoutFromExisting {
if !quiet {
d.out.print("Logged in.\n\(token)")
print("Logged in.\n\(token)")
}
return
}
@@ -54,7 +52,7 @@ struct AuthOperation {
}
try token.save()
d.out.print("Logged in.\n\(token)")
print("Logged in.\n\(token)")
}
private func logInWithKey() async throws -> AuthToken {
@@ -78,7 +76,7 @@ struct AuthOperation {
}
private func logInWithPassword() async throws -> AuthToken {
d.out.print("""
print("""
Heads up:
This works by emulating a virtual Mac to interact with Apple services.
We use a third-party service to create a randomized device ID token
@@ -98,7 +96,7 @@ struct AuthOperation {
throw Console.Error("Password cannot be empty.")
}
d.out.print("Logging in...")
print("Logging in...")
let authDelegate = XToolAuthDelegate()
let manager = DeveloperServicesLoginManager()
@@ -177,15 +175,15 @@ struct AuthLogoutCommand: AsyncParsableCommand {
func run() async throws {
if (try? AuthToken.saved()) != nil {
try AuthToken.clear()
d.out.print("Logged out")
print("Logged out")
} else {
d.out.print("Already logged out")
print("Already logged out")
}
if reset2FA {
@Dependency(\.anisetteDataProvider) var anisetteProvider
await anisetteProvider.resetProvisioning()
d.out.print("Forgot device")
print("Forgot device")
}
}
}
@@ -198,9 +196,9 @@ struct AuthStatusCommand: AsyncParsableCommand {
func run() async throws {
if let token = try? AuthToken.saved() {
d.out.print("Logged in.\n\(token)")
print("Logged in.\n\(token)")
} else {
d.out.print("Logged out")
print("Logged out")
}
}
}
-2
View File
@@ -1,5 +1,3 @@
import XCLIUtils
import XUtils
import Foundation
import XKit
import Dependencies
+1 -3
View File
@@ -1,5 +1,3 @@
import XUtils
import XCLIUtils
import Foundation
import XKit
import ArgumentParser
@@ -19,7 +17,7 @@ struct ConnectionOptions: ParsableArguments {
extension ConnectionOptions.WithoutSearchMode {
func client(searchMode search: ClientDevice.SearchMode) async throws -> ClientDevice {
d.out.print("Waiting for device to be connected...")
print("Waiting for device to be connected...")
let stream = try await ClientDevice.search(mode: search)
for await devices in stream {
@@ -1,15 +1,48 @@
import Foundation
import XKit
import XUtils
import Dependencies
import NIOPosix
import NIOCore
package enum Console {
package static func prompt(_ message: String) async throws -> String {
d.out.print(message, terminator: "", flush: true)
guard let line = try await d.input.readLine() else { throw Console.Error("Input ended before a response was received.") }
return line
enum Console {
private static func withStdio<T>(
_ body: (
_ stdin: NIOAsyncChannelInboundStream<ByteBuffer>,
_ stdout: NIOAsyncChannelOutboundWriter<ByteBuffer>
) async throws -> T
) async throws -> T {
try await NIOPipeBootstrap(group: .singletonMultiThreadedEventLoopGroup)
.takingOwnershipOfDescriptors(
input: FileDescriptor.standardInput.duplicate().rawValue,
output: FileDescriptor.standardOutput.duplicate().rawValue
)
.flatMapThrowing { try NIOAsyncChannel(wrappingChannelSynchronously: $0) }
.get()
.executeThenClose { try await body($0, $1) }
}
package static func promptRequired(_ message: String, existing: String?) async throws -> String {
static func prompt(_ message: String) async throws -> String {
try await withStdio { stdin, stdout in
try await stdout.write(ByteBuffer(bytes: message.utf8))
fflush(stdoutSafe)
var data = Data()
for try await chunk in stdin {
let view = chunk.readableBytesView
if let endIndex = view.firstIndex(of: UInt8(ascii: "\n")) {
data += view[..<endIndex]
break
} else {
data += view
}
}
let str = String(decoding: data, as: UTF8.self)
return str.hasSuffix("\r") ? String(str.dropLast()) : str
}
}
static func promptRequired(_ message: String, existing: String?) async throws -> String {
let value: String
if let existing {
value = existing
@@ -22,12 +55,12 @@ package enum Console {
return value
}
package static func getPassword(_ message: String) async throws -> String {
static func getPassword(_ message: String) async throws -> String {
if !message.isEmpty {
d.out.print(message, terminator: "")
print(message, terminator: "")
}
let password = try await withoutEcho { try await prompt("") }
d.out.print()
print()
return password
}
@@ -58,7 +91,7 @@ package enum Console {
#endif
}
package static func chooseNumber(in range: Range<Int>) async throws -> Int {
static func chooseNumber(in range: Range<Int>) async throws -> Int {
let message = "Choice (\(range.lowerBound)-\(range.upperBound - 1)): "
while true {
if let choice = try await Int(prompt(message)), range.contains(choice) {
@@ -67,7 +100,7 @@ package enum Console {
}
}
package static func choose<T>(
static func choose<T>(
from elements: [T],
onNoElement: () throws -> T,
multiPrompt: @autoclosure () -> String,
@@ -79,9 +112,9 @@ package enum Console {
case 1:
return elements[0]
default:
d.out.print(multiPrompt())
print(multiPrompt())
try elements.enumerated().forEach { index, element in
try d.out.print("\(index): \(formatter(element))")
try print("\(index): \(formatter(element))")
}
let choice = try await chooseNumber(in: elements.indices)
return elements[choice]
@@ -91,7 +124,7 @@ package enum Console {
private static let yesSet: Set<String> = ["yes", "y"]
private static let noSet: Set<String> = ["no", "n"]
package static func confirm(_ message: String) async throws -> Bool {
static func confirm(_ message: String) async throws -> Bool {
while true {
let resp = try await prompt("\(message) (yes/no): ").lowercased()
if yesSet.contains(resp) {
@@ -102,9 +135,9 @@ package enum Console {
}
}
package struct Error: Swift.Error, CustomStringConvertible {
package let description: String
package init(_ description: String) {
struct Error: Swift.Error, CustomStringConvertible {
let description: String
init(_ description: String) {
self.description = description
}
}
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import ArgumentParser
import XKit
@@ -25,64 +24,66 @@ struct DSCertificatesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let certificates = try await DeveloperAPIPages(\.links.next) {
let certificates = try await DeveloperAPIPages {
try await client.certificatesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
for certificate in certificates {
d.out.print("- id: \(certificate.id)")
print("- id: \(certificate.id)")
guard let attributes = certificate.attributes else {
continue
}
if let name = attributes.name {
d.out.print(" name: \(name)")
print(" name: \(name)")
}
if let certificateType = attributes.certificateType {
d.out.print(" type: \(certificateType.rawValue)")
print(" type: \(certificateType.rawValue)")
}
if let displayName = attributes.displayName {
d.out.print(" display name: \(displayName)")
print(" display name: \(displayName)")
}
if let serialNumber = attributes.serialNumber {
d.out.print(" serial number: \(serialNumber)")
print(" serial number: \(serialNumber)")
}
if let platform = attributes.platform {
d.out.print(" platform: \(platform.rawValue)")
print(" platform: \(platform.rawValue)")
}
if let expirationDate = attributes.expirationDate {
d.out.print(" expiry: \(expirationDate.formatted(.dateTime))")
print(" expiry: \(expirationDate.formatted(.dateTime))")
}
if let contentString = attributes.certificateContent {
guard let content = Data(base64Encoded: contentString) else {
d.out.print(" content: error: bad base64")
print(" content: error: bad base64")
continue
}
do {
let certificate = try Certificate(data: content)
d.out.print(" content:")
print(" content:")
switch Result(catching: { try certificate.developerIdentity() }) {
case .success(let id):
d.out.print(" common name: \(id)")
print(" common name: \(id)")
case .failure(let error):
d.out.print(" common name: error: \(error)")
print(" common name: error: \(error)")
}
switch Result(catching: { try certificate.teamID() }) {
case .success(let teamID):
d.out.print(" team id: \(teamID)")
print(" team id: \(teamID)")
case .failure(let error):
d.out.print(" team id: error: \(error)")
print(" team id: error: \(error)")
}
} catch {
d.out.print(" content: error: \(error)")
print(" content: error: \(error)")
}
}
}
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import XKit
import ArgumentParser
@@ -14,7 +13,7 @@ struct DSAnisetteCommand: AsyncParsableCommand {
@Dependency(\.anisetteDataProvider) var provider
let res = try await provider.fetchAnisetteData()
for (key, value) in res.dictionary.sorted(by: { $0.key < $1.key }) {
d.out.print("\(key): \(value)")
print("\(key): \(value)")
}
}
}
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import ArgumentParser
import XKit
@@ -24,44 +23,46 @@ struct DSDevicesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let devices = try await DeveloperAPIPages(\.links.next) {
let devices = try await DeveloperAPIPages {
try await client.devicesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
for device in devices {
d.out.print("- id: \(device.id)")
print("- id: \(device.id)")
guard let attributes = device.attributes else {
continue
}
if let name = attributes.name {
d.out.print(" name: \(name)")
print(" name: \(name)")
}
if let platform = attributes.platform {
d.out.print(" platform: \(platform.rawValue)")
print(" platform: \(platform.rawValue)")
}
if let udid = attributes.udid {
d.out.print(" udid: \(udid)")
print(" udid: \(udid)")
}
if let deviceClass = attributes.deviceClass {
d.out.print(" device class: \(deviceClass.rawValue)")
print(" device class: \(deviceClass.rawValue)")
}
if let status = attributes.status {
d.out.print(" status: \(status.rawValue)")
print(" status: \(status.rawValue)")
}
if let model = attributes.model {
d.out.print(" model: \(model)")
print(" model: \(model)")
}
if let addedDate = attributes.addedDate {
d.out.print(" added date: \(addedDate.formatted(.dateTime))")
print(" added date: \(addedDate.formatted(.dateTime))")
}
}
}
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import ArgumentParser
import XKit
@@ -24,28 +23,30 @@ struct DSIdentifiersListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let bundleIDs = try await DeveloperAPIPages(\.links.next) {
let bundleIDs = try await DeveloperAPIPages {
try await client.bundleIdsGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
for bundleID in bundleIDs {
d.out.print("- id: \(bundleID.id)")
print("- id: \(bundleID.id)")
guard let attributes = bundleID.attributes else {
continue
}
if let name = attributes.name {
d.out.print(" name: \(name)")
print(" name: \(name)")
}
if let identifier = attributes.identifier {
d.out.print(" identifier: \(identifier)")
print(" identifier: \(identifier)")
}
if let platform = attributes.platform {
d.out.print(" platform: \(platform.rawValue)")
print(" platform: \(platform.rawValue)")
}
if let seedId = attributes.seedId {
d.out.print(" seedId: \(seedId)")
print(" seedId: \(seedId)")
}
}
}
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import ArgumentParser
import XKit
@@ -27,71 +26,73 @@ struct DSProfilesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let profiles = try await DeveloperAPIPages(\.links.next) {
let profiles = try await DeveloperAPIPages {
try await client.profilesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
for profile in profiles {
d.out.print("- id: \(profile.id)")
print("- id: \(profile.id)")
guard let attributes = profile.attributes else {
continue
}
if let name = attributes.name {
d.out.print(" name: \(name)")
print(" name: \(name)")
}
if let platform = attributes.platform {
d.out.print(" platform: \(platform.rawValue)")
print(" platform: \(platform.rawValue)")
}
if let profileType = attributes.profileType {
d.out.print(" profile type: \(profileType.rawValue)")
print(" profile type: \(profileType.rawValue)")
}
if let profileState = attributes.profileState {
d.out.print(" profile state: \(profileState.rawValue)")
print(" profile state: \(profileState.rawValue)")
}
if let uuid = attributes.uuid {
d.out.print(" uuid: \(uuid)")
print(" uuid: \(uuid)")
}
if let createdDate = attributes.createdDate {
d.out.print(" created date: \(createdDate.formatted(.dateTime))")
print(" created date: \(createdDate.formatted(.dateTime))")
}
if let expirationDate = attributes.expirationDate {
d.out.print(" expiration date: \(expirationDate.formatted(.dateTime))")
print(" expiration date: \(expirationDate.formatted(.dateTime))")
}
if let contentString = attributes.profileContent {
guard let contentData = Data(base64Encoded: contentString) else {
d.out.print(" content: error: bad base64")
print(" content: error: bad base64")
continue
}
do {
let profile = try Mobileprovision(data: contentData)
let digest = try profile.digest()
d.out.print(" team identifiers:")
print(" team identifiers:")
for teamID in digest.teamIdentifiers {
d.out.print(" - \(teamID.rawValue)")
print(" - \(teamID.rawValue)")
}
d.out.print(" certificates:")
print(" certificates:")
for certificate in digest.certificates {
d.out.print(" - \(certificate.serialNumber())")
print(" - \(certificate.serialNumber())")
}
d.out.print(" devices:")
print(" devices:")
for device in digest.devices {
d.out.print(" - \(device)")
print(" - \(device)")
}
let entitlements = try? String(decoding: Self.encoder.encode(digest.entitlements), as: UTF8.self)
d.out.print(" entitlements: \(entitlements ?? "<error>")")
print(" entitlements: \(entitlements ?? "<error>")")
} catch {
d.out.print(" content: error: \(error)")
print(" content: error: \(error)")
}
}
}
@@ -1,5 +1,3 @@
import XCLIUtils
import XUtils
import Foundation
import ArgumentParser
import XKit
@@ -29,7 +27,7 @@ struct DSTeamsListCommand: AsyncParsableCommand {
}
let client = DeveloperServicesClient(authData: authData)
let teams: [DeveloperServicesTeam] = try await client.send(DeveloperServicesListTeamsRequest())
d.out.print(
print(
teams.map {
"\($0.name) [\($0.status)]: \($0.id.rawValue)" +
$0.memberships.map { "\n- \($0.name) (\($0.platform))" }.joined()
-2
View File
@@ -1,5 +1,3 @@
import XCLIUtils
import XUtils
import ArgumentParser
import Foundation
import XKit
+19 -19
View File
@@ -1,4 +1,3 @@
import XCLIUtils
import Foundation
import ArgumentParser
import PackLib
@@ -39,7 +38,7 @@ struct PackOperation {
try await EnsureSDKOperation(quiet: true).run()
d.out.print("Planning...")
print("Planning...")
let schema: PackSchema
let configPath = URL(fileURLWithPath: "xtool.yml")
@@ -47,7 +46,7 @@ struct PackOperation {
schema = try await PackSchema(url: configPath)
} else {
schema = .default
d.out.print("""
print("""
warning: Could not locate configuration file '\(configPath.path)'. Using default \
configuration with 'com.example' organization ID.
""")
@@ -81,21 +80,22 @@ struct PackOperation {
.allProducts
.compactMap { p in p.entitlementsPath.map { (p, $0) } }
if !productsWithEntitlements.isEmpty {
let mapping = try await withThrowingTaskGroup(of: (URL, Data).self) { group in
let mapping = try await withThrowingTaskGroup(of: (URL, Entitlements).self) { group in
for (product, path) in productsWithEntitlements {
group.addTask {
let entitlements = try await Data(reading: URL(fileURLWithPath: path))
let data = try await Data(reading: URL(fileURLWithPath: path))
let decoder = PropertyListDecoder()
let entitlements = try decoder.decode(Entitlements.self, from: data)
return (product.directory(inApp: bundle), entitlements)
}
}
return try await group.reduce(into: [:]) { $0[$1.0] = $1.1 }
}
d.out.print("Applying entitlements...")
try await d.signer.sign(
print("Applying entitlements...")
try await Signer.first().sign(
app: bundle,
identity: .adhoc,
entitlementMapping: mapping,
deep: true,
progress: { _ in }
)
}
@@ -112,7 +112,7 @@ struct DevXcodeCommand: AsyncParsableCommand {
func run() async throws {
let result = try await PackOperation(xcode: true).run()
d.out.print("Wrote to \(result.path)")
print("Wrote to \(result.path)")
}
}
@@ -167,12 +167,12 @@ struct DevBuildCommand: AsyncParsableCommand {
delegate: installDelegate
)
do {
defer { d.out.print() }
defer { print() }
try await installer.signInPlace(app: url)
} catch let error as CancellationError {
throw error
} catch {
d.out.print("Error: \(error)")
print("Error: \(error)")
throw ExitCode.failure
}
}
@@ -187,19 +187,19 @@ struct DevBuildCommand: AsyncParsableCommand {
let ipaURL = try await compressor.compress(directory: payloadDir) { progress in
if let progress {
let percent = Int(progress * 100)
d.out.print("\rPackaging... \(percent)%", terminator: "")
print("\rPackaging... \(percent)%", terminator: "")
} else {
d.out.print("\rPackaging...", terminator: "")
print("\rPackaging...", terminator: "")
}
}
d.out.print()
print()
try? FileManager.default.removeItem(at: finalURL)
try FileManager.default.moveItem(at: ipaURL, to: finalURL)
} else {
finalURL = url
}
d.out.print("Wrote to \(finalURL.path)")
print("Wrote to \(finalURL.path)")
}
}
@@ -251,7 +251,7 @@ struct DevRunCommand: AsyncParsableCommand {
let token = try AuthToken.saved()
let client = try await connectionOptions.client()
d.out.print("Installing to device: \(client.deviceName) (udid: \(client.udid))")
print("Installing to device: \(client.deviceName) (udid: \(client.udid))")
let installDelegate = XToolInstallerDelegate()
let installer = IntegratedInstaller(
@@ -259,7 +259,7 @@ struct DevRunCommand: AsyncParsableCommand {
delegate: installDelegate
)
defer { d.out.print() }
defer { print() }
do {
try await installer.install(
@@ -271,7 +271,7 @@ struct DevRunCommand: AsyncParsableCommand {
} catch let error as CancellationError {
throw error
} catch {
d.out.print("\nError: \(error)")
print("\nError: \(error)")
throw ExitCode.failure
}
}
@@ -309,7 +309,7 @@ struct SimInstallOperation {
output: .discarded
)
.checkSuccess()
d.out.print("Installed to simulator")
print("Installed to simulator")
}
}
#endif
+2 -3
View File
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import XKit
import ArgumentParser
@@ -32,10 +31,10 @@ struct DevicesCommand: AsyncParsableCommand {
guard wait else { break }
if shouldPrint {
shouldPrint = false
d.out.print("Waiting for devices to be connected...")
print("Waiting for devices to be connected...")
}
}
d.out.print(foundDevices.map { "\($0.deviceName) [\($0.connectionType)]: \($0.udid)" }.joined(separator: "\n"))
print(foundDevices.map { "\($0.deviceName) [\($0.connectionType)]: \($0.udid)" }.joined(separator: "\n"))
}
}
+3 -4
View File
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import XKit
import SwiftyMobileDevice
@@ -21,7 +20,7 @@ struct InstallCommand: AsyncParsableCommand {
let client = try await connectionOptions.client()
d.out.print("Installing to device: \(client.deviceName) (udid: \(client.udid))")
print("Installing to device: \(client.deviceName) (udid: \(client.udid))")
let installDelegate = XToolInstallerDelegate()
let installer = IntegratedInstaller(
@@ -36,11 +35,11 @@ struct InstallCommand: AsyncParsableCommand {
lookupMode: .only(client.connectionType),
configureDevice: false,
)
d.out.print("\nSuccessfully installed!")
print("\nSuccessfully installed!")
} catch let error as CancellationError {
throw error
} catch {
d.out.print("\nError: \(error)")
print("\nError: \(error)")
throw ExitCode.failure
}
}
+2 -3
View File
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import PackLib
@@ -35,7 +34,7 @@ enum LSPConfig {
do {
try await ensure(using: schema, quiet: quiet, currentDirectory: directory)
} catch {
d.out.print("warning: failed to validate LSP configuration: \(error)")
print("warning: failed to validate LSP configuration: \(error)")
}
}
@@ -81,7 +80,7 @@ enum LSPConfig {
}
if !quiet {
d.out.print("""
print("""
[LSP] Created \(primary.0) for enhanced IDE support. You may
need to restart your editor for the change to take effect.
You can disable this with `skipLSP: true` in xtool.yml.
+1 -3
View File
@@ -1,5 +1,3 @@
import XCLIUtils
import XUtils
import Foundation
import XKit
import SwiftyMobileDevice
@@ -35,7 +33,7 @@ struct LaunchCommand: AsyncParsableCommand {
throw Console.Error("Could not find an installed app with bundle ID '\(bundleID)'")
}
d.out.print("Launching \(executable.lastPathComponent)...")
print("Launching \(executable.lastPathComponent)...")
let debugserver = try DebugserverClient(device: client.device, label: "xtool")
guard try debugserver.launch(executable: executable, arguments: args) == "OK" else {
+5 -7
View File
@@ -1,5 +1,3 @@
import XUtils
import XCLIUtils
import ArgumentParser
import Foundation
import PackLib
@@ -63,7 +61,7 @@ struct NewCommand: AsyncParsableCommand {
throw Console.Error("Cannot create \(name): a file already exists at that path.")
}
d.out.print("Creating package: \(name)")
print("Creating package: \(name)")
let moduleName = name.replacingOccurrences(of: "-", with: "_")
@@ -164,7 +162,7 @@ struct NewCommand: AsyncParsableCommand {
at: url.deletingLastPathComponent(),
withIntermediateDirectories: true
)
d.out.print("Creating \(path)")
print("Creating \(path)")
try "\(contents)\n".write(to: url, atomically: true, encoding: .utf8)
}
@@ -174,8 +172,8 @@ struct NewCommand: AsyncParsableCommand {
currentDirectory: baseURL,
)
d.out.print("\nFinished generating project \(name). Next steps:")
d.out.print("- Enter the directory with `cd \(name)`")
d.out.print("- Build and run with `xtool dev`")
print("\nFinished generating project \(name). Next steps:")
print("- Enter the directory with `cd \(name)`")
print("- Build and run with `xtool dev`")
}
}
+19 -16
View File
@@ -1,4 +1,3 @@
import XCLIUtils
import Foundation
import Dependencies
import libunxip
@@ -136,13 +135,13 @@ struct SDKBuilder {
let iPhoneSimSDK = try sdk(platform: "iPhoneSimulator", prefix: "iPhoneSimulator")
let macOSSDK = try sdk(platform: "MacOSX", prefix: "MacOSX")
d.out.print("""
print("""
- \(iPhoneOSSDK)
- \(iPhoneSimSDK)
- \(macOSSDK)
""")
d.out.print("[Writing metadata]")
print("[Writing metadata]")
try """
{
"schemaVersion": "1.0",
@@ -247,7 +246,7 @@ struct SDKBuilder {
if let envOverride, let path = ProcessInfo.processInfo.environment[envOverride] {
let source = URL(fileURLWithPath: path)
if source.dirExists {
d.out.print("[Copying \(displayName)] \(source.path)")
print("[Copying \(displayName)] \(source.path)")
try await Subprocess.run(
.name("cp"),
arguments: ["-RL", "\(source.path)/.", "."],
@@ -268,7 +267,7 @@ struct SDKBuilder {
return
}
d.out.print("[Extracting \(displayName)] \(source.path)")
print("[Extracting \(displayName)] \(source.path)")
try await Subprocess.run(
.name("tar"),
arguments: ["xzf", source.path],
@@ -290,7 +289,7 @@ struct SDKBuilder {
case .unknown: nil
}
defer { d.out.print() }
defer { print() }
try await Subprocess.run(
.name("tar"),
arguments: ["xzf", "-"],
@@ -309,7 +308,8 @@ struct SDKBuilder {
guard let length else { continue }
let progress = Int(Double(totalWritten) / Double(length) * 100)
d.out.print("\r[Downloading \(displayName)] \(progress)%", terminator: "", flush: true)
print("\r[Downloading \(displayName)] \(progress)%", terminator: "")
fflush(stdoutSafe)
}
}
try await execution.standardInputWriter.finish()
@@ -525,7 +525,7 @@ struct SDKBuilder {
let sourceContentsDir = source.appendingPathComponent("Contents")
let expectedContentsDir = expectedAppDir.appendingPathComponent("Contents")
try FileManager.default.createDirectory(at: expectedContentsDir, withIntermediateDirectories: true)
d.out.print("[Copying Xcode.app] This might take a minute...")
print("[Copying Xcode.app] This might take a minute...")
for child in Self.expectedXcodeChildren {
let expectedFile = expectedContentsDir.appendingPathComponent(child)
let sourceFile = sourceContentsDir.appendingPathComponent(child)
@@ -559,11 +559,13 @@ struct SDKBuilder {
count += 1
if let wanted {
let progress = Int(Double(count) / Double(wanted) * 100)
d.out.print("\r[Installing SDKs] \(progress)%", terminator: "", flush: true)
print("\r[Installing SDKs] \(progress)%", terminator: "")
fflush(stdoutSafe)
}
if count % 100 == 0 {
if wanted == nil {
d.out.print("\r[Installing SDKs] Installed \(count) files", terminator: "", flush: true)
print("\r[Installing SDKs] Installed \(count) files", terminator: "")
fflush(stdoutSafe)
}
await Task.yield()
}
@@ -587,16 +589,16 @@ struct SDKBuilder {
if wanted != nil {
// otherwise the last log might say 99%
d.out.print("\r[Installing SDKs] 100%", terminator: "")
print("\r[Installing SDKs] 100%", terminator: "")
}
d.out.print()
print()
if let cleanupStageDir {
d.out.print("[Cleaning up]")
print("[Cleaning up]")
try FileManager.default.removeItem(at: cleanupStageDir)
}
d.out.print("[Finalizing SDKs]")
print("[Finalizing SDKs]")
for platform in ["iPhoneOS", "MacOSX", "iPhoneSimulator"] {
let lib = "../../../../../Library"
@@ -747,7 +749,8 @@ struct SDKBuilder {
for try await chunk in observer {
read += chunk.count
let progress = Int(Double(read) / Double(length) * 100)
d.out.print("\r[Extracting XIP] \(progress)%", terminator: "", flush: true)
print("\r[Extracting XIP] \(progress)%", terminator: "")
fflush(stdoutSafe)
if read == length { break }
}
}()
@@ -783,7 +786,7 @@ struct SDKBuilder {
}
_ = try await readTask
d.out.print()
print()
return wanted
}
+17 -18
View File
@@ -1,4 +1,3 @@
import XCLIUtils
import Foundation
import XKit
import ArgumentParser
@@ -52,7 +51,7 @@ struct DevSDKBuildCommand: AsyncParsableCommand {
let output = URL(fileURLWithPath: outputDir, isDirectory: true).appending(path: "darwin.xtoolsdk")
let builder = SDKBuilder(input: input, output: output, arch: builderArch, mode: .buildSlim)
try await builder.buildSDK()
d.out.print("Built SDK at \(output.path). You can install it with `xtool sdk install`.")
print("Built SDK at \(output.path). You can install it with `xtool sdk install`.")
}
}
@@ -123,7 +122,7 @@ struct DevSDKRemoveCommand: AsyncParsableCommand {
throw Console.Error("Cannot remove SDK: no Darwin SDK installed")
}
try sdk.remove()
d.out.print("Uninstalled SDK")
print("Uninstalled SDK")
}
}
@@ -135,12 +134,12 @@ struct DevSDKStatusCommand: AsyncParsableCommand {
func run() async throws {
if let sdk = try DarwinSDK.current() {
d.out.print("Darwin SDK is installed")
d.out.print(" Path: \(sdk.bundle.path)")
d.out.print(" Flavor: \(sdk.flavor)")
d.out.print(" Version: \(sdk.version)")
print("Darwin SDK is installed")
print(" Path: \(sdk.bundle.path)")
print(" Flavor: \(sdk.flavor)")
print(" Version: \(sdk.version)")
} else {
d.out.print("Not installed")
print("Not installed")
}
}
}
@@ -157,14 +156,14 @@ struct EnsureSDKOperation {
func run() async throws {
#if os(macOS)
if !quiet {
d.out.print("Skipping Darwin SDK setup since we're on macOS.")
print("Skipping Darwin SDK setup since we're on macOS.")
}
#else
let sdk = try DarwinSDK.current()
switch sdk.map({ ($0.isUpToDate(), $0.flavor) }) {
case (true, _)?: // swiftlint:disable:this optional_enum_case_matching
if !quiet {
d.out.print("Darwin SDK is up to date.")
print("Darwin SDK is up to date.")
}
case (false, .slim)?: // swiftlint:disable:this optional_enum_case_matching
throw Console.Error("""
@@ -175,10 +174,10 @@ struct EnsureSDKOperation {
xtool sdk install [--slim]
""")
case (false, .normal)?: // swiftlint:disable:this optional_enum_case_matching
d.out.print("Darwin SDK is out of date. Rebuilding...")
print("Darwin SDK is out of date. Rebuilding...")
try await UpdateSDKOperation().run()
case (false, .legacy)?: // swiftlint:disable:this optional_enum_case_matching
d.out.print("""
print("""
Darwin SDK is incompatible: built with an older version of xtool.
Requesting re-install. This is a one-time rebuild; after this,
@@ -187,7 +186,7 @@ struct EnsureSDKOperation {
""")
try await generateSDK()
case nil:
d.out.print("Now generating the Darwin SDK.\n")
print("Now generating the Darwin SDK.\n")
try await generateSDK()
}
@@ -218,13 +217,13 @@ struct InstallSDKOperation {
func run() async throws {
#if os(macOS)
d.out.print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
#else
let temporaryBundle = try DarwinSDK.prepareTemporaryBundle()
if path.hasSuffix(".xtoolsdk") {
d.out.print("Installing prebuilt SDK...")
print("Installing prebuilt SDK...")
try await FileManager.default.copyItem(at: URL(filePath: path), to: temporaryBundle.url, preserveOwner: false)
} else {
// validate input before removing existing SDK
@@ -237,7 +236,7 @@ struct InstallSDKOperation {
}
if let sdk = try DarwinSDK.current() {
d.out.print("Removing existing SDK...")
print("Removing existing SDK...")
try sdk.remove()
}
@@ -249,7 +248,7 @@ struct InstallSDKOperation {
struct UpdateSDKOperation {
func run() async throws {
#if os(macOS)
d.out.print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
#else
guard let existing = try DarwinSDK.current() else {
throw Console.Error("Could not locate existing SDK; cannot perform update.")
@@ -281,7 +280,7 @@ struct UpdateSDKOperation {
try existing.remove()
try await temporaryBundle.install()
d.out.print("Updated SDK")
print("Updated SDK")
#endif
}
}
+2 -3
View File
@@ -1,4 +1,3 @@
import XUtils
import Foundation
import XKit
import SwiftyMobileDevice
@@ -25,9 +24,9 @@ struct UninstallCommand: AsyncParsableCommand {
progress: { _ in }
)
} catch {
d.out.print("Failed: \(error)")
print("Failed: \(error)")
return
}
d.out.print("Success!")
print("Success!")
}
}
+1 -5
View File
@@ -1,9 +1,5 @@
import CXKit
import XCLIUtils
extension XTool {
public static let version = CommandVersion(
version: String(cString: xtl_version()),
hasUncommittedChanges: xtl_has_uncommitted_changes(),
)
public static let version = String(cString: xtl_version())
}
+3 -7
View File
@@ -1,9 +1,7 @@
import XCLIUtils
import Foundation
import XKit
import ArgumentParser
import XUtils
import Dependencies
public enum XTool {
public static func run(arguments: [String]? = nil) async throws {
@@ -58,8 +56,6 @@ extension ParsableCommand where Self: SendableMetatype {
for await _ in canStart {}
guard !Task.isCancelled else { return }
do {
@Dependency(\.shutdownRegistry) var shutdownRegistry
defer { await shutdownRegistry.shutdown() }
var command = try self.parseAsRoot(arguments)
if var asyncCommand = command as? AsyncParsableCommand {
try await asyncCommand.run()
@@ -67,12 +63,12 @@ extension ParsableCommand where Self: SendableMetatype {
try command.run()
}
} catch where error is CancellationError || Task.isCancelled {
d.out.print("Cancelled.", stream: .stderr)
print("Cancelled.")
self.exit()
} catch {
if ProcessInfo.processInfo.environment["XTL_DEBUG_ERRORS"] != nil {
d.out.print("ERROR DETAILS:")
d.out.print(String(reflecting: error))
print("ERROR DETAILS:")
print(String(reflecting: error))
}
self.exit(withError: error)
}
@@ -1,9 +1,6 @@
import XCLIUtils
import Foundation
import XKit
import ConcurrencyExtras
import Dependencies
import XUtils
final class XToolAuthDelegate: TwoFactorAuthDelegate {
func fetchCode() async -> String? {
@@ -12,8 +9,7 @@ final class XToolAuthDelegate: TwoFactorAuthDelegate {
}
actor XToolInstallerDelegate: IntegratedInstallerDelegate {
private nonisolated let _output = Dependency(\.out)
private nonisolated var output: CommandOutput { _output.wrappedValue }
init() {}
private let updateTask = LockIsolated<Task<Void, Never>?>(nil)
@@ -27,7 +23,8 @@ actor XToolInstallerDelegate: IntegratedInstallerDelegate {
case nil:
text = "Continuing..."
}
output.print("\n\(text)", terminator: "", flush: true)
print("\n\(text)", terminator: "")
fflush(stdoutSafe)
}
var prevStage: String?
@@ -55,15 +52,19 @@ actor XToolInstallerDelegate: IntegratedInstallerDelegate {
if stage != prevStage {
if let progString = progString {
output.print("\n[\(stage)] \(progString)", terminator: "", flush: true)
print("\n[\(stage)] \(progString)", terminator: "")
fflush(stdoutSafe)
} else {
output.print("\n[\(stage)] ...", terminator: "", flush: true)
print("\n[\(stage)] ...", terminator: "")
fflush(stdoutSafe)
}
} else if progString != prevProgress {
if let progString = progString {
output.print("\r[\(stage)] \(progString)", terminator: "", flush: true)
print("\r[\(stage)] \(progString)", terminator: "")
fflush(stdoutSafe)
} else {
output.print("\r[\(stage)]", terminator: "", flush: true)
print("\r[\(stage)]", terminator: "")
fflush(stdoutSafe)
}
}
}
@@ -78,8 +79,8 @@ actor XToolInstallerDelegate: IntegratedInstallerDelegate {
}
func confirmRevocation(of certificates: [DeveloperServicesCertificate]) async -> Bool {
output.print("\nThe following certificates must be revoked:")
output.print(
print("\nThe following certificates must be revoked:")
print(
certificates.map {
"- \($0.attributes!.name!) (expires \($0.attributes!.expirationDate!.formatted(date: .abbreviated, time: .shortened)))"
}.joined(separator: "\n")
-79
View File
@@ -1,79 +0,0 @@
// swiftlint:disable prefer_dependency_print
import Dependencies
import Foundation
import CXKit
public struct CommandOutput: DependencyKey, Sendable {
public enum Stream: String, Codable, Sendable {
case stdout
case stderr
}
public var write: @Sendable (_ data: Data, _ stream: Stream, _ flush: Bool) -> Void
public init(write: @escaping @Sendable (Data, Stream, Bool) -> Void) {
self.write = write
}
public func print(
_ message: String = "",
terminator: String = "\n",
stream: Stream = .stdout,
flush: Bool = false
) {
write(Data((message + terminator).utf8), stream, flush)
}
@_disfavoredOverload
public func print(
_ items: Any...,
separator: String = " ",
terminator: String = "\n",
stream: Stream = .stdout,
flush: Bool = false
) {
print(
items.map { String(describing: $0) }.joined(separator: separator),
terminator: terminator,
stream: stream,
flush: flush
)
}
public static var liveValue: Self {
let outputLock = NSLock()
return Self { data, stream, flush in
let descriptor: FileDescriptor = stream == .stdout ? .standardOutput : .standardError
// Keep concurrent messages together, including across partial writes.
outputLock.withLock {
try? data.withUnsafeBytes { try descriptor.writeAllWaiting($0) }
if flush { fflush(get_stdout()) }
}
}
}
public static var testValue: Self { Self(write: unimplemented("CommandOutput.write")) }
}
extension CommandOutput {
/// Create a `FileDescriptor` for writing to the given `CommandOutput` stream.
public func makeDescriptor(for stream: Stream) throws -> FileDescriptor {
let (readFD, writeFD) = try FileDescriptor.pipe()
let input = try DispatchInput(fileDesciptor: readFD)
// no need to keep a handle to the task, it'll terminate when writeFD is closed
Task {
while let next = try? await input.read() {
self.write(next, stream, false)
}
}
return writeFD
}
}
extension DependencyValues {
public var out: CommandOutput {
get { self[CommandOutput.self] }
set { self[CommandOutput.self] = newValue }
}
}
-132
View File
@@ -1,132 +0,0 @@
import Foundation
import ConcurrencyExtras
/// A bi-directional channel for streaming data from producer -> consumer.
///
/// Supports backpressure via `onRequest`.
public struct DataChannel: Sendable {
enum Phase {
case active
case closed(Error?)
}
public enum Errors: Error {
case concurrentRead
}
public struct Limit: Sendable {
public var limit: @Sendable (Data) throws -> Int
public init(limit: @escaping @Sendable (Data) throws -> Int) {
self.limit = limit
}
public static var unlimited: Limit {
Limit { _ in .max }
}
public static func bytes(_ count: Int) -> Limit {
Limit { _ in count }
}
public static var newline: Limit {
Limit { buffer in
if let newlineIndex = buffer.firstIndex(of: UInt8(ascii: "\n")) {
return buffer.distance(from: buffer.startIndex, to: newlineIndex) + 1
} else {
return .max
}
}
}
}
private struct State {
var waiter: (@Sendable () -> Void)?
var phase: Phase = .active
var buffer = Data()
var request: (@Sendable () -> Void)?
}
private let state = LockIsolated(State())
public init() {}
public func onRequest(_ request: @escaping @Sendable () -> Void) {
self.state.withValue { $0.request = request }
}
public func write(_ data: Data) {
let waiter: (@Sendable () -> Void)? = self.state.withValue { state in
guard case .active = state.phase else { return nil }
state.buffer.append(contentsOf: data)
return state.waiter.take()
}
waiter?()
}
public func finish(error: Error?) {
let waiter: (@Sendable () -> Void)? = self.state.withValue { state in
guard case .active = state.phase else { return nil }
state.phase = .closed(error)
return state.waiter.take()
}
waiter?()
}
private enum Outcome<T: Sendable>: Sendable {
case result(Result<T?, Error>)
case callRequest((@Sendable () -> Void)?)
}
nonisolated(nonsending) public func read<T: Sendable>(drain: @Sendable (inout Data) throws -> T) async throws -> T? {
while true {
try Task.checkCancellation()
let result: Result<T?, Error>? = await withTaskCancellationHandler {
await withCheckedContinuation { continuation in
let outcome: Outcome<T> = state.withValue { state in
guard !Task.isCancelled else {
return .result(.failure(CancellationError()))
}
if !state.buffer.isEmpty {
return .result(Result { try drain(&state.buffer) })
}
switch state.phase {
case .active:
guard state.waiter == nil else {
return .result(.failure(Errors.concurrentRead))
}
state.waiter = { continuation.resume(returning: nil) }
return .callRequest(state.request)
case .closed(nil):
return .result(.success(nil))
case .closed(let error?):
return .result(.failure(error))
}
}
switch outcome {
case .result(let result):
continuation.resume(returning: result)
case .callRequest(let request):
request?()
}
}
} onCancel: {
self.state.withValue { $0.waiter.take()?() }
}
if let result {
return try result.get()
}
}
}
nonisolated(nonsending) public func read(upTo limit: Limit = .unlimited) async throws -> Data? {
try await self.read { buffer in
let count = min(try limit.limit(buffer), buffer.count)
guard count > 0 else { return Data() }
let result = buffer.prefix(count)
buffer.removeFirst(count)
return result
}
}
}
-10
View File
@@ -1,10 +0,0 @@
import Dependencies
/// The current `DependencyValues`.
///
/// Prefer adding `@Dependency` fields to your type when possible, as
/// they remember the value assigned during initialization.
public var d: DependencyValues {
@Dependency(\.self) var values
return values
}
-141
View File
@@ -1,141 +0,0 @@
import Foundation
import ConcurrencyExtras
public final class DispatchInput: Sendable {
private struct State {
var hasClosed = false
var isReading = false
}
public static let defaultChunkSize: Int = 64 * 1024
let queue = DispatchQueue(label: "xtool.dispatch-reader")
let channel: DispatchIO
let chunkSize: Int
private let closeSignal: Task<Void, Never>
private let dataChannel = DataChannel()
private let state = LockIsolated(State())
public init(fileDesciptor: FileDescriptor, chunkSize: Int = DispatchInput.defaultChunkSize) throws {
let closeSignal = Task { _ = try? await Task.never() }
self.closeSignal = closeSignal
self.chunkSize = chunkSize
enum InitState {
case pending
case done(onClose: @Sendable (Int32) -> Void)
case failed(Int32)
}
let initState = LockIsolated<InitState>(.pending)
self.channel = DispatchIO(
type: .stream,
fileDescriptor: fileDesciptor.rawValue,
queue: queue,
) { err in
initState.withValue { state in
switch state {
case .pending:
state = .failed(err)
case .done(let onClose):
onClose(err)
case .failed: // wat
break
}
}
}
channel.setLimit(lowWater: 1)
try initState.withValue { state in
switch state {
case .pending:
state = .done { [weak self] err in
self?.didClose(code: err)
closeSignal.cancel()
}
case .done: // wat
break
case .failed(let err):
throw Errno(rawValue: err)
}
}
dataChannel.onRequest { [weak self] in
self?.onRequest()
}
}
nonisolated(nonsending) public func read(upTo limit: DataChannel.Limit = .unlimited) async throws -> Data? {
try await dataChannel.read(upTo: limit)
}
private func onRequest() {
let didMarkStarted = state.withValue { state in
guard !state.isReading else { return false }
state.isReading = true
return true
}
guard didMarkStarted else { return }
channel.read(
offset: 0,
length: chunkSize,
queue: queue,
) { [weak self] done, data, error in
guard let self else { return }
let data = data.map { Data($0) }
self.onRead(
done: done,
data: data,
error: error,
)
}
}
private func onRead(
done: Bool,
data: Data?,
error: Int32,
) {
if done {
state.withValue { $0.isReading = false }
}
let data = data.map { Data($0) }
if let data, !data.isEmpty {
dataChannel.write(data)
}
if error != 0 {
requestClose(error: Errno(rawValue: error))
} else if done, data?.isEmpty == true {
requestClose(error: nil)
}
}
nonisolated(nonsending) public func close() async {
requestClose(error: nil)
await closeSignal.value
}
private func requestClose(error: Error?) {
guard markClosedIfNeeded() else { return }
channel.close(flags: .stop)
dataChannel.finish(error: error)
}
private func didClose(code: Int32) {
guard markClosedIfNeeded() else { return }
dataChannel.finish(error: code == 0 ? nil : Errno(rawValue: code))
}
private func markClosedIfNeeded() -> Bool {
state.withValue { state in
let hadClosed = state.hasClosed
state.hasClosed = true
return !hadClosed
}
}
deinit {
guard !state.withValue(\.hasClosed) else { return }
channel.close(flags: .stop)
dataChannel.finish(error: nil)
}
}
+1 -1
View File
@@ -43,7 +43,7 @@ extension FileManager {
do {
try result.checkSuccess()
} catch {
d.out.print("Error copying \(srcURL.path) to \(dstURL.path): \(result.standardError)")
print("Error copying \(srcURL.path) to \(dstURL.path): \(result.standardError)")
throw error
}
return
-66
View File
@@ -1,66 +0,0 @@
extension Sequence where Element: Sendable {
/// Like `map`, but runs transformations concurrently.
///
/// - Parameter maxConcurrency: The maximum number of transforms to run concurrently.
/// If `nil`, we choose a reasonable default value. Use `.max` to run all at once.
///
/// - Parameter transform: The transformation to apply to each element.
///
/// - Returns: Transformed elements in the same order as the original sequence.
public nonisolated(nonsending) func concurrentMap<T: Sendable, E: Error>(
maxConcurrency: Int? = nil,
_ transform: @escaping @Sendable @isolated(any) (Element) async throws(E) -> T,
) async throws(E) -> [T] {
try await _concurrentMap(
maxConcurrency: maxConcurrency ?? 10,
transform,
willWaitForNext: nil,
)
}
nonisolated(nonsending) func _concurrentMap<T: Sendable, E: Error>(
maxConcurrency: Int,
_ transform: @escaping @Sendable @isolated(any) (Element) async throws(E) -> T,
willWaitForNext: (() -> Void)?, // hook for testing
) async throws(E) -> [T] {
precondition(maxConcurrency > 0, "maxConcurrency must be > 0")
return try await withTaskGroup(of: (Int, Result<T, E>).self) { group -> Result<[T], E> in
var results: [T?] = []
results.reserveCapacity(self.underestimatedCount)
var iterator = makeIterator()
var exhausted = false
var inFlight = 0
while true {
while !exhausted && inFlight < maxConcurrency {
guard let element = iterator.next() else {
exhausted = true
break
}
let index = results.count
results.append(nil)
group.addTask {
let result = await Result { () async throws(E) in
try await transform(element)
}
return (index, result)
}
inFlight += 1
}
willWaitForNext?()
guard let (index, result) = await group.next() else { break }
inFlight -= 1
switch result {
case .success(let value):
results[index] = value
case .failure(let error):
group.cancelAll()
return .failure(error)
}
}
// we can't use `as! [T]` because it breaks nested optionals (Foo??)
return .success(results.map { $0! })
}
.get()
}
}
-17
View File
@@ -54,21 +54,4 @@ extension Environment {
)
}
}
extension OutputProtocol where Self == FileDescriptorOutput {
/// Writes subprocess output to `d.out`'s stdout
public static func xtoolOutput() throws -> Self {
try makeXToolOutput(for: .stdout)
}
/// Writes subprocess output to `d.out`'s stderr
public static func xtoolError() throws -> Self {
try makeXToolOutput(for: .stderr)
}
private static func makeXToolOutput(for stream: CommandOutput.Stream) throws -> Self {
let fd = try d.out.makeDescriptor(for: stream)
return .fileDescriptor(fd, closeAfterSpawningProcess: true)
}
}
#endif
+2 -29
View File
@@ -28,34 +28,7 @@ extension FilePath {
#endif
extension FileDescriptor {
/// Writes every byte, waiting for capacity if the descriptor is nonblocking.
package func writeAllWaiting(_ bytes: UnsafeRawBufferPointer) throws {
var offset = 0
while offset < bytes.count {
do {
// Swift System retries EINTR; retain the offset when a write is partial.
let count = try write(UnsafeRawBufferPointer(rebasing: bytes[offset...]))
guard count > 0 else { throw Errno.ioError }
offset += count
} catch let error as Errno where error == .resourceTemporarilyUnavailable || error == .wouldBlock {
var descriptor = pollfd(fd: rawValue, events: Int16(POLLOUT), revents: 0)
while true {
try Task.checkCancellation()
// periodically wake up to check for cancellation
let result = poll(&descriptor, 1, 100)
if result > 0 { break }
if result == -1 {
let error = Errno(rawValue: errno)
guard error != .interrupted else { continue }
throw error
}
}
// Retry write to report terminal errors (including POLLERR/POLLNVAL).
}
}
}
public enum LockMode {
enum LockMode {
case shared
case exclusive
@@ -67,7 +40,7 @@ extension FileDescriptor {
}
}
public func tryLock(mode: LockMode) throws -> Bool {
func tryLock(mode: LockMode) throws -> Bool {
if flock(rawValue, mode.raw | LOCK_NB) == 0 {
return true
}
+18 -1
View File
@@ -71,7 +71,24 @@ private struct TemporaryDirectoryRoot {
}
private init() {
let url = XToolCache.directory
let url: URL
let env = ProcessInfo.processInfo.environment
if let tmpdir = env["XTL_TMPDIR"] ?? env["TMPDIR"] {
url = URL(fileURLWithPath: tmpdir).appendingPathComponent("sh.xtool")
} else {
#if os(Linux)
// On Linux, /tmp is commonly a tmpfs mount while ~/.swiftpm lives on ext4.
// Foundation's FileManager.copyItem uses sendfile(2) internally, which returns
// EINVAL when copying between different filesystem types (e.g. tmpfs → ext4).
// This causes `swift sdk install` to fail on distros like Linux Mint (#181).
// Using a cache dir on the home filesystem avoids the cross-fs copy entirely.
let xdgCache = env["XDG_CACHE_HOME"].map { URL(fileURLWithPath: $0) }
?? FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".cache")
url = xdgCache.appendingPathComponent("xtool")
#else
url = FileManager.default.temporaryDirectory.appendingPathComponent("sh.xtool")
#endif
}
Self.pruneOrphans(in: url)
-22
View File
@@ -1,22 +0,0 @@
import Foundation
package enum XToolCache {
package static var directory: URL {
let env = ProcessInfo.processInfo.environment
if let tmpdir = env["XTL_TMPDIR"], !tmpdir.isEmpty {
return URL(fileURLWithPath: tmpdir).appendingPathComponent("sh.xtool")
}
#if os(Linux)
let xdgCache: URL
if let xdgCachePath = env["XDG_CACHE_HOME"],
(xdgCachePath as NSString).isAbsolutePath {
xdgCache = URL(filePath: xdgCachePath)
} else {
xdgCache = FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".cache")
}
return xdgCache.appending(component: "xtool")
#else
return URL.cachesDirectory.appending(component: "sh.xtool")
#endif
}
}
+1 -2
View File
@@ -2,10 +2,9 @@ import Foundation
private import XcodeProj
extension XCSchema.Project {
public func pbxprojRepresentation(name: String, projectDirPath: String = "") throws -> Data {
public func pbxprojRepresentation(name: String) throws -> Data {
let xcprojData = try self.jsonRepresentation()
let pbxproj = try PBXProj(xcprojData: xcprojData, projectName: name)
try pbxproj.rootProject()?.projectDirPath = projectDirPath
// dataRepresentation should never return nil
return try pbxproj.dataRepresentation() ?? Data()
}
+8 -43
View File
@@ -1,5 +1,4 @@
import Foundation
private import XcodeProj
@_exported import XcodeProjectFormat
// This library is a lightweight layer on top of the XcodeProjectFormat
@@ -17,31 +16,13 @@ public struct XcodeProject: Equatable, Sendable {
public var project: XCSchema.Project
public var format: Format
/// The .xcodeproj bundle's location, including for projects constructed in memory.
public var url: URL
/// For pbxproj projects, an explicit source root.
public var projectDirPath = ""
public var sourceRoot: URL {
if projectDirPath.isEmpty {
url.deletingLastPathComponent()
} else {
URL(
filePath: projectDirPath,
directoryHint: .isDirectory,
relativeTo: url.deletingLastPathComponent(),
).standardizedFileURL
}
}
public init(
project: XCSchema.Project,
url: URL,
format: Format = .pbxproj,
) {
self.project = project
self.format = format
self.url = url.standardizedFileURL.resolvingSymlinksInPath()
}
/// Reads the project from the given `.xcodeproj` path.
@@ -49,8 +30,6 @@ public struct XcodeProject: Equatable, Sendable {
guard url.pathExtension == "xcodeproj" else {
throw Errors.notAnXcodeproj(url.path)
}
let url = url.standardizedFileURL.resolvingSymlinksInPath()
self.url = url
let xcprojURL = url.appending(path: "project.xcproj")
lazy var pbxprojURL = url.appending(path: "project.pbxproj")
if FileManager.default.fileExists(atPath: xcprojURL.path) {
@@ -59,9 +38,7 @@ public struct XcodeProject: Equatable, Sendable {
self.format = .xcproj
} else if FileManager.default.fileExists(atPath: pbxprojURL.path) {
let data = try Data(contentsOf: pbxprojURL)
let pbxproj = try PBXProj(data: data)
self.project = try XCSchema.Project(jsonRepresentation: pbxproj.xcprojData())
self.projectDirPath = try pbxproj.rootProject()?.projectDirPath ?? ""
self.project = try XCSchema.Project(pbxprojRepresentation: data)
self.format = .pbxproj
} else {
throw Errors.missingProjectFile(url.path)
@@ -75,39 +52,27 @@ public struct XcodeProject: Equatable, Sendable {
return copy
}
/// Returns a copy at a new bundle location.
public func withURL(_ url: URL) -> Self {
var copy = self
copy.url = url.standardizedFileURL.resolvingSymlinksInPath()
return copy
}
/// Writes the project to its current `.xcodeproj` URL.
public func write() throws {
/// Writes the project to the given `.xcodeproj` path.
public func write(to url: URL) throws {
try? FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
switch format {
case .pbxproj:
try project.pbxprojRepresentation(
name: url.deletingPathExtension().lastPathComponent,
projectDirPath: projectDirPath,
).write(to: url.appendingPathComponent("project.pbxproj"))
try project
.pbxprojRepresentation(name: url.deletingPathExtension().lastPathComponent)
.write(to: url.appendingPathComponent("project.pbxproj"))
case .xcproj:
guard projectDirPath.isEmpty else {
throw Errors.xcprojWithExplicitSourceRoot
}
try project
.jsonRepresentation()
.write(to: url.appendingPathComponent("project.xcproj"))
}
let workspaceURL = url.appendingPathComponent("project.xcworkspace")
try XcodeWorkspace(children: [.file(.current)], url: workspaceURL).write()
try XcodeWorkspace(children: [.file(.current)])
.write(to: url.appendingPathComponent("project.xcworkspace"))
}
public enum Errors: Error {
case notAnXcodeproj(String)
case missingProjectFile(String)
case xcprojWithExplicitSourceRoot
}
}
@@ -4,15 +4,14 @@ private import XcodeProj
extension XcodeWorkspace {
public init(url: URL) throws {
let workspace = try XCWorkspace(pathString: url.path)
self.init(workspace.data, url: url)
self.init(workspace.data)
}
public func dataRepresentation() throws -> Data {
try xcWorkspaceData.dataRepresentation() ?? Data()
}
/// Writes the workspace to its current URL.
public func write() throws {
public func write(to url: URL) throws {
try? FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
try self.dataRepresentation()
.write(to: url.appendingPathComponent("contents.xcworkspacedata"))
@@ -22,8 +21,8 @@ extension XcodeWorkspace {
// MARK: - Conversion
extension XcodeWorkspace {
fileprivate init(_ xcWorkspaceData: XCWorkspaceData, url: URL) {
self.init(children: xcWorkspaceData.children.map { .init(from: $0) }, url: url)
fileprivate init(_ xcWorkspaceData: XCWorkspaceData) {
self.init(children: xcWorkspaceData.children.map { .init(from: $0) })
}
fileprivate var xcWorkspaceData: XCWorkspaceData {
+1 -10
View File
@@ -63,18 +63,9 @@ public struct XcodeWorkspace: Hashable, Sendable {
}
public var children: [Element]
public var url: URL
public init(children: [Element], url: URL) {
public init(children: [Element]) {
self.children = children
self.url = url.standardizedFileURL.resolvingSymlinksInPath()
}
/// Returns a copy at a new workspace location.
public func withURL(_ url: URL) -> Self {
var copy = self
copy.url = url.standardizedFileURL.resolvingSymlinksInPath()
return copy
}
}
-27
View File
@@ -1,27 +0,0 @@
import Foundation
import Testing
@testable import XKit
struct AnisetteDataTests {
@Test(arguments: [
(0.0, "1970-01-01T00:00:00Z"),
(1_609_459_200.0, "2021-01-01T00:00:00Z"),
(1_582_934_400.0, "2020-02-29T00:00:00Z"),
(1_704_164_645.75, "2024-01-02T03:04:05Z"),
])
func dictionaryFormatsClientTime(timestamp: TimeInterval, expected: String) {
let data = AnisetteData(
clientTime: Date(timeIntervalSince1970: timestamp),
routingInfo: 123,
machineID: "machine",
localUserID: "user",
oneTimePassword: "password",
deviceInfo: DeviceInfo(
deviceID: "device",
clientInfo: "client",
akdUserAgent: "agent"
)
)
#expect(data.dictionary["X-Apple-I-Client-Time"] == expected)
}
}
-104
View File
@@ -1,104 +0,0 @@
@testable import XCLIUtils
import XUtils
import ConcurrencyExtras
import Foundation
import Testing
@Suite(.timeLimit(.minutes(1)))
struct CommandInputTests {
@Test(arguments: [Data("bar".utf8), Data([0, 255, 128, 13, 10])])
func rawReadCoalescesBytesAfterLine(remainder: Data) async throws {
let channel = DataChannel()
let input = CommandInput(channel: channel)
channel.write(Data("foo\n".utf8) + remainder)
channel.write(Data("next\nlast".utf8))
channel.finish(error: nil)
#expect(try await input.readLine() == "foo")
#expect(try await input.read() == remainder + Data("next\nlast".utf8))
#expect(try await input.read() == nil)
#expect(try await input.readLine() == nil)
}
@Test
func lineReadsAfterRawReadPreserveFollowingLines() async throws {
let channel = DataChannel()
let input = CommandInput(channel: channel)
channel.write(Data("raw".utf8))
#expect(try await input.read() == Data("raw".utf8))
channel.write(Data("foo\r\n\nbar\nlast".utf8))
channel.finish(error: nil)
#expect(try await input.readLine() == "foo")
#expect(try await input.readLine() == "")
#expect(try await input.readLine() == "bar")
#expect(try await input.read() == Data("last".utf8))
#expect(try await input.readLine() == nil)
}
@Test
func lineReadAccumulatesSplitUTF8AndCRLF() async throws {
let channel = DataChannel()
let input = CommandInput(channel: channel)
// Split both a Unicode scalar and the CRLF terminator across reads.
let chunks = LockIsolated([
Data([0xF0, 0x9F]),
Data([0x98, 0x80, 13]),
Data("\n\nlast".utf8),
])
channel.onRequest { [channel] in
let chunk = chunks.withValue { $0.isEmpty ? nil : $0.removeFirst() }
if let chunk {
channel.write(chunk)
} else {
channel.finish(error: nil)
}
}
try await withInputTestTimeout { () async throws in
#expect(try await input.readLine() == "😀")
#expect(try await input.readLine() == "")
#expect(try await input.readLine() == "last")
#expect(try await input.readLine() == nil)
} cleanup: {
channel.finish(error: nil)
}
}
@Test
@available(anyAppleOS 26.0, *)
func cancellingLineDiscardsConsumedPrefixAndPreservesFutureInput() async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let input = CommandInput(channel: channel)
channel.write(Data("discarded prefix".utf8))
let reading = Task.immediate { try await input.readLine() }
defer { reading.cancel() }
try await withInputTestTimeout { () async throws in
reading.cancel()
await #expect(throws: CancellationError.self) { try await reading.value }
channel.write(Data("next\nkept".utf8))
#expect(try await input.readLine() == "next")
#expect(try await input.read() == Data("kept".utf8))
} cleanup: {
channel.finish(error: nil)
}
}
@Test
@available(anyAppleOS 26.0, *)
func finishingChannelWakesLineReadAndReturnsItsUnterminatedBytes() async throws {
let channel = DataChannel()
let input = CommandInput(channel: channel)
channel.write(Data("partial".utf8))
let reading = Task.immediate { try await input.readLine() }
defer { reading.cancel(); channel.finish(error: nil) }
try await withInputTestTimeout { () async throws in
channel.finish(error: nil)
#expect(try await reading.value == "partial")
#expect(try await input.read() == nil)
} cleanup: {
channel.finish(error: nil)
}
}
}
-131
View File
@@ -1,131 +0,0 @@
import ConcurrencyExtras
import Dependencies
import Foundation
import Testing
import XUtils
struct CommandOutputTests {
@Test
func dependencyOutputSupportsStringAndVariadicPrinting() {
struct Output: Equatable, Sendable {
var message: String
var stream: CommandOutput.Stream
var flush: Bool
}
let received = LockIsolated<[Output]>([])
withDependencies {
$0.out.write = { data, stream, flush in
received.withValue {
$0.append(Output(message: String(decoding: data, as: UTF8.self), stream: stream, flush: flush))
}
}
} operation: {
d.out.print()
d.out.print("message")
d.out.print("progress", 42, separator: ": ", terminator: "", stream: .stderr, flush: true)
}
#expect(received.value == [
Output(message: "\n", stream: .stdout, flush: false),
Output(message: "message\n", stream: .stdout, flush: false),
Output(message: "progress: 42", stream: .stderr, flush: true),
])
}
@Test(.timeLimit(.minutes(1)))
func fullNonblockingPipePreservesAllBytes() async throws {
let pipe = Pipe()
let writer = FileDescriptor(rawValue: pipe.fileHandleForWriting.fileDescriptor)
let reader = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
let flags = fcntl(writer.rawValue, F_GETFL)
try #require(flags != -1)
try #require(fcntl(writer.rawValue, F_SETFL, flags | O_NONBLOCK) == 0)
// Fill the pipe before invoking the output writer, forcing EAGAIN.
let padding = Data(repeating: 255, count: 4096)
var prefix = Data()
while true {
do {
let count = try padding.withUnsafeBytes { try writer.write($0) }
prefix.append(padding.prefix(count))
} catch let error as Errno where error.rawValue == EAGAIN || error.rawValue == EWOULDBLOCK {
break
}
}
let message = Data([0, 255, 128]) + Data(String(repeating: "output é 🌍\n", count: 100_000).utf8)
let writing = Task.detached {
defer { try? pipe.fileHandleForWriting.close() }
try message.withUnsafeBytes { try writer.writeAllWaiting($0) }
}
// Let the writer encounter the full pipe before draining it.
try await Task.sleep(for: .milliseconds(20))
let received = try await Task.detached {
var received = Data()
var buffer = [UInt8](repeating: 0, count: 1024)
while true {
let count = try buffer.withUnsafeMutableBytes { try reader.read(into: $0) }
if count == 0 { return received }
received.append(contentsOf: buffer.prefix(count))
}
}.value
try await writing.value
#expect(received == prefix + message)
#expect(fcntl(reader.rawValue, F_GETFL) != -1)
}
@Test(.timeLimit(.minutes(1)))
func fullNonblockingPipeWriteCanBeCancelled() async throws {
let pipe = Pipe()
let writer = FileDescriptor(rawValue: pipe.fileHandleForWriting.fileDescriptor)
let flags = fcntl(writer.rawValue, F_GETFL)
try #require(flags != -1)
try #require(fcntl(writer.rawValue, F_SETFL, flags | O_NONBLOCK) == 0)
let padding = Data(repeating: 255, count: 4096)
while true {
do {
_ = try padding.withUnsafeBytes { try writer.write($0) }
} catch let error as Errno where error.rawValue == EAGAIN || error.rawValue == EWOULDBLOCK {
break
}
}
let (started, continuation) = AsyncStream.makeStream(of: Never.self)
let finished = LockIsolated(false)
let writing = Task.detached {
defer {
try? pipe.fileHandleForWriting.close()
finished.setValue(true)
}
continuation.finish()
try padding.withUnsafeBytes { try writer.writeAllWaiting($0) }
}
for await _ in started {}
// Give the writer time to enter poll before cancelling, without draining the pipe.
try await Task.sleep(for: .milliseconds(20))
writing.cancel()
let deadline = ContinuousClock.now.advanced(by: .seconds(30))
while !finished.value && ContinuousClock.now < deadline {
try await Task.sleep(for: .milliseconds(10))
}
if !finished.value {
Issue.record("Cancelled writer did not stop while the pipe remained full")
// Unblock a regressed writer so the test fails instead of hanging.
_ = try pipe.fileHandleForReading.readToEnd()
}
await #expect(throws: CancellationError.self) {
try await writing.value
}
}
@Test
func invalidDescriptorThrowsInsteadOfRaisingAnException() {
let descriptor = FileDescriptor(rawValue: -1)
#expect(throws: Errno.badFileDescriptor) {
try Data("output".utf8).withUnsafeBytes { try descriptor.writeAllWaiting($0) }
}
// Empty output does not attempt a system call.
#expect(throws: Never.self) {
try Data().withUnsafeBytes { try descriptor.writeAllWaiting($0) }
}
}
}
-227
View File
@@ -1,227 +0,0 @@
import Testing
@testable import XUtils
@Suite(.timeLimit(.minutes(1)))
struct ConcurrentMapTests {
@Test(arguments: [[], [7], [3, 1, 3, 2], Array(0..<10)], [nil, 1, 2, Int.max] as [Int?])
func nonThrowingTransform(input: [Int], maxConcurrency: Int?) async {
// No `try` is needed when the transform cannot throw.
let result = await input.concurrentMap(maxConcurrency: maxConcurrency) { String($0 * 2) }
#expect(result == input.map { String($0 * 2) })
}
@Test func emptyInputDoesNotCallTransform() async throws {
let result = try await [Int]().concurrentMap { _ throws(MapError) -> Int in
Issue.record("An empty sequence must not invoke the transform")
throw .failed(0)
}
#expect(result.isEmpty)
}
@Test func singlePassSequence() async {
var next = 0
let input = AnySequence(AnyIterator<Int> {
defer { next += 1 }
return next < 4 ? next : nil
})
#expect(input.underestimatedCount == 0)
let result = await input.concurrentMap(maxConcurrency: 1) { $0 * 2 }
#expect(result == [0, 2, 4, 6])
}
@Test func optionalResults() async {
let result = await (0..<4).concurrentMap { value -> Int? in
value.isMultiple(of: 2) ? nil : value
}
#expect(result == [nil, 1, nil, 3])
}
@Test func nestedOptionalResults() async {
let input: [Int??] = [.none, .some(.none), .some(.some(3))]
let result = await input.concurrentMap { $0 }
#expect(result == input)
}
@Test(arguments: [2, 4, Int.max])
func concurrentExecutionPreservesInputOrder(maxConcurrency: Int) async {
let started = AsyncStream<Int>.makeStream()
let finished = AsyncStream<Int>.makeStream()
let gates = (0..<4).map { _ in AsyncStream<Void>.makeStream() }
let task = Task {
await (0..<4).concurrentMap(maxConcurrency: maxConcurrency) { value in
started.continuation.yield(value)
for await _ in gates[value].stream {}
finished.continuation.yield(value)
return value * 2
}
}
defer { task.cancel() }
// Fill the concurrency window before allowing any transform to finish.
let initialCount = min(maxConcurrency, 4)
var starts = started.stream.makeAsyncIterator()
var startedValues: [Int] = []
for _ in 0..<initialCount {
if let value = await starts.next() {
startedValues.append(value)
}
}
#expect(startedValues.sorted() == Array(0..<initialCount))
// Finish the newest transform first, keeping the first one suspended while work is replenished.
var finishes = finished.stream.makeAsyncIterator()
var pending = Set(startedValues)
var next = initialCount
while let value = pending.max() {
pending.remove(value)
gates[value].continuation.finish()
#expect(await finishes.next() == value)
if next < 4 {
#expect(await starts.next() == next)
pending.insert(next)
next += 1
}
}
#expect(await task.value == [0, 2, 4, 6])
}
@Test(arguments: [1, 2, 3, 25, 100, Int.max])
func limitsConcurrentTransforms(maxConcurrency: Int) async {
let checkpoints = AsyncStream<Int>.makeStream()
let gates = (0..<25).map { _ in AsyncStream<Void>.makeStream() }
let task = Task {
// Both closures below run in the producer task. Only immutable snapshots
// cross to the test through the checkpoint stream.
var submitted = 0
let input = AnySequence(AnyIterator<Int> {
guard submitted < gates.count else { return nil }
defer { submitted += 1 }
return submitted
})
return await input._concurrentMap(maxConcurrency: maxConcurrency) { value in
for await _ in gates[value].stream {}
return value * 2
} willWaitForNext: {
checkpoints.continuation.yield(submitted)
}
}
defer { task.cancel() }
// No transform can finish yet. The hook proves submission has reached
// group.next(), rather than merely being paused by the scheduler.
let initialCount = min(maxConcurrency, gates.count)
var waits = checkpoints.stream.makeAsyncIterator()
#expect(await waits.next() == initialCount)
// Each completed transform frees exactly one slot. Check the next submission
// boundary before releasing another transform, including while draining.
for value in gates.indices {
gates[value].continuation.finish()
#expect(await waits.next() == min(initialCount + value + 1, gates.count))
}
let result = await withTaskCancellationHandler {
await task.value
} onCancel: {
task.cancel()
}
#expect(result == (0..<25).map { $0 * 2 })
}
@Test @MainActor func actorIsolatedTransform() async {
var visited: [Int] = []
let result = await (0..<4).concurrentMap(maxConcurrency: 2) { @MainActor value in
MainActor.assertIsolated()
visited.append(value)
return value * 2
}
#expect(visited.sorted() == [0, 1, 2, 3])
#expect(result == [0, 2, 4, 6])
}
@Test func preservesTypedError() async {
// This signature also checks that concurrentMap preserves the error type.
func map() async throws(MapError) -> [Int] {
try await [42].concurrentMap { value throws(MapError) -> Int in
throw .failed(value)
}
}
await #expect(throws: MapError.failed(42)) {
try await map()
}
}
@Test func failureCancelsUnfinishedTransforms() async {
let started = AsyncStream<Int>.makeStream()
let failureGate = AsyncStream<Void>.makeStream()
let siblingGate = AsyncStream<Void>.makeStream()
let cancelled = AsyncStream<Int>.makeStream()
let task = Task {
try await (0..<10).concurrentMap(maxConcurrency: 3) { value async throws(MapError) -> Int in
#expect(value < 3, "A failure must not schedule the remaining inputs")
started.continuation.yield(value)
if value == 1 {
for await _ in failureGate.stream {}
throw .failed(value)
}
// This stream only finishes when the task is cancelled.
for await _ in siblingGate.stream {}
#expect(Task.isCancelled)
cancelled.continuation.yield(value)
return value
}
}
defer { task.cancel() }
var starts = started.stream.makeAsyncIterator()
for _ in 0..<3 {
_ = await starts.next()
}
failureGate.continuation.finish()
await #expect(throws: MapError.failed(1)) {
try await withTaskCancellationHandler {
try await task.value
} onCancel: {
// Let the suite's time limit break a regression in sibling cancellation.
task.cancel()
}
}
// The task group must wait for both cancelled transforms to exit.
cancelled.continuation.finish()
var cancelledValues: [Int] = []
for await value in cancelled.stream {
cancelledValues.append(value)
}
#expect(cancelledValues.sorted() == [0, 2])
}
@Test func parentCancellationReachesTransforms() async {
let started = AsyncStream<Void>.makeStream()
let gate = AsyncStream<Void>.makeStream()
let task = Task {
try await [1].concurrentMap { _ in
started.continuation.yield(())
for await _ in gate.stream {}
try Task.checkCancellation()
}
}
defer { task.cancel() }
var starts = started.stream.makeAsyncIterator()
_ = await starts.next()
task.cancel()
await #expect(throws: CancellationError.self) {
try await task.value
}
}
private enum MapError: Error, Equatable {
case failed(Int)
}
}
-200
View File
@@ -1,200 +0,0 @@
@testable import XUtils
import ConcurrencyExtras
import CustomDump
import Foundation
import Testing
@Suite(.timeLimit(.minutes(1)))
struct DataChannelTests {
private enum TestError: Error { case producer, drain }
@Test(arguments: [1, 3, 100])
func byteLimitPreservesRemainder(limit: Int) async throws {
let channel = DataChannel()
channel.write(Data([0, 255]))
channel.write(Data([128, 13, 10]))
channel.finish(error: nil)
let bytes = Data([0, 255, 128, 13, 10])
let first = try await channel.read(upTo: .bytes(limit))
expectNoDifference(first, Data(bytes.prefix(limit)))
if limit < bytes.count {
let remainder = try await channel.read()
expectNoDifference(remainder, Data(bytes.dropFirst(limit)))
}
#expect(try await channel.read() == nil)
#expect(try await channel.read() == nil)
}
@Test
func zeroLimitDoesNotConsumeBufferedBytes() async throws {
let channel = DataChannel()
channel.write(Data("kept".utf8))
channel.finish(error: nil)
#expect(try await channel.read(upTo: .bytes(0)) == Data())
let bytes = try await channel.read()
expectNoDifference(bytes, Data("kept".utf8))
}
@Test(arguments: [false, true])
func newlinePreservesRemainderAfterPartialRead(consumePrefix: Bool) async throws {
let channel = DataChannel()
channel.write(Data("abfirst\nsecond line with a long remainder".utf8))
channel.finish(error: nil)
if consumePrefix {
let prefix = try await channel.read(upTo: .bytes(2))
expectNoDifference(prefix, Data("ab".utf8))
}
let line = try await channel.read(upTo: .newline)
expectNoDifference(line, Data((consumePrefix ? "first\n" : "abfirst\n").utf8))
let remainder = try await channel.read()
expectNoDifference(remainder, Data("second line with a long remainder".utf8))
}
@Test
func newlineReturnsEmptyLineAndUnterminatedChunk() async throws {
let channel = DataChannel()
channel.write(Data("\npartial".utf8))
channel.finish(error: nil)
#expect(try await channel.read(upTo: .newline) == Data("\n".utf8))
let remainder = try await channel.read(upTo: .newline)
expectNoDifference(remainder, Data("partial".utf8))
#expect(try await channel.read() == nil)
}
@Test
func throwingLimitLeavesBufferAvailable() async throws {
let channel = DataChannel()
channel.write(Data("kept".utf8))
channel.finish(error: nil)
await #expect(throws: TestError.drain) {
try await channel.read(drain: { _ in throw TestError.drain })
}
let bytes = try await channel.read()
expectNoDifference(bytes, Data("kept".utf8))
}
@Test(arguments: [false, true])
func finishDrainsBufferAndKeepsFirstTerminalResult(failed: Bool) async throws {
let channel = DataChannel()
channel.write(Data("before".utf8))
channel.finish(error: failed ? TestError.producer : nil)
channel.write(Data("ignored".utf8))
channel.finish(error: failed ? nil : TestError.producer)
let bytes = try await channel.read()
expectNoDifference(bytes, Data("before".utf8))
for _ in 0..<2 {
if failed {
await #expect(throws: TestError.producer) { try await channel.read() }
} else {
#expect(try await channel.read() == nil)
}
}
}
@Test
func requestsDataOnlyWhenBufferIsEmpty() async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let requests = LockIsolated(0)
channel.onRequest { [channel] in
requests.withValue { $0 += 1 }
channel.write(Data("new".utf8))
}
channel.write(Data("buffered".utf8))
try await withInputTestTimeout {
let buffered = try await channel.read()
expectNoDifference(buffered, Data("buffered".utf8))
#expect(requests.value == 0)
for expectedRequests in 1...2 {
let bytes = try await channel.read()
expectNoDifference(bytes, Data("new".utf8))
#expect(requests.value == expectedRequests)
}
} cleanup: {
channel.finish(error: nil)
}
channel.finish(error: nil)
#expect(try await channel.read() == nil)
#expect(requests.value == 2)
}
@Test(arguments: [false, true])
@available(anyAppleOS 26.0, *)
func finishWakesPendingRead(failed: Bool) async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let reading = Task.immediate { try await channel.read() }
defer { reading.cancel() }
try await withInputTestTimeout { () async throws in
channel.finish(error: failed ? TestError.producer : nil)
if failed {
await #expect(throws: TestError.producer) { try await reading.value }
} else {
#expect(try await reading.value == nil)
}
} cleanup: {
channel.finish(error: nil)
}
}
@Test
@available(anyAppleOS 26.0, *)
func concurrentReadThrowsWithoutDisruptingPendingRead() async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let reading = Task.immediate { try await channel.read() }
defer { reading.cancel() }
try await withInputTestTimeout {
await #expect(throws: DataChannel.Errors.concurrentRead) {
try await channel.read()
}
channel.write(Data("first".utf8))
let first = try await reading.value
expectNoDifference(first, Data("first".utf8))
channel.write(Data("next".utf8))
let next = try await channel.read()
expectNoDifference(next, Data("next".utf8))
} cleanup: {
channel.finish(error: nil)
}
}
@Test
@available(anyAppleOS 26.0, *)
func cancelledPendingReadAllowsAnotherRead() async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let reading = Task.immediate { try await channel.read() }
defer { reading.cancel() }
try await withInputTestTimeout {
reading.cancel()
await #expect(throws: CancellationError.self) { try await reading.value }
channel.write(Data("kept".utf8))
let bytes = try await channel.read()
expectNoDifference(bytes, Data("kept".utf8))
} cleanup: {
channel.finish(error: nil)
}
}
@Test
func alreadyCancelledReadDoesNotConsumeBufferOrRequestData() async throws {
let channel = DataChannel()
defer { channel.finish(error: nil) }
let requested = LockIsolated(false)
channel.onRequest { requested.setValue(true) }
channel.write(Data("kept".utf8))
let reading = Task {
withUnsafeCurrentTask { $0?.cancel() }
return try await channel.read()
}
await #expect(throws: CancellationError.self) { try await reading.value }
#expect(!requested.value)
let bytes = try await channel.read()
expectNoDifference(bytes, Data("kept".utf8))
}
}
-193
View File
@@ -1,193 +0,0 @@
@testable import XUtils
import XCLIUtils
import CustomDump
import Foundation
import Testing
@Suite(.timeLimit(.minutes(1)))
struct DispatchInputTests {
@Test
func commandInputReadsLinesAcrossDispatchBatches() async throws {
let pipe = Pipe()
let descriptor = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
try pipe.fileHandleForWriting.write(contentsOf: Data("abfirst\r\n\nlast".utf8))
try pipe.fileHandleForWriting.close()
try await withReader(descriptor: descriptor, chunkSize: 2) { reader async throws in
let input = CommandInput(read: { try await reader.read(upTo: $0) })
#expect(try await input.read(upTo: .bytes(2)) == Data("ab".utf8))
#expect(try await input.readLine() == "first")
#expect(try await input.readLine() == "")
#expect(try await input.readLine() == "last")
#expect(try await input.read() == nil)
}
}
@Test
func pipeDeliversShortChunksBeforeEOF() async throws {
let pipe = Pipe()
let descriptor = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
let flags = fcntl(descriptor.rawValue, F_GETFL)
try await withReader(descriptor: descriptor) { reader in
for bytes in [Data("first\n".utf8), Data([0, 255, 128])] {
try pipe.fileHandleForWriting.write(contentsOf: bytes)
let chunk = try await reader.read()
expectNoDifference(chunk, bytes)
}
try pipe.fileHandleForWriting.close()
#expect(try await reader.read() == nil)
#expect(try await reader.read() == nil)
}
#expect(fcntl(descriptor.rawValue, F_GETFL) == flags)
}
@Test
func pipePreservesBytesAcrossBatches() async throws {
let pipe = Pipe()
let descriptor = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
let bytes = Data((0..<1027).map { UInt8(truncatingIfNeeded: $0) })
try pipe.fileHandleForWriting.write(contentsOf: bytes)
try pipe.fileHandleForWriting.close()
try await withReader(descriptor: descriptor, chunkSize: 64) { reader in
var received = Data()
while let chunk = try await reader.read() {
#expect(!chunk.isEmpty)
#expect(chunk.count <= 64)
received.append(chunk)
}
expectNoDifference(received, bytes)
}
}
@Test(arguments: [false, true])
@available(anyAppleOS 26.0, *)
func closeFinishesBeforeOrDuringRead(pendingRead: Bool) async throws {
let pipe = Pipe()
let descriptor = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
let flags = fcntl(descriptor.rawValue, F_GETFL)
try await withReader(descriptor: descriptor) { reader async throws in
if pendingRead {
let reading = Task.immediate { try await reader.read() }
defer { reading.cancel() }
await reader.close()
#expect(try await reading.value == nil)
} else {
await reader.close()
}
#expect(try await reader.read() == nil)
await reader.close()
}
#expect(fcntl(descriptor.rawValue, F_GETFL) == flags)
}
@Test
func nullInputClosesAfterEOF() async throws {
let descriptor = try FileDescriptor.open("/dev/null", .readOnly)
defer { try? descriptor.close() }
try await withReader(descriptor: descriptor) { reader async throws in
#expect(try await reader.read() == nil)
await reader.close()
#expect(try await reader.read() == nil)
}
#expect(fcntl(descriptor.rawValue, F_GETFL) != -1)
}
@Test
func readErrorSurvivesClose() async throws {
let descriptor = try FileDescriptor.open("/dev/null", .writeOnly)
defer { try? descriptor.close() }
try await withReader(descriptor: descriptor) { reader in
await #expect(throws: Errno.badFileDescriptor) { try await reader.read() }
await reader.close()
await #expect(throws: Errno.badFileDescriptor) { try await reader.read() }
}
}
@Test
func invalidDescriptorFailsDuringInitOrRead() async throws {
// DispatchIO can report initialization failure before or after init returns.
await #expect(throws: Errno.badFileDescriptor) {
try await withReader(descriptor: FileDescriptor(rawValue: -1)) { reader in
_ = try await reader.read()
}
}
}
@Test
func fileReadsAreBoundedAndPreserveAllBytes() async throws {
let path = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: path) }
let bytes = Data((0..<10_003).map { UInt8(truncatingIfNeeded: $0) })
try bytes.write(to: path)
let descriptor = try FileDescriptor.open(FilePath(path.path), .readOnly)
defer { try? descriptor.close() }
try await withReader(descriptor: descriptor, chunkSize: 1024) { reader in
var received = Data()
while let chunk = try await reader.read() {
#expect(!chunk.isEmpty)
#expect(chunk.count <= 1024)
received.append(chunk)
}
expectNoDifference(received, bytes)
#expect(try await reader.read() == nil)
}
}
@Test
func idleConsumerDoesNotStartAnotherBatch() async throws {
let path = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
defer { try? FileManager.default.removeItem(at: path) }
try Data(repeating: 255, count: 16 * 1024).write(to: path)
let descriptor = try FileDescriptor.open(FilePath(path.path), .readOnly)
defer { try? descriptor.close() }
try await withReader(descriptor: descriptor, chunkSize: 1024) { reader in
#expect(try await reader.read() != nil)
// Allow any unintended read-ahead to run while the consumer is idle.
try await Task.sleep(for: .milliseconds(20))
await reader.close()
let offset = try descriptor.seek(offset: 0, from: .current)
#expect(offset > 0)
#expect(offset <= 1024)
}
}
@Test
func deinitClosesPendingIOAndRestoresDescriptor() async throws {
let pipe = Pipe()
let descriptor = FileDescriptor(rawValue: pipe.fileHandleForReading.fileDescriptor)
let flags = fcntl(descriptor.rawValue, F_GETFL)
weak var weakReader: DispatchInput?
do {
let reader: DispatchInput = try DispatchInput(fileDesciptor: descriptor)
weakReader = reader
try pipe.fileHandleForWriting.write(contentsOf: Data("a".utf8))
let chunk = try await withInputTestTimeout {
try await reader.read()
} cleanup: { [reader] in
await reader.close()
}
expectNoDifference(chunk, Data("a".utf8))
#expect(fcntl(descriptor.rawValue, F_GETFL) & O_NONBLOCK != 0)
}
#expect(weakReader == nil)
// poll for channel.close() to finish
let deadline = ContinuousClock.now + .seconds(30)
while fcntl(descriptor.rawValue, F_GETFL) != flags {
try #require(ContinuousClock.now < deadline, "Timed out waiting for input operation")
try await Task.sleep(for: .milliseconds(1))
}
}
private func withReader(
descriptor: FileDescriptor,
chunkSize: Int = DispatchInput.defaultChunkSize,
operation: (DispatchInput) async throws -> Void,
) async throws {
let reader = try DispatchInput(fileDesciptor: descriptor, chunkSize: chunkSize)
defer { await reader.close() }
try await withInputTestTimeout {
try await operation(reader)
} cleanup: {
await reader.close()
}
}
}
-24
View File
@@ -1,24 +0,0 @@
import Foundation
import Testing
/// Releases suspended reads on timeout so a regression cannot hang the test process.
func withInputTestTimeout<T>(
_ timeout: Duration = .seconds(30),
operation: () async throws -> T,
cleanup: @escaping @Sendable () async -> Void,
) async throws -> T {
let watchdog = Task {
do {
try await Task.sleep(for: timeout)
} catch {
return
}
Issue.record("Input operation exceeded timeout of \(timeout)")
await cleanup()
}
defer {
watchdog.cancel()
await watchdog.value
}
return try await operation()
}
@@ -1,41 +0,0 @@
import Testing
import XCLIUtils
struct ShutdownRegistryTests {
@Test
func concurrentShutdownRunsCleanupOnceInReverseOrder() async {
let registry = ShutdownRegistry()
let events = ShutdownEvents()
registry.register { await events.append(1) }
registry.register { await events.append(2) }
await withTaskGroup(of: Void.self) { group in
for _ in 0..<3 { group.addTask { await registry.shutdown() } }
}
#expect(await events.values == [2, 1])
await registry.shutdown()
#expect(await events.values == [2, 1])
}
@Test
func concurrentRegistrationsAreAllIncludedInShutdown() async {
let registry = ShutdownRegistry()
let events = ShutdownEvents()
await withTaskGroup(of: Void.self) { group in
for value in 0..<100 {
group.addTask {
registry.register { await events.append(value) }
}
}
}
await registry.shutdown()
#expect(await events.values.sorted() == Array(0..<100))
}
}
private actor ShutdownEvents {
var values: [Int] = []
func append(_ value: Int) {
values.append(value)
}
}
+1 -1
View File
@@ -5,7 +5,7 @@
base = "Documentation/"
publish = "xtool.docc/.docc-build"
command = "./build.sh"
environment = { SWIFT_VERSION = "6.4.2" }
environment = { SWIFT_VERSION = "6.4.1" }
ignore = "git -C .. diff --quiet $CACHED_COMMIT_REF $COMMIT_REF -- Documentation netlify.toml"
[[redirects]]