[ECO-5356] Remove public raw values from enums. #316
Conversation
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
|
""" WalkthroughThis change refactors several enums in the codebase to remove their direct conformance to Changes
Sequence Diagram(s)sequenceDiagram
participant Decoder
participant Message
participant MessageAction (enum)
participant InternalRawRepresentable
Decoder->>Message: decode(from: JSON)
Message->>Decoder: extract "action" as String
Message->>MessageAction: init?(rawValue: String)
alt valid action
MessageAction-->>Message: MessageAction instance
Message-->>Decoder: Message instance
else invalid action
Message-->>Decoder: throw DecodingError
end
Assessment against linked issues
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
maratal
changed the title
maratal
force-pushed
the
279-no-public-raw-values
branch
from
3a6d7eb to
939e576
Compare
umair-ably
approved these changes
Jul 4, 2025
| extension MessageAction: InternalRawRepresentable { | ||
| internal typealias RawValue = String | ||
|
|
||
| internal init?(rawValue: String) { |
There was a problem hiding this comment.
Would be nice if we could avoid duplicating the raw values. There are various ways you could do this, but perhaps the easiest would be to just have an internal WireMessageAction: String type that you convert to and from MessageAction.
| @@ -171,9 +171,13 @@ extension Message: JSONObjectDecodable { | |||
| values: summaryJson | |||
| ) | |||
| } | |||
| let rawAction = try jsonObject.stringValueForKey("action") | |||
| guard let action = MessageAction(rawValue: rawAction) else { | |||
| throw JSONValueDecodingError.failedToDecodeFromRawValue(rawAction).toInternalError() | |||
There was a problem hiding this comment.
Also would be good to have a convenience method à la rawRepresentableValueForKey
There was a problem hiding this comment.
I'm not sure I've understood, this method belongs to jsonObject and similar to stringValueForKey?
maratal
force-pushed
the
279-no-public-raw-values
branch
from
939e576 to
1f07c14
Compare
maratal
force-pushed
the
279-no-public-raw-values
branch
from
1f07c14 to
8f6626a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #279
Summary by CodeRabbit
Refactor
Bug Fixes