Skip to content

feat: new reason values #100

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat: new reason values #100

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
75aaf57
feat: add new reason values
duyhungtnn Feb 10, 2025
ca7f6a6
feat: prepare for using new reason values
duyhungtnn Feb 12, 2025
c2363d2
test: update test for new Reason values
duyhungtnn Feb 13, 2025
cacafe5
test: add test to check if we could handle new values
duyhungtnn Feb 13, 2025
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
10 changes: 10 additions & 0 deletions Bucketeer/Sources/Internal/Model/ReasonType.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ enum ReasonType: String, Codable, Hashable {
case target = "TARGET"
case rule = "RULE"
case `default` = "DEFAULT"

@available(*, deprecated, message: "ReasonType `client` has been deprecated")
case client = "CLIENT"

case offVariation = "OFF_VARIATION"
case prerequisite = "PREREQUISITE"

case errorNoEvaluations = "ERROR_NO_EVALUATIONS"
case errorFlagNotFound = "ERROR_FLAG_NOT_FOUND"
case errorWrongType = "ERROR_WRONG_TYPE"
case errorUserIdNotSpecified = "ERROR_USER_ID_NOT_SPECIFIED"
case errorFeatureFlagIdNotSpecified = "ERROR_FEATURE_FLAG_ID_NOT_SPECIFIED"
case errorException = "ERROR_EXCEPTION"
}
20 changes: 17 additions & 3 deletions Bucketeer/Sources/Public/BKTEvaluationDetails.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,21 @@ public struct BKTEvaluationDetails<T:Equatable>: Equatable {
case target = "TARGET"
case rule = "RULE"
case `default` = "DEFAULT"
@available(*, deprecated, message: "ReasonType `client` has been deprecated")
case client = "CLIENT"

case offVariation = "OFF_VARIATION"
case prerequisite = "PREREQUISITE"

case errorNoEvaluations = "ERROR_NO_EVALUATIONS"
case errorFlagNotFound = "ERROR_FLAG_NOT_FOUND"
case errorWrongType = "ERROR_WRONG_TYPE"
case errorUserIdNotSpecified = "ERROR_USER_ID_NOT_SPECIFIED"
case errorFeatureFlagIdNotSpecified = "ERROR_FEATURE_FLAG_ID_NOT_SPECIFIED"
case errorException = "ERROR_EXCEPTION"

public static func fromString(value: String) -> Reason {
return Reason(rawValue: value) ?? .client
return Reason(rawValue: value) ?? .errorException
}
}

Expand All @@ -32,15 +41,20 @@ public struct BKTEvaluationDetails<T:Equatable>: Equatable {
lhs.variationValue == rhs.variationValue
}

static func newDefaultInstance(featureId: String, userId: String, defaultValue: T) -> BKTEvaluationDetails<T> {
static func newDefaultInstance(
featureId: String,
userId: String,
defaultValue: T,
reason: Reason? = nil
) -> BKTEvaluationDetails<T> {
return BKTEvaluationDetails(
featureId: featureId,
featureVersion: 0,
userId: userId,
variationId: "",
variationName: "",
variationValue: defaultValue,
reason: .client
reason: reason ?? .client
)
}

Expand Down
27 changes: 27 additions & 0 deletions BucketeerTests/ApiResponseTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import XCTest
@testable import Bucketeer

class ReasonTypeDecodingTests: XCTestCase {
func testDecodeValidAndInvalidReasonType() throws {
let json = """
[
"TARGET",
"RULE",
"OFF_VARIATION",
"PREREQUISITE",
"INVALID_VALUE",
]
""".data(using: .utf8)!

let decoder = JSONDecoder()
let decoded = try decoder.decode([ReasonType].self, from: json)

XCTAssertEqual(decoded, [
.target,
.rule,
.default, // "INVALID_VALUE"
.offVariation,
.prerequisite
])
}
}
66 changes: 36 additions & 30 deletions BucketeerTests/BKTEvaluationDetailTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: 2,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "1",
featureVersion: 0,
userId: "2",
variationId: "",
variationName: "",
variationValue: 2,
reason: .client))
reason: .errorException))
XCTAssertNotEqual(BKTEvaluationDetails(
featureId: "1",
featureVersion: 0,
userId: "2",
variationId: "",
variationName: "",
variationValue: 2,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "12",
featureVersion: 0,
userId: "2",
Expand All @@ -43,29 +43,29 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: "2",
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "2",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: "2",
reason: .client))
reason: .errorException))
XCTAssertNotEqual(BKTEvaluationDetails(
featureId: "2",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: "2",
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "2",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: "22",
reason: .client))
reason: .errorWrongType))

XCTAssertEqual(BKTEvaluationDetails(
featureId: "3",
Expand All @@ -74,14 +74,14 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: 3.0,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "3",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: 3.0,
reason: .client))
reason: .errorException))

XCTAssertNotEqual(BKTEvaluationDetails(
featureId: "3",
Expand All @@ -90,14 +90,14 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: 3.0,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "3",
featureVersion: 1,
userId: "3",
variationId: "",
variationName: "",
variationValue: 3.1,
reason: .client))
reason: .errorUserIdNotSpecified))

XCTAssertEqual(BKTEvaluationDetails(
featureId: "4",
Expand All @@ -106,14 +106,14 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: true,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "4",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: true,
reason: .client))
reason: .errorException))

XCTAssertNotEqual(BKTEvaluationDetails(
featureId: "4",
Expand All @@ -122,14 +122,14 @@ final class BKTEvaluationDetailTests: XCTestCase {
variationId: "",
variationName: "",
variationValue: true,
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "4",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: false,
reason: .client))
reason: .errorNoEvaluations))

XCTAssertEqual(BKTEvaluationDetails(
featureId: "5",
Expand All @@ -141,7 +141,7 @@ final class BKTEvaluationDetailTests: XCTestCase {
"key1" : "value1",
"key2" : "value2"
],
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "5",
featureVersion: 0,
userId: "3",
Expand All @@ -151,7 +151,7 @@ final class BKTEvaluationDetailTests: XCTestCase {
"key2" : "value2",
"key1" : "value1"
],
reason: .client))
reason: .errorException))

XCTAssertNotEqual(BKTEvaluationDetails(
featureId: "5",
Expand All @@ -163,7 +163,7 @@ final class BKTEvaluationDetailTests: XCTestCase {
"key1" : "value1",
"key2" : "value2"
],
reason: .client), BKTEvaluationDetails(
reason: .errorException), BKTEvaluationDetails(
featureId: "5",
featureVersion: 0,
userId: "3",
Expand All @@ -174,59 +174,59 @@ final class BKTEvaluationDetailTests: XCTestCase {
"key1" : "value1",
"key3" : "value3"
],
reason: .client))
reason: .errorUserIdNotSpecified))
}

func testCreateDefaultInstance() throws {
XCTAssertEqual(BKTEvaluationDetails<Int>.newDefaultInstance(featureId: "1", userId: "2", defaultValue: 2),
XCTAssertEqual(BKTEvaluationDetails<Int>.newDefaultInstance(featureId: "1", userId: "2", defaultValue: 2, reason: .default),
BKTEvaluationDetails(
featureId: "1",
featureVersion: 0,
userId: "2",
variationId: "",
variationName: "",
variationValue: 2,
reason: .client)
reason: .default)
)
XCTAssertEqual(BKTEvaluationDetails<String>.newDefaultInstance(featureId: "2", userId: "3", defaultValue: "2"),
XCTAssertEqual(BKTEvaluationDetails<String>.newDefaultInstance(featureId: "2", userId: "3", defaultValue: "2", reason: .default),
BKTEvaluationDetails(
featureId: "2",
featureVersion: 0,
userId: "3",
variationId: "",
variationName: "",
variationValue: "2",
reason: .client)
reason: .default)
)
XCTAssertEqual(BKTEvaluationDetails<Double>.newDefaultInstance(featureId: "1", userId: "2", defaultValue: 2.0),
XCTAssertEqual(BKTEvaluationDetails<Double>.newDefaultInstance(featureId: "1", userId: "2", defaultValue: 2.0, reason: .errorException),
BKTEvaluationDetails(
featureId: "1",
featureVersion: 0,
userId: "2",
variationId: "",
variationName: "",
variationValue: 2.0,
reason: .client)
reason: .errorException)
)
XCTAssertEqual(BKTEvaluationDetails<Bool>.newDefaultInstance(featureId: "11", userId: "22", defaultValue: true),
XCTAssertEqual(BKTEvaluationDetails<Bool>.newDefaultInstance(featureId: "11", userId: "22", defaultValue: true, reason: .errorFeatureFlagIdNotSpecified),
BKTEvaluationDetails(
featureId: "11",
featureVersion: 0,
userId: "22",
variationId: "",
variationName: "",
variationValue: true,
reason: .client)
reason: .errorFeatureFlagIdNotSpecified)
)
XCTAssertEqual(BKTEvaluationDetails<[String: AnyHashable]>.newDefaultInstance(featureId: "11", userId: "22", defaultValue: ["key":"value"]),
XCTAssertEqual(BKTEvaluationDetails<[String: AnyHashable]>.newDefaultInstance(featureId: "11", userId: "22", defaultValue: ["key":"value"], reason: .errorNoEvaluations),
BKTEvaluationDetails(
featureId: "11",
featureVersion: 0,
userId: "22",
variationId: "",
variationName: "",
variationValue: ["key":"value"],
reason: .client)
reason: .errorNoEvaluations)
)
}

Expand All @@ -237,10 +237,16 @@ final class BKTEvaluationDetailTests: XCTestCase {
XCTAssertEqual(BKTEvaluationDetails<Double>.Reason.fromString(value: "CLIENT"), .client)
XCTAssertEqual(BKTEvaluationDetails<Bool>.Reason.fromString(value: "OFF_VARIATION"), .offVariation)
XCTAssertEqual(BKTEvaluationDetails<Int>.Reason.fromString(value: "PREREQUISITE"), .prerequisite)
XCTAssertEqual(BKTEvaluationDetails<Double>.Reason.fromString(value: "ERROR_USER_ID_NOT_SPECIFIED"), .errorUserIdNotSpecified)
XCTAssertEqual(BKTEvaluationDetails<Bool>.Reason.fromString(value: "ERROR_NO_EVALUATIONS"), .errorNoEvaluations)
XCTAssertEqual(BKTEvaluationDetails<Int>.Reason.fromString(value: "ERROR_FEATURE_FLAG_ID_NOT_SPECIFIED"), .errorFeatureFlagIdNotSpecified)
XCTAssertEqual(BKTEvaluationDetails<Double>.Reason.fromString(value: "ERROR_WRONG_TYPE"), .errorWrongType)
XCTAssertEqual(BKTEvaluationDetails<Bool>.Reason.fromString(value: "ERROR_EXCEPTION"), .errorException)
XCTAssertEqual(BKTEvaluationDetails<Bool>.Reason.fromString(value: "ERROR_FLAG_NOT_FOUND"), .errorFlagNotFound)
}

func testFromStringWithInvalidValue() {
XCTAssertEqual(BKTEvaluationDetails<Int>.Reason.fromString(value: "INVALID"), .client)
XCTAssertEqual(BKTEvaluationDetails<Int>.Reason.fromString(value: "INVALID"), .errorException)
}
}
// swiftlint:enable function_body_length
Loading