Add Wire Binary Compatibility plugin by HLGreer · Pull Request #3306 · square/wire

HLGreer · 2025-03-31T14:48:58Z

This change adds a Kotlin compiler plugin that rewrites Wire-generated callsites to be more resilient to schema changes. This first PR only rewrites uses of the generated constructor.

Why:

When a new field is added to a proto Message, existing usages of the Wire-generated class constructor can cause class conflicts. This is often encountered this when there are duplicate or transitive dependencies pulling in different versions of the same proto, resulting in errors shaped as java.lang.NoSuchMethod at runtime.

When faced with this situation, a frequent recommendation is to refactor the codebase to use the class' Builder. Rather than requiring individuals to update their codebases, we can adapt their Kotlin code instead. Wrapping up this solution as a plugin allows for individual opt-in and rollout without influencing the core Wire implementation.

I suspect that you could do it as compileOnly if you also add it to the testImplementation or testRuntimeOnly configuration. I'm still a bit concerned that having this dependency as implementation will infect downstream consumers. Looking at the pom file I think it transitively brings in the kotlin-gradle-plugins-bom which will cause downstream consumers to get upgraded to the version of kotlin being used by wire.

staktrace · 2025-03-31T15:29:05Z

...src/main/kotlin/com/squareup/wire/binarycompatibility/kotlin/BurstCompilerPluginRegistrar.kt

Filename is copypasta, should probably be updated

HLGreer · 2025-03-31T15:31:01Z

...src/main/kotlin/com/squareup/wire/binarycompatibility/kotlin/BurstCompilerPluginRegistrar.kt

@@ -0,0 +1,42 @@
+/*


One more name fixup needed here

…ttings.gradle Co-authored-by: Jesse Wilson <jwilson@squareup.com> Co-authored-by: Hannah Greer <hgreer@squareup.com>

…sion Co-authored-by: Jesse Wilson <jwilson@squareup.com>

swankjesse

So rad

swankjesse · 2025-04-01T16:07:58Z

wire-binary-compatibility-gradle-plugin/README.md

+When a new field is added to the Dinosaur schema, if there are competing versions of the compiled class and the new
+version is resolved at runtime, the usage above may encounter an error:
+```
+java.lang.NoSuchMethodError: 'void com.squareup.dinosaurs.Dinosaur<init>(java.lang.String, java.lang.Double,


swankjesse · 2025-04-01T16:08:46Z

...ty-gradle-plugin/src/main/kotlin/com/squareup/wire/binarycompatibility/gradle/BuildConfig.kt

+ */
+package com.squareup.wire.binarycompatibility.gradle
+
+object BuildConfig {


Usually this file can be generated from gradle properties.

I was looking at some prior art! I figured that is a good follow up unless someone felt strongly to have it generated here now

It must be generated, at least the version component, or it will not work properly in the destination project. It's only a few lines in the Gradle build and you can copy it from Burst or Zipline probably without any changes.

I think maybe this PR also demonstrates this: https://github.com/square/gradle-dependencies-sorter/pull/123/files

autonomousapps · 2025-04-01T20:57:12Z

wire-binary-compatibility-gradle-plugin/build.gradle.kts

+configure<MavenPublishBaseExtension> {
+  configure(
+    GradlePlugin(
+      javadocJar = JavadocJar.Empty()


Out of curiosity, why publish an empty javadoc jar?

It isn’t a library for external use, but Maven Central requires Javadoc

...com/squareup/wire/binarycompatibility/kotlin/WireBinaryCompatibilityIrGenerationExtension.kt

…uareup/wire/binarycompatibility/kotlin/WireBinaryCompatibilityIrGenerationExtension.kt Co-authored-by: Jesse Wilson <jwilson@squareup.com>

…pileOnly otherwise

Add Wire Binary Compatibility plugin

fe5b6f0

Co-authored-by: Jesse Wilson <jwilson@squareup.com> Co-authored-by: Hannah Greer <hgreer@squareup.com>

HLGreer requested a review from oldergod March 31, 2025 14:48

oldergod approved these changes Mar 31, 2025

View reviewed changes

squarejesse reviewed Mar 31, 2025

View reviewed changes

staktrace reviewed Mar 31, 2025

View reviewed changes

HLGreer commented Mar 31, 2025

View reviewed changes

HLGreer and others added 5 commits March 31, 2025 12:06

Update class name, use specific imports, remove Xcode by-pass from se…

8bf29b0

…ttings.gradle Co-authored-by: Jesse Wilson <jwilson@squareup.com> Co-authored-by: Hannah Greer <hgreer@squareup.com>

Add documentation comment to WireBinaryCompatibilityIrGenerationExten…

30528fc

…sion Co-authored-by: Jesse Wilson <jwilson@squareup.com>

Add readme with example

cfd8a4b

spotlessApply

cabbb63

Add simple BuildConfig object with GradlePluginArtifacts

5ec88c2

HLGreer force-pushed the wire-binary-compatibility branch from ecc42a4 to b868c71 Compare April 1, 2025 14:45

Use CompileOnly for gradle-plugin-api, wbc plugin

af75cfc

HLGreer force-pushed the wire-binary-compatibility branch from b868c71 to af75cfc Compare April 1, 2025 15:04

swankjesse approved these changes Apr 1, 2025

View reviewed changes

HLGreer requested a review from staktrace April 1, 2025 17:25

autonomousapps reviewed Apr 1, 2025

View reviewed changes

HLGreer added 2 commits April 22, 2025 15:03

Use compileOnly for kotlin.gradlePlugin

b6bcc37

Generate BuildConfig for the plugin

54295d9

HLGreer requested a review from autonomousapps April 23, 2025 19:15

squarejesse approved these changes Apr 25, 2025

View reviewed changes

...com/squareup/wire/binarycompatibility/kotlin/WireBinaryCompatibilityIrGenerationExtension.kt Outdated Show resolved Hide resolved

HLGreer and others added 2 commits April 25, 2025 15:13

Update wire-binary-compatibility-kotlin-plugin/src/main/kotlin/com/sq…

3df3a26

…uareup/wire/binarycompatibility/kotlin/WireBinaryCompatibilityIrGenerationExtension.kt Co-authored-by: Jesse Wilson <jwilson@squareup.com>

Use a testImplementation of 'gradle-plugin-api' during tests, and com…

88ef84b

…pileOnly otherwise

               include(":wire-test-utils")
               include(":wire-tests")
-              if (startParameter.projectProperties.get("swift") != "false") {
+              if (false && startParameter.projectProperties.get("swift") != "false") {

+              import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+              import org.jetbrains.kotlin.ir.IrStatement
+              import org.jetbrains.kotlin.ir.backend.js.utils.valueArguments
+              import org.jetbrains.kotlin.ir.builders.*

+                override fun getPluginArtifact(): SubpluginArtifact = SubpluginArtifact(
+                  groupId = "com.squareup.wire.binarycompatibility",
+                  artifactId = "wire-binary-compatibility-kotlin-plugin",
+                  version = "2.6.0-SNAPSHOT",

+              dependencies {
+                implementation(kotlin("gradle-plugin-api"))
+                implementation(project(":wire-binary-compatibility-kotlin-plugin"))
+                implementation(libs.kotlin.gradlePlugin)

Conversation

HLGreer commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why:

Next:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swankjesse left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

HLGreer commented Mar 31, 2025 •

edited

Loading