Add support for mutable messages in Wire's Kotlin Generator. #3217
Conversation
This file contains 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
oldergod
reviewed
Dec 18, 2024
wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt
Outdated
Show resolved
Hide resolved
oldergod
force-pushed
the
gen-mutable
branch
from
9d2090c to
83c75b8
Compare
tikurahul
force-pushed
the
gen-mutable
branch
from
7946e6e to
5f09272
Compare
JakeWharton
approved these changes
Dec 18, 2024
wire-golden-files/src/main/kotlin/squareup/wire/mutable/MutableHeader.kt
Outdated
Show resolved
Hide resolved
wire-golden-files/src/main/kotlin/squareup/wire/mutable/MutableHeader.kt
Outdated
Show resolved
Hide resolved
wire-golden-files/src/main/kotlin/squareup/wire/mutable/MutableHeader.kt
Outdated
Show resolved
Hide resolved
tikurahul
force-pushed
the
gen-mutable
branch
from
5f09272 to
75ab3de
Compare
JakeWharton
reviewed
Dec 19, 2024
wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt
Outdated
Show resolved
Hide resolved
* Sometimes its very useful to avoid needing to create new object graph instances when all we need to do is to serialize the object graph into a `ProtoSink`. * Mutable messages solves for this, for code that is particularly performance sensitive where a large number of objects would have otherwise been created which adds unnecesssary GC pressure. * Mutable messages should be **used very carefully**. There are **no guarantees of safety whatsoever**. * When using mutable messages, `hashCode()` is no longer cached. * Mutable messages don't support `redact()`. Test: Added a unit test in KotlinGeneratorTest
* `newBuilder()` throws an `UnsupportedOperationException` instead. Thanks @oldergod. * Updated the `KotlinGeneratorTest` to use the renamed option in the `KotlinGenerator`. * Update goldens to include the new error message. * Update API files for `wire-compiler`.
* `Mutable` messsages now have access to mutable `unknownFields`. Test: Updated KotlinGeneratorTest and the golden tests.
* `Mutable` messsages now have access to mutable `unknownFields`. Test: Updated KotlinGeneratorTest and the golden tests.
* Regenerate golden files. * Update API files for `wire-gradle-plugin`. * Update API files for `wire-kotlin-generator`. * Spotless checks.
tikurahul
force-pushed
the
gen-mutable
branch
from
8fbb653 to
88666f2
Compare
squarejesse
reviewed
Dec 23, 2024
wire-golden-files/src/main/kotlin/squareup/wire/mutable/MutableHeader.kt
Show resolved
Hide resolved
squarejesse
reviewed
Dec 23, 2024
| ) | ||
| override fun newBuilder(): Nothing = throw UnsupportedOperationException("newBuilder() is unsupported for mutable message types") | ||
|
|
||
| override fun equals(other: Any?): Boolean { |
There was a problem hiding this comment.
should this be by-identity rather than by-value? Equals is weird on mutable things
There was a problem hiding this comment.
Did you mean that we should only support referential equality ?
I think it's also okay for us to also compare the values. Otherwise it might just end up being confusing.
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.
ProtoSink.Builders and sonewBuilder()throws anUnsupportedOperationException().copy(...).hashCode()is no longer cached.redact().Test: Added a unit test in
KotlinGeneratorTest.