Simplify gradle web wasm build (#1089)

Following changes introduced in this PR:
* jsWasmMain and jsWasmTest sourcesets renamed to webMain and webTest
(it causes less confusion, regarding the fact that we already have
wasmJsMain, apart from that, this would be a standard name for this
sourceset in webMain)
* remove redunant resource processing (there's yet room for improvement
though)
   * Simplify wasm task introduction
* Remove flag for building js separately from wasm (this flag was a lie
- we can not have separate js target)

skiko/build.gradle.kts

@@ -81,14 +81,14 @@ kotlin {
         }
     }
 
-    val linkWasmTask = skikoProjectContext.createWasmLinkTask()
 
-    if (supportJs) {
-        js(IR) {
+    if (supportWeb) {
+        skikoProjectContext.declareWasmTasks()
+
+        js {
             moduleName = "skiko-kjs" // override the name to avoid name collision with a different skiko.js file
             browser {
                 testTask {
-                    dependsOn(linkWasmTask!!)
                     useKarma {
                         useChromeHeadless()
                         useConfigDirectory(project.projectDir.resolve("karma.config.d").resolve("js"))
@@ -101,32 +101,19 @@ kotlin {
             val test by compilations.getting
 
             project.tasks.named<Copy>(test.processResourcesTaskName) {
-                from(linkWasmTask!!) {
-                    include("*.mjs")
-                    include("*.wasm")
-                }
-
-                from(wasmImports) {
-                    include("*.mjs")
-                }
-
                 dependsOn(test.compileTaskProvider, tasks["compileTestKotlinWasmJs"])
             }
 
             setupImportsGeneratorPlugin()
         }
-    }
 
-    if (supportWasm) {
 
         @OptIn(ExperimentalWasmDsl::class)
         wasmJs {
             moduleName = "skiko-kjs-wasm" // override the name to avoid name collision with a different skiko.js file
             browser {
                 testTask {
-                    dependsOn(linkWasmTask!!)
                     useKarma {
-                        this.webpackConfig.experiments.add("topLevelAwait")
                         useChromeHeadless()
                         useConfigDirectory(project.projectDir.resolve("karma.config.d").resolve("wasm"))
                     }
@@ -137,13 +124,6 @@ kotlin {
             val test by compilations.getting
 
             project.tasks.named<Copy>(test.processResourcesTaskName) {
-                from(linkWasmTask!!) {
-                    include("*.mjs")
-                    include("*.wasm")
-                }
-
-                from(skikoTestMjs)
-
                 dependsOn(test.compileTaskProvider, tasks["compileTestKotlinJs"])
             }
 
@@ -237,7 +217,7 @@ kotlin {
             }
         }
 
-        if (supportJs || supportWasm || supportAnyNative) {
+        if (supportWeb || supportAnyNative) {
             val nativeJsMain by creating {
                 dependsOn(commonMain)
             }
@@ -246,38 +226,41 @@ kotlin {
                 dependsOn(commonTest)
             }
 
-            if (supportJs || supportWasm) {
-                val jsWasmMain by creating {
+            if (supportWeb) {
+                val webMain by creating {
                     dependsOn(nativeJsMain)
                 }
 
-                val jsWasmTest by creating {
+                val webTest by creating {
                     dependsOn(nativeJsTest)
+
+                    resources.srcDirs(
+                        tasks.named("linkWasm"),
+                        wasmImports
+                    )
                 }
 
-                if (supportJs) {
                 val jsMain by getting {
-                        dependsOn(jsWasmMain)
+                    dependsOn(webMain)
                 }
 
                 val jsTest by getting {
-                        dependsOn(jsWasmTest)
-                    }
+                    dependsOn(webTest)
+
                 }
 
-                if (supportWasm) {
                 val wasmJsMain by getting {
-                        dependsOn(jsWasmMain)
+                    dependsOn(webMain)
                 }
+
                 val wasmJsTest by getting {
-                        dependsOn(jsWasmTest)
+                    dependsOn(webTest)
 
                     dependencies {
                         implementation(kotlin("test-wasm-js"))
                     }
                 }
             }
-            }
 
             if (supportAnyNative) {
                 all {
@@ -597,7 +580,7 @@ publishing {
             }
         }
 
-        if (supportJs || supportWasm) {
+        if (supportWeb) {
             create<MavenPublication>("skikoWasmRuntime") {
                 pomNameForPublication[name] = "Skiko WASM Runtime"
                 artifactId = SkikoArtifacts.jsWasmArtifactId

skiko/buildSrc/src/main/kotlin/SkikoProjectContext.kt

@@ -148,12 +148,9 @@ val Project.supportNativeLinux: Boolean
 val Project.supportAnyNative: Boolean
     get() = supportAllNative || supportAnyNativeIos || supportNativeMac || supportNativeLinux
 
-val Project.supportWasm: Boolean
+val Project.supportWeb: Boolean
     get() = findProperty("skiko.wasm.enabled") == "true" || isInIdea
 
-val Project.supportJs: Boolean
-    get() = findProperty("skiko.js.enabled") == "true" || supportWasm || isInIdea
-
 fun Project.skiaVersion(target: String): String {
     val platformSpecificVersion = "dependencies.skia.$target"
 

skiko/buildSrc/src/main/kotlin/tasks/configuration/CommonTasksConfiguration.kt

@@ -6,12 +6,11 @@ import SkiaBuildType
 import SkikoProperties
 import org.gradle.api.DefaultTask
 import org.gradle.api.Project
-import org.gradle.kotlin.dsl.get
 import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompileTool
 import registerSkikoTask
 import supportAndroid
-import supportWasm
+import supportWeb
 import toTitleCase
 import java.io.File
 import skiaVersion
@@ -113,7 +112,7 @@ fun skiaPreprocessorFlags(os: OS, buildType: SkiaBuildType): Array<String> {
 }
 
 fun Project.configureSignAndPublishDependencies() {
-    if (supportWasm) {
+    if (supportWeb) {
         tasks.configureEach {
             val publishJs = "publishJsPublicationTo"
             val publishWasm = "publishSkikoWasmRuntimePublicationTo"

skiko/buildSrc/src/main/kotlin/tasks/configuration/WasmTasksConfiguration.kt

@@ -10,7 +10,6 @@ import compilerForTarget
 import linkerForTarget
 import org.gradle.api.Project
 import org.gradle.api.provider.Provider
-import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.bundling.Jar
 import org.gradle.kotlin.dsl.get
 import org.gradle.kotlin.dsl.getValue
@@ -24,37 +23,34 @@ import registerOrGetSkiaDirProvider
 import setupMjs
 import setupReexportMjs
 import skikoTestMjs
-import supportJs
-import supportWasm
+import supportWeb
 import java.io.File
 
-fun SkikoProjectContext.createWasmLinkTask(): TaskProvider<LinkSkikoWasmTask>? = with(this.project) {
-    if (!supportWasm && !supportJs) {
-        return null
+fun SkikoProjectContext.declareWasmTasks() {
+    if (!project.supportWeb) {
+        return
     }
 
     val skiaWasmDir = registerOrGetSkiaDirProvider(OS.Wasm, Arch.Wasm, false)
-    val compileWasm by tasks.registering(CompileSkikoCppTask::class) {
-        val osArch = OS.Wasm to Arch.Wasm
-
+    val compileWasm by project.tasks.registering(CompileSkikoCppTask::class) {
         dependsOn(skiaWasmDir)
 
         compiler.set(compilerForTarget(OS.Wasm, Arch.Wasm, isJvm = false))
-        buildTargetOS.set(osArch.first)
-        buildTargetArch.set(osArch.second)
+        buildTargetOS.set(OS.Wasm)
+        buildTargetArch.set(Arch.Wasm)
         buildVariant.set(buildType)
 
-        val srcDirs = projectDirs("src/commonMain/cpp/common", "src/jsWasmMain/cpp", "src/nativeJsMain/cpp") +
+        val srcDirs = projectDirs("src/commonMain/cpp/common", "src/webMain/cpp", "src/nativeJsMain/cpp") +
                 if (skiko.includeTestHelpers) projectDirs("src/nativeJsTest/cpp") else emptyList()
         sourceRoots.set(srcDirs)
 
-        includeHeadersNonRecursive(projectDir.resolve("src/nativeJsMain/cpp"))
-        includeHeadersNonRecursive(projectDir.resolve("src/jsWasmMain/cpp"))
-        includeHeadersNonRecursive(projectDir.resolve("src/commonMain/cpp/common/include"))
+        includeHeadersNonRecursive(project.projectDir.resolve("src/nativeJsMain/cpp"))
+        includeHeadersNonRecursive(project.projectDir.resolve("src/webMain/cpp"))
+        includeHeadersNonRecursive(project.projectDir.resolve("src/commonMain/cpp/common/include"))
         includeHeadersNonRecursive(skiaHeadersDirs(skiaWasmDir.get()))
 
         flags.set(
-            mutableListOf<String?>().apply {
+            buildList {
                 addAll(skiaPreprocessorFlags(OS.Wasm, buildType))
                 addAll(buildType.clangFlags)
                 add("-fno-rtti")
@@ -64,38 +60,27 @@ fun SkikoProjectContext.createWasmLinkTask(): TaskProvider<LinkSkikoWasmTask>? =
         )
     }
 
-    val configureCommon: LinkSkikoWasmTask.(prefixPath: String, forD8: Boolean) -> Unit = { prefixPath, isForD8 ->
-        val osArch = OS.Wasm to Arch.Wasm
-
+    fun LinkSkikoWasmTask.configureCommon(prefixPath: String) {
         dependsOn(compileWasm)
         dependsOn(skiaWasmDir)
-        val unpackedSkia = skiaWasmDir.get()
 
         linker.set(linkerForTarget(OS.Wasm, Arch.Wasm, isJvm = false))
-        buildTargetOS.set(osArch.first)
-        buildTargetArch.set(osArch.second)
+        buildTargetOS.set(OS.Wasm)
+        buildTargetArch.set(Arch.Wasm)
         buildVariant.set(buildType)
-        if (isForD8) buildSuffix.set("d8") else buildSuffix.set("es6")
 
-        libFiles = project.fileTree(unpackedSkia) { include("**/*.a") }
+        libFiles = project.fileTree(skiaWasmDir.get()) { include("**/*.a") }
         objectFiles = project.fileTree(compileWasm.map { it.outDir.get() }) {
             include("**/*.o")
         }
 
-        val wasmFileName = if (isForD8) "skikod8.wasm" else "skiko.wasm"
-        val jsFileName = if (isForD8) "skikod8.mjs" else "skiko.mjs"
-
-        libOutputFileName.set(wasmFileName) // emcc ignores this, it names .wasm file identically to js output
-        jsOutputFileName.set(jsFileName) // this determines the name .wasm file too
-
         externPostJs.from(
             // the order matters
-            project.layout.projectDirectory.file("src/jsWasmMain/resources/skikoCallbacks.js"),
+            project.layout.projectDirectory.file("src/webMain/resources/skikoCallbacks.js"),
             project.layout.projectDirectory.file(prefixPath)
         )
 
-        @OptIn(kotlin.ExperimentalStdlibApi::class)
-        flags.set(mutableListOf<String?>().apply {
+        flags.addAll(buildList {
             addAll(
                 listOf(
                     "-l", "GL",
@@ -107,85 +92,79 @@ fun SkikoProjectContext.createWasmLinkTask(): TaskProvider<LinkSkikoWasmTask>? =
                     "-s", "MODULARIZE=1",
                     "-s", "EXPORT_NAME=loadSkikoWASM",
                     "-s", "EXPORTED_RUNTIME_METHODS=\"[GL, wasmExports]\"",
+                    "-s", "SUPPORT_LONGJMP=wasm",
                     "--bind",
                     // -O2 saves 800kB for the output file, and ~100kB for transferred size.
                     // -O3 breaks the exports in js/mjs files. skiko.wasm size is the same though
                     "-O2"
                 )
             )
-            addAll(listOf("-s", "SUPPORT_LONGJMP=wasm"))
-            if (isForD8) {
-                addAll(listOf("-s", "ENVIRONMENT=shell"))
-            }
 
             if (skiko.isWasmBuildWithProfiling) add("--profiling")
         })
 
         doLast {
-            // skiko.js (and skiko.mjs) files are directly referenced in karma.config.d/*/config.js
+            // skiko.mjs is referenced in karma.config.d/*/config.js
             // so symbols must be replaced right after linking
-            val jsFiles = outDir.asFile.get().walk()
-                .filter { it.isFile && (it.name.endsWith(".js") || it.name.endsWith(".mjs")) }
+            val jsFile = outDir.asFile.get().walk().first { it.name == jsOutputFileName.get() }
 
             val isEnvironmentNodeCheckRegex = Regex(
-                // spaces are different in release and debug builds
+                // spacing is different in release and debug builds
                 """if\s*\(ENVIRONMENT_IS_NODE\)\s*\{"""
             )
 
-            for (jsFile in jsFiles) {
             val originalContent = jsFile.readText()
-                val newContent = originalContent.replace("_org_jetbrains", "org_jetbrains")
-                    .replace("skikod8.wasm", "skiko.wasm")
+            val newContent = originalContent
                 .replace(isEnvironmentNodeCheckRegex, "if (false) {") // to make webpack erase this part
             jsFile.writeText(newContent)
-
-                if (isForD8) {
-                    // delete this file as its presence can be confusing.
-                    // It's identical to skiko.wasm and we use skiko.wasm in `skikoWasmJar`task
-                    outDir.file(wasmFileName).get().asFile.delete()
-
-                    val renameTo = "skikod8.mjs"
-                    outDir.file(jsFileName).get().asFile.renameTo(outDir.asFile.get().resolve(renameTo))
-                }
-            }
         }
     }
 
-    val linkWasm by tasks.registering(LinkSkikoWasmTask::class) {
+    val linkWasm by project.tasks.registering(LinkSkikoWasmTask::class) {
         dependsOn(
             kotlin.wasmJs().compilations["main"].compileTaskProvider,
             kotlin.js().compilations["main"].compileTaskProvider
         )
 
-        configureCommon(setupMjs.normalize().absolutePath, false)
+        buildSuffix.set("es6")
+        jsOutputFileName.set("skiko.mjs") // this determines the name .wasm file too
+        libOutputFileName.set("skiko.wasm")
+
+        configureCommon(project.setupMjs.normalize().absolutePath)
     }
 
-    val linkWasmD8WithES6 by tasks.registering(LinkSkikoWasmTask::class) {
+    val linkWasmD8WithES6 by project.tasks.registering(LinkSkikoWasmTask::class) {
         dependsOn(
             kotlin.wasmJs().compilations["main"].compileTaskProvider,
             kotlin.js().compilations["main"].compileTaskProvider
         )
-        configureCommon(setupMjs.normalize().absolutePath, true)
+
+        buildSuffix.set("d8")
+        jsOutputFileName.set("skikod8.mjs") // this determines the name .wasm file too
+        libOutputFileName.set("skikod8.wasm")
+
+        flags.addAll(listOf("-s", "ENVIRONMENT=shell"))
+
+        configureCommon(project.setupMjs.normalize().absolutePath)
     }
 
     // skikoWasmJar is used by task name
     val skikoWasmJar by project.tasks.registering(Jar::class) {
-        dependsOn(linkWasm)
         // We produce jar that contains .js of wrapper/bindings and .wasm with Skia + bindings.
-        val wasmEsOutDir = linkWasm.map { it.outDir }
-        val wasmD8OutDir = linkWasmD8WithES6.map { it.outDir }
-
-        from(setupReexportMjs.parentFile) {
-            include(setupReexportMjs.name)
+        from(project.setupReexportMjs.parentFile) {
+            include(project.setupReexportMjs.name)
         }
 
-        from(wasmEsOutDir) {
-            include("*.js")
+        from(linkWasm) {
             include("*.wasm")
             include("*.mjs")
         }
-        from(wasmD8OutDir) {
+
+        from(linkWasmD8WithES6) {
             include("*.mjs")
+            filesMatching("*.mjs") {
+                filter { it.replace("skikod8.wasm", "skiko.wasm") }
+            }
         }
 
         archiveBaseName.set("skiko-wasm")
@@ -193,8 +172,6 @@ fun SkikoProjectContext.createWasmLinkTask(): TaskProvider<LinkSkikoWasmTask>? =
             println("Wasm and JS at: ${archiveFile.get().asFile.absolutePath}")
         }
     }
-
-    return linkWasm
 }
 
 abstract class AbstractImportGeneratorCompilerPluginSupportPlugin(
@@ -235,14 +212,14 @@ abstract class AbstractImportGeneratorCompilerPluginSupportPlugin(
 class WasmImportsGeneratorCompilerPluginSupportPlugin : AbstractImportGeneratorCompilerPluginSupportPlugin(
     KotlinCompilation.MAIN_COMPILATION_NAME,
     { it.setupMjs },
-    { it.projectDir.resolve("src/jsWasmMain/resources/pre-setup.mjs") },
+    { it.projectDir.resolve("src/webMain/resources/pre-setup.mjs") },
     { it.setupReexportMjs }
 )
 
 class WasmImportsGeneratorForTestCompilerPluginSupportPlugin : AbstractImportGeneratorCompilerPluginSupportPlugin(
     KotlinCompilation.TEST_COMPILATION_NAME,
     { it.skikoTestMjs },
-    { it.projectDir.resolve("src/jsWasmMain/resources/pre-skiko-test.mjs") },
+    { it.projectDir.resolve("src/webMain/resources/pre-skiko-test.mjs") },
     null
 )