Configure JPMS checks (#187)

Kotlin · Sep 23, 2024 · 4dc54f2 · 4dc54f2
1 parent c9c6d03
commit 4dc54f2
Show file tree

Hide file tree

Showing 77 changed files with 227 additions and 89 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -21,7 +21,7 @@ allprojects {
 }
 
 object Const {
-    const val INTERNAL_RPC_API_ANNOTATION = "kotlinx.rpc.internal.InternalRPCApi"
+    const val INTERNAL_RPC_API_ANNOTATION = "kotlinx.rpc.internal.utils.InternalRPCApi"
 }
 
 apiValidation {

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/awaitFieldInitialization.kt b/core/src/commonMain/kotlin/kotlinx/rpc/awaitFieldInitialization.kt
@@ -7,7 +7,7 @@ package kotlinx.rpc
 import kotlinx.rpc.internal.RPCDeferredField
 import kotlinx.rpc.internal.RPCServiceFieldsProvider
 import kotlinx.rpc.internal.findRPCStubProvider
-import kotlinx.rpc.internal.safeCast
+import kotlinx.rpc.internal.utils.safeCast
 import kotlin.reflect.KClass
 
 /**

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCDeferredField.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCDeferredField.kt
@@ -4,6 +4,8 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
+
 @InternalRPCApi
 public interface RPCDeferredField<Self> {
     public suspend fun await(): Self

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCMethodClassArguments.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCMethodClassArguments.kt
@@ -4,6 +4,8 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
+
 @InternalRPCApi
 public interface RPCMethodClassArguments {
     public fun asArray(): Array<out Any?>

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCStubObject.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/RPCStubObject.kt
@@ -6,6 +6,7 @@ package kotlinx.rpc.internal
 
 import kotlinx.rpc.RPC
 import kotlinx.rpc.RPCClient
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KType
 
 @InternalRPCApi

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.kt
@@ -4,6 +4,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/ServiceScope.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/ServiceScope.kt
@@ -7,6 +7,7 @@ package kotlinx.rpc.internal
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.currentCoroutineContext
 import kotlinx.coroutines.withContext
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.contracts.ExperimentalContracts
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.kt
@@ -4,6 +4,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 
 @InternalRPCApi

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/internal/scopedClientCall.kt b/core/src/commonMain/kotlin/kotlinx/rpc/internal/scopedClientCall.kt
@@ -5,6 +5,7 @@
 package kotlinx.rpc.internal
 
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.rpc.internal.utils.InternalRPCApi
 
 /**
  * Scopes client RPC call from a service with [serviceScope].

diff --git a/core/src/commonMain/kotlin/kotlinx/rpc/withService.kt b/core/src/commonMain/kotlin/kotlinx/rpc/withService.kt
@@ -8,7 +8,7 @@ import kotlinx.atomicfu.atomic
 import kotlinx.rpc.internal.RPCStubServiceProvider
 import kotlinx.rpc.internal.findRPCStubProvider
 import kotlinx.rpc.internal.kClass
-import kotlinx.rpc.internal.safeCast
+import kotlinx.rpc.internal.utils.safeCast
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 

diff --git a/core/src/jsMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.js.kt b/core/src/jsMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.js.kt
@@ -6,6 +6,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 
 @InternalRPCApi

diff --git a/core/src/jsMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.js.kt b/core/src/jsMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.js.kt
@@ -8,6 +8,7 @@ package kotlinx.rpc.internal
 
 import js.objects.Object
 import kotlinx.rpc.RPC
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.AssociatedObjectKey
 import kotlin.reflect.ExperimentalAssociatedObjects
 import kotlin.reflect.KClass

diff --git a/core/src/jvmMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.jvm.kt b/core/src/jvmMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.jvm.kt
@@ -6,6 +6,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 
 @InternalRPCApi

diff --git a/core/src/jvmMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.jvm.kt b/core/src/jvmMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.jvm.kt
@@ -6,6 +6,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 import kotlin.reflect.full.companionObjectInstance
 

diff --git a/core/src/nativeMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.native.kt b/core/src/nativeMain/kotlin/kotlinx/rpc/internal/ReflectionUtils.native.kt
@@ -6,6 +6,7 @@
 
 package kotlinx.rpc.internal
 
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.KClass
 
 @InternalRPCApi

diff --git a/core/src/nativeMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.native.kt b/core/src/nativeMain/kotlin/kotlinx/rpc/internal/WithRPCStubObject.native.kt
@@ -7,6 +7,7 @@
 package kotlinx.rpc.internal
 
 import kotlinx.rpc.RPC
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlin.reflect.AssociatedObjectKey
 import kotlin.reflect.ExperimentalAssociatedObjects
 import kotlin.reflect.KClass

diff --git a/gradle-conventions-settings/src/main/kotlin/util/OptInForInternalApi.kt b/gradle-conventions-settings/src/main/kotlin/util/OptInForInternalApi.kt
@@ -8,7 +8,7 @@ import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
 
 fun KotlinProjectExtension.optInForRPCApi() {
     sourceSets.all {
-        languageSettings.optIn("kotlinx.rpc.internal.InternalRPCApi")
-        languageSettings.optIn("kotlinx.rpc.internal.ExperimentalRPCApi")
+        languageSettings.optIn("kotlinx.rpc.internal.utils.InternalRPCApi")
+        languageSettings.optIn("kotlinx.rpc.internal.utils.ExperimentalRPCApi")
     }
 }
diff --git a/gradle-conventions-settings/src/main/kotlin/util/Path.kt b/gradle-conventions-settings/src/main/kotlin/util/Path.kt
@@ -4,6 +4,7 @@
 
 package util
 
+import org.gradle.api.Project
 import java.io.File
 import java.nio.file.Files
 import java.nio.file.Path
@@ -13,3 +14,5 @@ fun Path.name() = fileName?.toString().orEmpty()
 fun filterDirectory(sourceSetPath: Path, filter: (Path) -> Boolean): List<File> {
     return Files.newDirectoryStream(sourceSetPath).use { it.toList() }.filter(filter).map { it.toFile() }
 }
+
+val Project.files: Array<File> get() = project.projectDir.resolve("src").listFiles() ?: emptyArray()
diff --git a/gradle-conventions-settings/src/main/kotlin/util/jvm.kt b/gradle-conventions-settings/src/main/kotlin/util/jvm.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package util
+
+import org.gradle.api.Project
+import org.gradle.jvm.tasks.Jar
+import org.gradle.kotlin.dsl.attributes
+import org.gradle.kotlin.dsl.getByName
+
+fun Project.configureJvm(isKmp: Boolean) {
+    tasks.getByName<Jar>(if (isKmp) "jvmJar" else "jar").apply {
+        manifest {
+            attributes(
+                "Implementation-Title" to name,
+                "Implementation-Version" to libs.versions.kotlinx.rpc.get()
+            )
+            val name = project.javaModuleName()
+            attributes("Automatic-Module-Name" to name)
+        }
+    }
+}
+
+fun Project.javaModuleName(): String {
+    return "kotlinx.rpc.${project.name}".replace('-', '.')
+}
+
+val Project.hasJavaModule: Boolean
+    get() = plugins.hasPlugin("maven-publish") && name != "bom" && name != "jpms-check" && hasJvm
+
+val Project.hasJvm: Boolean
+    get() = files.any { it.name == "commonMain" }
+            || files.any { it.name == "jvmMain" }
+            || files.any { it.name == "main" }
diff --git a/gradle-conventions/src/main/kotlin/conventions-jvm.gradle.kts b/gradle-conventions/src/main/kotlin/conventions-jvm.gradle.kts
@@ -3,6 +3,7 @@
  */
 
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
+import util.configureJvm
 import util.optInForRPCApi
 
 plugins {
@@ -23,3 +24,5 @@ configure<KotlinJvmProjectExtension> {
 
     explicitApi()
 }
+
+configureJvm(isKmp = false)
diff --git a/gradle-conventions/src/main/kotlin/conventions-kmp.gradle.kts b/gradle-conventions/src/main/kotlin/conventions-kmp.gradle.kts
@@ -3,6 +3,7 @@
  */
 
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import util.configureJvm
 import util.configureKotlin
 import util.optInForRPCApi
 import util.optionalProperty
@@ -30,3 +31,5 @@ configureKotlin(
     js = !excludeJs,
     native = !excludeNative,
 )
+
+configureJvm(isKmp = true)
diff --git a/jpms-check/.gitignore b/jpms-check/.gitignore
@@ -0,0 +1 @@
+src/main/java/module-info.java
diff --git a/jpms-check/build.gradle.kts b/jpms-check/build.gradle.kts
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+import util.hasJavaModule
+import util.javaModuleName
+
+plugins {
+    `java-library`
+}
+
+description = "Internal module for checking JPMS compliance"
+
+tasks.register("generateModuleInfo") {
+    val modules = project.rootProject.subprojects
+        .filter { it.hasJavaModule }
+        .map { it.javaModuleName() }
+
+    val moduleInfoPath = project.projectDir.absolutePath + "/src/main/java/module-info.java"
+
+    doLast {
+        File(moduleInfoPath)
+            .apply {
+                parentFile.mkdirs()
+                createNewFile()
+            }
+            .bufferedWriter().use { writer ->
+                writer.write("module kotlinx.rpc.test.module {\n")
+                modules.forEach { writer.write("\trequires $it;\n") }
+                writer.write("}")
+            }
+    }
+}
+
+tasks.getByName<JavaCompile>("compileJava") {
+    dependsOn("generateModuleInfo")
+
+    val projectFiles = project.files()
+    doFirst {
+        options.compilerArgs.addAll(listOf("--module-path", classpath.asPath))
+        classpath = projectFiles
+    }
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
+
+dependencies {
+    rootProject.subprojects
+        .forEach {
+            val dep = generateSequence(it) { subProject -> subProject.parent }
+                .toList()
+                .dropLast(1)
+                .reversed()
+                .joinToString(":", prefix = ":") { segment -> segment.name }
+
+            it.plugins.withId("maven-publish") {
+                if (it.hasJavaModule) {
+                    api(project(dep))
+                }
+            }
+        }
+}
diff --git a/krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/KRPCClient.kt b/krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/KRPCClient.kt
@@ -12,11 +12,11 @@ import kotlinx.coroutines.flow.StateFlow
 import kotlinx.rpc.RPCCall
 import kotlinx.rpc.RPCClient
 import kotlinx.rpc.RPCField
-import kotlinx.rpc.internal.InternalRPCApi
-import kotlinx.rpc.internal.SupervisedCompletableDeferred
-import kotlinx.rpc.internal.getOrNull
-import kotlinx.rpc.internal.map.ConcurrentHashMap
 import kotlinx.rpc.internal.serviceScopeOrNull
+import kotlinx.rpc.internal.utils.InternalRPCApi
+import kotlinx.rpc.internal.utils.SupervisedCompletableDeferred
+import kotlinx.rpc.internal.utils.getOrNull
+import kotlinx.rpc.internal.utils.map.ConcurrentHashMap
 import kotlinx.rpc.krpc.*
 import kotlinx.rpc.krpc.client.internal.FieldDataObject
 import kotlinx.rpc.krpc.client.internal.RPCClientConnector

diff --git a/krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/internal/RPCFlow.kt b/krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/internal/RPCFlow.kt
@@ -11,7 +11,7 @@ import kotlinx.coroutines.flow.FlowCollector
 import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.rpc.internal.RPCDeferredField
-import kotlinx.rpc.internal.SupervisedCompletableDeferred
+import kotlinx.rpc.internal.utils.SupervisedCompletableDeferred
 
 internal sealed class RPCFlow<T, FlowT : Flow<T>>(private val serviceName: String, parent: Job) :
     RPCDeferredField<FlowT> {

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/RPCConfig.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/RPCConfig.kt
@@ -7,7 +7,7 @@ package kotlinx.rpc.krpc
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.SharedFlow
-import kotlinx.rpc.internal.InternalRPCApi
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlinx.rpc.krpc.serialization.RPCSerialFormat
 import kotlinx.rpc.krpc.serialization.RPCSerialFormatBuilder
 import kotlinx.rpc.krpc.serialization.RPCSerialFormatConfiguration

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/StreamScope.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/StreamScope.kt
@@ -5,11 +5,11 @@
 package kotlinx.rpc.krpc
 
 import kotlinx.coroutines.*
-import kotlinx.rpc.internal.AutoCloseable
-import kotlinx.rpc.internal.ExperimentalRPCApi
-import kotlinx.rpc.internal.InternalRPCApi
-import kotlinx.rpc.internal.map.ConcurrentHashMap
-import kotlinx.rpc.internal.use
+import kotlinx.rpc.internal.utils.AutoCloseable
+import kotlinx.rpc.internal.utils.ExperimentalRPCApi
+import kotlinx.rpc.internal.utils.InternalRPCApi
+import kotlinx.rpc.internal.utils.map.ConcurrentHashMap
+import kotlinx.rpc.internal.utils.use
 import kotlin.contracts.ExperimentalContracts
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/CancellationType.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/CancellationType.kt
@@ -4,8 +4,8 @@
 
 package kotlinx.rpc.krpc.internal
 
-import kotlinx.rpc.internal.IndexedEnum
-import kotlinx.rpc.internal.InternalRPCApi
+import kotlinx.rpc.internal.utils.IndexedEnum
+import kotlinx.rpc.internal.utils.InternalRPCApi
 
 @InternalRPCApi
 @Suppress("detekt.MagicNumber")

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/ExceptionUtils.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/ExceptionUtils.kt
@@ -4,8 +4,8 @@
 
 package kotlinx.rpc.krpc.internal
 
-import kotlinx.rpc.internal.InternalRPCApi
 import kotlinx.rpc.internal.typeName
+import kotlinx.rpc.internal.utils.InternalRPCApi
 
 @InternalRPCApi
 public fun serializeException(cause: Throwable): SerializedException {

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/ObjectId.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/ObjectId.kt
@@ -4,7 +4,7 @@
 
 package kotlinx.rpc.krpc.internal
 
-import kotlinx.rpc.internal.InternalRPCApi
+import kotlinx.rpc.internal.utils.InternalRPCApi
 
 private const val HEX_RADIX = 16
 

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCConnector.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCConnector.kt
@@ -9,8 +9,8 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
-import kotlinx.rpc.internal.InternalRPCApi
-import kotlinx.rpc.internal.hex.toHexStringInternal
+import kotlinx.rpc.internal.utils.InternalRPCApi
+import kotlinx.rpc.internal.utils.hex.toHexStringInternal
 import kotlinx.rpc.krpc.RPCTransport
 import kotlinx.rpc.krpc.RPCTransportMessage
 import kotlinx.rpc.krpc.internal.logging.CommonLogger

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCEndpoint.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCEndpoint.kt
@@ -6,7 +6,7 @@ package kotlinx.rpc.krpc.internal
 
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.launch
-import kotlinx.rpc.internal.InternalRPCApi
+import kotlinx.rpc.internal.utils.InternalRPCApi
 
 @InternalRPCApi
 public interface RPCEndpoint {

diff --git a/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCMessage.kt b/krpc/krpc-core/src/commonMain/kotlin/kotlinx/rpc/krpc/internal/RPCMessage.kt
@@ -4,7 +4,7 @@
 
 package kotlinx.rpc.krpc.internal
 
-import kotlinx.rpc.internal.InternalRPCApi
+import kotlinx.rpc.internal.utils.InternalRPCApi
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable