chore: Reference contributor for Hilla translate method usage

src/main/kotlin/com/vaadin/plugin/endpoints/VaadinReferenceContributor.kt → src/main/kotlin/com/vaadin/plugin/psi/FlowReferenceContributor.kt

@@ -1,19 +1,23 @@
-package com.vaadin.plugin.endpoints
+package com.vaadin.plugin.psi
 
-import com.intellij.codeInsight.highlighting.HighlightedReference
-import com.intellij.lang.properties.references.PropertyReference
 import com.intellij.microservices.jvm.url.uastUrlPathReferenceInjectorForScheme
 import com.intellij.microservices.jvm.url.uastUrlReferenceProvider
 import com.intellij.microservices.url.HTTP_SCHEMES
 import com.intellij.patterns.PsiJavaPatterns.psiMethod
 import com.intellij.patterns.uast.callExpression
 import com.intellij.patterns.uast.injectionHostUExpression
-import com.intellij.psi.*
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceContributor
+import com.intellij.psi.PsiReferenceRegistrar
+import com.intellij.psi.UastReferenceProvider
+import com.intellij.psi.registerUastReferenceProvider
 import com.intellij.util.ProcessingContext
+import com.vaadin.plugin.endpoints.VAADIN_ROUTE
+import com.vaadin.plugin.endpoints.vaadinUrlPksParser
 import org.jetbrains.uast.UElement
 import org.jetbrains.uast.expressions.UInjectionHost
 
-internal class VaadinReferenceContributor : PsiReferenceContributor() {
+internal class FlowReferenceContributor : PsiReferenceContributor() {
     override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
         registrar.registerUastReferenceProvider(
             injectionHostUExpression().annotationParam(VAADIN_ROUTE, "value"),
@@ -38,7 +42,7 @@ internal class VaadinReferenceContributor : PsiReferenceContributor() {
                     val key = element.evaluateToString() ?: return PsiReference.EMPTY_ARRAY
                     val sourcePsi = element.sourcePsi ?: return PsiReference.EMPTY_ARRAY
 
-                    return arrayOf(object : PropertyReference(key, sourcePsi, null, false), HighlightedReference {})
+                    return arrayOf(TranslationPropertyReference(key, sourcePsi))
                 }
             })
     }

src/main/kotlin/com/vaadin/plugin/psi/HillaReferenceContributor.kt

@@ -0,0 +1,30 @@
+package com.vaadin.plugin.psi
+
+import com.intellij.lang.javascript.patterns.JSPatterns
+import com.intellij.lang.javascript.psi.JSFile
+import com.intellij.lang.javascript.psi.JSLiteralExpression
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceContributor
+import com.intellij.psi.PsiReferenceProvider
+import com.intellij.psi.PsiReferenceRegistrar
+import com.intellij.util.ProcessingContext
+
+class HillaReferenceContributor : PsiReferenceContributor() {
+
+    override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
+        registrar.registerReferenceProvider(
+            JSPatterns.jsArgument("translate", 0),
+            object : PsiReferenceProvider() {
+                override fun getReferencesByElement(
+                    element: PsiElement,
+                    context: ProcessingContext
+                ): Array<PsiReference> {
+                    if (element !is JSLiteralExpression) return PsiReference.EMPTY_ARRAY
+                    if (!(element.containingFile as JSFile).referencedPaths.contains("@vaadin/hilla-react-i18n"))
+                        return PsiReference.EMPTY_ARRAY
+                    return arrayOf(TranslationPropertyReference(element.value as String, element))
+                }
+            })
+    }
+}

src/main/kotlin/com/vaadin/plugin/psi/TranslationPropertyReference.kt

@@ -0,0 +1,8 @@
+package com.vaadin.plugin.psi
+
+import com.intellij.codeInsight.highlighting.HighlightedReference
+import com.intellij.lang.properties.references.PropertyReference
+import com.intellij.psi.PsiElement
+
+class TranslationPropertyReference(key: String, psiElement: PsiElement) :
+    PropertyReference(key, psiElement, "vaadin-i18n.translations", false), HighlightedReference {}

src/main/resources/META-INF/vaadin-with-ultimate.xml

@@ -1,7 +1,8 @@
 <idea-plugin>
 
     <extensions defaultExtensionNs="com.intellij">
-        <psi.referenceContributor language="UAST" implementation="com.vaadin.plugin.endpoints.VaadinReferenceContributor"/>
+        <psi.referenceContributor language="UAST" implementation="com.vaadin.plugin.psi.FlowReferenceContributor"/>
+        <psi.referenceContributor language="JavaScript" implementation="com.vaadin.plugin.psi.HillaReferenceContributor"/>
     </extensions>
 
 </idea-plugin>

src/test/kotlin/com/vaadin/plugin/copilot/service/HillaReferenceContributorTest.kt

@@ -0,0 +1,74 @@
+package com.vaadin.plugin.copilot.service
+
+import com.intellij.lang.javascript.TypeScriptFileType
+import com.intellij.lang.properties.psi.Property
+import com.intellij.testFramework.fixtures.BasePlatformTestCase
+import com.intellij.testFramework.runInEdtAndWait
+import com.vaadin.plugin.psi.TranslationPropertyReference
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+
+class HillaReferenceContributorTest : BasePlatformTestCase() {
+
+    private val key = "button.label"
+    private val value = "Click"
+
+    @BeforeEach
+    public override fun setUp() {
+        super.setUp()
+    }
+
+    @AfterEach
+    public override fun tearDown() {
+        super.tearDown()
+    }
+
+    @Test
+    fun hillaReferenceInjectedAndResolved() {
+        val viewContent =
+            """
+            import { translate } from "@vaadin/hilla-react-i18n";
+
+            myButton.label = translate("$key")
+            """
+                .trimIndent()
+
+        val viewFile = myFixture.configureByText(TypeScriptFileType.INSTANCE, viewContent)
+        myFixture.addFileToProject("vaadin-i18n/translations.properties", "$key=$value")
+
+        runInEdtAndWait {
+            myFixture.openFileInEditor(viewFile.virtualFile)
+            myFixture.editor.caretModel.moveToOffset(viewContent.indexOf(key) + 1)
+
+            val ref = myFixture.getReferenceAtCaretPosition()
+            assertNotNull(ref)
+            assertTrue(ref is TranslationPropertyReference)
+
+            val property = ref!!.resolve() as Property
+            assertNotNull(property)
+
+            assertEquals(value, property.value)
+        }
+    }
+
+    @Test
+    fun hillaReferenceNotResolvedDueToMissingImport() {
+        val viewContent =
+            """               
+            myButton.label = translate("$key")
+            """
+                .trimIndent()
+
+        val viewFile = myFixture.configureByText(TypeScriptFileType.INSTANCE, viewContent)
+        myFixture.addFileToProject("vaadin-i18n/translations.properties", "$key=$value")
+
+        runInEdtAndWait {
+            myFixture.openFileInEditor(viewFile.virtualFile)
+            myFixture.editor.caretModel.moveToOffset(viewContent.indexOf(key) + 1)
+
+            val ref = myFixture.getReferenceAtCaretPosition()
+            assertTrue(ref == null || ref !is TranslationPropertyReference)
+        }
+    }
+}