Merge pull request #98 from gradle/no/compile-library-resources

Fix CompileLibraryResources cache miss.

Author: ghale

src/main/groovy/org/gradle/android/AndroidCacheFixPlugin.groovy

@@ -7,6 +7,7 @@ import com.android.build.gradle.tasks.ProcessAndroidResources
 import com.android.builder.model.Version
 import com.google.common.collect.ImmutableList
 import groovy.transform.CompileStatic
+import org.gradle.android.workarounds.CompileLibraryResourcesWorkaround
 import org.gradle.android.workarounds.CompilerArgsProcessor
 import org.gradle.android.workarounds.MergeJavaResourcesWorkaround
 import org.gradle.android.workarounds.MergeNativeLibsWorkaround
@@ -42,7 +43,8 @@ class AndroidCacheFixPlugin implements Plugin<Project> {
             WORKAROUNDS.addAll(
                 new MergeJavaResourcesWorkaround(),
                 new MergeNativeLibsWorkaround(),
-                new RoomSchemaLocationWorkaround()
+                new RoomSchemaLocationWorkaround(),
+                new CompileLibraryResourcesWorkaround()
             )
         }
     }

src/main/groovy/org/gradle/android/workarounds/CompileLibraryResourcesWorkaround.groovy

@@ -0,0 +1,62 @@
+package org.gradle.android.workarounds
+
+import org.gradle.android.AndroidIssue
+import org.gradle.api.Project
+import org.gradle.api.Task
+import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.tasks.PathSensitivity
+
+import java.lang.reflect.Field
+
+
+/**
+ * Fixes the cacheability issue with CompileLibraryResourcesWorkaround where the mergedLibraryResourcesDir field is
+ * treated as an input with absolute path sensitivity.
+ */
+@AndroidIssue(introducedIn = "4.0.0", fixedIn = [], link = "https://issuetracker.google.com/issues/155218379")
+class CompileLibraryResourcesWorkaround implements Workaround {
+    // This task is new in AGP 4.0.0 so use Class.forName to allow for backward compatibility with older AGP versions.
+    static Class<?> getAndroidTaskClass() {
+        return Class.forName('com.android.build.gradle.tasks.CompileLibraryResourcesTask')
+    }
+
+    String propertyName = "mergedLibraryResourcesDir"
+
+    public void setPropertyValue(Task task, DirectoryProperty directoryProperty) {
+        Field field = task.class.getDeclaredFields().find { it.name == "__${propertyName}__" }
+        field.setAccessible(true)
+        field.set(task, directoryProperty)
+    }
+
+    @Override
+    void apply(WorkaroundContext context) {
+        Project project = context.project
+        project.tasks.withType(androidTaskClass).configureEach { Task task ->
+            DirectoryProperty originalPropertyValue
+            // Create a synthetic input with the original property value and RELATIVE path sensitivity
+            project.gradle.taskGraph.beforeTask {
+                if (it == task) {
+                    originalPropertyValue = task.getProperty(propertyName)
+                    def dummyProperty = project.objects.directoryProperty()
+                    // Non-existent file to give the DirectoryProperty a value.
+                    dummyProperty.set(project.file('/doesnt-exist'))
+                    setPropertyValue(task, dummyProperty)
+                    task.inputs.dir(originalPropertyValue)
+                            .withPathSensitivity(PathSensitivity.RELATIVE)
+                            .withPropertyName("${propertyName}.workaround")
+                            .optional()
+                }
+            }
+            // Set the task property back to its original value
+            task.doFirst {
+                setPropertyValue(task, originalPropertyValue)
+            }
+        }
+    }
+
+    @Override
+    boolean canBeApplied(Project project) {
+        return true
+    }
+}
+

src/test/groovy/org/gradle/android/CrossVersionOutcomeAndRelocationTest.groovy

@@ -135,7 +135,6 @@ class CrossVersionOutcomeAndRelocationTest extends AbstractTest {
         def isAndroid35x = androidVersion >= android("3.5.0") && androidVersion < android("3.6.0")
         def isAndroid35xTo36x = androidVersion >= android("3.5.0") && androidVersion <= android("3.6.3")
         def isAndroid35xTo40x = androidVersion >= android("3.5.0") && androidVersion <= android("4.1.0-alpha01")
-        def isAndroid36x = androidVersion >= android("3.6.0") && androidVersion < android("4.0.0-alpha01")
         def isAndroid36xOrHigher = androidVersion >= android("3.6.0")
         def isAndroid40xOrHigher = androidVersion >= android("4.0.0-beta01")
         def isAndroid40x = androidVersion >= android("4.0.0") && androidVersion < android("4.1.0-alpha01")
@@ -162,11 +161,6 @@ class CrossVersionOutcomeAndRelocationTest extends AbstractTest {
             android35xTo36xExpectations(builder)
         }
 
-        // Applies to 3.6.x only
-        if (isAndroid36x) {
-            android36xOnlyExpectations(builder)
-        }
-
         // Applies to anything 3.6.0 or higher
         if (isAndroid36xOrHigher) {
             android36xOrHigherExpectations(builder)
@@ -414,9 +408,6 @@ class CrossVersionOutcomeAndRelocationTest extends AbstractTest {
         builder.expect(':library:parseReleaseLocalResources', FROM_CACHE)
         builder.expect(':library:syncDebugLibJars', FROM_CACHE)
         builder.expect(':library:syncReleaseLibJars', FROM_CACHE)
-    }
-
-    static void android36xOnlyExpectations(ExpectedOutcomeBuilder builder) {
         builder.expect(':library:compileDebugLibraryResources', FROM_CACHE)
         builder.expect(':library:compileReleaseLibraryResources', FROM_CACHE)
     }
@@ -430,9 +421,7 @@ class CrossVersionOutcomeAndRelocationTest extends AbstractTest {
         builder.expect(':app:mergeReleaseResources', SUCCESS)
         builder.expect(':app:processDebugResources', SUCCESS)
         builder.expect(':app:processReleaseResources', SUCCESS)
-        builder.expect(':library:compileDebugLibraryResources', SUCCESS)
         builder.expect(':library:compileDebugShaders', NO_SOURCE)
-        builder.expect(':library:compileReleaseLibraryResources', SUCCESS)
         builder.expect(':library:compileReleaseShaders', NO_SOURCE)
         builder.expect(':library:dataBindingMergeGenClassesDebug', FROM_CACHE)
         builder.expect(':library:dataBindingMergeGenClassesRelease', FROM_CACHE)

src/test/groovy/org/gradle/android/WorkaroundTest.groovy

@@ -12,8 +12,8 @@ class WorkaroundTest extends Specification {
         workarounds.collect { it.class.simpleName.replaceAll(/Workaround/, "") }.sort() == expectedWorkarounds.sort()
         where:
         androidVersion  | expectedWorkarounds
-        "4.1.0-alpha10"  | ['RoomSchemaLocation']
-        "4.0.0-beta04"  | ['MergeJavaResources', 'MergeNativeLibs', 'RoomSchemaLocation']
+        "4.1.0-alpha10" | ['RoomSchemaLocation', 'CompileLibraryResources']
+        "4.0.0"         | ['MergeJavaResources', 'MergeNativeLibs', 'RoomSchemaLocation', 'CompileLibraryResources']
         "3.6.2"         | ['MergeJavaResources', 'MergeNativeLibs', 'RoomSchemaLocation']
         "3.6.1"         | ['MergeJavaResources', 'MergeNativeLibs', 'RoomSchemaLocation']
         "3.6.0"         | ['MergeJavaResources', 'MergeNativeLibs', 'RoomSchemaLocation']