Add validation for invalid custom function calls in SQL inspections

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/DirectiveCompletion.kt

@@ -16,15 +16,13 @@
 package org.domaframework.doma.intellij.common.sql.directive
 
 import com.intellij.codeInsight.completion.CompletionResultSet
-import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 
 class DirectiveCompletion(
     private val originalFile: PsiFile,
     private val bindText: String,
     private val element: PsiElement,
-    private val project: Project,
     private val result: CompletionResultSet,
 ) {
     fun directiveHandle(symbol: String): Boolean {
@@ -56,7 +54,6 @@ class DirectiveCompletion(
                     element = element,
                     result = result,
                     bindText = bindText,
-                    project = project,
                 ).directiveHandle()
 
             else -> return false

src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/StaticDirectiveHandler.kt

@@ -17,7 +17,6 @@ package org.domaframework.doma.intellij.common.sql.directive
 
 import com.intellij.codeInsight.completion.CompletionResultSet
 import com.intellij.openapi.module.Module
-import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElement
 import com.intellij.psi.util.PsiTreeUtil
 import com.intellij.psi.util.elementType
@@ -34,7 +33,6 @@ class StaticDirectiveHandler(
     private val element: PsiElement,
     private val result: CompletionResultSet,
     private val bindText: String,
-    private val project: Project,
 ) : DirectiveHandler(originalFile) {
     override fun directiveHandle(): Boolean {
         var handleResult = false

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationInvalidFunctionCallResult.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.domaframework.doma.intellij.common.sql.validator.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+/**
+ * Non-existent package name or class
+ */
+open class ValidationInvalidFunctionCallResult(
+    override val identify: PsiElement,
+    override val shortName: String,
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+        project: Project,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message(
+                "inspection.invalid.sql.customFunction",
+                identify.text ?: "",
+            ),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionFunctionCallVisitorProcessor.kt

@@ -0,0 +1,59 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.domaframework.doma.intellij.inspection.sql.processor
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiMethod
+import org.domaframework.doma.intellij.common.helper.ExpressionFunctionsHelper
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationInvalidFunctionCallResult
+import org.domaframework.doma.intellij.extension.getJavaClazz
+import org.domaframework.doma.intellij.psi.SqlElFunctionCallExpr
+import org.domaframework.doma.intellij.setting.state.DomaToolsCustomFunctionSettings
+
+class InspectionFunctionCallVisitorProcessor(
+    val shortName: String,
+    private val element: SqlElFunctionCallExpr,
+) : InspectionVisitorProcessor(shortName) {
+    fun check(holder: ProblemsHolder) {
+        val project = element.project
+        val expressionHelper = ExpressionFunctionsHelper
+        val expressionFunctionalInterface = expressionHelper.setExpressionFunctionsInterface(project)
+
+        val functionName = element.elIdExpr
+        val expressionFunctionSetting = DomaToolsCustomFunctionSettings.getInstance(project)
+        val customFunctionClassNames = expressionFunctionSetting.state.customFunctionClassNames
+
+        var methods: Array<out PsiMethod?> = emptyArray()
+        customFunctionClassNames.takeWhile { clazz ->
+            val expressionClazz = project.getJavaClazz(clazz)
+            if (expressionClazz != null && expressionHelper.isInheritor(expressionClazz)) {
+                methods = expressionClazz.findMethodsByName(functionName.text, true)
+            }
+            methods.isEmpty()
+        }
+
+        if (methods.isEmpty()) {
+            methods = expressionFunctionalInterface?.findMethodsByName(functionName.text, true) ?: emptyArray()
+        }
+
+        if (methods.isEmpty()) {
+            ValidationInvalidFunctionCallResult(
+                functionName,
+                shortName,
+            ).highlightElement(holder)
+        }
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlInspectionVisitor.kt

@@ -24,10 +24,12 @@ import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
 import org.domaframework.doma.intellij.extension.psi.isFirstElement
 import org.domaframework.doma.intellij.inspection.sql.processor.InspectionFieldAccessVisitorProcessor
 import org.domaframework.doma.intellij.inspection.sql.processor.InspectionForDirectiveVisitorProcessor
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionFunctionCallVisitorProcessor
 import org.domaframework.doma.intellij.inspection.sql.processor.InspectionPrimaryVisitorProcessor
 import org.domaframework.doma.intellij.inspection.sql.processor.InspectionStaticFieldAccessVisitorProcessor
 import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
 import org.domaframework.doma.intellij.psi.SqlElForDirective
+import org.domaframework.doma.intellij.psi.SqlElFunctionCallExpr
 import org.domaframework.doma.intellij.psi.SqlElPrimaryExpr
 import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
 import org.domaframework.doma.intellij.psi.SqlTypes
@@ -48,6 +50,12 @@ class SqlInspectionVisitor(
         }
     }
 
+    override fun visitElFunctionCallExpr(element: SqlElFunctionCallExpr) {
+        super.visitElFunctionCallExpr(element)
+        val processor = InspectionFunctionCallVisitorProcessor(this.shortName, element)
+        processor.check(holder)
+    }
+
     override fun visitElStaticFieldAccessExpr(element: SqlElStaticFieldAccessExpr) {
         super.visitElStaticFieldAccessExpr(element)
         val processor = InspectionStaticFieldAccessVisitorProcessor(this.shortName)

src/main/resources/messages/DomaToolsBundle.properties

@@ -17,4 +17,5 @@ inspection.invalid.sql.staticProperty=[{0}] is not a public or static property i
 inspection.invalid.sql.testdata=Bind variables must be followed by test data
 inspection.invalid.sql.classpath=A non-existent package or class name was specified [{0}]
 inspection.invalid.sql.iterable=The type that can be used in the for directive is an Iterable type
-inspection.invalid.dao.duplicate=An element name that is a duplicate of an element name defined in SQL is used
+inspection.invalid.dao.duplicate=An element name that is a duplicate of an element name defined in SQL is used
+inspection.invalid.sql.customFunction=The function [{0}] is not defined in the registered custom function classes

src/main/resources/messages/DomaToolsBundle_ja.properties

@@ -17,4 +17,5 @@ inspection.invalid.sql.staticProperty=[{0}]\u0020\u306F\u30AF\u30E9\u30B9\u0020[
 inspection.invalid.sql.testdata=\u30D0\u30A4\u30F3\u30C9\u5909\u6570\u306E\u5F8C\u308D\u306B\u306F\u30C6\u30B9\u30C8\u30C7\u30FC\u30BF\u304C\u5FC5\u8981\u3067\u3059
 inspection.invalid.sql.classpath=\u5B58\u5728\u3057\u306A\u3044\u30D1\u30C3\u30B1\u30FC\u30B8\u307E\u305F\u306F\u30AF\u30E9\u30B9\u540D\u304C\u6307\u5B9A\u3055\u308C\u307E\u3057\u305F\u3002:[{0}]
 inspection.invalid.sql.iterable=\u0066\u006F\u0072\u30C7\u30A3\u30EC\u30AF\u30C6\u30A3\u30D6\u306B\u4F7F\u7528\u3067\u304D\u308B\u578B\u306F\u0049\u0074\u0065\u0072\u0061\u0062\u006C\u0065\u578B\u3067\u3059
-inspection.invalid.dao.duplicate=\u0053\u0051\u004C\u5185\u3067\u5B9A\u7FA9\u3055\u308C\u305F\u8981\u7D20\u540D\u3068\u91CD\u8907\u3057\u305F\u8981\u7D20\u540D\u304C\u4F7F\u7528\u3055\u308C\u3066\u3044\u307E\u3059
+inspection.invalid.dao.duplicate=\u0053\u0051\u004C\u5185\u3067\u5B9A\u7FA9\u3055\u308C\u305F\u8981\u7D20\u540D\u3068\u91CD\u8907\u3057\u305F\u8981\u7D20\u540D\u304C\u4F7F\u7528\u3055\u308C\u3066\u3044\u307E\u3059
+inspection.invalid.sql.customFunction=\u767B\u9332\u3055\u308C\u305F\u30AB\u30B9\u30BF\u30E0\u95A2\u6570\u30AF\u30E9\u30B9\u306B\u5B9A\u7FA9\u3055\u308C\u3066\u3044\u306A\u3044\u95A2\u6570\u304C\u547C\u3073\u51FA\u3055\u308C\u3066\u3044\u307E\u3059:[{0}]