[IJ Plugin] Report invalid oneOf input object builder uses (#5416)

Author: BoD

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/inspection/ApolloOneOfInputCreationInspection.kt

@@ -2,42 +2,91 @@ package com.apollographql.ijplugin.inspection
 
 import com.apollographql.ijplugin.ApolloBundle
 import com.apollographql.ijplugin.navigation.findInputTypeGraphQLDefinitions
+import com.apollographql.ijplugin.navigation.isApolloInputClass
 import com.apollographql.ijplugin.navigation.isApolloInputClassReference
 import com.apollographql.ijplugin.project.apolloProjectService
+import com.apollographql.ijplugin.util.canBeNull
 import com.apollographql.ijplugin.util.cast
 import com.apollographql.ijplugin.util.type
 import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemHighlightType
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.lang.jsgraphql.psi.GraphQLInputObjectTypeDefinition
 import com.intellij.psi.PsiElementVisitor
 import com.intellij.psi.util.parentOfType
 import org.jetbrains.kotlin.idea.base.utils.fqname.fqName
+import org.jetbrains.kotlin.idea.intentions.branchedTransformations.isNullExpression
+import org.jetbrains.kotlin.idea.references.mainReference
 import org.jetbrains.kotlin.psi.KtCallExpression
+import org.jetbrains.kotlin.psi.KtClass
+import org.jetbrains.kotlin.psi.KtDotQualifiedExpression
+import org.jetbrains.kotlin.psi.KtExpression
 import org.jetbrains.kotlin.psi.KtNameReferenceExpression
 import org.jetbrains.kotlin.psi.KtVisitorVoid
+import org.jetbrains.kotlin.psi.psiUtil.containingClass
+import org.jetbrains.kotlin.resolve.calls.util.getCalleeExpressionIfAny
+import org.jetbrains.kotlin.types.typeUtil.isNullableNothing
 
 class ApolloOneOfInputCreationInspection : LocalInspectionTool() {
   override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
     return object : KtVisitorVoid() {
+      private val expressionsWithFieldSet = mutableSetOf<KtExpression>()
+
+      // For constructor calls
       override fun visitCallExpression(expression: KtCallExpression) {
         super.visitCallExpression(expression)
         if (!expression.project.apolloProjectService.apolloVersion.isAtLeastV4) return
         val reference = (expression.calleeExpression.cast<KtNameReferenceExpression>())
         if (reference?.isApolloInputClassReference() != true) return
         val inputTypeName = reference.text
-        val inputTypeDefinition = findInputTypeGraphQLDefinitions(reference.project, inputTypeName).firstOrNull()
+        val inputTypeDefinition = findInputTypeGraphQLDefinitions(expression.project, inputTypeName).firstOrNull()
             ?.parentOfType<GraphQLInputObjectTypeDefinition>()
             ?: return
         val isOneOf = inputTypeDefinition.directives.any { it.name == "oneOf" }
         if (!isOneOf) return
         if (expression.valueArguments.size != 1) {
-          holder.registerProblem(expression.calleeExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.wrongNumberOfArgs"))
+          holder.registerProblem(expression.calleeExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.constructor.wrongNumberOfArgs"))
           return
         }
         val arg = expression.valueArguments.first()
         if (arg.getArgumentExpression()?.type()?.fqName?.asString() == "com.apollographql.apollo3.api.Optional.Absent") {
-          holder.registerProblem(expression.calleeExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.argIsAbsent"))
+          holder.registerProblem(expression.calleeExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.constructor.argIsAbsent"))
+        }
+      }
+
+      // For builder calls
+      override fun visitDotQualifiedExpression(expression: KtDotQualifiedExpression) {
+        super.visitDotQualifiedExpression(expression)
+        if (!expression.project.apolloProjectService.apolloVersion.isAtLeastV4) return
+        val expressionClass = expression.selectorExpression.getCalleeExpressionIfAny()?.mainReference?.resolve()?.parentOfType<KtClass>(withSelf = true)
+            ?: return
+        if (expressionClass.name != "Builder") return
+        val containingClass = expressionClass.containingClass() ?: return
+        if (!containingClass.isApolloInputClass()) return
+        val inputTypeName = containingClass.name ?: return
+        val inputTypeDefinition = findInputTypeGraphQLDefinitions(expression.project, inputTypeName).firstOrNull()
+            ?.parentOfType<GraphQLInputObjectTypeDefinition>()
+            ?: return
+        val isOneOf = inputTypeDefinition.directives.any { it.name == "oneOf" }
+        if (!isOneOf) return
+        val arguments = expression.selectorExpression.cast<KtCallExpression>()?.valueArguments ?: return
+        // No arguments: we're on the MyInput.Builder() or .build() call
+        if (arguments.size == 0) return
+
+        val argumentExpression = arguments.first().getArgumentExpression()
+        val argumentExpressionType = argumentExpression?.type()
+        if (argumentExpression?.isNullExpression() == true || argumentExpressionType?.isNullableNothing() == true) {
+          // `null`
+          holder.registerProblem(expression.selectorExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.builder.argIsNull"))
+        } else if (argumentExpressionType?.canBeNull() == true) {
+          // a nullable type: warning only
+          holder.registerProblem(expression.selectorExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.builder.argIsNull"), ProblemHighlightType.WARNING)
+        }
+
+        if (expression.receiverExpression in expressionsWithFieldSet) {
+          holder.registerProblem(expression.selectorExpression!!, ApolloBundle.message("inspection.oneOfInputCreation.reportText.builder.wrongNumberOfArgs"))
         }
+        expressionsWithFieldSet.add(expression)
       }
     }
   }

intellij-plugin/src/main/kotlin/com/apollographql/ijplugin/util/Psi.kt

@@ -23,6 +23,7 @@ import org.jetbrains.kotlin.psi.KtReferenceExpression
 import org.jetbrains.kotlin.psi.psiUtil.containingClass
 import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
 import org.jetbrains.kotlin.types.KotlinType
+import org.jetbrains.kotlin.types.isNullabilityFlexible
 import org.jetbrains.kotlin.utils.addToStdlib.firstIsInstanceOrNull
 
 fun PsiElement.containingKtFile(): KtFile? = getStrictParentOfType()
@@ -81,3 +82,5 @@ fun KtDeclaration.type(): KotlinType? = (resolveToDescriptorIfAny() as? Callable
 fun KtExpression.type(): KotlinType? = safeAnalyze(getResolutionFacade()).getType(this)
 
 fun KtReferenceExpression.resolve() = mainReference.resolve()
+
+fun KotlinType.canBeNull() = isMarkedNullable || isNullabilityFlexible()

intellij-plugin/src/main/resources/inspectionDescriptions/ApolloOneOfInputCreation.html

@@ -1,8 +1,10 @@
 <html>
 <body>
-Reports invalid constructor invocations of <code>@oneOf</code> input types.
+Reports invalid creation of <code>@oneOf</code> input types.
 <p>
-    Constructor of `@oneOf` input class must have exactly one <code>Present</code> argument.
+    <ul>
+    <li>`@oneOf` input class must be created with exactly one <code>Present</code> / non-null argument.
+    </ul>
 </p>
 </body>
 </html>

intellij-plugin/src/main/resources/messages/ApolloBundle.properties

@@ -143,8 +143,10 @@ inspection.endpointNotConfigured.reportText=GraphQL endpoint not configured
 inspection.endpointNotConfigured.quickFix=Add introspection block
 
 inspection.oneOfInputCreation.displayName=OneOf Input Object creation issue
-inspection.oneOfInputCreation.reportText.wrongNumberOfArgs=<html><tt>@oneOf</tt> input class constructor must have exactly one argument
-inspection.oneOfInputCreation.reportText.argIsAbsent=<html><tt>@oneOf</tt> input class argument must be <tt>Present</tt>
+inspection.oneOfInputCreation.reportText.constructor.wrongNumberOfArgs=<html><tt>@oneOf</tt> input class constructor must have exactly one argument
+inspection.oneOfInputCreation.reportText.constructor.argIsAbsent=<html><tt>@oneOf</tt> input class argument must be <tt>Present</tt>
+inspection.oneOfInputCreation.reportText.builder.wrongNumberOfArgs=<html><tt>@oneOf</tt> input class builder must have exactly one field set
+inspection.oneOfInputCreation.reportText.builder.argIsNull=<html><tt>@oneOf</tt> input class argument must be non-null
 
 inspection.suppress.field=Suppress for field
 

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

@@ -20,5 +20,8 @@ class ApolloOneOfInputCreationInspectionTest : ApolloTestCase() {
     assertTrue(highlightInfos.any { it.description == "@oneOf input class constructor must have exactly one argument" && it.text == "FindUserInput" && it.line == 8 })
     assertTrue(highlightInfos.any { it.description == "@oneOf input class constructor must have exactly one argument" && it.text == "FindUserInput" && it.line == 10 })
     assertTrue(highlightInfos.any { it.description == "@oneOf input class argument must be Present" && it.text == "FindUserInput" && it.line == 20 })
+    assertTrue(highlightInfos.any { it.description == "@oneOf input class builder must have exactly one field set" && it.text == "name(\"John\")" && it.line == 28 })
+    assertTrue(highlightInfos.any { it.description == "@oneOf input class argument must be non-null" && it.text == "email(null)" && it.line == 36 })
+    assertTrue(highlightInfos.any { it.description == "@oneOf input class argument must be non-null" && it.text == "email(someNullableEmail)" && it.line == 41 && it.type.getSeverity(null).name == "WARNING" })
   }
 }

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

@@ -99,7 +99,9 @@ class GraphQLGotoDeclarationHandlerTest : ApolloTestCase() {
       fromFile = "src/main/graphql/schema.graphqls",
       fromElement = { elementAt<PsiElement>("lastName", afterText = "input personInput {")!! },
       toFile = "build/generated/source/apollo/main/com/example/generated/type/PersonInput.kt",
-      toElement = { elementAt<KtParameter>("lastName")!! },
+      toElement = { elementAt<KtParameter>("lastName: String?")!! },
+      // We have 2 targets because of builders
+      multipleTarget = true,
   )
 }
 

tests/intellij-plugin-test-project/build.gradle.kts

@@ -13,5 +13,6 @@ apollo {
   service("main") {
     packageName.set("com.example.generated")
     languageVersion.set("1.5")
+    generateInputBuilders.set(true)
   }
 }

tests/intellij-plugin-test-project/src/main/kotlin/com/example/OneOf.kt

@@ -4,20 +4,40 @@ import com.apollographql.apollo3.api.Optional
 import com.apollographql.apollo3.api.Optional.Absent
 import com.example.generated.type.FindUserInput
 
-fun oneOf() {
+fun oneOfConstructor() {
   FindUserInput()
 
   FindUserInput(
-    email = Optional.present("[email protected]"),
-    name = Optional.present("John"),
+      email = Optional.present("[email protected]"),
+      name = Optional.present("John"),
   )
 
   FindUserInput(
-    email = Optional.present("[email protected]")
+      email = Optional.present("[email protected]")
   )
 
   val absentEmail: Absent = Optional.absent()
   FindUserInput(
-    email = absentEmail
+      email = absentEmail
   )
 }
+
+fun oneOfBuilder() {
+  FindUserInput.Builder()
+      .email("[email protected]")
+      .name("John")
+      .build()
+
+  FindUserInput.Builder()
+      .email("[email protected]")
+      .build()
+
+  FindUserInput.Builder()
+      .email(null)
+      .build()
+
+  val someNullableEmail: String? = null
+  FindUserInput.Builder()
+      .email(someNullableEmail)
+      .build()
+}