Merge pull request #2678 from square/kotlin-build-followups

Cleanup Kotlin build function
square · Oct 16, 2023 · fa69a5d · fa69a5d
2 parents 936caaf + 64cbd6a
commit fa69a5d
Show file tree

Hide file tree

Showing 67 changed files with 181 additions and 8 deletions.
diff --git a/wire-golden-files/src/main/kotlin/squareup/wire/alltypes/AllTypes.kt b/wire-golden-files/src/main/kotlin/squareup/wire/alltypes/AllTypes.kt
@@ -17,6 +17,7 @@ import com.squareup.wire.`internal`.FloatArrayList
 import com.squareup.wire.`internal`.IntArrayList
 import com.squareup.wire.`internal`.JvmField
 import com.squareup.wire.`internal`.JvmStatic
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.LongArrayList
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.decodePrimitive_double
@@ -4498,6 +4499,7 @@ public class AllTypes private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): AllTypes = Builder().apply(body).build()
   }
 
@@ -4633,6 +4635,7 @@ public class AllTypes private constructor(
 
       private const val serialVersionUID: Long = 0L
 
+      @JvmSynthetic
       public inline fun build(body: Builder.() -> Unit): NestedMessage =
           Builder().apply(body).build()
     }

diff --git a/wire-golden-files/src/main/kotlin/squareup/wire/boxedoneof/BoxedOneOfs.kt b/wire-golden-files/src/main/kotlin/squareup/wire/boxedoneof/BoxedOneOfs.kt
@@ -12,6 +12,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.`internal`.JvmField
 import com.squareup.wire.`internal`.JvmStatic
+import com.squareup.wire.`internal`.JvmSynthetic
 import kotlin.Any
 import kotlin.Boolean
 import kotlin.Int
@@ -152,6 +153,7 @@ public class BoxedOneOfs(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): BoxedOneOfs = Builder().apply(body).build()
   }
 }
diff --git a/wire-golden-files/src/main/kotlin/squareup/wire/buildersonly/SomeMessage.kt b/wire-golden-files/src/main/kotlin/squareup/wire/buildersonly/SomeMessage.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import kotlin.Any
 import kotlin.Boolean
 import kotlin.Int
@@ -125,6 +126,7 @@ public class SomeMessage private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): SomeMessage = Builder().apply(body).build()
   }
 
@@ -234,6 +236,7 @@ public class SomeMessage private constructor(
 
       private const val serialVersionUID: Long = 0L
 
+      @JvmSynthetic
       public inline fun build(body: Builder.() -> Unit): NestedMessage =
           Builder().apply(body).build()
     }

diff --git a/...on-support/src/test/java/com/squareup/wire/proto2/dinosaurs/javainteropkotlin/Dinosaur.kt b/...on-support/src/test/java/com/squareup/wire/proto2/dinosaurs/javainteropkotlin/Dinosaur.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.sanitize
@@ -261,6 +262,7 @@ public class Dinosaur(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): Dinosaur = Builder().apply(body).build()
   }
 }
diff --git a/wire-gson-support/src/test/java/squareup/proto2/keywords/KeywordKotlin.kt b/wire-gson-support/src/test/java/squareup/proto2/keywords/KeywordKotlin.kt
@@ -15,6 +15,7 @@ import com.squareup.wire.WireEnumConstant
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
 import com.squareup.wire.`internal`.JvmStatic
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.missingRequiredFields
@@ -269,6 +270,7 @@ public class KeywordKotlin(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): KeywordKotlin = Builder().apply(body).build()
   }
 

diff --git a/wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt b/wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt
@@ -550,7 +550,7 @@ class KotlinGenerator private constructor(
 
     addDefaultFields(type, companionBuilder, nameAllocator)
     addAdapter(type, companionBuilder)
-    if (buildersOnly || javaInterOp) addBuildClosure(type, companionBuilder, builderClassName)
+    if (buildersOnly || javaInterOp) addBuildFunction(type, companionBuilder, builderClassName)
 
     val classBuilder = TypeSpec.classBuilder(className)
       .apply {
@@ -1971,9 +1971,23 @@ class KotlinGenerator private constructor(
     }
   }
 
-  private fun addBuildClosure(type: MessageType, companionBuilder: TypeSpec.Builder, builderClassName: ClassName) {
-    val buildFn = FunSpec.builder("build")
+  /**
+   * Adds a closure into the [companionBuilder] allowing the creation of an instance via the Kotlin
+   * DSL.
+   *
+   * Example
+   * ```
+   * companion object {
+   *   @JvmSynthetic
+   *   public inline fun build(body: Builder.() -> Unit): AllTypes = Builder().apply(body).build()
+   * }
+   * ```
+   */
+  private fun addBuildFunction(type: MessageType, companionBuilder: TypeSpec.Builder, builderClassName: ClassName) {
+    val buildFunction = FunSpec.builder("build")
       .addModifiers(INLINE)
+      // We hide it to Java callers.
+      .addAnnotation(ClassName("com.squareup.wire.internal", "JvmSynthetic"))
       .addParameter(
         "body",
         LambdaTypeName.get(
@@ -1985,7 +1999,7 @@ class KotlinGenerator private constructor(
       .returns(generatedTypeName(type))
       .build()
 
-    companionBuilder.addFunction(buildFn)
+    companionBuilder.addFunction(buildFunction)
   }
 
   private fun redactFun(message: MessageType): FunSpec {

diff --git a/wire-kotlin-generator/src/test/java/com/squareup/wire/kotlin/KotlinGeneratorTest.kt b/wire-kotlin-generator/src/test/java/com/squareup/wire/kotlin/KotlinGeneratorTest.kt
@@ -1979,11 +1979,14 @@ class KotlinGeneratorTest {
       .generateKotlin("SomeMessage", buildersOnly = false, javaInterop = false)
     assertThat(code).doesNotContain("inline fun build(body: Builder.() -> Unit): SomeMessage")
     val buildersOnlyCode = KotlinWithProfilesGenerator(schema)
-      .generateKotlin("SomeMessage", buildersOnly = true)
-    assertThat(buildersOnlyCode).contains("inline fun build(body: Builder.() -> Unit): SomeMessage")
+      .generateKotlin("SomeMessage", buildersOnly = true, javaInterop = false)
+    assertThat(buildersOnlyCode).contains("@JvmSynthetic\n    public inline fun build(body: Builder.() -> Unit): SomeMessage")
     val javaInteropCode = KotlinWithProfilesGenerator(schema)
-      .generateKotlin("SomeMessage", javaInterop = true)
-    assertThat(javaInteropCode).contains("inline fun build(body: Builder.() -> Unit): SomeMessage")
+      .generateKotlin("SomeMessage", buildersOnly = false, javaInterop = true)
+    assertThat(javaInteropCode).contains("@JvmSynthetic\n    public inline fun build(body: Builder.() -> Unit): SomeMessage")
+    val bothCode = KotlinWithProfilesGenerator(schema)
+      .generateKotlin("SomeMessage", buildersOnly = true, javaInterop = true)
+    assertThat(bothCode).contains("@JvmSynthetic\n    public inline fun build(body: Builder.() -> Unit): SomeMessage")
   }
 
   @Test

diff --git a/...hi-adapter/src/test/java/com/squareup/wire/proto2/dinosaurs/javainteropkotlin/Dinosaur.kt b/...hi-adapter/src/test/java/com/squareup/wire/proto2/dinosaurs/javainteropkotlin/Dinosaur.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.sanitize
@@ -261,6 +262,7 @@ public class Dinosaur(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): Dinosaur = Builder().apply(body).build()
   }
 }
diff --git a/wire-moshi-adapter/src/test/java/com/squareup/wire/proto2/person/javainteropkotlin/Person.kt b/wire-moshi-adapter/src/test/java/com/squareup/wire/proto2/person/javainteropkotlin/Person.kt
@@ -14,6 +14,7 @@ import com.squareup.wire.WireEnum
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
 import com.squareup.wire.`internal`.JvmStatic
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.missingRequiredFields
@@ -251,6 +252,7 @@ public class Person(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): Person = Builder().apply(body).build()
   }
 
@@ -443,6 +445,7 @@ public class Person(
 
       private const val serialVersionUID: Long = 0L
 
+      @JvmSynthetic
       public inline fun build(body: Builder.() -> Unit): PhoneNumber = Builder().apply(body).build()
     }
   }

diff --git a/wire-moshi-adapter/src/test/java/squareup/proto2/keywords/KeywordKotlin.kt b/wire-moshi-adapter/src/test/java/squareup/proto2/keywords/KeywordKotlin.kt
@@ -15,6 +15,7 @@ import com.squareup.wire.WireEnumConstant
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
 import com.squareup.wire.`internal`.JvmStatic
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.missingRequiredFields
@@ -269,6 +270,7 @@ public class KeywordKotlin(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): KeywordKotlin = Builder().apply(body).build()
   }
 

diff --git a/wire-runtime/src/commonMain/kotlin/com/squareup/wire/internal/-Platform.kt b/wire-runtime/src/commonMain/kotlin/com/squareup/wire/internal/-Platform.kt
@@ -31,6 +31,8 @@ expect annotation class JvmDefaultWithCompatibility()
 
 expect annotation class JvmField()
 
+expect annotation class JvmSynthetic()
+
 expect annotation class JvmStatic()
 
 expect abstract class ObjectStreamException : IOException

diff --git a/wire-runtime/src/jsMain/kotlin/com/squareup/wire/internal/-Platform.kt b/wire-runtime/src/jsMain/kotlin/com/squareup/wire/internal/-Platform.kt
@@ -22,6 +22,9 @@ actual interface Serializable
 /** This annotation is an empty placeholder. */
 actual annotation class JvmField
 
+/** This annotation is an empty placeholder. */
+actual annotation class JvmSynthetic
+
 /** This annotation is an empty placeholder. */
 actual annotation class JvmStatic
 

diff --git a/wire-runtime/src/jvmMain/kotlin/com/squareup/wire/internal/-Platform.kt b/wire-runtime/src/jvmMain/kotlin/com/squareup/wire/internal/-Platform.kt
@@ -25,6 +25,8 @@ actual typealias JvmDefaultWithCompatibility = kotlin.jvm.JvmDefaultWithCompatib
 
 actual typealias JvmField = kotlin.jvm.JvmField
 
+actual typealias JvmSynthetic = kotlin.jvm.JvmSynthetic
+
 actual typealias JvmStatic = kotlin.jvm.JvmStatic
 
 actual typealias ObjectStreamException = java.io.ObjectStreamException

diff --git a/wire-runtime/src/nativeMain/kotlin/com/squareup/wire/internal/-Platform.kt b/wire-runtime/src/nativeMain/kotlin/com/squareup/wire/internal/-Platform.kt
@@ -22,6 +22,9 @@ actual interface Serializable
 /** This annotation is an empty placeholder. */
 actual annotation class JvmField
 
+/** This annotation is an empty placeholder. */
+actual annotation class JvmSynthetic
+
 /** This annotation is an empty placeholder. */
 actual annotation class JvmStatic
 

diff --git a/...monTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/NotRedacted.kt b/...monTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/NotRedacted.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.sanitize
 import kotlin.Any
 import kotlin.Boolean
@@ -150,6 +151,7 @@ public class NotRedacted private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): NotRedacted = Builder().apply(body).build()
   }
 }
diff --git a/...nTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedChild.kt b/...nTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedChild.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.sanitize
 import kotlin.Any
 import kotlin.Boolean
@@ -176,6 +177,7 @@ public class RedactedChild private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedChild = Builder().apply(body).build()
   }
 }
diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleA.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleA.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import kotlin.Any
 import kotlin.Boolean
 import kotlin.Int
@@ -126,6 +127,7 @@ public class RedactedCycleA private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedCycleA =
         Builder().apply(body).build()
   }

diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleB.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleB.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import kotlin.Any
 import kotlin.Boolean
 import kotlin.Int
@@ -126,6 +127,7 @@ public class RedactedCycleB private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedCycleB =
         Builder().apply(body).build()
   }

diff --git a/...t/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedExtension.kt b/...t/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedExtension.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.sanitize
 import kotlin.Any
 import kotlin.Boolean
@@ -152,6 +153,7 @@ public class RedactedExtension private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedExtension =
         Builder().apply(body).build()
   }

diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedFields.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedFields.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.sanitize
 import kotlin.Any
 import kotlin.Boolean
@@ -204,6 +205,7 @@ public class RedactedFields private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedFields =
         Builder().apply(body).build()
   }

diff --git a/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRepeated.kt b/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRepeated.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import com.squareup.wire.`internal`.checkElementsNotNull
 import com.squareup.wire.`internal`.immutableCopyOf
 import com.squareup.wire.`internal`.redactElements
@@ -170,6 +171,7 @@ public class RedactedRepeated private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedRepeated =
         Builder().apply(body).build()
   }

diff --git a/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRequired.kt b/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRequired.kt
@@ -11,6 +11,7 @@ import com.squareup.wire.ReverseProtoWriter
 import com.squareup.wire.Syntax.PROTO_2
 import com.squareup.wire.WireField
 import com.squareup.wire.`internal`.JvmField
+import com.squareup.wire.`internal`.JvmSynthetic
 import kotlin.Any
 import kotlin.Boolean
 import kotlin.Int
@@ -126,6 +127,7 @@ public class RedactedRequired private constructor(
 
     private const val serialVersionUID: Long = 0L
 
+    @JvmSynthetic
     public inline fun build(body: Builder.() -> Unit): RedactedRequired =
         Builder().apply(body).build()
   }