Sort dependencies in ComponentTreeDeps manually to give consistent ou…

…tput. Incremental processing can change the order we receive elements in our metadata package. This CL sorts our metadata deps manually by file name before generating the @ComponentTreeDeps. Fixes #3006 RELNOTES=Fix #3006:Sort dependencies in ComponentTreeDeps manually to give consistent output. PiperOrigin-RevId: 411619490
google · Nov 22, 2021 · f2c10c3 · f2c10c3
1 parent e32f9c6
commit f2c10c3
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 6 deletions.
diff --git a/java/dagger/hilt/android/plugin/src/test/kotlin/IncrementalProcessorTest.kt b/java/dagger/hilt/android/plugin/src/test/kotlin/IncrementalProcessorTest.kt
@@ -425,6 +425,7 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeActivitySource_addPublicMethod() {
     runFullBuild()
+    val componentTreeDepsFullBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Activity 1 source
     searchAndReplace(
@@ -470,6 +471,11 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val componentTreeDepsIncrementalBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(componentTreeDepsFullBuild)
+        .isEqualTo(componentTreeDepsIncrementalBuild)
+
     // Check compilation outputs
     // * Gen sources from activity 1 are re-compiled
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
@@ -504,6 +510,7 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeActivitySource_addPrivateMethod() {
     runFullBuild()
+    val componentTreeDepsFullBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Activity 1 source
     searchAndReplace(
@@ -548,6 +555,11 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val componentTreeDepsIncrementalBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(componentTreeDepsFullBuild)
+        .isEqualTo(componentTreeDepsIncrementalBuild)
+
     // Check compilation outputs
     // * Gen sources from activity 1 are re-compiled
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
@@ -578,6 +590,7 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeModuleSource() {
     runFullBuild()
+    val componentTreeDepsFullBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Module 1 source
     searchAndReplace(
@@ -619,6 +632,11 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val componentTreeDepsIncrementalBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(componentTreeDepsFullBuild)
+        .isEqualTo(componentTreeDepsIncrementalBuild)
+
     // Check compilation outputs
     // * Gen sources from module 1 are re-compiled
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
@@ -649,6 +667,7 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeAppSource() {
     runFullBuild()
+    val componentTreeDepsFullBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Application source
     searchAndReplace(
@@ -690,6 +709,11 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val componentTreeDepsIncrementalBuild = genComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(componentTreeDepsFullBuild)
+        .isEqualTo(componentTreeDepsIncrementalBuild)
+
     // Check compilation outputs
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
       listOf(
@@ -939,6 +963,8 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeTestSource_addPublicMethod() {
     runFullTestBuild()
+    val test1ComponentTreeDepsFullBuild = genTest1ComponentTreeDeps.readText(Charsets.UTF_8)
+    val test2ComponentTreeDepsFullBuild = genTest2ComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Test 1 source
     searchAndReplace(
@@ -972,6 +998,15 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val test1ComponentTreeDepsIncrementalBuild = genTest1ComponentTreeDeps.readText(Charsets.UTF_8)
+    val test2ComponentTreeDepsIncrementalBuild = genTest2ComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(test1ComponentTreeDepsFullBuild)
+        .isEqualTo(test1ComponentTreeDepsIncrementalBuild)
+    expect.withMessage("Full build")
+        .that(test2ComponentTreeDepsFullBuild)
+        .isEqualTo(test2ComponentTreeDepsIncrementalBuild)
+
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
       listOf(
         classSrcTest1,
@@ -996,6 +1031,8 @@ class IncrementalProcessorTest(private val incapMode: String) {
   @Test
   fun changeTestSource_addPrivateMethod() {
     runFullTestBuild()
+    val test1ComponentTreeDepsFullBuild = genTest1ComponentTreeDeps.readText(Charsets.UTF_8)
+    val test2ComponentTreeDepsFullBuild = genTest2ComponentTreeDeps.readText(Charsets.UTF_8)
 
     // Change Test 1 source
     searchAndReplace(
@@ -1031,6 +1068,15 @@ class IncrementalProcessorTest(private val incapMode: String) {
     }
     assertChangedFiles(FileType.JAVA, regeneratedSourceFiles)
 
+    val test1ComponentTreeDepsIncrementalBuild = genTest1ComponentTreeDeps.readText(Charsets.UTF_8)
+    val test2ComponentTreeDepsIncrementalBuild = genTest2ComponentTreeDeps.readText(Charsets.UTF_8)
+    expect.withMessage("Full build")
+        .that(test1ComponentTreeDepsFullBuild)
+        .isEqualTo(test1ComponentTreeDepsIncrementalBuild)
+    expect.withMessage("Full build")
+        .that(test2ComponentTreeDepsFullBuild)
+        .isEqualTo(test2ComponentTreeDepsIncrementalBuild)
+
     val recompiledClassFiles = if (incapMode == ISOLATING_MODE) {
       listOf(classSrcTest1)
     } else {

diff --git a/java/dagger/hilt/processor/internal/root/ir/ComponentTreeDepsIrCreator.kt b/java/dagger/hilt/processor/internal/root/ir/ComponentTreeDepsIrCreator.kt
@@ -236,12 +236,12 @@ class ComponentTreeDepsIrCreator private constructor(
       aggregatedEarlyEntryPointDeps: Set<AggregatedEarlyEntryPointIr>,
     ) = ComponentTreeDepsIrCreator(
       isSharedTestComponentsEnabled,
-      aggregatedRoots,
-      defineComponentDeps,
-      aliasOfDeps,
-      aggregatedDeps,
-      aggregatedUninstallModulesDeps,
-      aggregatedEarlyEntryPointDeps
+      aggregatedRoots.toList().sortedBy { it.fqName.canonicalName() }.toSet(),
+      defineComponentDeps.toList().sortedBy { it.fqName.canonicalName() }.toSet(),
+      aliasOfDeps.toList().sortedBy { it.fqName.canonicalName() }.toSet(),
+      aggregatedDeps.toList().sortedBy { it.fqName.canonicalName() }.toSet(),
+      aggregatedUninstallModulesDeps.toList().sortedBy { it.fqName.canonicalName() }.toSet(),
+      aggregatedEarlyEntryPointDeps.toList().sortedBy { it.fqName.canonicalName() }.toSet()
     ).let { producer ->
       if (isTest) {
         producer.testComponents()