ProtoName is now supported, allowing the overriding of the field name…

… for ProtoBuf only.

formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/ProtoTypes.kt

@@ -7,6 +7,16 @@ package kotlinx.serialization.protobuf
 import kotlinx.serialization.*
 import kotlinx.serialization.descriptors.*
 
+/**
+ * Specifies protobuf field name assigned to a Kotlin property or class.
+ *
+ * Used to get around invalid naming conventions.
+ */
+@SerialInfo
+@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
+@ExperimentalSerializationApi
+public annotation class ProtoName(public val name: String)
+
 /**
  * Specifies protobuf field number (a unique number for a field in the protobuf message)
  * assigned to a Kotlin property.

formats/protobuf/commonMain/src/kotlinx/serialization/protobuf/schema/ProtoBufSchemaGenerator.kt

@@ -182,7 +182,7 @@ public object ProtoBufSchemaGenerator {
         getAnnotations: (Int) -> List<Annotation> = { parentType.descriptor.getElementAnnotations(it) },
         getChildType: (Int) -> TypeDefinition = { parentType.descriptor.getElementDescriptor(it).let(::TypeDefinition) },
         getChildNumber: (Int) -> Int = { parentType.descriptor.getElementAnnotations(it).filterIsInstance<ProtoNumber>().singleOrNull()?.number ?: (it + 1) },
-        getChildName: (Int) -> String = { parentType.descriptor.getElementName(it) },
+        getChildName: (Int) -> String = { parentType.descriptor.getElementNameProtobuf(it) },
         inOneOfStruct: Boolean = false,
     ) {
         val messageDescriptor = parentType.descriptor
@@ -216,7 +216,7 @@ public object ProtoBufSchemaGenerator {
                         getAnnotations = { desc.annotations },
                         getChildType = { desc.elementDescriptors.single().let(::TypeDefinition) },
                         getChildNumber = { desc.getElementAnnotations(0).filterIsInstance<ProtoNumber>().singleOrNull()?.number ?: (it + 1) },
-                        getChildName = { desc.getElementName(0) },
+                        getChildName = { desc.getElementNameProtobuf(0) },
                         inOneOfStruct = true,
                     )
                 }
@@ -392,13 +392,15 @@ public object ProtoBufSchemaGenerator {
         val usedNumbers: MutableSet<Int> = mutableSetOf()
         val duplicatedNumbers: MutableSet<Int> = mutableSetOf()
         enumDescriptor.elementDescriptors.forEachIndexed { index, element ->
-            val elementName = element.protobufEnumElementName
+            val annotations = enumDescriptor.getElementAnnotations(index)
+
+            val elementName = annotations.filterIsInstance<ProtoName>().singleOrNull()?.name
+                ?: element.serialName.substringAfterLast('.', element.serialName)
             elementName.checkIsValidIdentifier {
                 "The enum element name '$elementName' is invalid in the " +
-                        "protobuf schema. Serial name of the enum class '${enumDescriptor.serialName}'"
+                    "protobuf schema. Serial name of the enum class '${enumDescriptor.serialName}'"
             }
 
-            val annotations = enumDescriptor.getElementAnnotations(index)
             val number = annotations.filterIsInstance<ProtoNumber>().singleOrNull()?.number ?: index
             if (!usedNumbers.add(number)) {
                 duplicatedNumbers.add(number)
@@ -416,6 +418,13 @@ public object ProtoBufSchemaGenerator {
         appendLine('}')
     }
 
+    private fun SerialDescriptor.getElementNameProtobuf(index: Int): String {
+        getElementAnnotations(index).forEach {
+            if(it is ProtoName) return it.name
+        }
+        return getElementName(index)
+    }
+
     private val SerialDescriptor.isOpenPolymorphic: Boolean
         get() = kind == PolymorphicKind.OPEN
 
@@ -453,8 +462,16 @@ public object ProtoBufSchemaGenerator {
         get() = kind == PrimitiveKind.INT || kind == PrimitiveKind.LONG || kind == PrimitiveKind.BOOLEAN || kind == PrimitiveKind.STRING
 
 
+    @Suppress("RecursivePropertyAccessor")
     private val SerialDescriptor.messageOrEnumName: String
-        get() = (serialName.substringAfterLast('.', serialName)).removeSuffix("?")
+        get() {
+            // Try to get the original descriptor to retrieve the ProtoName
+            if (this is NotNullSerialDescriptor) return this.original.messageOrEnumName
+            if (nonNullOriginal != this) return nonNullOriginal.messageOrEnumName
+
+            annotations.forEach { if(it is ProtoName) return it.name }
+            return serialName.substringAfterLast('.', serialName).removeSuffix("?")
+        }
 
     private fun SerialDescriptor.isChildOneOfMessage(index: Int): Boolean =
         this.getElementDescriptor(index).isSealedPolymorphic && this.getElementAnnotations(index).any { it is ProtoOneOf }
@@ -467,9 +484,6 @@ public object ProtoBufSchemaGenerator {
         }
     }
 
-    private val SerialDescriptor.protobufEnumElementName: String
-        get() = serialName.substringAfterLast('.', serialName)
-
     private fun SerialDescriptor.scalarTypeName(annotations: List<Annotation> = emptyList()): String {
         val integerType = annotations.filterIsInstance<ProtoType>().firstOrNull()?.type ?: ProtoIntegerType.DEFAULT
 
@@ -548,7 +562,7 @@ public object ProtoBufSchemaGenerator {
     ): TypeDefinition {
         val messageDescriptor = messageType.descriptor
         val fieldDescriptor = messageDescriptor.getElementDescriptor(index)
-        val fieldName = messageDescriptor.getElementName(index)
+        val fieldName = messageDescriptor.getElementNameProtobuf(index)
         val messageName = messageDescriptor.messageOrEnumName
 
         val wrapperName = "${messageName}_${fieldName}"
@@ -573,7 +587,7 @@ public object ProtoBufSchemaGenerator {
         description: String
     ): TypeDefinition {
         val messageDescriptor = messageType.descriptor
-        val fieldName = messageDescriptor.getElementName(index)
+        val fieldName = messageDescriptor.getElementNameProtobuf(index)
         val messageName = messageDescriptor.messageOrEnumName
 
         val wrapperName = "${messageName}_${fieldName}"

formats/protobuf/commonTest/src/kotlinx/serialization/protobuf/schema/SchemaValidationsTest.kt

@@ -17,9 +17,17 @@ class SchemaValidationsTest {
     @SerialName("invalid serial name")
     data class InvalidClassName(val i: Int)
 
+    @Serializable
+    @SerialName("invalid serial name")
+    @ProtoName("ValidSerialName")
+    data class InvalidClassNameFixed(val i: Int)
+
     @Serializable
     data class InvalidClassFieldName(@SerialName("invalid serial name") val i: Int)
 
+    @Serializable
+    data class InvalidClassFieldNameFixed(@ProtoName("okProtoName") @SerialName("invalid serial name") val i: Int)
+
     @Serializable
     data class FieldNumberDuplicates(@ProtoNumber(42) val i: Int, @ProtoNumber(42) val j: Int)
 
@@ -30,6 +38,11 @@ class SchemaValidationsTest {
     @SerialName("invalid serial name")
     enum class InvalidEnumName { SINGLETON }
 
+    @Serializable
+    @SerialName("invalid serial name")
+    @ProtoName("ValidEnumNameFixed")
+    enum class InvalidEnumNameFixed { SINGLETON }
+
     @Serializable
     enum class InvalidEnumElementName {
         FIRST,
@@ -38,6 +51,15 @@ class SchemaValidationsTest {
         SECOND
     }
 
+    @Serializable
+    enum class InvalidEnumElementNameFixed {
+        FIRST,
+
+        @SerialName("invalid serial name")
+        @ProtoName("validSerialName")
+        SECOND
+    }
+
     @Serializable
     enum class EnumWithExplicitProtoNumberDuplicate {
         @ProtoNumber(2)
@@ -71,18 +93,36 @@ class SchemaValidationsTest {
         assertFailsWith(IllegalArgumentException::class) { ProtoBufSchemaGenerator.generateSchemaText(descriptors) }
     }
 
+    @Test
+    fun testInvalidEnumElementSerialNameFixed() {
+        val descriptors = listOf(InvalidEnumElementNameFixed.serializer().descriptor)
+        println(ProtoBufSchemaGenerator.generateSchemaText(descriptors))
+    }
+
     @Test
     fun testInvalidClassSerialName() {
         val descriptors = listOf(InvalidClassName.serializer().descriptor)
         assertFailsWith(IllegalArgumentException::class) { ProtoBufSchemaGenerator.generateSchemaText(descriptors) }
     }
 
+    @Test
+    fun testInvalidClassSerialNameFixed() {
+        val descriptors = listOf(InvalidClassNameFixed.serializer().descriptor)
+        println(ProtoBufSchemaGenerator.generateSchemaText(descriptors))
+    }
+
     @Test
     fun testInvalidClassFieldSerialName() {
         val descriptors = listOf(InvalidClassFieldName.serializer().descriptor)
         assertFailsWith(IllegalArgumentException::class) { ProtoBufSchemaGenerator.generateSchemaText(descriptors) }
     }
 
+    @Test
+    fun testInvalidClassFieldSerialNameFixed() {
+        val descriptors = listOf(InvalidClassFieldNameFixed.serializer().descriptor)
+        println(ProtoBufSchemaGenerator.generateSchemaText(descriptors))
+    }
+
     @Test
     fun testDuplicateSerialNames() {
         val descriptors = listOf(InvalidClassFieldName.serializer().descriptor)
@@ -95,6 +135,12 @@ class SchemaValidationsTest {
         assertFailsWith(IllegalArgumentException::class) { ProtoBufSchemaGenerator.generateSchemaText(descriptors) }
     }
 
+    @Test
+    fun testInvalidEnumSerialNameFixed() {
+        val descriptors = listOf(InvalidEnumNameFixed.serializer().descriptor)
+        println(ProtoBufSchemaGenerator.generateSchemaText(descriptors))
+    }
+
     @Test
     fun testDuplicationSerialName() {
         val descriptors = listOf(ValidClass.serializer().descriptor, DuplicateClass.serializer().descriptor)