Skip to content

Preserve user-hidden status item defaults #1

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

Open
hhh2210 wants to merge 1 commit into
base: fix/repeat-status-item-defaults-repair
Choose a base branch
from
Open

Preserve user-hidden status item defaults #1

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
8 changes: 5 additions & 3 deletions Sources/CodexBar/MenuBarStatusItemDefaultsRepair.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ enum MenuBarStatusItemDefaultsRepair {
private static let legacyAutosavePrefix = "codexbar-"

static func repairHiddenVisibilityDefaultsIfNeeded(defaults: UserDefaults) -> [String] {
let didRepair = defaults.bool(forKey: self.didRepairKey)
let repairedKeys = defaults.dictionaryRepresentation().keys
.filter { key in
self.shouldRepair(key: key, value: defaults.object(forKey: key))
self.shouldRepair(key: key, value: defaults.object(forKey: key), didRepair: didRepair)
}
.sorted()

Expand All @@ -21,10 +22,11 @@ enum MenuBarStatusItemDefaultsRepair {
return repairedKeys
}

static func shouldRepair(key: String, value: Any?) -> Bool {
static func shouldRepair(key: String, value: Any?, didRepair: Bool = false) -> Bool {
guard key.hasPrefix(self.visibilityPrefix), self.isFalse(value) else { return false }
let itemName = String(key.dropFirst(self.visibilityPrefix.count))
return itemName.hasPrefix(self.legacyAutosavePrefix) || self.isDefaultStatusItemName(itemName)
if self.isDefaultStatusItemName(itemName) { return true }
return !didRepair && itemName.hasPrefix(self.legacyAutosavePrefix)
}
Comment on lines +25 to 30

private static func isDefaultStatusItemName(_ itemName: String) -> Bool {
Expand Down
16 changes: 13 additions & 3 deletions Tests/CodexBarTests/StatusItemControllerSplitLifecycleTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ struct StatusItemControllerSplitLifecycleTests {
}

@Test
func `status item defaults repair removes stale hidden Control Center keys repeatedly`() throws {
func `status item defaults repair removes stale hidden Control Center keys during migration`() throws {
let suite = "StatusItemControllerSplitLifecycleTests-repair-repeated-\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
defaults.removePersistentDomain(forName: suite)
Expand All @@ -351,16 +351,26 @@ struct StatusItemControllerSplitLifecycleTests {
#expect(defaults.object(forKey: "NSStatusItem VisibleCC Item-12") == nil)
#expect(defaults.object(forKey: "NSStatusItem VisibleCC codexbar-merged") == nil)
#expect(defaults.bool(forKey: MenuBarStatusItemDefaultsRepair.didRepairKey))
}

@Test
func `status item defaults repair repeats default item cleanup without overriding later user hides`() throws {
let suite = "StatusItemControllerSplitLifecycleTests-repair-repeat-default-\(UUID().uuidString)"
let defaults = try #require(UserDefaults(suiteName: suite))
defaults.removePersistentDomain(forName: suite)
defaults.set(true, forKey: MenuBarStatusItemDefaultsRepair.didRepairKey)
defer {
defaults.removePersistentDomain(forName: suite)
}

defaults.set(false, forKey: "NSStatusItem VisibleCC Item-2")
defaults.set(false, forKey: "NSStatusItem VisibleCC codexbar-codex")

#expect(MenuBarStatusItemDefaultsRepair.repairHiddenVisibilityDefaultsIfNeeded(defaults: defaults) == [
"NSStatusItem VisibleCC Item-2",
"NSStatusItem VisibleCC codexbar-codex",
])
#expect(defaults.object(forKey: "NSStatusItem VisibleCC Item-2") == nil)
#expect(defaults.object(forKey: "NSStatusItem VisibleCC codexbar-codex") == nil)
#expect(defaults.object(forKey: "NSStatusItem VisibleCC codexbar-codex") != nil)
Comment on lines 366 to +373
}

@Test
Expand Down