Merge pull request #5069 from ktorio/zibet27/ktor-client-webrtc-android

WebRTC Client

Author: bjhham

CONTRIBUTING.md

@@ -92,6 +92,18 @@ To import into IntelliJ IDEA, just open up the `Ktor` project folder. IntelliJ I
 that it is a Gradle project and import it. It's important that you make sure that all building and test operations
 are delegated to Gradle under [Gradle Settings](https://www.jetbrains.com/help/idea/gradle-settings.html).
 
+#### Working with Rust-based Modules Locally
+
+The `ktor-client-webrtc-rs` module utilizes Rust components internally. To develop with this module in your local environment, you'll need to complete the following setup steps:
+
+**Prerequisites:**
+- Install Rust and Cargo on your system
+- Configure your build environment by adding `ktorbuild.rustCompilation=true` to your global `gradle.properties` file
+  > ⚠️ **Important:** This setting should remain local to your development environment—do not commit this change to version control
+
+**Additional Dependencies:**
+Depending on your target platforms, you may need to install additional dependencies for Rust cross-compilation. For comprehensive guidance on cross-compilation requirements and troubleshooting, refer to the [Gobley cross-compilation documentation](https://gobley.dev/docs/cross-compilation-tips).
+
 ### Pull Requests
 
 Contributions are made using Github [pull requests](https://help.github.com/en/articles/about-pull-requests):

build-logic/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
     implementation(libs.gradleDoctor)
     implementation(libs.kotlinter)
     implementation(libs.mavenPublishing)
+    implementation(libs.android.kmp.library)
 
     // A hack to make version catalogs accessible from buildSrc sources
     // https://github.com/gradle/gradle/issues/15383#issuecomment-779893192

build-logic/settings.gradle.kts

@@ -5,6 +5,7 @@
 pluginManagement {
     // Add repositories required for build-settings-logic
     repositories {
+        google()
         gradlePluginPortal()
 
         // Should be in sync with ktorsettings.kotlin-user-project

build-logic/src/main/kotlin/ktorbuild.kmp.gradle.kts

@@ -15,10 +15,17 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinNativeLink
 plugins {
     id("ktorbuild.base")
     kotlin("multiplatform")
-    id("org.jetbrains.kotlinx.atomicfu")
     id("ktorbuild.codestyle")
 }
 
+// atomicfu gradle plugin is not compatible with Android KMP plugin
+// see https://github.com/Kotlin/kotlinx-atomicfu/issues/511
+if (!project.hasAndroidPlugin()) {
+    plugins {
+        id("org.jetbrains.kotlinx.atomicfu")
+    }
+}
+
 kotlin {
     jvmToolchain(KtorBuildExtension.DEFAULT_JDK)
     explicitApi()
@@ -31,7 +38,7 @@ kotlin {
     }
 
     applyHierarchyTemplate(KtorTargets.hierarchyTemplate)
-    addTargets(ktorBuild.targets)
+    addTargets(ktorBuild.targets, ktorBuild.isCI.get())
 }
 
 val targets = ktorBuild.targets
@@ -40,6 +47,7 @@ configureCommon()
 if (targets.hasJvm) configureJvm()
 if (targets.hasJs) configureJs()
 if (targets.hasWasmJs) configureWasmJs()
+if (targets.hasAndroidJvm && project.hasAndroidPlugin()) configureAndroidJvm()
 
 if (targets.hasJsOrWasmJs) {
     tasks.configureEach {
@@ -66,10 +74,10 @@ if (targets.hasNative) {
 
     // A workaround for KT-70915
     tasks.withType<KotlinNativeLink>()
-        .configureEach { withLimitedParallelism("native-link", maxParallelTasks = 1) }
+        .configureEach { withLimitedParallelism("native-tools", maxParallelTasks = 3) }
     // A workaround for KT-77609
     tasks.matching { it::class.simpleName?.startsWith("CInteropCommonizerTask") == true }
-        .configureEach { withLimitedParallelism("cinterop-commonizer", maxParallelTasks = 1) }
+        .configureEach { withLimitedParallelism("native-tools", maxParallelTasks = 3) }
 }
 
 if (ktorBuild.isCI.get()) configureTestTasksOnCi()

build-logic/src/main/kotlin/ktorbuild/internal/publish/PublishTasks.kt

@@ -17,6 +17,7 @@ import org.gradle.kotlin.dsl.withType
 
 private val jvmAndCommonPublications = setOf(
     "jvm",
+    "android",
     "androidRelease",
     "androidDebug",
     "metadata",

build-logic/src/main/kotlin/ktorbuild/targets/AndroidConfig.kt

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014-2025 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package ktorbuild.targets
+
+import com.android.build.api.dsl.KotlinMultiplatformAndroidLibraryTarget
+import org.gradle.api.Project
+import ktorbuild.internal.kotlin
+import org.gradle.kotlin.dsl.invoke
+import ktorbuild.internal.libs
+
+internal fun Project.hasAndroidPlugin(): Boolean {
+    return plugins.hasPlugin("com.android.kotlin.multiplatform.library")
+}
+
+@Suppress("UnstableApiUsage")
+internal fun KotlinMultiplatformAndroidLibraryTarget.addTests(targets: KtorTargets, allowDeviceTest: Boolean) {
+    if (targets.isEnabled("android.unitTest")) {
+        withHostTest {}
+    }
+    if (allowDeviceTest && targets.isEnabled("android.deviceTest")) {
+        withDeviceTestBuilder {
+            // make it depend on a commonTest
+            sourceSetTreeName = "test"
+        }.configure {
+            // androidx.test.runner should be installed
+            instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        }
+    }
+}
+
+internal fun Project.configureAndroidJvm() {
+    kotlin {
+        sourceSets {
+            androidMain {
+                // should be added automatically, but fails with the new Android KMP plugin
+                dependsOn(commonMain.get())
+            }
+
+            this.findByName("androidDeviceTest")?.apply {
+                // should be added automatically, but fails with the new Android KMP plugin
+                dependsOn(commonTest.get())
+                dependencies {
+                    implementation(libs.androidx.core)
+                    implementation(libs.androidx.runner)
+                }
+            }
+        }
+    }
+}

build-logic/src/main/kotlin/ktorbuild/targets/KtorTargets.kt

@@ -6,6 +6,7 @@
 
 package ktorbuild.targets
 
+import com.android.build.api.dsl.androidLibrary
 import ktorbuild.internal.KotlinHierarchyTracker
 import ktorbuild.internal.TrackedKotlinHierarchyTemplate
 import ktorbuild.internal.gradle.ProjectGradleProperties
@@ -50,6 +51,12 @@ import javax.inject.Inject
  * target.wasmJs.browser=false
  * ```
  *
+ * Android JVM tests could be also configured
+ * ```properties
+ * target.android.unitTest=false
+ * target.android.deviceTest=false
+ * ```
+ *
  * See the full list of targets and target groups in [KtorTargets.hierarchyTemplate].
  */
 abstract class KtorTargets internal constructor(
@@ -76,6 +83,7 @@ abstract class KtorTargets internal constructor(
     val hasJvm: Boolean get() = isEnabled("jvm")
     val hasJs: Boolean get() = isEnabled("js")
     val hasWasmJs: Boolean get() = isEnabled("wasmJs")
+    val hasAndroidJvm: Boolean get() = isEnabled("android")
 
     val hasJsOrWasmJs: Boolean get() = hasJs || hasWasmJs
     val hasNative: Boolean get() = resolveTargets("posix").any(::isEnabled)
@@ -174,6 +182,8 @@ abstract class KtorTargets internal constructor(
                     group("linux")
                     group("androidNative")
                 }
+
+                withAndroidTarget()
             }
         }
 
@@ -182,8 +192,12 @@ abstract class KtorTargets internal constructor(
     }
 }
 
-internal fun KotlinMultiplatformExtension.addTargets(targets: KtorTargets) {
+internal fun KotlinMultiplatformExtension.addTargets(targets: KtorTargets, isCI: Boolean) {
     if (targets.hasJvm) jvm()
+    if (targets.hasAndroidJvm && project.hasAndroidPlugin()) {
+        // device tests are not configured on the CI yet
+        androidLibrary { addTests(targets, allowDeviceTest = !isCI) }
+    }
 
     if (targets.hasJs) js { addSubTargets(targets) }
     @OptIn(ExperimentalWasmDsl::class)

build-settings-logic/build.gradle.kts

@@ -14,6 +14,7 @@ plugins {
 
 dependencies {
     implementation(libs.kotlin.gradlePlugin)
+    implementation(libs.android.kmp.library)
     implementation(libs.develocity)
     implementation(libs.develocity.commonCustomUserData)
 }

build-settings-logic/settings.gradle.kts

@@ -21,6 +21,7 @@ dependencyResolutionManagement {
     }
 
     repositories {
+        google()
         gradlePluginPortal()
 
         // Should be in sync with ktorsettings.kotlin-user-project

build-settings-logic/src/main/kotlin/ktorsettings.dependency-resolution-management.settings.gradle.kts

@@ -24,12 +24,17 @@ dependencyResolutionManagement {
 
             downgradeTestDependencies()
         }
+
+        create("kotlinWrappers") {
+            from("org.jetbrains.kotlin-wrappers:kotlin-wrappers-catalog:2025.7.10")
+        }
     }
 }
 
 private fun RepositoryHandler.configureRepositories() {
     google {
         content {
+            includeGroupAndSubgroups("androidx")
             includeGroupAndSubgroups("com.google")
             includeGroupAndSubgroups("com.android")
         }