Wrap API response data in DeepReadonly#362
Open
thearyanahmed wants to merge 1 commit into
Open
Conversation
thearyanahmed
force-pushed
the
readonly-response-data
branch
from
612dab3 to
23b44f1
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Addresses #329.
This PR wraps API response payloads in
DeepReadonly<T>so they can't be mutated, nested objects and arrays included. Covers both success (ApiSuccess.data) and API error (ErrorResult'sErrorBody) responses; the client-sideclient_errorvariant getsreadonlybindings for consistency.Applied at the response boundary in
http-client.ts, so request bodies stay mutable: a shared schema is mutable when you build a request and frozen when it comes back.Dateis passed through untouched.I am a bit uncertain if that is what issue 329 wants or is it expected to have the DeepReadonly around the whole type. I went with this approach as this keeps the server's response readonly.