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

Jump to bottom

[#147] Crash Fix for Optionals in UserDefaultsStore #151

Merged
merged 4 commits into from
May 13, 2024
Merged

[#147] Crash Fix for Optionals in UserDefaultsStore #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c34006f
Enabled Throwing in `setValueSync(_:for:)`
yakovmanshin May 13, 2024
f248add
`UserDefaultsStore.Error`
yakovmanshin May 13, 2024
c83fda1
Updated Tests
yakovmanshin May 13, 2024
860e6b8
Updated `UserDefaultsStore`
yakovmanshin May 13, 2024
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
20 changes: 19 additions & 1 deletion Sources/YMFF/FeatureFlagResolver/Store/UserDefaultsStore.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,20 @@ final public class UserDefaultsStore {
extension UserDefaultsStore: SynchronousMutableFeatureFlagStore {

public func valueSync<Value>(for key: FeatureFlagKey) -> Result<Value, FeatureFlagStoreError> {
guard !(Value.self is ExpressibleByNilLiteral.Type) else {
return .failure(.otherError(Error.optionalValuesAreNotSupported))
}

guard let anyValue = userDefaults.object(forKey: key) else { return .failure(.valueNotFound) }
guard let value = anyValue as? Value else { return .failure(.typeMismatch) }
return .success(value)
}

public func setValueSync<Value>(_ value: Value, for key: FeatureFlagKey) {
public func setValueSync<Value>(_ value: Value, for key: FeatureFlagKey) throws {
guard !(value is ExpressibleByNilLiteral) else {
throw FeatureFlagStoreError.otherError(Error.optionalValuesAreNotSupported)
}

userDefaults.set(value, forKey: key)
}

Expand All @@ -54,4 +62,14 @@ extension UserDefaultsStore: SynchronousMutableFeatureFlagStore {

}

// MARK: - Error

extension UserDefaultsStore {

enum Error: Swift.Error {
case optionalValuesAreNotSupported
}

}

#endif
102 changes: 99 additions & 3 deletions Tests/YMFFTests/Cases/UserDefaultsStoreTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,52 @@ final class UserDefaultsStoreTests: XCTestCase {
}
}

func test_value_optionals() async {
userDefaults.set("TEST_value1", forKey: "TEST_key1")
// No record for TEST_key2

do {
let _: String? = try await store.value(for: "TEST_key1").get()
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key1"), "TEST_value1")
} catch {
XCTFail("Unexpected error: \(error)")
}

do {
let _: String? = try await store.value(for: "TEST_key2").get()
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertNil(userDefaults.string(forKey: "TEST_key2"))
} catch {
XCTFail("Unexpected error: \(error)")
}
}

func test_valueSync_optionals() {
userDefaults.set("TEST_value1", forKey: "TEST_key1")
// No record for TEST_key2

do {
let _: String? = try store.valueSync(for: "TEST_key1").get()
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key1"), "TEST_value1")
} catch {
XCTFail("Unexpected error: \(error)")
}

do {
let _: String? = try store.valueSync(for: "TEST_key2").get()
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertNil(userDefaults.string(forKey: "TEST_key2"))
} catch {
XCTFail("Unexpected error: \(error)")
}
}

func test_setValue() async throws {
userDefaults.set("TEST_value1", forKey: "TEST_key1")

Expand All @@ -91,16 +137,66 @@ final class UserDefaultsStoreTests: XCTestCase {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key2"), "TEST_newValue2")
}

func test_setValueSync() {
func test_setValueSync() throws {
userDefaults.set("TEST_value1", forKey: "TEST_key1")

store.setValueSync("TEST_newValue1", for: "TEST_key1")
store.setValueSync("TEST_newValue2", for: "TEST_key2")
try store.setValueSync("TEST_newValue1", for: "TEST_key1")
try store.setValueSync("TEST_newValue2", for: "TEST_key2")

XCTAssertEqual(userDefaults.string(forKey: "TEST_key1"), "TEST_newValue1")
XCTAssertEqual(userDefaults.string(forKey: "TEST_key2"), "TEST_newValue2")
}

func test_setValue_optionals() async {
userDefaults.set("TEST_value1", forKey: "TEST_key1")
userDefaults.set("TEST_value2", forKey: "TEST_key2")

do {
let optionalValue1: String? = "TEST_newValue1"
try await store.setValue(optionalValue1, for: "TEST_key1")
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key1"), "TEST_value1")
} catch {
XCTFail("Unexpected error: \(error)")
}

do {
let optionalValue2: String? = nil
try await store.setValue(optionalValue2, for: "TEST_key2")
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key2"), "TEST_value2")
} catch {
XCTFail("Unexpected error: \(error)")
}
}

func test_setValueSync_optionals() {
userDefaults.set("TEST_value1", forKey: "TEST_key1")
userDefaults.set("TEST_value2", forKey: "TEST_key2")

do {
let optionalValue1: String? = "TEST_newValue1"
try store.setValueSync(optionalValue1, for: "TEST_key1")
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key1"), "TEST_value1")
} catch {
XCTFail("Unexpected error: \(error)")
}

do {
let optionalValue2: String? = nil
try store.setValueSync(optionalValue2, for: "TEST_key2")
XCTFail("Expected an error")
} catch FeatureFlagStoreError.otherError(UserDefaultsStore.Error.optionalValuesAreNotSupported) {
XCTAssertEqual(userDefaults.string(forKey: "TEST_key2"), "TEST_value2")
} catch {
XCTFail("Unexpected error: \(error)")
}
}

func test_removeValue() async throws {
userDefaults.set("TEST_value1", forKey: "TEST_key1")
userDefaults.set("TEST_value2", forKey: "TEST_key2")
Expand Down
Loading