import ParcelCore import ParcelPlatform import Testing @testable import ParcelEngine @Suite @MainActor struct EngineFailureLogAggregationTests { @Test func firstRealWindowTimeoutIsImmediateWithoutScheduledWork() { let harness = FailureLogHarness() let failure = EnginePlatformFailure.accessibility(engineApp, window: WindowID(rawValue: 42), cause: .timedOut) harness.log.record(.platform(failure)) #expect(harness.output.messages == [line(failure, count: 1, total: 1)]) #expect(harness.scheduler.pendingCount == 0) #expect(harness.scheduler.scheduledCount == 0) } @Test func burstAcrossWindowsReportsExactCountsAtTheBoundaryAndThenGoesIdle() throws { let harness = FailureLogHarness() let first = EnginePlatformFailure.accessibility(engineApp, window: WindowID(rawValue: 1), cause: .timedOut) harness.log.record(.platform(first)) for id in UInt32(2)...10_000 { harness.log.record(.platform(.accessibility(engineApp, window: WindowID(rawValue: id), cause: .timedOut))) } #expect(harness.output.messages == [line(first, count: 1, total: 1)]) #expect(harness.scheduler.pendingCount == 1) #expect(harness.scheduler.scheduledCount == 1) try harness.scheduler.advance(by: 4) #expect(harness.output.messages.count == 1) try harness.scheduler.advance(by: 1) let last = EnginePlatformFailure.accessibility(engineApp, window: WindowID(rawValue: 10_000), cause: .timedOut) #expect(harness.output.messages.last == line(last, count: 9_999, total: 10_000)) #expect(harness.scheduler.pendingCount == 0) try harness.scheduler.advance(by: 100) #expect(harness.output.messages.count == 2) } @Test(arguments: windowFailureSamples) func windowIdentityDoesNotSplitAppCauseCounts(failures: [EnginePlatformFailure]) throws { let harness = FailureLogHarness() let first = try #require(failures.first) let last = try #require(failures.last) for failure in failures { harness.log.record(.platform(failure)) } #expect(harness.output.messages == [line(first, count: 1, total: 1)]) harness.log.flush() #expect(harness.output.messages == [line(first, count: 1, total: 1), line(last, count: 1, total: 2)]) #expect(harness.scheduler.pendingCount == 0) } @Test func appIdentityTypedCauseCodesNotificationsAndDetailsStayDistinct() throws { let harness = FailureLogHarness() let failures: [EnginePlatformFailure] = [ .accessibility(engineApp, window: nil, cause: .timedOut), .accessibility(secondEngineApp, window: nil, cause: .timedOut), .accessibility(AppID(pid: engineApp.pid, bundleID: "test.other"), window: nil, cause: .timedOut), .accessibility(engineApp, window: nil, cause: .other(-25202)), .accessibility(engineApp, window: nil, cause: .other(-25203)), .accessibility(engineApp, window: nil, cause: .unexpectedValue("first")), .accessibility(engineApp, window: nil, cause: .unexpectedValue("second")), .appThread(engineApp, cause: .accessibility(.timedOut)), .appThread(engineApp, cause: .observerRegistration(notification: "AXMoved", windowID: 1, code: -25202)), .appThread(engineApp, cause: .observerRegistration(notification: "AXResized", windowID: 1, code: -25202)), .appThread(engineApp, cause: .observerRegistration(notification: "AXMoved", windowID: 1, code: -25203)), .appThread(engineApp, cause: .observerRemoval(notification: "AXMoved", windowID: 1, code: -25202)), .appThread(engineApp, cause: .observerRegistrationExhausted(notifications: ["AXMoved"])), .appThread(engineApp, cause: .observerRegistrationExhausted(notifications: ["AXResized"])), .appThread(engineApp, cause: .windowFrame("first")), .appThread(engineApp, cause: .windowFrame("second")), .appUnavailable(engineApp), .operation(.activationRefused(engineApp)), .timedOut(engineApp), ] for failure in failures { harness.log.record(.platform(failure)) harness.log.record(.platform(failure)) } #expect(harness.output.messages == failures.map { line($0, count: 1, total: 1) }) #expect(harness.scheduler.pendingCount == 1) try harness.scheduler.advance(by: 5) #expect( harness.output.messages == failures.map { line($0, count: 1, total: 1) } + failures.map { line($0, count: 1, total: 2) }) #expect(harness.scheduler.pendingCount == 0) } @Test func diagnosticsWithoutAnAppCauseRemainUnthrottled() { let harness = FailureLogHarness() let diagnostics: [EngineDiagnostic] = [ .platform(.permissionLost), .platform(.vanished(WindowID(rawValue: 1))), .platform(.correctiveWriteLimit(WindowID(rawValue: 1), limit: 3)), .platform(.operation(.focusUnchanged(WindowID(rawValue: 1)))), .platform(.unexpected(EngineUnexpectedFailure(cause: HarnessError.startup))), .configuration("invalid configuration"), .internalFailure(HarnessError.startup), ] for diagnostic in diagnostics { harness.log.record(diagnostic) harness.log.record(diagnostic) } #expect( harness.output.messages == diagnostics.flatMap { [String(describing: $0), String(describing: $0)] }) #expect(harness.scheduler.pendingCount == 0) } @Test func flushIsIdempotentAndCumulativeCountsSurviveFurtherFailures() throws { let harness = FailureLogHarness() let failure = EnginePlatformFailure.timedOut(engineApp) harness.log.record(.platform(failure)) harness.log.record(.platform(failure)) harness.log.record(.platform(failure)) harness.log.flush() harness.log.flush() #expect(harness.output.messages == [line(failure, count: 1, total: 1), line(failure, count: 2, total: 3)]) #expect(harness.scheduler.pendingCount == 0) harness.log.record(.platform(failure)) #expect(harness.output.messages.count == 2) #expect(harness.scheduler.pendingCount == 1) harness.scheduler.fireCancelledWork() #expect(harness.output.messages.count == 2) #expect(harness.scheduler.pendingCount == 1) try harness.scheduler.advance(by: 5) #expect(harness.output.messages.last == line(failure, count: 1, total: 4)) harness.log.flush() #expect(harness.output.messages.count == 3) } @Test func anExpiredWindowIncludesTheNewFailureWithoutAnExtraSummary() throws { let harness = FailureLogHarness() let failure = EnginePlatformFailure.timedOut(engineApp) harness.log.record(.platform(failure)) harness.log.record(.platform(failure)) // Let record observe the deadline before the scheduled callback gets to run. harness.clock.now += 5 harness.log.record(.platform(failure)) #expect(harness.output.messages == [line(failure, count: 1, total: 1), line(failure, count: 2, total: 3)]) #expect(harness.scheduler.pendingCount == 0) try harness.scheduler.runReady() harness.scheduler.fireCancelledWork() #expect(harness.output.messages.count == 2) harness.log.record(.platform(failure)) #expect(harness.output.messages.count == 2) try harness.scheduler.advance(by: 5) #expect(harness.output.messages.last == line(failure, count: 1, total: 4)) } @Test func eachAppKeepsItsOwnDeadlineWithOneSharedWake() throws { let harness = FailureLogHarness() let first = EnginePlatformFailure.timedOut(engineApp) let second = EnginePlatformFailure.timedOut(secondEngineApp) harness.log.record(.platform(first)) harness.log.record(.platform(first)) try harness.scheduler.advance(by: 2) harness.log.record(.platform(second)) harness.log.record(.platform(second)) #expect(harness.scheduler.pendingCount == 1) #expect(harness.scheduler.nextDeadline == 15) try harness.scheduler.advance(by: 3) #expect(harness.output.messages.last == line(first, count: 1, total: 2)) #expect(harness.scheduler.nextDeadline == 17) #expect(harness.scheduler.pendingCount == 1) try harness.scheduler.advance(by: 2) #expect(harness.output.messages.last == line(second, count: 1, total: 2)) #expect(harness.scheduler.pendingCount == 0) } @Test func exactTotalsAreInspectableEvenBeforePendingRepetitionsAreLogged() { let harness = FailureLogHarness() let aggregation = EngineFailureLogAggregation( clock: harness.clock, scheduler: harness.scheduler, interval: 5, output: { _ in }) let first = EnginePlatformFailure.accessibility(engineApp, window: nil, cause: .timedOut) let second = EnginePlatformFailure.accessibility(engineApp, window: WindowID(rawValue: 2), cause: .timedOut) #expect(aggregation.totalCount(for: first) == nil) aggregation.record(.platform(first)) aggregation.record(.platform(second)) #expect(aggregation.totalCount(for: first) == 2) #expect(aggregation.totalCount(for: second) == 2) aggregation.flush() #expect(aggregation.totalCount(for: first) == 2) #expect(aggregation.totalCount(for: .permissionLost) == nil) } @Test func evictionBoundsRetainedCausesAndFlushesTheLeastRecentlyFailedCause() { let harness = FailureLogHarness() let aggregation = EngineFailureLogAggregation( clock: harness.clock, scheduler: harness.scheduler, interval: 5, maximumCauses: 2, output: { harness.output.messages.append($0) }) let first = EnginePlatformFailure.timedOut(engineApp) let second = EnginePlatformFailure.timedOut(secondEngineApp) let third = EnginePlatformFailure.appUnavailable(engineApp) aggregation.record(.platform(first)) aggregation.record(.platform(second)) aggregation.record(.platform(second)) aggregation.record(.platform(first)) aggregation.record(.platform(third)) #expect(aggregation.totalCount(for: first) == 2) #expect(aggregation.totalCount(for: second) == nil) #expect(aggregation.totalCount(for: third) == 1) #expect( harness.output.messages == [ line(first, count: 1, total: 1), line(second, count: 1, total: 1), line(second, count: 1, total: 2), line(third, count: 1, total: 1), ]) aggregation.record(.platform(second)) #expect(aggregation.totalCount(for: first) == nil) #expect(aggregation.totalCount(for: second) == 1) #expect( harness.output.messages.suffix(2) == [line(first, count: 1, total: 2), line(second, count: 1, total: 1)]) #expect(harness.scheduler.pendingCount == 0) } @Test func forgettingAnAppFlushesOnlyItsPendingCausesAndResetsReusedIdentity() throws { let harness = FailureLogHarness() let first = EnginePlatformFailure.timedOut(engineApp) let second = EnginePlatformFailure.appUnavailable(engineApp) let other = EnginePlatformFailure.timedOut(secondEngineApp) for failure in [first, second, other] { harness.log.record(.platform(failure)) harness.log.record(.platform(failure)) } harness.log.forgetFailures(for: engineApp) harness.log.forgetFailures(for: engineApp) #expect( harness.output.messages == [ line(first, count: 1, total: 1), line(second, count: 1, total: 1), line(other, count: 1, total: 1), line(first, count: 1, total: 2), line(second, count: 1, total: 2), ]) #expect(harness.scheduler.pendingCount == 1) harness.log.record(.platform(first)) #expect(harness.output.messages.last == line(first, count: 1, total: 1)) try harness.scheduler.advance(by: 5) #expect(harness.output.messages.last == line(other, count: 1, total: 2)) #expect(harness.scheduler.pendingCount == 0) } @Test func engineStopFlushesPendingFailuresEvenWhileTheLogIsRetained() async throws { let harness = FailureLogHarness() let world = FakeEngineWorld(clock: harness.clock) let links = FakeEngineLinks() let engine = try ParcelEngine( world: world, clock: harness.clock, scheduler: harness.scheduler, displayLink: { try links.make($0) }, announcer: FakeEngineAnnouncer(), log: harness.log, configuration: engineConfiguration(), initialState: engineInitialState(), trace: nil, reduceMotionSource: nil) try await engine.start() try harness.scheduler.runReady() let failure = EnginePlatformFailure.accessibility(engineApp, window: WindowID(rawValue: 42), cause: .timedOut) world.emit(.failure(failure)) world.emit(.failure(failure)) #expect(harness.output.messages == [line(failure, count: 1, total: 1)]) await engine.stop() #expect(harness.output.messages == [line(failure, count: 1, total: 1), line(failure, count: 1, total: 2)]) #expect(harness.scheduler.pendingCount == 0) harness.scheduler.fireCancelledWork() #expect(harness.output.messages.count == 2) } @Test func engineAppExitFlushesFailuresBeforeTheSamePIDIsReused() async throws { let harness = FailureLogHarness() let world = FakeEngineWorld(clock: harness.clock) let links = FakeEngineLinks() let engine = try ParcelEngine( world: world, clock: harness.clock, scheduler: harness.scheduler, displayLink: { try links.make($0) }, announcer: FakeEngineAnnouncer(), log: harness.log, configuration: engineConfiguration(), initialState: engineInitialState(), trace: nil, reduceMotionSource: nil) try await engine.start() try harness.scheduler.runReady() let failure = EnginePlatformFailure.appUnavailable(engineApp) world.emit(.failure(failure)) #expect(engine.unmanageableApps.contains(engineApp)) world.emit(.appAvailable(engineApp)) #expect(!engine.unmanageableApps.contains(engineApp)) world.emit(.failure(failure)) #expect(engine.unmanageableApps.contains(engineApp)) #expect(harness.output.messages == [line(failure, count: 1, total: 1)]) world.emit(.appExited(engineApp)) #expect(!engine.unmanageableApps.contains(engineApp)) world.emit(.appLaunched(engineApp, at: harness.clock.now)) world.emit(.failure(failure)) #expect(engine.unmanageableApps.contains(engineApp)) #expect( harness.output.messages == [ line(failure, count: 1, total: 1), line(failure, count: 1, total: 2), line(failure, count: 1, total: 1), ]) await engine.stop() #expect(harness.scheduler.pendingCount == 0) } @Test func releasingTheLogFlushesPendingCountsAndCancelsItsWake() { let clock = ManualEngineClock() let scheduler = ManualEngineScheduler(clock: clock) let output = FailureLogOutput() var log: SystemEngineLog? = SystemEngineLog(clock: clock, scheduler: scheduler) { output.messages.append($0) } let failure = EnginePlatformFailure.timedOut(engineApp) log?.record(.platform(failure)) log?.record(.platform(failure)) weak let releasedLog = log log = nil #expect(releasedLog == nil) #expect(output.messages == [line(failure, count: 1, total: 1), line(failure, count: 1, total: 2)]) #expect(scheduler.pendingCount == 0) scheduler.fireCancelledWork() #expect(output.messages.count == 2) } private func line(_ failure: EnginePlatformFailure, count: UInt64, total: UInt64) -> String { "\(String(describing: EngineDiagnostic.platform(failure))) [count=\(count) total=\(total)]" } } private let windowFailureSamples: [[EnginePlatformFailure]] = [ [ .accessibility(engineApp, window: nil, cause: .timedOut), .accessibility(engineApp, window: WindowID(rawValue: 2), cause: .timedOut), ], [ .appThread(engineApp, cause: .observerRegistration(notification: "AXMoved", windowID: nil, code: -25202)), .appThread(engineApp, cause: .observerRegistration(notification: "AXMoved", windowID: 2, code: -25202)), ], [ .appThread(engineApp, cause: .observerRemoval(notification: "AXMoved", windowID: 1, code: -25202)), .appThread(engineApp, cause: .observerRemoval(notification: "AXMoved", windowID: 2, code: -25202)), ], [ .appThread(engineApp, cause: .windowNotFound(1)), .appThread(engineApp, cause: .windowNotFound(2)), ], ] @MainActor private final class FailureLogOutput { var messages: [String] = [] } @MainActor private struct FailureLogHarness { let clock: ManualEngineClock let scheduler: ManualEngineScheduler let output: FailureLogOutput let log: SystemEngineLog init() { let clock = ManualEngineClock() let scheduler = ManualEngineScheduler(clock: clock) let output = FailureLogOutput() self.clock = clock self.scheduler = scheduler self.output = output log = SystemEngineLog(clock: clock, scheduler: scheduler) { output.messages.append($0) } } }