mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-21 21:04:07 +00:00
Reserve one toolbar status area through saving, deployment, and collection refresh. Show counted transient success and persistent actionable failures, with distinct applied, unchanged-runtime, and deferred-save results. Keep cached rows when collection reload fails. Require explicit refresh and fresh selection after a version conflict. Validation: 774 hostless tests passed with local ad-hoc signing. Format, lint, two-axis review, and isolated Chinese/English view rendering checked.
202 lines
8.5 KiB
Swift
202 lines
8.5 KiB
Swift
import Combine
|
|
import XCTest
|
|
|
|
@testable import ShadowsocksX_NG2
|
|
|
|
@MainActor
|
|
final class RuleStatusWorkflowTests: XCTestCase {
|
|
func testSavedRulesWithFailedReloadKeepOldRowsAndRequireExplicitRefresh() async throws {
|
|
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
|
|
defer { try? FileManager.default.removeItem(at: directory) }
|
|
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
|
|
let rule = CustomRule(action: .proxy, match: .domainExact("example.net"))
|
|
try store.save([rule])
|
|
let reloadStarted = expectation(description: "failed reload")
|
|
let gate = RuleDocumentReloadGate(store: store, started: reloadStarted, failureOnReload: true)
|
|
let workflow = RulesWorkflow(
|
|
loadDocument: { try gate.load() },
|
|
commitDocument: { document in saveFixture(document, to: store, outcome: .applied) },
|
|
feedbackDelay: { XCTFail("An incomplete collection must not start the success timer") },
|
|
loadBuiltin: { rulesFixture($0) })
|
|
await workflow.refresh()
|
|
let rows = workflow.snapshot.rows
|
|
await workflow.setEnabled(false, identities: [rule.identity])
|
|
await fulfillment(of: [reloadStarted], timeout: 3)
|
|
XCTAssertEqual(workflow.snapshot.operationStatus, .collectionIncomplete)
|
|
XCTAssertEqual(workflow.snapshot.rows, rows)
|
|
XCTAssertFalse(workflow.snapshot.isComplete)
|
|
await workflow.refresh()
|
|
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
|
|
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
|
|
}
|
|
|
|
func testSuccessCountsOnlyActualChangesAndExpiresAfterCollectionUpdate() async throws {
|
|
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
|
|
defer { try? FileManager.default.removeItem(at: directory) }
|
|
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
|
|
let disabled = CustomRule(action: .proxy, match: .domainExact("disabled.example"))
|
|
let enabled = CustomRule(action: .proxy, match: .domainExact("enabled.example"))
|
|
try store.saveDocument(
|
|
CustomRuleDocument(rules: [disabled, enabled], disabledIdentities: [disabled.identity]))
|
|
let timerStarted = expectation(description: "success timer started")
|
|
let clock = RuleFeedbackClock(started: timerStarted)
|
|
let workflow = RulesWorkflow(
|
|
loadDocument: { try store.loadDocument() },
|
|
commitDocument: { document in
|
|
saveFixture(document, to: store, outcome: .applied)
|
|
},
|
|
feedbackDelay: { await clock.wait() },
|
|
loadBuiltin: { rulesFixture($0) })
|
|
await workflow.refresh()
|
|
let fixed = try XCTUnwrap(workflow.snapshot.rows.first { $0.isFixed }?.identity)
|
|
await workflow.setEnabled(true, identities: [disabled.identity, enabled.identity, fixed])
|
|
let feedback = try XCTUnwrap(workflow.snapshot.commitFeedback)
|
|
XCTAssertEqual(feedback.changedCount, 1)
|
|
XCTAssertTrue(feedback.enabled)
|
|
XCTAssertEqual(feedback.outcome, .applied)
|
|
XCTAssertTrue(workflow.snapshot.rows.first { $0.identity == disabled.identity }!.isEnabled)
|
|
await fulfillment(of: [timerStarted], timeout: 3)
|
|
let expired = expectation(description: "success dismissed")
|
|
let observation = workflow.$snapshot.filter { $0.commitFeedback == nil }.sink { _ in
|
|
expired.fulfill()
|
|
}
|
|
await clock.resume()
|
|
await fulfillment(of: [expired], timeout: 3)
|
|
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
|
|
withExtendedLifetime(observation) {}
|
|
}
|
|
|
|
func testCollectionRefreshRemainsOneBusyOperationAndAllowsBrowsing() async throws {
|
|
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
|
|
defer { try? FileManager.default.removeItem(at: directory) }
|
|
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
|
|
let rule = CustomRule(action: .proxy, match: .domainExact("example.net"))
|
|
try store.save([rule])
|
|
let reloadStarted = expectation(description: "collection reload paused")
|
|
let gate = RuleDocumentReloadGate(store: store, started: reloadStarted)
|
|
defer { gate.release.signal() }
|
|
let workflow = RulesWorkflow(
|
|
loadDocument: { try gate.load() },
|
|
commitDocument: { document in
|
|
saveFixture(document, to: store, outcome: .runtimeUnchanged)
|
|
},
|
|
loadBuiltin: { rulesFixture($0) })
|
|
await workflow.refresh()
|
|
let pending = Task { await workflow.setEnabled(false, identities: [rule.identity]) }
|
|
await fulfillment(of: [reloadStarted], timeout: 3)
|
|
XCTAssertTrue(workflow.snapshot.isLoading)
|
|
XCTAssertEqual(workflow.snapshot.operationStatus, .updating)
|
|
XCTAssertNil(workflow.snapshot.commitFeedback)
|
|
XCTAssertTrue(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
|
|
let query = RulesQuery(search: "example", source: .custom)
|
|
workflow.query(query)
|
|
let row = try XCTUnwrap(workflow.snapshot.rows.first)
|
|
workflow.select([row.id])
|
|
gate.release.signal()
|
|
await pending.value
|
|
XCTAssertEqual(workflow.snapshot.query, query)
|
|
XCTAssertEqual(workflow.snapshot.selection, [row.id])
|
|
XCTAssertFalse(workflow.snapshot.rows.first!.isEnabled)
|
|
XCTAssertEqual(workflow.snapshot.commitOutcome, .runtimeUnchanged)
|
|
}
|
|
|
|
func testOldSuccessTimerCannotDismissNewFailureAndClosingDoesNotChangeRules() async throws {
|
|
let directory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
|
|
defer { try? FileManager.default.removeItem(at: directory) }
|
|
let store = CustomRuleStore(fileURL: directory.appendingPathComponent("rules.json"))
|
|
let rule = CustomRule(action: .proxy, match: .domainExact("example.net"))
|
|
try store.save([rule])
|
|
let timerStarted = expectation(description: "success timer started")
|
|
let timerReturned = expectation(description: "old timer returned")
|
|
let clock = RuleFeedbackClock(started: timerStarted)
|
|
let commitState = RuleCommitState()
|
|
let workflow = RulesWorkflow(
|
|
loadDocument: { try store.loadDocument() },
|
|
commitDocument: { document in
|
|
commitState.outcome.isSuccess
|
|
? saveFixture(document, to: store, outcome: commitState.outcome) : commitState.outcome
|
|
},
|
|
feedbackDelay: {
|
|
await clock.wait()
|
|
timerReturned.fulfill()
|
|
},
|
|
loadBuiltin: { rulesFixture($0) })
|
|
await workflow.refresh()
|
|
await workflow.setEnabled(false, identities: [rule.identity])
|
|
await fulfillment(of: [timerStarted], timeout: 3)
|
|
commitState.outcome = .persistenceFailed
|
|
await workflow.setEnabled(true, identities: [rule.identity])
|
|
await clock.resume()
|
|
await fulfillment(of: [timerReturned], timeout: 3)
|
|
XCTAssertEqual(workflow.snapshot.commitOutcome, .persistenceFailed)
|
|
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
|
|
workflow.dismissFeedback()
|
|
XCTAssertEqual(workflow.snapshot.operationStatus, .idle)
|
|
XCTAssertFalse(workflow.snapshot.rows.first { $0.identity == rule.identity }!.isEnabled)
|
|
}
|
|
}
|
|
|
|
@MainActor
|
|
private final class RuleCommitState {
|
|
var outcome: CustomRuleUpdateOutcome = .saved
|
|
}
|
|
|
|
private actor RuleFeedbackClock {
|
|
let started: XCTestExpectation
|
|
private var continuation: CheckedContinuation<Void, Never>?
|
|
|
|
init(started: XCTestExpectation) { self.started = started }
|
|
|
|
func wait() async {
|
|
await withCheckedContinuation {
|
|
continuation = $0
|
|
started.fulfill()
|
|
}
|
|
}
|
|
|
|
func resume() {
|
|
continuation?.resume()
|
|
continuation = nil
|
|
}
|
|
}
|
|
|
|
private final class RuleDocumentReloadGate: @unchecked Sendable {
|
|
let store: CustomRuleStore
|
|
let started: XCTestExpectation
|
|
let release = DispatchSemaphore(value: 0)
|
|
private let lock = NSLock()
|
|
private var reads = 0
|
|
private let failureOnReload: Bool
|
|
|
|
init(store: CustomRuleStore, started: XCTestExpectation, failureOnReload: Bool = false) {
|
|
self.store = store
|
|
self.started = started
|
|
self.failureOnReload = failureOnReload
|
|
}
|
|
|
|
func load() throws -> CustomRuleDocument {
|
|
let shouldPause = lock.withLock {
|
|
reads += 1
|
|
return reads == 3
|
|
}
|
|
if shouldPause {
|
|
started.fulfill()
|
|
if failureOnReload { throw CocoaError(.fileReadCorruptFile) }
|
|
release.wait()
|
|
}
|
|
return try store.loadDocument()
|
|
}
|
|
}
|
|
|
|
private func saveFixture(
|
|
_ document: CustomRuleDocument, to store: CustomRuleStore, outcome: CustomRuleUpdateOutcome
|
|
) -> CustomRuleUpdateOutcome {
|
|
do {
|
|
try store.saveDocument(document)
|
|
return outcome
|
|
} catch {
|
|
XCTFail("Fixture save failed: \(error)")
|
|
return .persistenceFailed
|
|
}
|
|
}
|