[gradle] Add a flag to disable multimodule resources. (#4771)

The Compose Multiplatform Resources with the mulimodule.publication support is a new feature and may have some not found problems. The PR introduces a gradle property to switch back to the previous behavior: `org.jetbrains.compose.resources.multimodule.disable=true` ## Testing After update to Kotlin 2.0.0 and CMP 1.6.10 all projects will be switched to the new logic with the multimodule support. Gradle info output should contain a message: ``` Configure KMP resources ``` If the new feature breaks user's projects they may add `org.jetbrains.compose.resources.multimodule.disable=true` to the `gradle.properties` to disable it. After that Gradle info output will contain: ``` Configure compose resources ``` ## Release Notes ### Resources To disable the Compose Resources publication and the multimodule support in cases of problems add `org.jetbrains.compose.resources.multimodule.disable=true` to the root `gradle.properties`.
JetBrains · May 8, 2024 · bf6142d · bf6142d
1 parent b6e7ba7
commit bf6142d
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 23 deletions.
diff --git a/...ain/kotlin/org/jetbrains/compose/desktop/application/internal/ComposeProjectProperties.kt b/...ain/kotlin/org/jetbrains/compose/desktop/application/internal/ComposeProjectProperties.kt
@@ -22,7 +22,7 @@ internal object ComposeProperties {
     internal const val MAC_NOTARIZATION_PASSWORD = "compose.desktop.mac.notarization.password"
     internal const val MAC_NOTARIZATION_TEAM_ID_PROVIDER = "compose.desktop.mac.notarization.teamID"
     internal const val CHECK_JDK_VENDOR = "compose.desktop.packaging.checkJdkVendor"
-    internal const val ALWAYS_GENERATE_RESOURCE_ACCESSORS = "compose.resources.always.generate.accessors"
+    internal const val DISABLE_MULTIMODULE_RESOURCES = "org.jetbrains.compose.resources.multimodule.disable"
     internal const val SYNC_RESOURCES_PROPERTY = "compose.ios.resources.sync"
 
     fun isVerbose(providers: ProviderFactory): Provider<Boolean> =
@@ -55,6 +55,9 @@ internal object ComposeProperties {
     fun checkJdkVendor(providers: ProviderFactory): Provider<Boolean> =
         providers.valueOrNull(CHECK_JDK_VENDOR).toBooleanProvider(true)
 
+    fun disableMultimoduleResources(providers: ProviderFactory): Provider<Boolean> =
+        providers.valueOrNull(DISABLE_MULTIMODULE_RESOURCES).toBooleanProvider(false)
+
     //providers.valueOrNull works only with root gradle.properties
     fun dontSyncResources(project: Project): Provider<Boolean> = project.provider {
         project.findProperty(SYNC_RESOURCES_PROPERTY)?.toString().equals("false", true)

diff --git a/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ComposeResources.kt b/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ComposeResources.kt
@@ -9,6 +9,7 @@ import org.gradle.api.tasks.SourceSet
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.util.GradleVersion
 import org.jetbrains.compose.ComposePlugin
+import org.jetbrains.compose.desktop.application.internal.ComposeProperties
 import org.jetbrains.compose.internal.KOTLIN_JVM_PLUGIN_ID
 import org.jetbrains.compose.internal.KOTLIN_MPP_PLUGIN_ID
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
@@ -41,23 +42,26 @@ private fun Project.onKgpApplied(config: Provider<ResourcesExtension>, kgp: Kotl
     val hasKmpResources = extraProperties.has(KMP_RES_EXT)
     val currentGradleVersion = GradleVersion.current()
     val minGradleVersion = GradleVersion.version(MIN_GRADLE_VERSION_FOR_KMP_RESOURCES)
-    val kmpResourcesAreAvailable = hasKmpResources && currentGradleVersion >= minGradleVersion
+    val disableMultimoduleResources = ComposeProperties.disableMultimoduleResources(providers).get()
+    val kmpResourcesAreAvailable = !disableMultimoduleResources && hasKmpResources && currentGradleVersion >= minGradleVersion
 
     if (kmpResourcesAreAvailable) {
         configureKmpResources(kotlinExtension, extraProperties.get(KMP_RES_EXT)!!, config)
     } else {
-        if (!hasKmpResources) logger.info(
-            """
-                Compose resources publication requires Kotlin Gradle Plugin >= 2.0
-                Current Kotlin Gradle Plugin is ${kgp.pluginVersion}
-            """.trimIndent()
-        )
-        if (currentGradleVersion < minGradleVersion) logger.info(
-            """
-                Compose resources publication requires Gradle >= $MIN_GRADLE_VERSION_FOR_KMP_RESOURCES
-                Current Gradle is ${currentGradleVersion.version}
-            """.trimIndent()
-        )
+        if (!disableMultimoduleResources) {
+            if (!hasKmpResources) logger.info(
+                """
+                    Compose resources publication requires Kotlin Gradle Plugin >= 2.0
+                    Current Kotlin Gradle Plugin is ${kgp.pluginVersion}
+                """.trimIndent()
+            )
+            if (currentGradleVersion < minGradleVersion) logger.info(
+                """
+                    Compose resources publication requires Gradle >= $MIN_GRADLE_VERSION_FOR_KMP_RESOURCES
+                    Current Gradle is ${currentGradleVersion.version}
+                """.trimIndent()
+            )
+        }
 
         val commonMain = KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME
         configureComposeResources(kotlinExtension, commonMain, config)

diff --git a/...ins/compose/src/test/kotlin/org/jetbrains/compose/test/tests/integration/ResourcesTest.kt b/...ins/compose/src/test/kotlin/org/jetbrains/compose/test/tests/integration/ResourcesTest.kt
@@ -1,6 +1,7 @@
 package org.jetbrains.compose.test.tests.integration
 
 import org.gradle.util.GradleVersion
+import org.jetbrains.compose.desktop.application.internal.ComposeProperties
 import org.jetbrains.compose.internal.utils.*
 import org.jetbrains.compose.resources.XmlValuesConverterTask
 import org.jetbrains.compose.test.utils.*
@@ -158,42 +159,50 @@ class ResourcesTest : GradlePluginTestBase() {
             check.logContains("${testXml.name} is not valid. Check the file content.")
         }
 
-        testXml.writeText("""
+        testXml.writeText(
+            """
             <resources>
                 <aaa name="v">aaa</aaa>
             </resources>
-        """.trimIndent())
+        """.trimIndent()
+        )
         gradleFailure("prepareKotlinIdeaImport").checks {
             check.logContains("${testXml.name} is not valid. Unknown resource type: 'aaa'.")
         }
 
-        testXml.writeText("""
+        testXml.writeText(
+            """
             <resources>
                 <drawable name="v">aaa</drawable>
             </resources>
-        """.trimIndent())
+        """.trimIndent()
+        )
         gradleFailure("prepareKotlinIdeaImport").checks {
             check.logContains("${testXml.name} is not valid. Unknown string resource type: 'drawable'.")
         }
 
-        testXml.writeText("""
+        testXml.writeText(
+            """
             <resources>
                 <string name="v1">aaa</string>
                 <string name="v2">aaa</string>
                 <string name="v3">aaa</string>
                 <string name="v1">aaa</string>
             </resources>
-        """.trimIndent())
+        """.trimIndent()
+        )
         gradleFailure("prepareKotlinIdeaImport").checks {
             check.logContains("${testXml.name} is not valid. Duplicated key 'v1'.")
         }
 
-        testXml.writeText("""
+        testXml.writeText(
+            """
             <resources>
                 <string name="v1">aaa</string>
                 <string foo="v2">aaa</string>
             </resources>
-        """.trimIndent())
+        """.trimIndent()
+        )
         gradleFailure("prepareKotlinIdeaImport").checks {
             check.logContains("${testXml.name} is not valid. Attribute 'name' not found.")
         }
@@ -219,7 +228,7 @@ class ResourcesTest : GradlePluginTestBase() {
     @Test
     fun testMultiModuleResources() {
         val environment = defaultTestEnvironment.copy(
-            kotlinVersion = "2.0.0-Beta5"
+            kotlinVersion = "2.0.0-RC2"
         )
         with(
             testProject("misc/kmpResourcePublication", environment)
@@ -232,6 +241,8 @@ class ResourcesTest : GradlePluginTestBase() {
             }
 
             gradle(":cmplib:publishAllPublicationsToMavenRepository").checks {
+                check.logContains("Configure KMP resources")
+
                 val resDir = file("cmplib/src/commonMain/composeResources")
                 val resourcesFiles = resDir.walkTopDown()
                     .filter { !it.isDirectory && !it.isHidden }
@@ -317,6 +328,22 @@ class ResourcesTest : GradlePluginTestBase() {
         }
     }
 
+    @Test
+    fun testDisableMultimoduleResourcesWithNewKotlin() {
+        val environment = defaultTestEnvironment.copy(
+            kotlinVersion = "2.0.0-RC2"
+        )
+
+        with(testProject("misc/kmpResourcePublication", environment)) {
+            file("gradle.properties").modify { content ->
+                content + "\n" + ComposeProperties.DISABLE_MULTIMODULE_RESOURCES + "=true"
+            }
+            gradle(":cmplib:build").checks {
+                check.logContains("Configure compose resources")
+            }
+        }
+    }
+
     private fun checkResourcesZip(zipFile: File, resourcesFiles: Sequence<String>, subdir: String) {
         assertTrue(zipFile.exists(), "File not found: " + zipFile.path)
         ZipFile(zipFile).use { zip ->

diff --git a/...ins/compose/src/test/test-projects/misc/kmpResourcePublication/appModule/build.gradle.kts b/...ins/compose/src/test/test-projects/misc/kmpResourcePublication/appModule/build.gradle.kts
@@ -3,6 +3,7 @@ import org.jetbrains.compose.ExperimentalComposeLibrary
 plugins {
     id("org.jetbrains.compose")
     kotlin("multiplatform")
+    kotlin("plugin.compose")
     id("com.android.application")
 }
 

diff --git a/gradle-plugins/compose/src/test/test-projects/misc/kmpResourcePublication/build.gradle.kts b/gradle-plugins/compose/src/test/test-projects/misc/kmpResourcePublication/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("org.jetbrains.compose").apply(false)
     kotlin("multiplatform").apply(false)
+    kotlin("plugin.compose").apply(false)
     id("com.android.library").apply(false)
     id("com.android.application").apply(false)
 }
diff --git a/...lugins/compose/src/test/test-projects/misc/kmpResourcePublication/cmplib/build.gradle.kts b/...lugins/compose/src/test/test-projects/misc/kmpResourcePublication/cmplib/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("org.jetbrains.compose")
     kotlin("multiplatform")
+    kotlin("plugin.compose")
     id("maven-publish")
     id("com.android.library")
 }

diff --git a/...compose/src/test/test-projects/misc/kmpResourcePublication/featureModule/build.gradle.kts b/...compose/src/test/test-projects/misc/kmpResourcePublication/featureModule/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("org.jetbrains.compose")
     kotlin("multiplatform")
+    kotlin("plugin.compose")
     id("com.android.library")
 }
 

diff --git a/...le-plugins/compose/src/test/test-projects/misc/kmpResourcePublication/settings.gradle.kts b/...le-plugins/compose/src/test/test-projects/misc/kmpResourcePublication/settings.gradle.kts
@@ -15,6 +15,7 @@ pluginManagement {
     }
     plugins {
         id("org.jetbrains.kotlin.multiplatform").version("KOTLIN_VERSION_PLACEHOLDER")
+        id("org.jetbrains.kotlin.plugin.compose").version("KOTLIN_VERSION_PLACEHOLDER")
         id("org.jetbrains.compose").version("COMPOSE_GRADLE_PLUGIN_VERSION_PLACEHOLDER")
         id("com.android.library").version("AGP_VERSION_PLACEHOLDER")
         id("com.android.application").version("AGP_VERSION_PLACEHOLDER")