refactor: Add attributable protocol for typed attribute values #7077
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,145 @@ | ||||||
| public protocol SentryAttributeValuable { | ||||||
| var asAttributeValue: SentryAttributeValue { get } | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| extension String: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| return .string(self) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| extension Bool: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| return .boolean(self) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| extension Int: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| return .integer(self) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| extension Double: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| return .double(self) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| extension Float: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| return .double(Double(self)) | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| extension Array: SentryAttributeValuable { | ||||||
| public var asAttributeValue: SentryAttributeValue { | ||||||
| // Arrays can be heterogenous, therefore we must validate if all elements are of the same type. | ||||||
| // We must assert the element type too, because due to Objective-C bridging we noticed invalid conversions | ||||||
| // of empty String Arrays to Bool Arrays. | ||||||
| if Element.self == Bool.self, let values = self as? [Bool] { | ||||||
| return .booleanArray(values) | ||||||
| } | ||||||
| if Element.self == Double.self, let values = self as? [Double] { | ||||||
| return .doubleArray(values) | ||||||
| } | ||||||
| if Element.self == Float.self, let values = self as? [Float] { | ||||||
| return .doubleArray(values.map(Double.init)) | ||||||
| } | ||||||
| if Element.self == Int.self, let values = self as? [Int] { | ||||||
| return .integerArray(values) | ||||||
| } | ||||||
| if Element.self == String.self, let values = self as? [String] { | ||||||
| return .stringArray(values) | ||||||
| } | ||||||
| if let values = self as? [SentryAttributeValuable] { | ||||||
| return castArrayToAttributeValue(values: values) | ||||||
| } | ||||||
| return .stringArray(self.map { element in | ||||||
| String(describing: element) | ||||||
| }) | ||||||
| } | ||||||
|
|
||||||
| private func castArrayToAttributeValue(values: [SentryAttributeValuable]) -> SentryAttributeValue { | ||||||
|
Member
There was a problem hiding this comment.
Member
Author
There was a problem hiding this comment. I tried to do that but it's not possible in Swift to have multiple conformances like this: extension Array: SentryAttributeValuable where Element == Bool {
public var asAttributeValue: SentryAttributeValue {
return .booleanArray(self)
}
}
extension Array: SentryAttributeValuable where Element == Int {
public var asAttributeValue: SentryAttributeValue {
return .integerArray(self)
}
}
extension Array: SentryAttributeValuable where Element == String {
public var asAttributeValue: SentryAttributeValue {
return .stringArray(self)
}
}
extension Array: SentryAttributeValuable where Element == Double {
public var asAttributeValue: SentryAttributeValue {
return .doubleArray(self)
}
}...because Swift does not allow multiple conditional conformances of the same generic type to the same protocol — even if the constraints are mutually exclusive. This is a hard compiler rule, not a limitation of my code. If you, @itaybre or @noahsmartin know how we can make only these types of arrays can actually be casted to
Member
There was a problem hiding this comment. OK, maybe we need a completely different approach if it doesn't work with the current one. I can try to come up with something, but that will take some time, and that will have to wait after the holidays. |
||||||
| // Check if the values are homogeneous and can be casted to a specific array type | ||||||
| if let booleanArray = castValuesToBooleanArray(values) { | ||||||
| return booleanArray | ||||||
| } | ||||||
| if let doubleArray = castValuesToDoubleArray(values) { | ||||||
| return doubleArray | ||||||
| } | ||||||
| if let integerArray = castValuesToIntegerArray(values) { | ||||||
| return integerArray | ||||||
| } | ||||||
| if let stringArray = castValuesToStringArray(values) { | ||||||
| return stringArray | ||||||
| } | ||||||
| // If the values are not homogenous we resolve the individual valuables to strings | ||||||
| return .stringArray(values.map { value in | ||||||
| switch value.asAttributeValue { | ||||||
| case .boolean(let value): | ||||||
| return String(describing: value) | ||||||
| case .double(let value): | ||||||
| return String(describing: value) | ||||||
| case .integer(let value): | ||||||
| return String(describing: value) | ||||||
| case .string(let value): | ||||||
| return value | ||||||
| default: | ||||||
| return String(describing: value) | ||||||
| } | ||||||
| }) | ||||||
| } | ||||||
|
|
||||||
| func castValuesToBooleanArray(_ values: [SentryAttributeValuable]) -> SentryAttributeValue? { | ||||||
| let mappedBooleanValues = values.compactMap { element -> Bool? in | ||||||
| guard case .boolean(let value) = element.asAttributeValue else { | ||||||
| return nil | ||||||
| } | ||||||
| return value | ||||||
| } | ||||||
| guard mappedBooleanValues.count == values.count else { | ||||||
| return nil | ||||||
| } | ||||||
| return .booleanArray(mappedBooleanValues) | ||||||
| } | ||||||
|
|
||||||
| func castValuesToDoubleArray(_ values: [SentryAttributeValuable]) -> SentryAttributeValue? { | ||||||
| let mappedDoubleValues = values.compactMap { element -> Double? in | ||||||
| guard case .double(let value) = element.asAttributeValue else { | ||||||
| return nil | ||||||
| } | ||||||
| return value | ||||||
| } | ||||||
| guard mappedDoubleValues.count == values.count else { | ||||||
| return nil | ||||||
| } | ||||||
| return .doubleArray(mappedDoubleValues) | ||||||
| } | ||||||
|
|
||||||
| func castValuesToIntegerArray(_ values: [SentryAttributeValuable]) -> SentryAttributeValue? { | ||||||
| let mappedIntegerValues = values.compactMap { element -> Int? in | ||||||
| guard case .integer(let value) = element.asAttributeValue else { | ||||||
| return nil | ||||||
| } | ||||||
| return value | ||||||
| } | ||||||
| guard mappedIntegerValues.count == values.count else { | ||||||
| return nil | ||||||
| } | ||||||
| return .integerArray(mappedIntegerValues) | ||||||
| } | ||||||
|
|
||||||
| func castValuesToStringArray(_ values: [SentryAttributeValuable]) -> SentryAttributeValue? { | ||||||
| let mappedStringValues = values.compactMap { element -> String? in | ||||||
| guard case .string(let value) = element.asAttributeValue else { | ||||||
| return nil | ||||||
| } | ||||||
| return value | ||||||
| } | ||||||
| guard mappedStringValues.count == values.count else { | ||||||
| return nil | ||||||
| } | ||||||
| return .stringArray(mappedStringValues) | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
h: I would highly appreciate proper code docs for all these new init methods, as these are public API.