Keep binary compatibility for DefaultFrameInterceptorData

The compiler plugin is hardcoded to this class at this point, this will be changed later.
kordlib · Jun 7, 2024 · e7581b9 · e7581b9
1 parent ad518d0
commit e7581b9
Show file tree

Hide file tree

Showing 7 changed files with 233 additions and 0 deletions.
diff --git a/compiler-plugins/build.gradle.kts b/compiler-plugins/build.gradle.kts
@@ -0,0 +1,7 @@
+plugins {
+    `kord-internal-module`
+}
+
+dependencies {
+    compileOnly(libs.kotlin.compiler)
+}
diff --git a/compiler-plugins/src/main/kotlin/ValueClassesBinaryCompatibilityPlugin.kt b/compiler-plugins/src/main/kotlin/ValueClassesBinaryCompatibilityPlugin.kt
@@ -0,0 +1,214 @@
+package dev.kord.compiler
+
+import org.jetbrains.kotlin.backend.common.ClassLoweringPass
+import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
+import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
+import org.jetbrains.kotlin.backend.common.lower.DeclarationIrBuilder
+import org.jetbrains.kotlin.backend.common.lower.irIfThen
+import org.jetbrains.kotlin.backend.common.lower.irThrow
+import org.jetbrains.kotlin.backend.jvm.extensions.ClassGenerator
+import org.jetbrains.kotlin.backend.jvm.extensions.ClassGeneratorExtension
+import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys
+import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity.ERROR
+import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity.INFO
+import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
+import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi
+import org.jetbrains.kotlin.config.CompilerConfiguration
+import org.jetbrains.kotlin.descriptors.DescriptorVisibilities.PRIVATE
+import org.jetbrains.kotlin.descriptors.DescriptorVisibilities.PUBLIC
+import org.jetbrains.kotlin.ir.builders.*
+import org.jetbrains.kotlin.ir.builders.declarations.addConstructor
+import org.jetbrains.kotlin.ir.builders.declarations.addFunction
+import org.jetbrains.kotlin.ir.builders.declarations.addValueParameter
+import org.jetbrains.kotlin.ir.declarations.*
+import org.jetbrains.kotlin.ir.expressions.IrExpression
+import org.jetbrains.kotlin.ir.symbols.IrSymbol
+import org.jetbrains.kotlin.ir.symbols.UnsafeDuringIrConstructionAPI
+import org.jetbrains.kotlin.ir.types.defaultType
+import org.jetbrains.kotlin.ir.types.isNullable
+import org.jetbrains.kotlin.ir.types.isNullableString
+import org.jetbrains.kotlin.ir.types.makeNullable
+import org.jetbrains.kotlin.ir.util.*
+import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.Name
+import org.jetbrains.kotlin.platform.jvm.isJvm
+import org.jetbrains.org.objectweb.asm.Opcodes.ACC_PRIVATE
+import org.jetbrains.org.objectweb.asm.Opcodes.ACC_PUBLIC
+
+private val DEFAULT_FRAME_INTERCEPTOR_DATA = ClassId.fromString("dev/kord/voice/DefaultFrameInterceptorData")
+private val SPEAKING_FLAGS = ClassId.fromString("dev/kord/voice/SpeakingFlags")
+private val NULL_POINTER_EXCEPTION = ClassId.fromString("java/lang/NullPointerException")
+private val VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN =
+    IrDeclarationOriginImpl("VALUE_CLASSES_BINARY_COMPATIBILITY", isSynthetic = true)
+
+@OptIn(ExperimentalCompilerApi::class)
+class ValueClassesBinaryCompatibilityCompilerPluginRegistrar : CompilerPluginRegistrar() {
+    override val supportsK2 get() = true
+
+    override fun ExtensionStorage.registerExtensions(configuration: CompilerConfiguration) {
+        val messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE)
+        IrGenerationExtension.registerExtension(ValueClassesBinaryCompatibilityIrGenerationExtension(messageCollector))
+        ClassGeneratorExtension.registerExtension(
+            ValueClassesBinaryCompatibilityClassGeneratorExtension(messageCollector),
+        )
+    }
+}
+
+private class ValueClassesBinaryCompatibilityIrGenerationExtension(
+    private val messageCollector: MessageCollector,
+) : IrGenerationExtension {
+    override fun generate(moduleFragment: IrModuleFragment, pluginContext: IrPluginContext) {
+        val platform = pluginContext.platform
+        if (!pluginContext.platform.isJvm()) {
+            messageCollector.report(ERROR, "Plugin shouldn't be applied to non JVM platforms: $platform")
+            return
+        }
+        ValueClassesBinaryCompatibilityClassLoweringPass(messageCollector, pluginContext).lower(moduleFragment)
+    }
+}
+
+@OptIn(UnsafeDuringIrConstructionAPI::class)
+private class ValueClassesBinaryCompatibilityClassLoweringPass(
+    private val messageCollector: MessageCollector,
+    private val context: IrPluginContext,
+) : ClassLoweringPass {
+    private val speakingFlags = context.referenceClass(SPEAKING_FLAGS)!!.defaultType.makeNullable()
+    private val nullPointerException = context.referenceClass(NULL_POINTER_EXCEPTION)!!
+    private val speakingState = Name.identifier("speakingState")
+    private val component1 = Name.identifier("component1")
+    private val copy = Name.identifier("copy")
+
+    private fun IrSymbol.builder() = DeclarationIrBuilder(context, symbol = this)
+
+    private fun IrBuilderWithScope.nullCheck(arg: IrExpression) = irIfThen(
+        condition = irEqualsNull(arg),
+        thenPart = irThrow(
+            irCallConstructor(
+                callee = nullPointerException.constructors.single {
+                    it.owner.valueParameters.singleOrNull()?.type?.isNullableString() == true
+                },
+                typeArguments = emptyList(),
+            ).apply {
+                putValueArgument(
+                    index = 0,
+                    irString("Null was passed as a parameter that was previously non-nullable."),
+                )
+            }
+        ),
+    )
+
+    override fun lower(irClass: IrClass) {
+        if (irClass.classId != DEFAULT_FRAME_INTERCEPTOR_DATA) {
+            return
+        }
+        messageCollector.report(INFO, "lowering ${irClass.classId}")
+
+        val primaryCtor = irClass.primaryConstructor!!
+
+        val ctor1 = irClass.addConstructor {
+            origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
+            visibility = PUBLIC
+        }
+        ctor1.body = ctor1.symbol.builder().irBlockBody {
+            +irDelegatingConstructorCall(primaryCtor)
+        }
+        messageCollector.report(INFO, "ctor1: ${ctor1.render()}")
+
+        val ctor2 = irClass.addConstructor {
+            origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
+            visibility = PUBLIC
+        }
+        val param = ctor2
+            .addValueParameter("speakingState", speakingFlags, VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN)
+            .apply { defaultValue = primaryCtor.valueParameters.first().defaultValue }
+        ctor2.body = ctor2.symbol.builder().irBlockBody {
+            val arg = irGet(param)
+            +nullCheck(arg)
+            +irDelegatingConstructorCall(primaryCtor).apply { putValueArgument(index = 0, arg) }
+        }
+        messageCollector.report(INFO, "ctor2: ${ctor2.render()}")
+
+        val inlineSpeakingState = irClass.properties.single { it.name == speakingState }
+        val speakingState = irClass.addFunction(
+            name = "getSpeakingState",
+            returnType = speakingFlags,
+            visibility = PUBLIC,
+            origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN,
+        ).apply {
+            body = with(symbol.builder()) {
+                irExprBody(irCall(inlineSpeakingState.getter!!))
+            }
+        }
+        messageCollector.report(INFO, "speakingState: ${speakingState.render()}")
+
+        val inlineComponent1 = irClass.functions.single { it.name == component1 }
+        val component1 = inlineComponent1.deepCopyWithSymbols().apply {
+            origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
+            returnType = speakingFlags
+            body = with(symbol.builder()) {
+                irExprBody(irCall(inlineComponent1).apply { dispatchReceiver = irGet(dispatchReceiverParameter!!) })
+            }
+        }
+        irClass.declarations.add(component1)
+        messageCollector.report(INFO, "component1: ${component1.render()}")
+
+        val inlineCopy = irClass.functions.single { it.name == copy }
+        val copy = inlineCopy.deepCopyWithSymbols().apply {
+            origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
+            val copyParam = valueParameters.single().apply {
+                type = speakingFlags
+            }
+            body = symbol.builder().irBlockBody {
+                val arg = irGet(copyParam)
+                +nullCheck(arg)
+                +irReturn(irCall(inlineCopy).apply {
+                    dispatchReceiver = irGet(dispatchReceiverParameter!!)
+                    putValueArgument(index = 0, arg)
+                })
+            }
+        }
+        irClass.declarations.add(copy)
+        messageCollector.report(INFO, "copy: ${copy.render()}")
+    }
+}
+
+private class ValueClassesBinaryCompatibilityClassGeneratorExtension(
+    private val messageCollector: MessageCollector,
+) : ClassGeneratorExtension {
+    override fun generateClass(generator: ClassGenerator, declaration: IrClass?): ClassGenerator {
+        if (declaration?.classId != DEFAULT_FRAME_INTERCEPTOR_DATA) {
+            return generator
+        }
+        return object : ClassGenerator by generator {
+            override fun newMethod(
+                declaration: IrFunction?,
+                access: Int,
+                name: String,
+                desc: String,
+                signature: String?,
+                exceptions: Array<out String>?,
+            ) = generator.newMethod(
+                declaration = declaration, name = name, desc = desc, signature = signature, exceptions = exceptions,
+                access = when (declaration) {
+                    is IrConstructor -> {
+                        val visibility = declaration.visibility
+                        val params = declaration.valueParameters
+                        when {
+                            visibility == PUBLIC && params.size == 2 && params[0].type.isNullable() -> {
+                                messageCollector.report(INFO, "changing visibility to private: ${declaration.render()}")
+                                (access and ACC_PUBLIC.inv()) or ACC_PRIVATE
+                            }
+                            visibility == PRIVATE && params.size == 1 && params[0].type.isNullable() -> {
+                                messageCollector.report(INFO, "changing visibility to public: ${declaration.render()}")
+                                (access and ACC_PRIVATE.inv()) or ACC_PUBLIC
+                            }
+                            else -> access
+                        }
+                    }
+                    else -> access
+                },
+            )
+        }
+    }
+}
diff --git a/.../resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar b/.../resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
@@ -0,0 +1 @@
+dev.kord.compiler.ValueClassesBinaryCompatibilityCompilerPluginRegistrar
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -69,6 +69,7 @@ bignum = { module = "com.ionspin.kotlin:bignum", version.ref = "bignum" }
 stately-collections = { module = "co.touchlab:stately-concurrent-collections", version.ref = "stately" }
 
 # code generation
+kotlin-compiler = { module = "org.jetbrains.kotlin:kotlin-compiler", version.ref = "kotlin" }
 ksp-api = { module = "com.google.devtools.ksp:symbol-processing-api", version.ref = "ksp" }
 kotlinpoet = { module = "com.squareup:kotlinpoet", version.ref = "kotlinpoet" }
 kotlinpoet-ksp = { module = "com.squareup:kotlinpoet-ksp", version.ref = "kotlinpoet" }

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -8,6 +8,7 @@ rootProject.name = "kord"
 include(
     "bom",
     "common",
+    "compiler-plugins",
     "core",
     "core:live-tests",
     "core-voice",

diff --git a/voice/api/voice.api b/voice/api/voice.api
@@ -183,12 +183,19 @@ public final class dev/kord/voice/DefaultFrameInterceptor : dev/kord/voice/Frame
 }
 
 public final class dev/kord/voice/DefaultFrameInterceptorData {
+	public synthetic fun <init> ()V
 	public synthetic fun <init> (IILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public synthetic fun <init> (ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Ldev/kord/voice/SpeakingFlags;)V
+	public synthetic fun <init> (Ldev/kord/voice/SpeakingFlags;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final synthetic fun component1 ()Ldev/kord/voice/SpeakingFlags;
 	public final fun component1-jIm6Qs8 ()I
+	public final synthetic fun copy (Ldev/kord/voice/SpeakingFlags;)Ldev/kord/voice/DefaultFrameInterceptorData;
+	public static synthetic fun copy$default (Ldev/kord/voice/DefaultFrameInterceptorData;Ldev/kord/voice/SpeakingFlags;ILjava/lang/Object;)Ldev/kord/voice/DefaultFrameInterceptorData;
 	public final fun copy-tttCGww (I)Ldev/kord/voice/DefaultFrameInterceptorData;
 	public static synthetic fun copy-tttCGww$default (Ldev/kord/voice/DefaultFrameInterceptorData;IILjava/lang/Object;)Ldev/kord/voice/DefaultFrameInterceptorData;
 	public fun equals (Ljava/lang/Object;)Z
+	public final synthetic fun getSpeakingState ()Ldev/kord/voice/SpeakingFlags;
 	public final fun getSpeakingState-jIm6Qs8 ()I
 	public fun hashCode ()I
 	public fun toString ()Ljava/lang/String;

diff --git a/voice/build.gradle.kts b/voice/build.gradle.kts
@@ -18,4 +18,6 @@ dependencies {
     compileOnly(projects.kspAnnotations)
 
     api(libs.ktor.network)
+
+    kotlinCompilerPluginClasspathMain(projects.compilerPlugins)
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		dev.kord.compiler.ValueClassesBinaryCompatibilityCompilerPluginRegistrar