Restore Android compatibility in Executor.asCoroutineDispatcher (#4396)

An Android compatibility trick was removed in #4196,
and animal-sniffer was misconfigured and didn't catch that.
With this change, animal-sniffer works once again,
and the trick is restored.

Author: dkhalanskyjb

build.gradle.kts

@@ -95,7 +95,19 @@ allprojects {
 }
 
 // needs to be before evaluationDependsOn due to weird Gradle ordering
-apply(plugin = "animalsniffer-conventions")
+configure(subprojects) {
+    fun Project.shouldSniff(): Boolean =
+        platformOf(project) == "jvm" && project.name !in unpublished && project.name !in sourceless
+            && project.name !in androidNonCompatibleProjects
+    // Skip JDK 8 projects or unpublished ones
+    if (shouldSniff()) {
+        if (isMultiplatform) {
+            apply(plugin = "animalsniffer-multiplatform-conventions")
+        } else {
+            apply(plugin = "animalsniffer-jvm-conventions")
+        }
+    }
+}
 
 configure(subprojects.filter { !sourceless.contains(it.name) }) {
     if (isMultiplatform) {
@@ -157,4 +169,3 @@ rootProject.registerTopLevelDeployTask()
 
 // Report Kotlin compiler version when building project
 println("Using Kotlin compiler version: ${KotlinCompilerVersion.VERSION}")
-

buildSrc/src/main/kotlin/AuxBuildConfiguration.kt

@@ -13,7 +13,6 @@ object AuxBuildConfiguration {
     @JvmStatic
     fun configure(rootProject: Project) {
         rootProject.allprojects {
-            workaroundForCleanTask()
             CacheRedirector.configure(this)
             workaroundForCoroutinesLeakageToClassPath()
         }
@@ -27,18 +26,6 @@ object AuxBuildConfiguration {
         }
     }
 
-    private fun Project.workaroundForCleanTask() {
-        // the 'clean' task cannot delete expanded.lock file on Windows as it is still held by Gradle, failing the build
-        // Gradle issue: https://github.com/gradle/gradle/issues/25752
-        tasks {
-            val clean by existing(Delete::class) {
-                setDelete(fileTree(layout.buildDirectory) {
-                    exclude("tmp/.cache/expanded/expanded.lock")
-                })
-            }
-        }
-    }
-
     /*
      * 'kotlinx-coroutines-core' dependency leaks into test runtime classpath via 'kotlin-compiler-embeddable'
      * and conflicts with our own test/runtime incompatibilities (e.g. when class is moved from a main to test),

buildSrc/src/main/kotlin/animalsniffer-conventions.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("ru.vyarus.animalsniffer")
+}
+
+project.plugins.withType(JavaPlugin::class.java) {
+    val signature: Configuration by configurations
+    dependencies {
+        signature("net.sf.androidscents.signature:android-api-level-14:4.0_r4@signature")
+        signature("org.codehaus.mojo.signature:java17:1.0@signature")
+    }
+}

buildSrc/src/main/kotlin/animalsniffer-jvm-conventions.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("ru.vyarus.animalsniffer")
+}
+
+project.plugins.withType(KotlinMultiplatformConventionsPlugin::class.java) {
+    val signature: Configuration by configurations
+    dependencies {
+        signature("net.sf.androidscents.signature:android-api-level-14:4.0_r4@signature")
+        signature("org.codehaus.mojo.signature:java17:1.0@signature")
+    }
+}

buildSrc/src/main/kotlin/animalsniffer-multiplatform-conventions.gradle.kts

@@ -28,7 +28,7 @@ jna_version=5.9.0
 
 # Gradle
 jdk_toolchain_version=11
-animalsniffer_version=1.7.1
+animalsniffer_version=2.0.0
 
 # Android versions
 android_version=4.1.1.4

gradle.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip
+distributionSha256Sum=fba8464465835e74f7270bbf43d6d8a8d7709ab0a43ce1aa3323f73e9aa0c612
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.jar

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -84,7 +86,7 @@ done
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
 # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
-APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -203,7 +205,7 @@ fi
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Collect all arguments for the java command:
-#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
 #     and any embedded shellness will be escaped.
 #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
 #     treated as '${Hostname}' itself on the command line.

gradle/wrapper/gradle-wrapper.properties

@@ -13,6 +13,8 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
 @if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
@@ -43,11 +45,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -57,11 +59,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

gradlew

@@ -1,4 +1,5 @@
 import org.gradle.api.publish.maven.internal.publication.DefaultMavenPublication
+import java.util.Locale
 
 plugins {
     id("java-platform")
@@ -38,7 +39,9 @@ publishing {
         forEach { pub ->
             pub as DefaultMavenPublication
             pub.unsetModuleDescriptorGenerator()
-            tasks.matching { it.name == "generateMetadataFileFor${pub.name.capitalize()}Publication" }.all {
+            tasks.matching {
+                it.name == "generateMetadataFileFor${ pub.name.replaceFirstChar { it.uppercaseChar() } }Publication"
+            }.all {
                 onlyIf { false }
             }
         }

gradlew.bat

@@ -1,11 +1,13 @@
 import org.gradle.api.tasks.testing.*
 import org.gradle.kotlin.dsl.*
+import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
 import org.jetbrains.kotlin.gradle.plugin.mpp.*
 import org.jetbrains.kotlin.gradle.targets.native.tasks.*
 import org.jetbrains.kotlin.gradle.tasks.*
 import org.jetbrains.kotlin.gradle.testing.*
+import ru.vyarus.gradle.plugin.animalsniffer.AnimalSniffer
 
 plugins {
     kotlin("multiplatform")
@@ -84,11 +86,6 @@ kotlin {
             }
         }
     }
-
-    jvm {
-        // For animal sniffer
-        withJava()
-    }
 }
 
 private fun KotlinMultiplatformExtension.setupBenchmarkSourceSets(ss: NamedDomainObjectContainer<KotlinSourceSet>) {
@@ -293,3 +290,19 @@ artifacts {
 tasks.named("dokkaHtmlPartial") {
     dependsOn(jvmJar)
 }
+
+// Specific files so nothing from core is accidentally skipped
+tasks.withType<AnimalSniffer> {
+    exclude("**/future/FutureKt*")
+    exclude("**/future/ContinuationHandler*")
+    exclude("**/future/CompletableFutureCoroutine*")
+
+    exclude("**/stream/StreamKt*")
+    exclude("**/stream/StreamFlow*")
+
+    exclude("**/time/TimeKt*")
+}
+
+animalsniffer {
+    defaultTargets = setOf("jvmMain")
+}

kotlinx-coroutines-bom/build.gradle.kts

@@ -117,12 +117,13 @@ private class DispatcherExecutor(@JvmField val dispatcher: CoroutineDispatcher)
 
 internal class ExecutorCoroutineDispatcherImpl(override val executor: Executor) : ExecutorCoroutineDispatcher(), Delay {
 
+    /*
+     * Attempts to reflectively (to be Java 6 compatible) invoke
+     * ScheduledThreadPoolExecutor.setRemoveOnCancelPolicy in order to cleanup
+     * internal scheduler queue on cancellation.
+     */
     init {
-        /* Attempt to invoke ScheduledThreadPoolExecutor.setRemoveOnCancelPolicy in order to clean up
-         * the internal scheduler queue on cancellation. */
-        if (executor is ScheduledThreadPoolExecutor) {
-            executor.removeOnCancelPolicy = true
-        }
+        removeFutureOnCancel(executor)
     }
 
     override fun dispatch(context: CoroutineContext, block: Runnable) {

kotlinx-coroutines-core/build.gradle.kts

@@ -1,6 +1,9 @@
 package kotlinx.coroutines.internal
 
+import java.lang.reflect.Method
 import java.util.*
+import java.util.concurrent.Executor
+import java.util.concurrent.ScheduledThreadPoolExecutor
 import kotlin.concurrent.withLock as withLockJvm
 
 internal actual typealias ReentrantLock = java.util.concurrent.locks.ReentrantLock
@@ -18,3 +21,22 @@ internal actual annotation class BenignDataRace()
 @Suppress("NOTHING_TO_INLINE") // So that R8 can completely remove ConcurrentKt class
 internal actual inline fun <E> identitySet(expectedSize: Int): MutableSet<E> =
     Collections.newSetFromMap(IdentityHashMap(expectedSize))
+
+private val REMOVE_FUTURE_ON_CANCEL: Method? = try {
+    ScheduledThreadPoolExecutor::class.java.getMethod("setRemoveOnCancelPolicy", Boolean::class.java)
+} catch (_: Throwable) {
+    null
+}
+
+/* We can not simply call `setRemoveOnCancelPolicy`, even though the code would compile and tests would pass,
+ * because older Android versions don't support it. */
+@Suppress("NAME_SHADOWING")
+internal fun removeFutureOnCancel(executor: Executor): Boolean {
+    try {
+        val executor = executor as? ScheduledThreadPoolExecutor ?: return false
+        (REMOVE_FUTURE_ON_CANCEL ?: return false).invoke(executor, true)
+        return true
+    } catch (_: Throwable) {
+        return false // failed to setRemoveOnCancelPolicy, assume it does not remove the future on cancel
+    }
+}

kotlinx-coroutines-core/jvm/src/Executors.kt

@@ -1,5 +1,4 @@
-import org.jetbrains.kotlin.gradle.plugin.mpp.*
-import org.jetbrains.kotlin.gradle.targets.js.dsl.*
+import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
 
 kotlin {
     sourceSets {

kotlinx-coroutines-core/jvm/src/internal/Concurrent.kt

@@ -18,7 +18,7 @@ tasks.withType(DokkaTaskPartial::class) {
 
 val testNG by tasks.registering(Test::class) {
     useTestNG()
-    reports.html.outputLocation = file("$buildDir/reports/testng")
+    reports.html.outputLocation = file("${layout.buildDirectory.get()}/reports/testng")
     include("**/*ReactiveStreamTckTest.*")
     // Skip testNG when tests are filtered with --tests, otherwise it simply fails
     onlyIf {
@@ -32,5 +32,5 @@ val testNG by tasks.registering(Test::class) {
 
 val test by tasks.getting(Test::class) {
     dependsOn(testNG)
-    reports.html.outputLocation = file("$buildDir/reports/junit")
+    reports.html.outputLocation = file("${layout.buildDirectory.get()}/reports/junit")
 }

kotlinx-coroutines-test/build.gradle.kts

@@ -18,7 +18,7 @@ tasks.withType(DokkaTaskPartial::class) {
 
 val testNG by tasks.registering(Test::class) {
     useTestNG()
-    reports.html.outputLocation = file("$buildDir/reports/testng")
+    reports.html.outputLocation = file("${layout.buildDirectory.get()}/reports/testng")
     include("**/*ReactiveStreamTckTest.*")
     // Skip testNG when tests are filtered with --tests, otherwise it simply fails
     onlyIf {
@@ -32,5 +32,5 @@ val testNG by tasks.registering(Test::class) {
 
 val test by tasks.getting(Test::class) {
     dependsOn(testNG)
-    reports.html.outputLocation = file("$buildDir/reports/junit")
+    reports.html.outputLocation = file("${layout.buildDirectory.get()}/reports/junit")
 }