[IJ plugin] v3 -> v4 migration: enum capitalization (#5128)

Author: BoD

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/refactoring/Refactoring.kt

@@ -12,6 +12,7 @@ import com.intellij.psi.PsiMigration
 import com.intellij.psi.PsiPackage
 import com.intellij.psi.PsiReference
 import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.psi.search.searches.AllClassesSearch
 import com.intellij.psi.search.searches.ClassInheritorsSearch
 import com.intellij.psi.search.searches.ReferencesSearch
 import com.intellij.refactoring.rename.RenamePsiElementProcessor
@@ -96,3 +97,7 @@ fun findInheritorsOfClass(project: Project, className: String): Collection<PsiCl
   // Using allScope for the search so all inheritors are found even if some of them are not in the project
   return ClassInheritorsSearch.search(psiLookupClass, GlobalSearchScope.allScope(project), true).toList()
 }
+
+fun findAllClasses(project: Project): Collection<PsiClass> {
+  return AllClassesSearch.search(GlobalSearchScope.projectScope(project), project).findAll()
+}

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/refactoring/migration/ApolloMigrationRefactoringProcessor.kt

@@ -84,10 +84,12 @@ abstract class ApolloMigrationRefactoringProcessor(project: Project) : BaseRefac
       val usageInfos = migrationItems
           .flatMap { migrationItem ->
             migrationItem.findUsages(myProject, migration!!, searchScope)
-                .filterNot { usageInfo ->
+                .filter { usageInfo ->
                   // Filter out all generated code usages. We don't want generated code to come up in findUsages.
-                  // TODO: how to mark Apollo generated code as generated per this method?
-                  usageInfo.virtualFile?.isGenerated(myProject) == true
+                  usageInfo.virtualFile?.isGenerated(myProject) != true //&&
+
+                  // Also filter out usages outside of projects (see https://youtrack.jetbrains.com/issue/KTIJ-26411)
+                  usageInfo.virtualFile?.let { searchScope.contains(it) } == true
                 }
           }
           .toMutableList()

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/refactoring/migration/v3tov4/ApolloV3ToV4MigrationProcessor.kt

@@ -14,7 +14,9 @@ import com.apollographql.ijplugin.refactoring.migration.item.UpdateGradlePluginI
 import com.apollographql.ijplugin.refactoring.migration.item.UpdateMethodCall
 import com.apollographql.ijplugin.refactoring.migration.item.UpdateMethodName
 import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.EncloseInService
+import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.RemoveFieldInService
 import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.RemoveWatchMethodArguments
+import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.UpdateEnumClassUpperCase
 import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.UpdateFieldNameInService
 import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.UpdateMultiModuleConfiguration
 import com.apollographql.ijplugin.refactoring.migration.v3tov4.item.UpdateWebSocketReconnectWhen
@@ -73,13 +75,16 @@ class ApolloV3ToV4MigrationProcessor(project: Project) : ApolloMigrationRefactor
       ConstructorInsteadOfBuilder("$apollo3.cache.normalized.api.CacheKey.Companion", "from"),
       UpdateWebSocketReconnectWhen,
 
+      UpdateEnumClassUpperCase,
+
       // Gradle
       UpdateGradlePluginInBuildKts(apollo3, apollo3, apollo4LatestVersion),
       UpdateGradleDependenciesInToml(apollo3, apollo3, apollo4LatestVersion),
       UpdateGradleDependenciesBuildKts(apollo3, apollo3),
 
       UpdateFieldNameInService("generateModelBuilder", "generateModelBuilders"),
       UpdateFieldNameInService("generateTestBuilders", "generateDataBuilders"),
+      RemoveFieldInService("languageVersion"),
       UpdateCustomTypeMappingInBuildKts,
       UpdateMultiModuleConfiguration,
       EncloseInService,

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/refactoring/migration/v3tov4/item/RemoveFieldInService.kt

@@ -0,0 +1,49 @@
+package com.apollographql.ijplugin.refactoring.migration.v3tov4.item
+
+import com.apollographql.ijplugin.refactoring.migration.item.DeletesElements
+import com.apollographql.ijplugin.refactoring.migration.item.MigrationItem
+import com.apollographql.ijplugin.refactoring.migration.item.MigrationItemUsageInfo
+import com.apollographql.ijplugin.refactoring.migration.item.toMigrationItemUsageInfo
+import com.apollographql.ijplugin.util.cast
+import com.apollographql.ijplugin.util.findPsiFilesByName
+import com.apollographql.ijplugin.util.getMethodName
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiMigration
+import com.intellij.psi.search.GlobalSearchScope
+import org.jetbrains.kotlin.psi.KtCallExpression
+import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
+import org.jetbrains.kotlin.psi.KtFile
+import org.jetbrains.kotlin.psi.KtNameReferenceExpression
+import org.jetbrains.kotlin.psi.KtTreeVisitorVoid
+
+class RemoveFieldInService(
+    val fieldName:String,
+) : MigrationItem(), DeletesElements {
+  override fun findUsages(project: Project, migration: PsiMigration, searchScope: GlobalSearchScope): List<MigrationItemUsageInfo> {
+    val usages = mutableListOf<MigrationItemUsageInfo>()
+    val buildGradleKtsFiles: List<KtFile> = project.findPsiFilesByName("build.gradle.kts", searchScope).filterIsInstance<KtFile>()
+    for (file in buildGradleKtsFiles) {
+      file.accept(object : KtTreeVisitorVoid() {
+        override fun visitCallExpression(expression: KtCallExpression) {
+          super.visitCallExpression(expression)
+          if (expression.getMethodName() == "apollo") {
+            expression.accept(object : KtTreeVisitorVoid() {
+              override fun visitDotQualifiedExpression(expression: KtDotQualifiedExpression) {
+                super.visitDotQualifiedExpression(expression)
+                if (expression.receiverExpression.cast<KtNameReferenceExpression>()?.getReferencedName() == fieldName) {
+                  usages.add(expression.toMigrationItemUsageInfo())
+                }
+              }
+            })
+          }
+        }
+      })
+    }
+    return usages
+  }
+
+  override fun performRefactoring(project: Project, migration: PsiMigration, usage: MigrationItemUsageInfo) {
+    val element = usage.element
+    element.delete()
+  }
+}

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/refactoring/migration/v3tov4/item/UpdateEnumClassUpperCase.kt

@@ -0,0 +1,37 @@
+package com.apollographql.ijplugin.refactoring.migration.v3tov4.item
+
+import com.apollographql.ijplugin.navigation.isApolloEnumClass
+import com.apollographql.ijplugin.refactoring.findAllClasses
+import com.apollographql.ijplugin.refactoring.findClassReferences
+import com.apollographql.ijplugin.refactoring.migration.item.MigrationItem
+import com.apollographql.ijplugin.refactoring.migration.item.MigrationItemUsageInfo
+import com.apollographql.ijplugin.refactoring.migration.item.toMigrationItemUsageInfo
+import com.apollographql.ijplugin.util.capitalizeFirstLetter
+import com.apollographql.ijplugin.util.cast
+import com.apollographql.ijplugin.util.isGenerated
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiMigration
+import com.intellij.psi.search.GlobalSearchScope
+import org.jetbrains.kotlin.asJava.classes.KtUltraLightClass
+import org.jetbrains.kotlin.psi.KtClass
+import org.jetbrains.kotlin.psi.KtPsiFactory
+
+object UpdateEnumClassUpperCase : MigrationItem() {
+  override fun findUsages(project: Project, migration: PsiMigration, searchScope: GlobalSearchScope): List<MigrationItemUsageInfo> {
+    val allClasses = findAllClasses(project)
+    val allApolloGeneratedEnums: List<KtClass> = allClasses
+        .filter { it.isEnum }
+        .mapNotNull { it.cast<KtUltraLightClass>()?.kotlinOrigin?.cast<KtClass>() }
+        .filter { it.isApolloEnumClass() && it.name!![0].isLowerCase() }
+    return allApolloGeneratedEnums.flatMap {
+      findClassReferences(project, it.fqName!!.asString())
+          // Exclude references in generated code
+          .filterNot { it.element.containingFile?.virtualFile?.isGenerated(project) == true }
+
+    }.toMigrationItemUsageInfo()
+  }
+
+  override fun performRefactoring(project: Project, migration: PsiMigration, usage: MigrationItemUsageInfo) {
+    usage.element.replace(KtPsiFactory(project).createExpression(usage.element.text.capitalizeFirstLetter()))
+  }
+}

intellij-plugin/src/test/kotlin/com/apollographql/ijplugin/ApolloV3ToV4MigrationTest.kt

@@ -31,7 +31,7 @@ class ApolloV3ToV4MigrationTest : ApolloTestCase() {
   fun testUpdateGradleDependenciesInLibsVersionsToml() = runMigration(extension = "versions.toml", fileNameInProject = "libs.versions.toml")
 
   @Test
-  fun deprecations() = runMigration()
+  fun testDeprecations() = runMigration()
 
   @Test
   fun testEncloseInService() = runMigration(extension = "gradle.kts", fileNameInProject = "build.gradle.kts")
@@ -45,6 +45,9 @@ class ApolloV3ToV4MigrationTest : ApolloTestCase() {
   @Test
   fun testMultiModule() = runMigration(extension = "gradle.kts", fileNameInProject = "build.gradle.kts")
 
+  @Test
+  fun testUpdateEnumClassUpperCase() = runMigration()
+
   private fun runMigration(extension: String = "kt", fileNameInProject: String? = null) {
     val fileBaseName = getTestName(true)
     if (fileNameInProject != null) {

intellij-plugin/src/test/testData/migration/v3-to-v4/gradleDeprecations.gradle.kts

@@ -5,11 +5,13 @@ dependencies {
 apollo {
   generateModelBuilder.set(true)
   generateTestBuilders.set(true)
+  languageVersion.set("1.4")
 }
 
 apollo {
   service("xxx") {
     generateModelBuilder.set(true)
     generateTestBuilders.set(true)
+    languageVersion.set("1.4")
   }
 }

intellij-plugin/src/test/testData/migration/v3-to-v4/updateEnumClassUpperCase.kt

@@ -0,0 +1,33 @@
+package com.example
+
+import com.apollographql.apollo3.api.EnumType
+
+public enum class myEnum(
+    public val rawValue: String,
+) {
+  VALUE_A("VALUE_A"),
+  VALUE_B("VALUE_B"),
+
+  /**
+   * Auto generated constant for unknown enum values
+   */
+  UNKNOWN__("UNKNOWN__"),
+  ;
+
+  public companion object {
+    public val type: EnumType = EnumType("myEnum", listOf("VALUE_A", "VALUE_B"))
+
+    public fun safeValueOf(rawValue: String): myEnum = values().find { it.rawValue == rawValue } ?: UNKNOWN__
+
+    /**
+     * Returns all [myEnum] known at compile time
+     */
+    public fun knownValues(): Array<myEnum> = arrayOf(
+        VALUE_A,
+        VALUE_B)
+  }
+}
+
+fun main() {
+  val myEnum: myEnum = myEnum.VALUE_A
+}

intellij-plugin/src/test/testData/migration/v3-to-v4/updateEnumClassUpperCase_after.kt

@@ -0,0 +1,33 @@
+package com.example
+
+import com.apollographql.apollo3.api.EnumType
+
+public enum class myEnum(
+    public val rawValue: String,
+) {
+  VALUE_A("VALUE_A"),
+  VALUE_B("VALUE_B"),
+
+  /**
+   * Auto generated constant for unknown enum values
+   */
+  UNKNOWN__("UNKNOWN__"),
+  ;
+
+  public companion object {
+    public val type: EnumType = EnumType("myEnum", listOf("VALUE_A", "VALUE_B"))
+
+    public fun safeValueOf(rawValue: String): MyEnum = values().find { it.rawValue == rawValue } ?: UNKNOWN__
+
+    /**
+     * Returns all [MyEnum] known at compile time
+     */
+    public fun knownValues(): Array<MyEnum> = arrayOf(
+        VALUE_A,
+        VALUE_B)
+  }
+}
+
+fun main() {
+  val myEnum: MyEnum = MyEnum.VALUE_A
+}