Skip to content

[codex] Preserve app rule migration metadata #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ygsgdbd merged 1 commit into from
Jul 21, 2026
Merged

[codex] Preserve app rule migration metadata #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion TypeSwitch/Sources/Migrations/AppRulesStoreMigration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,18 @@ enum AppRulesStoreMigration {
legacyRules: [String: AppRuleRecord]
) -> [String: AppRuleRecord] {
currentRules.merging(legacyRules) { currentRule, legacyRule in
currentRule.strategy == .none ? legacyRule : currentRule
guard currentRule.strategy == .none else {
return currentRule
}

var recoveredRule = currentRule
if legacyRule.lastKnownPath != nil {
recoveredRule.lastKnownPath = legacyRule.lastKnownPath
recoveredRule.lastKnownName = legacyRule.lastKnownName
}
recoveredRule.strategy = legacyRule.strategy
recoveredRule.updatedAt = legacyRule.updatedAt
return recoveredRule
}
}
}
Expand Down
27 changes: 24 additions & 3 deletions TypeSwitchTests/AppFeatureTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1604,18 +1604,39 @@ final class AppFeatureTests: XCTestCase {
}

func testLegacyRulesLoadedSavesBeforeMarkingMigrationCompleted() async {
let currentDate = Date(timeIntervalSince1970: 100)
let migrationDate = Date(timeIntervalSince1970: 777)
let migrationTracker = MigrationTracker()
let legacyRule = AppRuleRecord(
let currentRule = AppRuleRecord(
bundleId: "com.test.notes",
lastKnownPath: "/Applications/Notes.app",
lastKnownName: "Notes",
strategy: .none,
createdAt: currentDate,
updatedAt: currentDate
)
let legacyRule = AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: nil,
lastKnownName: currentRule.bundleId,
strategy: .fixed(inputMethodId: "ime.zh"),
createdAt: migrationDate,
updatedAt: migrationDate
)
let expectedRule = AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: currentRule.lastKnownPath,
lastKnownName: currentRule.lastKnownName,
strategy: legacyRule.strategy,
createdAt: currentDate,
updatedAt: migrationDate
)
var initialState = makeMigrationTestState()
initialState.$appRulesStore.withLock {
$0.rules[currentRule.bundleId] = currentRule
}

let store = TestStore(initialState: makeMigrationTestState()) {
let store = TestStore(initialState: initialState) {
AppFeature()
}
store.dependencies.appRulesStoreMigrationClient.save = { _ in
Expand All @@ -1627,7 +1648,7 @@ final class AppFeatureTests: XCTestCase {

await store.send(.response(.legacyRulesLoaded([legacyRule.bundleId: legacyRule]))) {
$0.$appRulesStore.withLock {
$0.rules[legacyRule.bundleId] = legacyRule
$0.rules[legacyRule.bundleId] = expectedRule
}
}
await store.finish()
Expand Down
88 changes: 84 additions & 4 deletions TypeSwitchTests/AppRulesStoreMigrationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,10 @@ final class AppRulesStoreMigrationTests: XCTestCase {
))
}

func testMergeRestoresMissingAndNoneRulesWithoutOverwritingExplicitStrategies() {
func testMergeAddsMissingLegacyRulesWithoutOverwritingExplicitStrategies() {
let currentDate = Date(timeIntervalSince1970: 100)
let legacyDate = Date(timeIntervalSince1970: 200)
let currentRules = [
"none": makeRule(bundleId: "none", strategy: .none, date: currentDate),
"fixed": makeRule(bundleId: "fixed", strategy: .fixed(inputMethodId: "current.fixed"), date: currentDate),
"followLast": makeRule(
bundleId: "followLast",
Expand All @@ -168,7 +167,6 @@ final class AppRulesStoreMigrationTests: XCTestCase {
]
let legacyRules = [
"missing": makeRule(bundleId: "missing", strategy: .fixed(inputMethodId: "legacy.missing"), date: legacyDate),
"none": makeRule(bundleId: "none", strategy: .fixed(inputMethodId: "legacy.none"), date: legacyDate),
"fixed": makeRule(bundleId: "fixed", strategy: .fixed(inputMethodId: "legacy.fixed"), date: legacyDate),
"followLast": makeRule(bundleId: "followLast", strategy: .fixed(inputMethodId: "legacy.last"), date: legacyDate),
"ignored": makeRule(bundleId: "ignored", strategy: .fixed(inputMethodId: "legacy.ignored"), date: legacyDate),
Expand All @@ -180,12 +178,94 @@ final class AppRulesStoreMigrationTests: XCTestCase {
)

XCTAssertEqual(mergedRules["missing"], legacyRules["missing"])
XCTAssertEqual(mergedRules["none"], legacyRules["none"])
XCTAssertEqual(mergedRules["fixed"], currentRules["fixed"])
XCTAssertEqual(mergedRules["followLast"], currentRules["followLast"])
XCTAssertEqual(mergedRules["ignored"], currentRules["ignored"])
}

func testMergeRestoresNoneRuleUsingMatchedLegacyMetadata() {
let currentDate = Date(timeIntervalSince1970: 100)
let legacyDate = Date(timeIntervalSince1970: 200)
let currentRule = AppRuleRecord(
bundleId: "com.test.editor",
lastKnownPath: "/Applications/Old Editor.app",
lastKnownName: "Old Editor",
strategy: .none,
createdAt: currentDate,
updatedAt: currentDate
)
let legacyRule = AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: "/Applications/Editor.app",
lastKnownName: "Editor",
strategy: .fixed(inputMethodId: "legacy.fixed"),
createdAt: legacyDate,
updatedAt: legacyDate
)

let mergedRules = AppRulesStoreMigration.merge(
currentRules: [currentRule.bundleId: currentRule],
legacyRules: [legacyRule.bundleId: legacyRule]
)

XCTAssertEqual(
mergedRules[currentRule.bundleId],
AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: legacyRule.lastKnownPath,
lastKnownName: legacyRule.lastKnownName,
strategy: legacyRule.strategy,
createdAt: currentDate,
updatedAt: legacyDate
)
)
}

func testMergeRestoresNoneRuleWithoutDiscardingCurrentMetadataWhenLegacyAppIsUnmatched() throws {
let currentDate = Date(timeIntervalSince1970: 100)
let legacyDate = Date(timeIntervalSince1970: 200)
let appURL = FileManager.default.temporaryDirectory
.appending(path: "Editor-\(UUID().uuidString).app", directoryHint: .isDirectory)
try FileManager.default.createDirectory(at: appURL, withIntermediateDirectories: true)
defer { try? FileManager.default.removeItem(at: appURL) }

let currentRule = AppRuleRecord(
bundleId: "com.test.editor",
lastKnownPath: appURL.path,
lastKnownName: "Editor",
strategy: .none,
createdAt: currentDate,
updatedAt: currentDate
)
let legacyRule = AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: nil,
lastKnownName: currentRule.bundleId,
strategy: .fixed(inputMethodId: "legacy.fixed"),
createdAt: legacyDate,
updatedAt: legacyDate
)

let mergedRules = AppRulesStoreMigration.merge(
currentRules: [currentRule.bundleId: currentRule],
legacyRules: [legacyRule.bundleId: legacyRule]
)
let mergedRule = try XCTUnwrap(mergedRules[currentRule.bundleId])

XCTAssertEqual(
mergedRule,
AppRuleRecord(
bundleId: currentRule.bundleId,
lastKnownPath: currentRule.lastKnownPath,
lastKnownName: currentRule.lastKnownName,
strategy: legacyRule.strategy,
createdAt: currentDate,
updatedAt: legacyDate
)
)
XCTAssertTrue(mergedRule.isAvailable)
}

func testMergeIsIdempotent() {
let currentDate = Date(timeIntervalSince1970: 100)
let legacyDate = Date(timeIntervalSince1970: 200)
Expand Down
Loading