Files
ShadowsocksX-NG/ShadowsocksX-NG2/Domain/Credentials/CredentialWriteJournal.swift
T
Qiu Yuzhou 856d6b4272 refactor(domain): 按主题重组 Domain/ 源码目录
Domain/ 根目录原有 62 个平铺源文件,无法从目录读出主题划分。

按「目录即主题」重组为 11 个目录(Rules/Custom 为嵌套子目录):Catalog /
Subscription / Rules / Runtime / Activation / Settings / SystemProxy /
Plugin / Credentials / LegacyImport / Diagnostics。纯移动:类型名、模块名
与 import 均未改动,Domain/ 根下不再有散落文件。目录口径取自
GLOSSARY.md 的章节划分(配置与订阅、代理规则、代理控制与网络、设置、
凭据与诊断),而非新造分类。

配套改动:

- project.yml:wrapper 与 helper 两个 target 按文件引用的 15 条显式路径
  随目录改名,并补注释固定这一约定——这 15 条指向不存在的文件时,
  xcodegen generate 以 "missing source directory" 直接失败(实测,不静默)。
- SkeletonTests 新增 DomainLayoutTests:断言 Domain/ 根下无平铺 .swift、
  树下只有 .swift。后者防的是与 App/ 同源的坑——Domain/ 整目录是 app 与
  Core 的 source path,任何非源码文件都会被 XcodeGen 收进 Resources 阶段
  并封进签名后的 bundle。
- README 工程结构说明同步;docs/design 与 docs/research 属历史文档不改。

验证:xcodegen generate 后 app 164 / Core 163 源文件数与整理前一致;Agent
恰好 9 个、Helper 恰好 6 个 Domain 文件(无缺失无多出);app 与 Core 各覆盖
全部 62 个。clean build 0 error;task test 1024 用例全通过(整理前 1022,
+2 为新增守卫);task format 未改写任何被移动文件(证明纯移动);task lint
与整理前同为 21 条内容型 warning;packaging-gate.sh ALL CHECKS PASSED。

布局守卫已做变异验证:临时投放松散 .swift 与非 .swift 文件时两个用例均
失败并点名违规文件,清理后复验为绿。
2026-10-05 20:13:35 +08:00

86 lines
3.2 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import Foundation
/// 凭据回滚的结构化结果:回滚是尽力恢复,存储失败不二次上抛,残局经此
/// 显式报出。纯数据、不含用户可见文案(文案归 presentation edge)。
enum CredentialRollbackOutcome: Equatable, Sendable {
/// 本次未触碰任何凭据引用,无需恢复。
case nothingToRestore
/// 全部触碰过的引用恢复成功(集合非空)。
case restored(Set<CredentialReference>)
/// 尽力恢复后的残局:旧值继续生效的不变量被存储失败违例,未能恢复的
/// 引用点名在 `failed`。
case partial(restored: Set<CredentialReference>, failed: Set<CredentialReference>)
}
/// 凭据写入日志:目录文件只有在全部凭据写入成功后才替换;如果任何凭据或
/// 目录写入失败,则恢复改动前的每个引用值,避免旧秘密被覆盖或丢失
/// (story 13/29)。
///
/// 回滚是 best-effort:单个引用恢复失败不中断其余引用,残局经
/// `CredentialRollbackOutcome` 报出。写入期 `delete` 同样尽力而为——删除
/// 失败留下的孤儿秘密不属本 module 的回滚语义(known limitation)。
struct CredentialWriteJournal {
private struct OriginalValue {
let secret: String?
}
let credentials: CredentialStoring
private var originals: [CredentialReference: OriginalValue] = [:]
init(credentials: CredentialStoring) {
self.credentials = credentials
}
mutating func save(_ secret: String, for reference: CredentialReference) throws {
if originals[reference] == nil {
originals[reference] = OriginalValue(secret: try credentials.secret(for: reference))
}
try credentials.save(secret, for: reference)
}
/// 尽力删除(幂等);回滚时恢复改动前的原值或「不存在」。
mutating func delete(_ reference: CredentialReference) {
try? deleteOrThrow(reference)
}
/// 事务调用方需要知道删除是否成功;保留 `delete` 的既有尽力而为语义
/// 给目录工作流使用。
mutating func deleteOrThrow(_ reference: CredentialReference) throws {
if originals[reference] == nil {
originals[reference] = OriginalValue(secret: try credentials.secret(for: reference))
}
try credentials.delete(reference)
}
/// 恢复全部触碰过的引用到改动前的值(尽力),返回逐引用结果。
func rollback() -> CredentialRollbackOutcome {
guard !originals.isEmpty else { return .nothingToRestore }
var restored: Set<CredentialReference> = []
var failed: Set<CredentialReference> = []
for (reference, original) in originals {
let didRestore: Bool
if let secret = original.secret {
do {
try credentials.save(secret, for: reference)
didRestore = true
} catch {
didRestore = false
}
} else {
do {
try credentials.delete(reference)
didRestore = true
} catch {
didRestore = false
}
}
if didRestore {
restored.insert(reference)
} else {
failed.insert(reference)
}
}
return failed.isEmpty ? .restored(restored) : .partial(restored: restored, failed: failed)
}
}