Skip to content
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

Deprecate storing user data in UserDefaults #574

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Deprecate storing user data in UserDefaults #574

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
104 changes: 39 additions & 65 deletions BeeKit/Managers/CurrentUserManager.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,13 @@ public actor CurrentUserManager {

init(requestManager: RequestManager, container: BeeminderPersistentContainer) {
self.requestManager = requestManager
modelContainer = container
self.modelContainer = container
let context = container.newBackgroundContext()
context.name = "CurrentUserManager"
modelExecutor = .init(context: context)
self.modelExecutor = .init(context: context)

migrateValuesToCoreData()
cleanUpUserDefaults()
}

// If there is an existing session based on UserDefaults, create a new User object
Expand All @@ -69,7 +71,6 @@ public actor CurrentUserManager {
return
}


// Create a new user
let _ = User(context: context,
username: userDefaults.object(forKey: CurrentUserManager.usernameKey) as! String,
Expand All @@ -82,6 +83,14 @@ public actor CurrentUserManager {
try! context.save()
}

private nonisolated func cleanUpUserDefaults() {
for key in CurrentUserManager.allKeys {
userDefaults.removeObject(forKey: key)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though this removes not just elements of user but also the access token; not sure if that was intended

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not strictly intended but I think fine - the access token should be stored in the keychain now.

}
}


// MARK: - User Management

public nonisolated func user(context: NSManagedObjectContext) -> User? {
do {
Expand All @@ -94,11 +103,27 @@ public actor CurrentUserManager {
}
}

private func modifyUser(_ callback: (User)->()) throws {
public nonisolated func isDeadbeat(context: NSManagedObjectContext) -> Bool {
return user(context: context)?.deadbeat ?? false
}

public var username: String? {
return user(context: modelContext)?.username
}

public func refreshUser() async throws {
let response = try await requestManager.get(url: "api/v1/users/\(username!).json", parameters: [:])
let responseJSON = JSON(response!)

guard let user = self.user(context: modelContext) else { return }
modelContext.refresh(user, mergeChanges: false)
callback(user)
user.updateToMatch(json: responseJSON)
try modelContext.save()

await Task { @MainActor in
guard let user = self.user(context: modelContainer.viewContext) else { return }
modelContainer.viewContext.refresh(user, mergeChanges: false)
}.value
}

private func deleteUser() throws {
Expand All @@ -110,38 +135,22 @@ public actor CurrentUserManager {
try modelContext.save()
}

/// Write a value to the UserDefaults store
///
/// During migration to the appGroup shared store we still want to support users downgrading
/// to prior versions, and thus write all values to both stores.
func set(_ value: Any, forKey key: String) {
userDefaults.set(value, forKey: key)
}

func removeObject(forKey key: String) {
userDefaults.removeObject(forKey: key)
}
// MARK: - Keychain Management

public nonisolated var accessToken :String? {
return keychain.get(CurrentUserManager.accessTokenKey)
nonisolated func setAccessToken(_ accessToken: String) {
keychain.set(accessToken, forKey: CurrentUserManager.accessTokenKey, withAccess: .accessibleAfterFirstUnlock)
}

public var username :String? {
return user(context: modelContext)?.username
public nonisolated var accessToken: String? {
return keychain.get(CurrentUserManager.accessTokenKey)
}

// MARK: - Authentication

public nonisolated func signedIn(context: NSManagedObjectContext) -> Bool {
return self.accessToken != nil && self.user(context: context)?.username != nil
}

public nonisolated func isDeadbeat(context: NSManagedObjectContext) -> Bool {
return user(context: context)?.deadbeat ?? false
}

nonisolated func setAccessToken(_ accessToken: String) {
keychain.set(accessToken, forKey: CurrentUserManager.accessTokenKey, withAccess: .accessibleAfterFirstUnlock)
}

public func signInWithEmail(_ email: String, password: String) async {
do {
let response = try await requestManager.post(url: "api/private/sign_in", parameters: ["user": ["login": email, "password": password], "beemios_secret": self.beemiosSecret] as Dictionary<String, Any>)
Expand All @@ -157,42 +166,13 @@ public actor CurrentUserManager {
let _ = User(context: modelContext, json: responseJSON)
try modelContext.save()

if responseJSON["deadbeat"].boolValue {
self.set(true, forKey: CurrentUserManager.deadbeatKey)
} else {
self.removeObject(forKey: CurrentUserManager.deadbeatKey)
}
self.setAccessToken(responseJSON[CurrentUserManager.accessTokenKey].string!)
self.set(responseJSON[CurrentUserManager.usernameKey].string!, forKey: CurrentUserManager.usernameKey)
self.set(responseJSON[CurrentUserManager.defaultAlertstartKey].number!, forKey: CurrentUserManager.defaultAlertstartKey)
self.set(responseJSON[CurrentUserManager.defaultDeadlineKey].number!, forKey: CurrentUserManager.defaultDeadlineKey)
self.set(responseJSON[CurrentUserManager.defaultLeadtimeKey].number!, forKey: CurrentUserManager.defaultLeadtimeKey)
self.set(responseJSON[CurrentUserManager.beemTZKey].string!, forKey: CurrentUserManager.beemTZKey)

await Task { @MainActor in
NotificationCenter.default.post(name: Notification.Name(rawValue: CurrentUserManager.signedInNotificationName), object: self)
}.value
}

public func refreshUser() async throws {
let response = try await requestManager.get(url: "api/v1/users/\(username!).json", parameters: [:])
let responseJSON = JSON(response!)

try! modifyUser { user in
user.updateToMatch(json: responseJSON)
}

self.set(responseJSON[CurrentUserManager.usernameKey].string!, forKey: CurrentUserManager.usernameKey)
self.set(responseJSON[CurrentUserManager.defaultAlertstartKey].number!, forKey: CurrentUserManager.defaultAlertstartKey)
self.set(responseJSON[CurrentUserManager.defaultDeadlineKey].number!, forKey: CurrentUserManager.defaultDeadlineKey)
self.set(responseJSON[CurrentUserManager.defaultLeadtimeKey].number!, forKey: CurrentUserManager.defaultLeadtimeKey)
self.set(responseJSON[CurrentUserManager.beemTZKey].string!, forKey: CurrentUserManager.beemTZKey)

await Task { @MainActor in
guard let user = self.user(context: modelContainer.viewContext) else { return }
modelContainer.viewContext.refresh(user, mergeChanges: false)
}.value
}

func handleFailedSignin(_ responseError: Error, errorMessage : String?) async throws {
await Task { @MainActor in
NotificationCenter.default.post(name: Notification.Name(rawValue: CurrentUserManager.failedSignInNotificationName), object: self, userInfo: ["error" : responseError])
Expand All @@ -208,15 +188,9 @@ public actor CurrentUserManager {
try deleteUser()

keychain.delete(CurrentUserManager.accessTokenKey)
self.removeObject(forKey: CurrentUserManager.deadbeatKey)
self.removeObject(forKey: CurrentUserManager.usernameKey)

await Task { @MainActor in
NotificationCenter.default.post(name: Notification.Name(rawValue: CurrentUserManager.signedOutNotificationName), object: self)
}.value
}
}

public enum CurrentUserManagerError : Error {
case loggedOut
}
}
Loading