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,33 @@ | ||||||
| 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)) | ||||||
| } | ||||||
| } | ||||||
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,134 @@ | ||
| public enum SentryAttributeValue: Equatable, Hashable { | ||
| case string(String) | ||
| case boolean(Bool) | ||
| case integer(Int) | ||
| case double(Double) | ||
| case stringArray([String]) | ||
| case booleanArray([Bool]) | ||
| case integerArray([Int]) | ||
| case doubleArray([Double]) | ||
|
|
||
| var type: String { | ||
| switch self { | ||
| case .string: | ||
| return "string" | ||
| case .boolean: | ||
| return "boolean" | ||
| case .integer: | ||
| return "integer" | ||
| case .double: | ||
| return "double" | ||
| case .stringArray: | ||
| return "string[]" | ||
| case .booleanArray: | ||
| return "boolean[]" | ||
| case .integerArray: | ||
| return "integer[]" | ||
| case .doubleArray: | ||
| return "double[]" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue: Encodable { | ||
| private enum CodingKeys: String, CodingKey { | ||
| case type | ||
| case value | ||
| } | ||
|
|
||
| public func encode(to encoder: any Encoder) throws { | ||
| var container = encoder.container(keyedBy: CodingKeys.self) | ||
| try container.encode(type, forKey: .type) | ||
|
|
||
| switch self { | ||
| case .string(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .boolean(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .integer(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .double(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .stringArray(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .booleanArray(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .integerArray(let value): | ||
| try container.encode(value, forKey: .value) | ||
| case .doubleArray(let value): | ||
| try container.encode(value, forKey: .value) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue { | ||
| static func from(anyValue value: Any) -> Self { | ||
| if let val = value as? String { | ||
| return .string(val) | ||
| } | ||
| if let val = value as? Bool { | ||
| return .boolean(val) | ||
| } | ||
| if let val = value as? Int { | ||
| return .integer(val) | ||
| } | ||
| if let val = value as? Double { | ||
| return .double(val) | ||
| } | ||
| if let val = value as? Float { | ||
| return .double(Double(val)) | ||
| } | ||
| if let val = value as? SentryAttributeValue { | ||
| return val | ||
| } | ||
| if let val = value as? SentryAttributeValuable { | ||
| return val.asAttributeValue | ||
| } | ||
| return .string(String(describing: value)) | ||
| } | ||
philprime marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| var anyValue: Any { | ||
| switch self { | ||
| case .string(let value): | ||
| return value | ||
| case .boolean(let value): | ||
| return value | ||
| case .integer(let value): | ||
| return value | ||
| case .double(let value): | ||
| return value | ||
| case .stringArray(let value): | ||
| return value | ||
| case .booleanArray(let value): | ||
| return value | ||
| case .integerArray(let value): | ||
| return value | ||
| case .doubleArray(let value): | ||
| return value | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue: ExpressibleByStringLiteral { | ||
| public init(stringLiteral value: StringLiteralType) { | ||
| self = .string(value) | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue: ExpressibleByBooleanLiteral { | ||
| public init(booleanLiteral value: BooleanLiteralType) { | ||
| self = .boolean(value) | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue: ExpressibleByFloatLiteral { | ||
| public init(floatLiteral value: FloatLiteralType) { | ||
| self = .double(value) | ||
| } | ||
| } | ||
|
|
||
| extension SentryAttributeValue: ExpressibleByIntegerLiteral { | ||
| public init(integerLiteral value: IntegerLiteralType) { | ||
| self = .integer(value) | ||
| } | ||
| } | ||
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 |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| protocol BatcherItem: Encodable { | ||
| var attributesMap: [String: SentryAttributeValue] { get set } | ||
|
Member
Author
There was a problem hiding this comment. This was renamed because it would otherwise collide with the type of |
||
| var traceId: SentryId { get set } | ||
| var body: String { get } | ||
| } | ||
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.