Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, macOS.
Improve tmpdir management (#147)
Kabir Oberai836fca8dafac
diff --git a/Package.swift b/Package.swiftindex 4a702ee..a1e26ff 100644--- a/Package.swift+++ b/Package.swift@@ -90,11 +90,14 @@ let package = Package(],exclude: ["openapi-generator-config.yaml", "patch.js"]),+ // common utilities shared across xtool targets+ .target(name: "XUtils"),.target(name: "XKit",dependencies: ["DeveloperAPI","CXKit",+ "XUtils",.byName(name: "XADI", condition: .when(platforms: [.linux])),.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),.product(name: "Dependencies", package: "swift-dependencies"),@@ -165,6 +168,7 @@ let package = Package(.target(name: "PackLib",dependencies: [+ "XUtils",.product(name: "Yams", package: "Yams"),.product(name: "XcodeGenKit", package: "XcodeGen", condition: .when(platforms: [.macOS])),]diff --git a/Sources/PackLib/Foundation+Utils.swift b/Sources/PackLib/Foundation+Utils.swiftdeleted file mode 100644index 5a1073d..0000000--- a/Sources/PackLib/Foundation+Utils.swift+++ /dev/null@@ -1,56 +0,0 @@-import Foundation--package struct TemporaryDirectory: ~Copyable {- private var shouldDelete = true-- package let url: URL-- package init(name: String) throws {- self.url = FileManager.default.temporaryDirectory.appendingPathComponent(name, isDirectory: true)- _delete()- try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)- }-- private func _delete() {- try? FileManager.default.removeItem(at: url)- }-- package consuming func persist() -> URL {- shouldDelete = false- return url- }-- package consuming func persist(at location: URL) throws {- try FileManager.default.moveItem(at: url, to: location)- // we do this after moving, so that if the move fails we clean up- shouldDelete = false- }-- deinit {- if shouldDelete { _delete() }- }-}--extension Data {- // AsyncBytes is Darwin-only :/-- package init(reading fileHandle: FileHandle) async throws {- #if canImport(Darwin)- self = try await fileHandle.bytes.reduce(into: Data()) { $0.append($1) }- #else- self = try fileHandle.readToEnd() ?? Data()- #endif- }-- package init(reading file: URL) async throws {- #if canImport(Darwin)- self = try await file.resourceBytes.reduce(into: Data()) { $0.append($1) }- #else- try self.init(contentsOf: file)- #endif- }-}--package func stderrPrint(_ message: String, terminator: String = "\n") {- try? FileHandle.standardError.write(contentsOf: Data("\(message)\(terminator)".utf8))-}diff --git a/Sources/PackLib/PackSchema.swift b/Sources/PackLib/PackSchema.swiftindex e696d2d..406ef24 100644--- a/Sources/PackLib/PackSchema.swift+++ b/Sources/PackLib/PackSchema.swift@@ -1,5 +1,6 @@import Foundationimport Yams+import XUtilspublic struct PackSchemaBase: Codable, Sendable {public enum Version: Int, Codable, Sendable {diff --git a/Sources/PackLib/Packer.swift b/Sources/PackLib/Packer.swiftindex b852343..ff402bd 100644--- a/Sources/PackLib/Packer.swift+++ b/Sources/PackLib/Packer.swift@@ -1,4 +1,5 @@import Foundation+import XUtilspublic struct Packer: Sendable {public let buildSettings: BuildSettingsdiff --git a/Sources/PackLib/Planner.swift b/Sources/PackLib/Planner.swiftindex cf56430..b3f3e93 100644--- a/Sources/PackLib/Planner.swift+++ b/Sources/PackLib/Planner.swift@@ -1,4 +1,5 @@import Foundation+import XUtilspublic struct Planner: Sendable {public var buildSettings: BuildSettings@@ -213,7 +214,7 @@ public struct Planner: Sendable {}private func dumpDependencies() async throws -> PackageDependency {- let tempDir = try TemporaryDirectory(name: "xtool-dump-\(UUID().uuidString)")+ let tempDir = try TemporaryDirectory(name: "xtool-dump")let tempFileURL = tempDir.url.appendingPathComponent("dump.json")// SwiftPM sometimes prints extraneous data to stdout, so askdiff --git a/Sources/XKit/Integration/IntegratedInstaller.swift b/Sources/XKit/Integration/IntegratedInstaller.swiftindex 1a55819..a8cb990 100644--- a/Sources/XKit/Integration/IntegratedInstaller.swift+++ b/Sources/XKit/Integration/IntegratedInstaller.swift@@ -2,6 +2,7 @@ import Foundationimport SwiftyMobileDeviceimport ConcurrencyExtrasimport Dependencies+import XUtilsextension LockdownClient {static let installerLabel = "xtool"@@ -54,9 +55,6 @@ public actor IntegratedInstaller {private var appInstaller: AppInstaller?- private let tempDir = FileManager.default.temporaryDirectoryShim- .appendingPathComponent("sh.xtool.Staging")-private var stage: String?private nonisolated let updateTask = LockIsolated<Task<Void, Never>?>(nil)@@ -206,12 +204,9 @@ public actor IntegratedInstaller {public func install(app: URL) async throws -> String {try await self.updateStage(to: "Unpacking app", initialProgress: nil)- if FileManager.default.fileExists(atPath: tempDir.path) {- try? FileManager.default.removeItem(at: tempDir)- }-- try FileManager.default.createDirectory(at: tempDir, withIntermediateDirectories: true)- defer { try? FileManager.default.removeItem(at: tempDir) }+ let _tempDir = try TemporaryDirectory(name: "staging")+ let tempDir = _tempDir.url+ defer { withExtendedLifetime(_tempDir) {} }switch app.pathExtension {case "ipa":@@ -235,7 +230,7 @@ public actor IntegratedInstaller {try await self.updateProgress(to: 1)- let payload = self.tempDir.appendingPathComponent("Payload")+ let payload = tempDir.appendingPathComponent("Payload")guard let appDir = payload.implicitContents.first(where: { $0.pathExtension == "app" })else { throw Error.appExtractionFailed }diff --git a/Sources/XToolSupport/DevCommand.swift b/Sources/XToolSupport/DevCommand.swiftindex d2a57ff..83f8ac6 100644--- a/Sources/XToolSupport/DevCommand.swift+++ b/Sources/XToolSupport/DevCommand.swift@@ -3,6 +3,7 @@ import ArgumentParserimport PackLibimport XKitimport Dependencies+import XUtilsstruct PackOperation {struct BuildOptions: ParsableArguments {@@ -136,12 +137,8 @@ struct DevBuildCommand: AsyncParsableCommand {if ipa {@Dependency(\.zipCompressor) var compressorfinalURL = url.deletingPathExtension().appendingPathExtension("ipa")- let tmpDir = try TemporaryDirectory(name: "sh.xtool.tmp")- let payloadDir = tmpDir.url.appendingPathComponent("Payload", isDirectory: true)- try FileManager.default.createDirectory(- at: payloadDir,- withIntermediateDirectories: true- )+ let tmpDir = try TemporaryDirectory(name: "Payload")+ let payloadDir = tmpDir.urltry FileManager.default.moveItem(at: url, to: payloadDir.appendingPathComponent(url.lastPathComponent))let ipaURL = try await compressor.compress(directory: payloadDir) { progress inif let progress {diff --git a/Sources/XToolSupport/SDKCommand.swift b/Sources/XToolSupport/SDKCommand.swiftindex ebb75c6..d587ec8 100644--- a/Sources/XToolSupport/SDKCommand.swift+++ b/Sources/XToolSupport/SDKCommand.swift@@ -4,6 +4,7 @@ import Versionimport ArgumentParserimport Dependenciesimport PackLib+import XUtilsstruct SDKCommand: AsyncParsableCommand {static let configuration = CommandConfiguration(diff --git a/Sources/XToolSupport/XTool.swift b/Sources/XToolSupport/XTool.swiftindex d4d0a41..b369dd6 100644--- a/Sources/XToolSupport/XTool.swift+++ b/Sources/XToolSupport/XTool.swift@@ -1,9 +1,11 @@import Foundationimport XKitimport ArgumentParser+import XUtilspublic enum XTool {public static func run(arguments: [String]? = nil) async throws {+ TemporaryDirectory.prepare()await XToolCommand.cancellableMain(arguments)}}diff --git a/Sources/XUtils/Foundation+Utils.swift b/Sources/XUtils/Foundation+Utils.swiftnew file mode 100644index 0000000..50d02df--- /dev/null+++ b/Sources/XUtils/Foundation+Utils.swift@@ -0,0 +1,25 @@+import Foundation++extension Data {+ // AsyncBytes is Darwin-only :/++ package init(reading fileHandle: FileHandle) async throws {+ #if canImport(Darwin)+ self = try await fileHandle.bytes.reduce(into: Data()) { $0.append($1) }+ #else+ self = try fileHandle.readToEnd() ?? Data()+ #endif+ }++ package init(reading file: URL) async throws {+ #if canImport(Darwin)+ self = try await file.resourceBytes.reduce(into: Data()) { $0.append($1) }+ #else+ try self.init(contentsOf: file)+ #endif+ }+}++package func stderrPrint(_ message: String, terminator: String = "\n") {+ try? FileHandle.standardError.write(contentsOf: Data("\(message)\(terminator)".utf8))+}diff --git a/Sources/XUtils/TemporaryDirectory.swift b/Sources/XUtils/TemporaryDirectory.swiftnew file mode 100644index 0000000..6f50a30--- /dev/null+++ b/Sources/XUtils/TemporaryDirectory.swift@@ -0,0 +1,97 @@+import Foundation++package struct TemporaryDirectory: ~Copyable {+ private static let debugTmp = ProcessInfo.processInfo.environment["XTL_DEBUG_TMP"] != nil++ private var shouldDelete: Bool+ package let url: URL++ /// Prepares a fresh tmpdir root.+ ///+ /// Optional, but try calling this at launch to clean up old resources.+ package static func prepare() {+ _ = TemporaryDirectoryRoot.shared+ }++ /// Creates a temporary directory where `lastPathComponent` is exactly `name`.+ ///+ /// The directory is deleted on deinit or (if the object never deinits) on next launch.+ /// To save the contents, move them elsewhere with ``persist(at:)``.+ package init(name: String) throws {+ do {+ let basename = name.replacingOccurrences(of: ".", with: "_")+ self.url = try TemporaryDirectoryRoot.shared.url+ // ensures uniqueness+ .appendingPathComponent("tmp-\(basename)-\(UUID().uuidString)")+ .appendingPathComponent(name, isDirectory: true)+ self.shouldDelete = true+ } catch {+ // non-copyable types can't be partially initialized so we need a stub value+ self.url = URL(fileURLWithPath: "")+ self.shouldDelete = false+ throw error+ }+ try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)++ if Self.debugTmp {+ stderrPrint("Created TemporaryDirectory: \(url.path)")+ }+ }++ private func _delete() {+ guard !Self.debugTmp else { return }+ try? FileManager.default.removeItem(at: url)+ }++ package consuming func persist(at location: URL) throws {+ try FileManager.default.moveItem(at: url, to: location)+ // we do this after moving, so that if the move fails we clean up+ shouldDelete = false+ }++ deinit {+ if shouldDelete { _delete() }+ }+}++private struct TemporaryDirectoryRoot {+ static let shared = TemporaryDirectoryRoot()++ private let _url: Result<URL, Errors>+ var url: URL {+ get throws(Errors) {+ try _url.get()+ }+ }++ private init() {+ let base: URL+ let env = ProcessInfo.processInfo.environment+ if let tmpdir = env["XTL_TMPDIR"] ?? env["TMPDIR"] {+ base = URL(fileURLWithPath: tmpdir)+ } else {+ base = FileManager.default.temporaryDirectory+ }++ let url = base.appendingPathComponent("sh.xtool")+ try? FileManager.default.removeItem(at: url)+ do {+ try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)+ } catch {+ self._url = .failure(Errors.tmpdirCreationFailed(url, error))+ return+ }+ self._url = .success(url)+ }++ enum Errors: Error, CustomStringConvertible {+ case tmpdirCreationFailed(URL, Error)++ var description: String {+ switch self {+ case let .tmpdirCreationFailed(url, error):+ "Could not create temporary directory at '\(url.path)': \(error)"+ }+ }+ }+}