Use resolved Twig template icons in Symfony Profiler actions

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/profiler/widget/action/SymfonyProfilerWidgetActions.java

@@ -3,9 +3,13 @@
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.Presentation;
+import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Computable;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
+import com.intellij.ui.IconManager;
+import com.intellij.util.PsiIconUtil;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
 import fr.adrienbrault.idea.symfony2plugin.form.util.FormUtil;
@@ -35,8 +39,8 @@ public static class TemplateAction extends AnAction {
         private final String templateName;
         private final Project project;
 
-        public TemplateAction(Project project, @NotNull String templateName) {
-            super(templateName, "Open Template", TwigIcons.TwigFileIcon);
+        public TemplateAction(@NotNull Project project, @NotNull String templateName) {
+            super(templateName, "Open Template", createDeferredTemplateIcon(project, templateName));
             this.templateName = templateName;
             this.project = project;
         }
@@ -50,6 +54,32 @@ public void actionPerformed(@NotNull AnActionEvent e) {
                 IdeHelper.navigateToPsiElement(psiFiles.iterator().next());
             }
         }
+
+        @NotNull
+        private static Icon createDeferredTemplateIcon(@NotNull Project project, @NotNull String templateName) {
+            return IconManager.getInstance().createDeferredIcon(
+                TwigIcons.TwigFileIcon,
+                new TemplateIconRequest(project, templateName),
+                request -> {
+                    Icon icon = ApplicationManager.getApplication().runReadAction((Computable<Icon>) () ->
+                        getTemplateFileIcon(request.project(), request.templateName())
+                    );
+                    return icon != null ? icon : TwigIcons.TwigFileIcon;
+                }
+            );
+        }
+
+        @Nullable
+        public static Icon getTemplateFileIcon(@NotNull Project project, @NotNull String templateName) {
+            for (PsiFile psiFile : TwigUtil.getTemplatePsiElements(project, templateName)) {
+                return PsiIconUtil.getIconFromProviders(psiFile, 0);
+            }
+
+            return null;
+        }
+
+        private record TemplateIconRequest(@NotNull Project project, @NotNull String templateName) {
+        }
     }
 
     public static class FormTypeAction extends AnAction {

src/test/java/fr/adrienbrault/idea/symfony2plugin/profiler/widget/SymfonyProfilerWidgetTest.java

@@ -3,17 +3,26 @@
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.DefaultActionGroup;
 import com.intellij.openapi.actionSystem.Separator;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.util.Computable;
+import com.intellij.ui.LayeredIcon;
+import fr.adrienbrault.idea.symfony2plugin.Settings;
 import fr.adrienbrault.idea.symfony2plugin.profiler.ProfilerIndexInterface;
 import fr.adrienbrault.idea.symfony2plugin.profiler.collector.DefaultDataCollectorInterface;
 import fr.adrienbrault.idea.symfony2plugin.profiler.collector.MailCollectorInterface;
 import fr.adrienbrault.idea.symfony2plugin.profiler.collector.TwigComponentDataCollectorInterface;
 import fr.adrienbrault.idea.symfony2plugin.profiler.dict.MailMessage;
 import fr.adrienbrault.idea.symfony2plugin.profiler.dict.ProfilerRequestInterface;
 import fr.adrienbrault.idea.symfony2plugin.profiler.dict.ProfilerTwigComponent;
+import fr.adrienbrault.idea.symfony2plugin.profiler.widget.action.SymfonyProfilerWidgetActions;
+import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.TwigIncludeStubIndex;
+import fr.adrienbrault.idea.symfony2plugin.templating.path.TwigNamespaceSetting;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import javax.swing.Icon;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -80,6 +89,30 @@ public String getUrlForRequest(@NotNull ProfilerRequestInterface request) {
         assertTrue(actionTexts.indexOf("HighTraffic") < actionTexts.indexOf("LowTraffic"));
     }
 
+    public void testTemplateActionUsesResolvedTemplateFileIcon() {
+        Settings.getInstance(getProject()).twigNamespaces.clear();
+        Settings.getInstance(getProject()).twigNamespaces.add(
+            new TwigNamespaceSetting(TwigUtil.MAIN, "templates", true, TwigUtil.NamespaceType.ADD_PATH, true)
+        );
+
+        myFixture.addFileToProject(
+            "templates/page.html.twig",
+            "{% include 'partial.html.twig' %}"
+        );
+        myFixture.addFileToProject(
+            "templates/partial.html.twig",
+            "<div>Partial</div>"
+        );
+
+        assertIndexContains(TwigIncludeStubIndex.KEY, "partial.html.twig");
+
+        Icon icon = ApplicationManager.getApplication().runReadAction((Computable<Icon>) () ->
+            SymfonyProfilerWidgetActions.TemplateAction.getTemplateFileIcon(getProject(), "partial.html.twig")
+        );
+
+        assertTrue("Profiler template action should use the decorated Twig file icon", icon instanceof LayeredIcon);
+    }
+
     private static class TestProfilerRequest implements ProfilerRequestInterface {
         private final String hash;
         private final String url;