diff --git a/Xcodes/Frontend/Cleanup/CleanupModel+Cleanup.swift b/Xcodes/Frontend/Cleanup/CleanupModel+Cleanup.swift index cc8e6e11..eb3c9a6e 100644 --- a/Xcodes/Frontend/Cleanup/CleanupModel+Cleanup.swift +++ b/Xcodes/Frontend/Cleanup/CleanupModel+Cleanup.swift @@ -107,8 +107,12 @@ extension CleanupModel { case "chromeLeftovers": tools = ["google chrome"] default: tools = [] } - let running = activeTools.intersection(tools).sorted() - if !running.isEmpty { return "In use by \(running.joined(separator: ", ")). Stop these processes and try again." } + var running = activeTools.intersection(tools) + if category.id == "derivedData", running.contains("xcodebuild"), + !CleanupOperations.xcodebuildMayUseDerivedData(item.path, scopedPaths: xcodebuildDerivedDataPaths) { + running.remove("xcodebuild") + } + if !running.isEmpty { return "In use by \(running.sorted().joined(separator: ", ")). Stop these processes and try again." } } if item.path.bytes.split(separator: 47).contains(where: { $0.elementsEqual("node_modules".utf8) }), !activeTools.isDisjoint(with: ["node", "npm", "pnpm", "yarn"]) { return "Stop Node.js and package-manager processes before cleanup." diff --git a/Xcodes/Frontend/Cleanup/CleanupModel+Simulators.swift b/Xcodes/Frontend/Cleanup/CleanupModel+Simulators.swift index 2e940a4f..35849a8f 100644 --- a/Xcodes/Frontend/Cleanup/CleanupModel+Simulators.swift +++ b/Xcodes/Frontend/Cleanup/CleanupModel+Simulators.swift @@ -35,9 +35,15 @@ extension CleanupModel { /// Ordinary Trash operations need active-use checks, not a full CoreSimulator inventory. func refreshRunningTools() async { protectedPaths = Self.makeProtectedPaths() - let output = try? await Process.runAsync(URL(fileURLWithPath: "/bin/ps"), ["-axo", "comm="]) + let output = try? await Process.runAsync(URL(fileURLWithPath: "/bin/ps"), ["-axo", "pid=,comm="]) guard !Task.isCancelled else { return } - activeTools = Set((output?.out ?? "").split(separator: "\n").map { URL(fileURLWithPath: String($0).trimmingCharacters(in: .whitespaces)).lastPathComponent.lowercased() }) + let processList = output?.out ?? "" + activeTools = Set(processList.split(separator: "\n").compactMap { line in + let fields = line.split(maxSplits: 1, whereSeparator: \.isWhitespace) + guard fields.count == 2 else { return nil } + return URL(fileURLWithPath: String(fields[1])).lastPathComponent.lowercased() + }) + xcodebuildDerivedDataPaths = CleanupOperations.xcodebuildDerivedDataPaths(processList: processList) runningApplications = NSWorkspace.shared.runningApplications.map { (name: $0.localizedName ?? "the running app", bundleID: $0.bundleIdentifier, path: $0.bundleURL.flatMap { try? FilesystemPath($0) }) } diff --git a/Xcodes/Frontend/Cleanup/CleanupModel.swift b/Xcodes/Frontend/Cleanup/CleanupModel.swift index 94b5140b..db2debd9 100644 --- a/Xcodes/Frontend/Cleanup/CleanupModel.swift +++ b/Xcodes/Frontend/Cleanup/CleanupModel.swift @@ -95,6 +95,7 @@ final class CleanupModel: ObservableObject { var activityUnavailable = true var runningApplications: [(name: String, bundleID: String?, path: FilesystemPath?)] = [] var activeTools: Set = [] + var xcodebuildDerivedDataPaths: [FilesystemPath]? init(defaults: Defaults = Current.defaults, folderConfigurationURL: URL? = nil, useFileConfiguration: Bool = false) { folderDefaults = defaults diff --git a/Xcodes/Frontend/Cleanup/CleanupOperations.swift b/Xcodes/Frontend/Cleanup/CleanupOperations.swift index b00248a3..ff99393c 100644 --- a/Xcodes/Frontend/Cleanup/CleanupOperations.swift +++ b/Xcodes/Frontend/Cleanup/CleanupOperations.swift @@ -38,6 +38,52 @@ enum CleanupOperations { UInt64(UInt32(bitPattern: metadata.st_dev)) == item.identity.device else { throw CleanupOperationError.changed } } + /// nil means at least one xcodebuild could be using the default Derived Data location. + static func xcodebuildDerivedDataPaths( + processList: String, + arguments: (pid_t) -> [String]? = processArguments + ) -> [FilesystemPath]? { + var paths: [FilesystemPath] = [] + for line in processList.split(separator: "\n") { + let fields = line.split(maxSplits: 1, whereSeparator: \.isWhitespace) + guard fields.count == 2, let pid = pid_t(fields[0]), + URL(fileURLWithPath: String(fields[1])).lastPathComponent.lowercased() == "xcodebuild" else { continue } + guard let args = arguments(pid) else { return nil } + let flags = args.indices.filter { args[$0] == "-derivedDataPath" } + guard flags.count == 1, let flag = flags.first, flag + 1 < args.count, + args[flag + 1].hasPrefix("/"), + let path = try? FilesystemPath(URL(fileURLWithPath: args[flag + 1]).resolvingSymlinksInPath()) + else { return nil } + paths.append(path) + } + return paths + } + + static func xcodebuildMayUseDerivedData(_ path: FilesystemPath, scopedPaths: [FilesystemPath]?) -> Bool { + guard let scopedPaths, !scopedPaths.isEmpty, + let canonicalPath = try? FilesystemPath(path.url.resolvingSymlinksInPath()) else { return true } + return scopedPaths.contains { $0.contains(canonicalPath) || canonicalPath.contains($0) } + } + + private static func processArguments(_ pid: pid_t) -> [String]? { + var mib: [Int32] = [CTL_KERN, KERN_PROCARGS2, pid] + var size = 0 + guard sysctl(&mib, 3, nil, &size, nil, 0) == 0, size > MemoryLayout.size else { return nil } + var bytes = [UInt8](repeating: 0, count: size) + let status = bytes.withUnsafeMutableBytes { sysctl(&mib, 3, $0.baseAddress, &size, nil, 0) } + guard status == 0, size > MemoryLayout.size else { return nil } + let count = bytes.withUnsafeBytes { Int($0.loadUnaligned(as: Int32.self)) } + guard count > 0 else { return nil } + // The kernel buffer begins with argc, the executable path, then NUL padding before argv. + let payload = bytes[MemoryLayout.size.. count else { return nil } + let arguments = rawArguments.prefix(count).compactMap { String(bytes: $0, encoding: .utf8) } + return arguments.count == count ? arguments : nil + } + struct SimulatorRuntime: Sendable, Codable, Identifiable, Equatable { let identifier: String let runtimeIdentifier: String diff --git a/Xcodes/Frontend/Cleanup/CleanupWindow.swift b/Xcodes/Frontend/Cleanup/CleanupWindow.swift index ab58ebe4..f6bb39d9 100644 --- a/Xcodes/Frontend/Cleanup/CleanupWindow.swift +++ b/Xcodes/Frontend/Cleanup/CleanupWindow.swift @@ -146,8 +146,20 @@ struct CleanupWindow: View { Text(model.cleanupConfirmationMessage) } .alert("Cleanup", isPresented: Binding(get: { model.message != nil }, set: { if !$0 { model.message = nil } })) { - Button("OK") { model.message = nil } - } message: { Text(model.message ?? "") } + Button("OK", role: .cancel) { model.message = nil } + if let details = model.message, details != Self.errorPreview(details) { + Button("Copy Details") { + NSPasteboard.general.clearContents() + NSPasteboard.general.setString(details, forType: .string) + } + } + } message: { Text(Self.errorPreview(model.message ?? "")) } + } + + private static func errorPreview(_ message: String) -> String { + let lines = message.split(omittingEmptySubsequences: false, whereSeparator: \.isNewline) + let preview = String(lines.prefix(6).joined(separator: "\n").prefix(480)) + return preview == message ? preview : preview + "…" } private var savingsHelp: some View { diff --git a/XcodesTests/CleanupOperationsTests.swift b/XcodesTests/CleanupOperationsTests.swift index 28c61b01..989c9f06 100644 --- a/XcodesTests/CleanupOperationsTests.swift +++ b/XcodesTests/CleanupOperationsTests.swift @@ -5,6 +5,65 @@ import XcodesCleanupKit @testable import Xcodes final class CleanupOperationsTests: XCTestCase { + func testXcodebuildWithExplicitDerivedDataProtectsOnlyOverlappingPaths() throws { + let processes = " 123 /Applications/Xcode Beta.app/Contents/Developer/usr/bin/xcodebuild" + let paths = try XCTUnwrap(CleanupOperations.xcodebuildDerivedDataPaths(processList: processes) { pid in + XCTAssertEqual(pid, 123) + return ["xcodebuild", "-derivedDataPath", "/tmp/Build Cache/Active", "test"] + }) + + for path in ["/tmp/Build Cache", "/tmp/Build Cache/Active", "/tmp/Build Cache/Active/Build"] { + XCTAssertTrue(CleanupOperations.xcodebuildMayUseDerivedData( + try FilesystemPath(URL(fileURLWithPath: path)), scopedPaths: paths + )) + } + XCTAssertFalse(CleanupOperations.xcodebuildMayUseDerivedData( + try FilesystemPath(URL(fileURLWithPath: "/tmp/Build Cache/Active-Old")), scopedPaths: paths + )) + } + + func testXcodebuildWithUnknownOutputPathKeepsConservativeGuard() throws { + let processes = "123 /usr/bin/xcodebuild\n456 /usr/bin/xcodebuild" + for unknownArguments in [nil, ["xcodebuild", "test"], ["xcodebuild", "-derivedDataPath", "Relative"]] { + let paths = CleanupOperations.xcodebuildDerivedDataPaths(processList: processes) { pid in + pid == 123 ? ["xcodebuild", "-derivedDataPath", "/tmp/Scoped"] : unknownArguments + } + XCTAssertNil(paths) + XCTAssertTrue(CleanupOperations.xcodebuildMayUseDerivedData( + try FilesystemPath(URL(fileURLWithPath: "/tmp/Unrelated")), scopedPaths: paths + )) + } + } + + @MainActor + func testCleanupBlocksActiveDerivedDataAndAllowsUnrelatedCache() async throws { + let root = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString) + let active = root.appendingPathComponent("Active Build") + let stale = root.appendingPathComponent("Stale Build") + for directory in [active, stale] { + try FileManager.default.createDirectory(at: directory, withIntermediateDirectories: true) + } + defer { try? FileManager.default.removeItem(at: root) } + + let location = try FilesystemPath(root) + let category = FindingCategory(id: "derivedData", title: "Derived Data", explanation: "", + location: location, classification: .review) + let result = try await ScanSession(request: ScanRequest(roots: [location])).result() + let model = CleanupModel(defaults: .mock) + model.configureScan(categories: [category], policyCategories: [category]) + model.activityUnavailable = false + model.activeTools = ["xcodebuild"] + model.xcodebuildDerivedDataPaths = [try FilesystemPath(active.resolvingSymlinksInPath())] + + let activeItem = try XCTUnwrap(result.item(at: FilesystemPath(active))) + let staleItem = try XCTUnwrap(result.item(at: FilesystemPath(stale))) + XCTAssertNotNil(model.blockingReason(activeItem, classification: .review)) + XCTAssertNil(model.blockingReason(staleItem, classification: .review)) + + model.activeTools.insert("clang") + XCTAssertNotNil(model.blockingReason(staleItem, classification: .review)) + } + func testSimulatorInventoryRetainsAvailabilityAndAllDeviceNames() throws { let unavailable = UUID().uuidString let available = UUID().uuidString @@ -74,7 +133,7 @@ final class CleanupOperationsTests: XCTestCase { let missing = try FilesystemPath(folder.appendingPathComponent("missing")) let session = try ScanSession(request: ScanRequest(roots: [FilesystemPath(folder), missing])) let result = try await session.result() - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(result) let root = try XCTUnwrap(result.item(at: FilesystemPath(folder))) let children = result.children(of: root.id) @@ -102,7 +161,7 @@ final class CleanupOperationsTests: XCTestCase { let session = try ScanSession(request: ScanRequest(roots: [FilesystemPath(folder)])) let result = try await session.result() let item = try XCTUnwrap(result.children(of: result.rootIDs[0]).first) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(result) model.setSelected(item, selected: true) model.close() @@ -123,7 +182,7 @@ final class CleanupOperationsTests: XCTestCase { let category = FindingCategory(id: "fixture", title: "Fixture", explanation: "Fixture", location: try FilesystemPath(folder), classification: .review) let session = try ScanSession(request: ScanRequest(roots: [category.location], categories: [category])) let progressResult = try await session.result() - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) // Feed a queryable progress view without invoking the app's finishScan path. model.configureScan(categories: [category], policyCategories: [category]) model.receiveScanProgress(progressResult) @@ -149,7 +208,7 @@ final class CleanupOperationsTests: XCTestCase { let result = try await session.result() let deviceItem = try XCTUnwrap(result.item(at: FilesystemPath(device))) let ordinaryItem = try XCTUnwrap(result.item(at: FilesystemPath(ordinary))) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(result) model.selected = [ordinaryItem.id] XCTAssertEqual(model.cleanupActionTitle, "Move to Trash") @@ -173,7 +232,7 @@ final class CleanupOperationsTests: XCTestCase { let session = try ScanSession(request: ScanRequest(roots: [FilesystemPath(folder)], detectNodeModules: true)) let result = try await session.result() let finding = try XCTUnwrap(result.findings.first { $0.categoryID == "nodeModules" }) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(result) let items = model.items(for: finding) let start = ContinuousClock.now @@ -196,7 +255,7 @@ final class CleanupOperationsTests: XCTestCase { } let session = try ScanSession(request: ScanRequest(roots: [FilesystemPath(folder), categories[1].location], categories: categories)) let result = try await session.result() - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: categories, policyCategories: categories) model.finishScan(result) XCTAssertEqual(model.sections.count, 3) @@ -217,7 +276,7 @@ final class CleanupOperationsTests: XCTestCase { let session = try ScanSession(request: ScanRequest(roots: [category.location], categories: [category])) let result = try await session.result() let item = try XCTUnwrap(result.children(of: result.rootIDs[0]).first) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.finishScan(result) XCTAssertEqual(model.classification(for: item), .regenerable) @@ -252,7 +311,7 @@ final class CleanupOperationsTests: XCTestCase { let orphanItem = try XCTUnwrap(result.item(at: FilesystemPath(orphan))) let local = await CleanupOperations.localSimulatorDetails([item, orphanItem]).mapValues(\.name) XCTAssertEqual(local, [deviceID: "Renamed iPhone"]) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.applySimulatorInventory(names: [deviceID: "iPhone 17"]) model.finishScan(result) @@ -330,7 +389,7 @@ final class CleanupOperationsTests: XCTestCase { var assessment = CleanupOperations.SimulatorAssessment() assessment.include(.init(devices: [availableID: available, obsoleteID: obsolete, bootedID: booted]), xcode: selected) assessment.include(.init(devices: [availableID: available, obsoleteID: obsolete]), xcode: installed) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.applySimulatorAssessment(assessment) model.finishScan(result) @@ -403,7 +462,7 @@ final class CleanupOperationsTests: XCTestCase { XCTAssertEqual(versions[oldItem.id], "iOS 17.5") XCTAssertEqual(versions[currentItem.id], "iOS 27.0") XCTAssertEqual(versions[backupItem.id], "iOS 17.6.1") - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: categories, policyCategories: categories) model.finishScan(result) defer { model.close() } @@ -444,7 +503,7 @@ final class CleanupOperationsTests: XCTestCase { let ios = CleanupOperations.SimulatorRuntime(identifier: UUID().uuidString, runtimeIdentifier: "com.apple.CoreSimulator.SimRuntime.iOS-17-5", build: "21F79", path: image.path, parentImagePath: nil, runtimeBundlePath: nil, sizeBytes: 100, deletable: true, state: "Ready") let vision = CleanupOperations.SimulatorRuntime(identifier: UUID().uuidString, runtimeIdentifier: "com.apple.CoreSimulator.SimRuntime.xrOS-26-0", build: "23M1", path: "/unused/vision.dmg", parentImagePath: nil, runtimeBundlePath: nil, sizeBytes: 200, deletable: true, state: "Ready") let xcode = CleanupOperations.SimulatorXcode(developerDirectory: "/Selected", name: "Xcode 27", selected: true) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(result) defer { model.close() } model.applyRuntimeInventory([vision, ios], associations: [ios.id: [xcode]]) @@ -517,7 +576,7 @@ final class CleanupOperationsTests: XCTestCase { let project = try XCTUnwrap(result.item(at: FilesystemPath(folder.appendingPathComponent("project")))) let modules = try XCTUnwrap(result.item(at: FilesystemPath(nested))) let failed = try XCTUnwrap(result.item(at: FilesystemPath(other))) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.finishScan(result) defer { model.close() } @@ -546,7 +605,7 @@ final class CleanupOperationsTests: XCTestCase { func testCleanupKeepsOSFilterAndRemovesOnlySuccessfulRuntimes() { let old = CleanupOperations.SimulatorRuntime(identifier: UUID().uuidString, runtimeIdentifier: "com.apple.CoreSimulator.SimRuntime.iOS-17-5", build: "21F79", path: "/old.dmg", parentImagePath: nil, runtimeBundlePath: nil, sizeBytes: 100, deletable: true, state: "Ready") let failed = CleanupOperations.SimulatorRuntime(identifier: UUID().uuidString, runtimeIdentifier: "com.apple.CoreSimulator.SimRuntime.iOS-17-0", build: "21A1", path: "/failed.dmg", parentImagePath: nil, runtimeBundlePath: nil, sizeBytes: 200, deletable: true, state: "Ready") - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.applyRuntimeInventory([old, failed], associations: [:]) model.selectedOperatingSystem = "iOS 17" model.toggleRuntimeSelection() @@ -737,7 +796,7 @@ final class CleanupOperationsTests: XCTestCase { let missing = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString) let category = FindingCategory(id: "trash", title: "Trash", explanation: "Review only", location: try FilesystemPath(missing), classification: .manageExternally) let session = try ScanSession(request: ScanRequest(roots: [category.location], categories: [category])) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.finishScan(try await session.result()) let section = try XCTUnwrap(model.sections.first) @@ -764,7 +823,7 @@ final class CleanupOperationsTests: XCTestCase { let restricted = try XCTUnwrap(result.item(at: FilesystemPath(denied))) XCTAssertEqual(restricted.status, .inaccessible) XCTAssertTrue(restricted.isAccessDenied) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.finishScan(result) XCTAssertTrue(try XCTUnwrap(model.sections.first).accessDenied, "An unreadable descendant must be reported on its collapsed category") @@ -798,7 +857,7 @@ final class CleanupOperationsTests: XCTestCase { let category = FindingCategory(id: "limited", title: "Folder", explanation: "", location: try FilesystemPath(folder), classification: .review) let session = try ScanSession(request: ScanRequest(roots: [category.location], categories: [category], maximumDepth: 1)) let result = try await session.result() - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: [category], policyCategories: [category]) model.finishScan(result) let section = try XCTUnwrap(model.sections.first) @@ -846,7 +905,7 @@ final class CleanupOperationsTests: XCTestCase { let session = try ScanSession(request: ScanRequest(roots: categories.map(\.location), categories: categories)) let result = try await session.result() let item = try XCTUnwrap(result.item(at: FilesystemPath(project))) - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.configureScan(categories: categories, policyCategories: categories) model.receiveScanProgress(result) XCTAssertNil(model.availableCleanupBytes, "Progress must not publish a completed total") @@ -1030,7 +1089,7 @@ final class CleanupOperationsTests: XCTestCase { func testCleanupContinuesAfterWindowClosesAndPublishesProgress() async throws { let fixture = try await Self.cleanupProgressFixture() defer { try? FileManager.default.removeItem(at: fixture.root) } - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(fixture.result) let gate = AsyncStream.makeStream() let started = expectation(description: "First operation started") @@ -1066,7 +1125,7 @@ final class CleanupOperationsTests: XCTestCase { func testStopCleanupFinishesCurrentItemAndLeavesRemainingSelection() async throws { let fixture = try await Self.cleanupProgressFixture() defer { try? FileManager.default.removeItem(at: fixture.root) } - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(fixture.result) model.selected = Set(fixture.items.map(\.id)) let gate = AsyncStream.makeStream() @@ -1102,7 +1161,7 @@ final class CleanupOperationsTests: XCTestCase { func testCleanupFailureAdvancesProgressAndRemainsAvailableForReview() async throws { let fixture = try await Self.cleanupProgressFixture() defer { try? FileManager.default.removeItem(at: fixture.root) } - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(fixture.result) model.selected = Set(fixture.items.map(\.id)) model.startCleanup(items: fixture.items, runtimes: [], performItem: { item in @@ -1125,7 +1184,7 @@ final class CleanupOperationsTests: XCTestCase { func testOrdinaryCleanupSkipsCoreSimulatorRefreshButStillValidatesAndChecksActivity() async throws { let fixture = try await Self.cleanupProgressFixture() defer { try? FileManager.default.removeItem(at: fixture.root) } - let model = CleanupModel() + let model = CleanupModel(defaults: .mock) model.finishScan(fixture.result) let xcode = CleanupOperations.SimulatorXcode(developerDirectory: "/fixture/Xcode.app/Contents/Developer", name: "Fixture Xcode", selected: false) model.simulatorAssessment = .init(failedXcodes: [xcode])