Check NodeJs and D8 versions before adding --experimental-wasm-gc (#213)

Starting from version 22, NodeJS is shipped with the V8 
that no longer accepts --experimental-wasm-gc flag.
The option disappeared from V8 somewhere around 12.3.68.

To avoid errors when running benchmarks with recent
NodeJS/D8 version, plugin now checks runtime's version and
appends  --experimental-wasm-gc flag only when needed.

Closes #212

Author: fzhinkin

integration/src/main/kotlin/kotlinx/benchmark/integration/ProjectBuilder.kt

@@ -4,6 +4,8 @@ class ProjectBuilder {
     private val configurations = mutableMapOf<String, BenchmarkConfiguration>()
     private val targets = mutableMapOf<String, BenchmarkTarget>()
 
+    var kotlinVersion: String = System.getProperty("kotlin_version")
+
     fun configuration(name: String, configuration: BenchmarkConfiguration.() -> Unit = {}) {
         configurations[name] = BenchmarkConfiguration().apply(configuration)
     }
@@ -25,15 +27,15 @@ benchmark {
 }
             """.trimIndent()
 
-        return buildScript + "\n\n" + original + "\n\n" + script
+        return generateBuildScript(kotlinVersion) + "\n\n" + original + "\n\n" + script
     }
 }
 
 private val kotlin_repo = System.getProperty("kotlin_repo_url").let {
     if (it.isNullOrBlank()) "" else "maven { url '$it' }"
 }
 
-private val buildScript =
+private fun generateBuildScript(kotlinVersion: String) =
     """
     buildscript {
         repositories {
@@ -42,7 +44,7 @@ private val buildScript =
             mavenCentral()
         }
         dependencies {
-            classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:${System.getProperty("kotlin_version")}'
+            classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion'
             classpath 'org.jetbrains.kotlinx:kotlinx-benchmark-plugin:0.5.0-SNAPSHOT'
         }
     }

integration/src/test/kotlin/kotlinx/benchmark/integration/GradleTest.kt

@@ -21,9 +21,12 @@ abstract class GradleTest {
         name: String,
         print: Boolean = false,
         gradleVersion: GradleTestVersion? = null,
+        kotlinVersion: String? = null,
         build: ProjectBuilder.() -> Unit = {}
     ): Runner {
-        val builder = ProjectBuilder().apply(build)
+        val builder = ProjectBuilder().apply {
+            kotlinVersion?.let { this.kotlinVersion = it }
+        }.apply(build)
         templates.resolve(name).copyRecursively(rootProjectDir)
         file("build.gradle").modify(builder::build)
         val settingsFile = file("settings.gradle")

integration/src/test/kotlin/kotlinx/benchmark/integration/WasmGcOptionsTest.kt

@@ -0,0 +1,25 @@
+package kotlinx.benchmark.integration
+
+import org.junit.Test
+
+class WasmGcOptionsTest : GradleTest() {
+    @Test
+    fun nodeJs() {
+        // The test uses Kotlin 1.9.24 as previous versions
+        // would append the --experimental-wasm-gc flag causing run failures.
+        val runner = project(
+            "wasm-gc-non-experimental/wasm-nodejs", true, kotlinVersion = "1.9.24"
+        )
+        runner.run("wasmJsBenchmark")
+    }
+
+    @Test
+    fun d8() {
+        // The test uses Kotlin 1.9.24 as previous versions
+        // would append the --experimental-wasm-gc flag causing run failures.
+        val runner = project(
+            "wasm-gc-non-experimental/wasm-d8", true, kotlinVersion = "1.9.24"
+        )
+        runner.run( "wasmJsBenchmark")
+    }
+}

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-d8/build.gradle

@@ -0,0 +1,25 @@
+import org.jetbrains.kotlin.gradle.targets.js.d8.D8RootExtension
+
+kotlin {
+    wasm('wasmJs') {
+        d8()
+    }
+
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.5.0-SNAPSHOT")
+            }
+        }
+        wasmJsMain {
+        }
+    }
+}
+
+benchmark {
+    targets {
+        register("wasmJs")
+    }
+}
+
+rootProject.extensions.getByType(D8RootExtension).version = "12.6.99"

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-d8/gradle.properties

@@ -0,0 +1 @@
+org.gradle.jvmargs=-Xmx2g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-d8/src/commonMain/kotlin/CommonBenchmark.kt

@@ -0,0 +1,15 @@
+package test
+
+import kotlinx.benchmark.*
+import kotlin.math.*
+
+@State(Scope.Benchmark)
+@Measurement(iterations = 3, time = 1, timeUnit = BenchmarkTimeUnit.SECONDS)
+@OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS)
+@BenchmarkMode(Mode.Throughput)
+open class CommonBenchmark {
+    @Benchmark
+    open fun mathBenchmark(): Double {
+        return log(sqrt(3.0) * cos(3.0), 2.0)
+    }
+}

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-nodejs/build.gradle

@@ -0,0 +1,25 @@
+import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension
+
+kotlin {
+    wasm('wasmJs') {
+        nodejs()
+    }
+
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation("org.jetbrains.kotlinx:kotlinx-benchmark-runtime:0.5.0-SNAPSHOT")
+            }
+        }
+        wasmJsMain {
+        }
+    }
+}
+
+benchmark {
+    targets {
+        register("wasmJs")
+    }
+}
+
+rootProject.extensions.getByType(NodeJsRootExtension).nodeVersion = "22.1.0"

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-nodejs/gradle.properties

@@ -0,0 +1 @@
+org.gradle.jvmargs=-Xmx2g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8

integration/src/test/resources/templates/wasm-gc-non-experimental/wasm-nodejs/src/commonMain/kotlin/CommonBenchmark.kt

@@ -0,0 +1,15 @@
+package test
+
+import kotlinx.benchmark.*
+import kotlin.math.*
+
+@State(Scope.Benchmark)
+@Measurement(iterations = 3, time = 1, timeUnit = BenchmarkTimeUnit.SECONDS)
+@OutputTimeUnit(BenchmarkTimeUnit.MILLISECONDS)
+@BenchmarkMode(Mode.Throughput)
+open class CommonBenchmark {
+    @Benchmark
+    open fun mathBenchmark(): Double {
+        return log(sqrt(3.0) * cos(3.0), 2.0)
+    }
+}

plugin/main/src/kotlinx/benchmark/gradle/JsEngineExecTasks.kt

@@ -6,8 +6,10 @@ import org.gradle.api.*
 import org.gradle.api.file.RegularFile
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.TaskProvider
+import org.gradle.util.internal.VersionNumber
 import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
 import org.jetbrains.kotlin.gradle.targets.js.d8.D8Exec
+import org.jetbrains.kotlin.gradle.targets.js.d8.D8RootExtension
 import org.jetbrains.kotlin.gradle.targets.js.dsl.*
 import org.jetbrains.kotlin.gradle.targets.js.ir.*
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.*
@@ -65,7 +67,7 @@ private fun Project.getExecutableFile(compilation: KotlinJsIrCompilation): Provi
 private val KotlinJsIrCompilation.isWasmCompilation: Boolean get() =
     target.platformType == KotlinPlatformType.wasm
 
-private fun MutableList<String>.addWasmArguments() {
+private fun MutableList<String>.addWasmGcArguments() {
     add("--experimental-wasm-gc")
 }
 
@@ -86,7 +88,15 @@ private fun Project.createNodeJsExec(
     inputFileProperty.set(getExecutableFile(compilation))
     with(nodeArgs) {
         if (compilation.isWasmCompilation) {
-            addWasmArguments()
+            val addGcArgs = rootProject.extensions.findByType(NodeJsRootExtension::class.java)?.let {
+                val nodeVersion = VersionNumber.parse(it.nodeVersion)
+                // Starting from version 22, NodeJS is shipped with V8 versions
+                // that no longer accept --experimental-wasm-gc argument.
+                nodeVersion.major < 22
+            } ?: true
+            if (addGcArgs) {
+                addWasmGcArguments()
+            }
         } else {
             addJsArguments()
         }
@@ -106,7 +116,14 @@ private fun Project.createD8Exec(
     description = "Executes benchmark for '${target.name}' with D8"
     inputFileProperty.set(getExecutableFile(compilation))
     if (compilation.isWasmCompilation) {
-        d8Args.addWasmArguments()
+        val addGcArgs = rootProject.extensions.findByType(D8RootExtension::class.java)?.let {
+            val d8Version = VersionNumber.parse(it.version)
+            // --experimental-wasm-gc flag was removed from V8 starting from ~ 12.3.68
+            d8Version < VersionNumber(12, 3, 68, null)
+        } ?: true
+        if (addGcArgs) {
+            d8Args.addWasmGcArguments()
+        }
     }
     val reportFile = setupReporting(target, config)
     args(writeParameters(target.name, reportFile, traceFormat(), config))