Tooltip on Hover

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/README.md

@@ -259,4 +259,4 @@ integration, telemetry connectivity, and Azure Toolkit integration.
   that require it. Otherwise, it is not necessary to authenticate non-Azure Open-AI clients.
   Please refer to
   the [KeyCredential Class documentation](https://learn.microsoft.com/java/api/com.azure.core.credential.keycredential?view=azure-java-stable)
-  for more information.
+  for more information.

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/CustomTooltipOnHover.java

@@ -0,0 +1,150 @@
+package com.microsoft.azure.toolkit.intellij.azure.sdk.buildtool;
+
+import com.intellij.codeInspection.LocalQuickFix;
+import com.intellij.codeInspection.ProblemDescriptor;
+import com.intellij.ide.BrowserUtil;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.openapi.editor.colors.EditorColorsManager;
+import com.intellij.openapi.editor.colors.EditorFontType;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.ui.popup.Balloon;
+import com.intellij.openapi.ui.popup.JBPopupFactory;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.intellij.ui.JBColor;
+import com.intellij.ui.awt.RelativePoint;
+import com.intellij.ui.components.JBPanel;
+import com.intellij.util.ui.JBUI;
+import com.intellij.openapi.editor.EditorFactory;
+import org.jetbrains.annotations.NotNull;
+
+import javax.swing.JEditorPane;
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Insets;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.text.html.HTMLEditorKit;
+import javax.swing.text.html.StyleSheet;
+
+/**
+ * This class is used to create a custom quick fix that shows a tooltip with a recommendation text and a link to the Azure SDK for Java documentation.
+ */
+class CustomTooltipOnHover implements LocalQuickFix {
+
+    private final String recommendationText;
+    private final String linkUrl;
+
+    /**
+     * Constructor for CustomTooltipOnHover.
+     *
+     * @param recommendationText - the recommendation text to be shown in the tooltip
+     * @param linkUrl            - the URL to be opened when the user clicks on the link in the tooltip
+     */
+    CustomTooltipOnHover(String recommendationText, String linkUrl) {
+        this.recommendationText = recommendationText;
+        this.linkUrl = linkUrl;
+    }
+
+    /**
+     * This method is used to get the name of the quick fix.
+     *
+     * @return The name of the quick fix.
+     */
+    @Override
+    public @NotNull String getName() {
+        return "Show Details";
+    }
+
+    /**
+     * This method is used to get the family name of the quick fix.
+     * The family name is used to group similar quick fixes together in the UI.
+     *
+     * @return The family name of the quick fix.
+     */
+    @Override
+    public @NotNull String getFamilyName() {
+        return getName();
+    }
+
+    /**
+     * This method is used to display the tooltip when the user clicks on the "Show Details" link in the tooltip.
+     *
+     * @param project    The project in which the problem was found.
+     * @param descriptor The descriptor for the problem that was found.
+     */
+    @Override
+    public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
+        PsiElement element = descriptor.getPsiElement();
+        showDetailsTooltip(element, project);
+    }
+
+    /**
+     * This method is used to show a tooltip with the recommendation text and a link to the Azure SDK for Java documentation.
+     *
+     * @param element - the PsiElement where the tooltip should be shown
+     * @param project - the Project object
+     */
+    private void showDetailsTooltip(@NotNull PsiElement element, @NotNull Project project) {
+
+        // Create a panel for the tooltip
+        JBPanel<JBPanel<?>> panel = new JBPanel<>();
+        panel.setBorder(JBUI.Borders.empty(5)); // Add padding
+
+        // Create a JEditorPane for both the recommendation text and the link
+        JEditorPane editorPane = new JEditorPane();
+        editorPane.setEditorKit(new HTMLEditorKit());
+        StyleSheet styleSheet = ((HTMLEditorKit) editorPane.getEditorKit()).getStyleSheet();
+
+        // Get IntelliJ's default editor font
+        Font editorFont = EditorColorsManager.getInstance().getGlobalScheme().getFont(EditorFontType.PLAIN);
+        int fontSize = editorFont.getSize();
+
+        // Apply a font stack that's likely to match IntelliJ's appearance
+        styleSheet.addRule("body { font-family: 'sans-serif'; font-size: " + fontSize + "pt; margin: 0; padding: 0; color: #FFFFFF; }");
+        styleSheet.addRule("a { color: #8AC3F7; text-decoration: none; }");
+        editorPane.setContentType("text/html");
+
+        // Combine the recommendation text and the link on the same line
+        String htmlContent = "<html><body style='width: 500px; color: #B0B0B0;'>" + recommendationText + " <a href='" + linkUrl + "'>Refer to Azure SDK for Java documentation</a>" + " for more information on this suggestion. </body></html>";
+
+        // Set the HTML content to the editorPane
+        editorPane.setText(htmlContent);
+        editorPane.setEditable(false);
+        editorPane.setBackground(panel.getBackground());
+        editorPane.setForeground(JBColor.LIGHT_GRAY);
+
+        // Add hyperlink listener
+        editorPane.addHyperlinkListener(e -> {
+            if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
+                BrowserUtil.browse(e.getURL());
+            }
+        });
+
+        // Add the linkLabel to the panel
+        panel.add(editorPane, BorderLayout.CENTER);
+
+        PsiFile psiFile = element.getContainingFile();
+        Editor editor = EditorFactory.getInstance().getEditors(psiFile.getViewProvider().getDocument(), project)[0];
+
+        // Get the relative position of the element in the editor
+        RelativePoint relativePoint = new RelativePoint(editor.getContentComponent(), editor.visualPositionToXY(editor.getCaretModel().getVisualPosition()));
+
+        // Create a balloon tooltip with custom appearance
+        JBPopupFactory.getInstance().createBalloonBuilder(panel).setFillColor(new Color(100, 100, 100)) // Dark gray background
+                .setBorderColor(new Color(100, 100, 100)) // Remove border
+                .setHideOnAction(true).setHideOnClickOutside(true).setHideOnFrameResize(true).setHideOnKeyOutside(true).setBorderInsets(new Insets(0, 0, 0, 0)) // Remove padding
+                .createBalloon().show(relativePoint, Balloon.Position.above);
+    }
+
+    /**
+     * This method is used to show a recommendation text with a link to the Azure SDK for Java documentation.
+     *
+     * @param recommendationText - the recommendation text to be shown in the tooltip
+     * @param linkUrl            - the URL to be opened when the user clicks on the link in the tooltip
+     * @return CustomTooltipOnHover object
+     */
+    static CustomTooltipOnHover showRecommendationText(String recommendationText, String linkUrl) {
+        return new CustomTooltipOnHover(recommendationText, linkUrl);
+    }
+}

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/DetectDiscouragedAPIUsageCheck.java

@@ -112,7 +112,7 @@ public void visitElement(@NotNull PsiElement element) {
                             return;
                         }
                         // give the suggestion of the discouraged method
-                        holder.registerProblem(problemElement, RULE_CONFIG.getAntiPatternMessageMap().get(method.getName()));
+                        holder.registerProblem(problemElement, RULE_CONFIG.getAntiPatternMessageMap().get(method.getName()), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get(method.getName()), RULE_CONFIG.getRecommendationLink().get(method.getName())));
                     }
                 }
             }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/DetectDiscouragedClientCheck.java

@@ -75,7 +75,7 @@ public void visitTypeElement(PsiTypeElement element) {
                 String elementType = element.getType().getPresentableText();
 
                 // Register a problem if the client used matches a discouraged client
-                holder.registerProblem(element, RULE_CONFIG.getAntiPatternMessageMap().get(elementType));
+                holder.registerProblem(element, RULE_CONFIG.getAntiPatternMessageMap().get(elementType), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get(elementType), RULE_CONFIG.getRecommendationLink().get(elementType)));
             }
         }
     }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/DisableAutoCompleteCheck.java

@@ -124,7 +124,7 @@ private void processVariableDeclaration(PsiVariable variable) {
                 // Process the new expression initialization
                 if (!isAutoCompleteDisabled((PsiMethodCallExpression) initializer)) {
                     // Register a problem if the auto-complete feature is not disabled
-                    holder.registerProblem(initializer, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    holder.registerProblem(initializer, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             }
         }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/DynamicClientCreationCheck.java

@@ -127,7 +127,7 @@ private void checkClientCreation(PsiStatement blockChild) {
 
                 // Check if the right-hand side is a method call expression
                 if (rhs != null && isClientCreationMethod((PsiMethodCallExpression) rhs)) {
-                    holder.registerProblem(rhs, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    holder.registerProblem(rhs, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             } else if (blockChild instanceof PsiDeclarationStatement) {    // This is a check for the declaration statement
 
@@ -152,7 +152,7 @@ private void checkClientCreation(PsiStatement blockChild) {
                     // Check if the initializer is a method call expression
                     PsiMethodCallExpression methodCallExpression = (PsiMethodCallExpression) initializer;
                     if (isClientCreationMethod(methodCallExpression)) {
-                        holder.registerProblem(methodCallExpression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                        holder.registerProblem(methodCallExpression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                     }
                 }
             }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/EndpointOnNonAzureOpenAIAuthCheck.java

@@ -89,7 +89,7 @@ public void visitMethodCallExpression(@NotNull PsiMethodCallExpression expressio
                 // Using KeyCredential indicates authentication of a non-Azure OpenAI client
                 // If the endpoint method is used with KeyCredential for non-Azure OpenAI clients, a warning is registered
                 if (isUsingKeyCredential(expression)) {
-                    holder.registerProblem(expression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    holder.registerProblem(expression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             }
         }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/GetSyncPollerOnPollerFluxCheck.java

@@ -95,7 +95,7 @@ public void visitMethodCallExpression(@NotNull PsiMethodCallExpression expressio
                 boolean isAsyncContext = checkIfAsyncContext(methodCall);
 
                 if (isAsyncContext && isAzureClient(methodCall)) {
-                    holder.registerProblem(expression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    holder.registerProblem(expression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             }
         }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/HardcodedAPIKeysAndTokensCheck.java

@@ -76,7 +76,7 @@ public void visitElement(@NotNull PsiElement element) {
                 // Check if the class reference is not null, the qualifier name starts with "com.azure" and
                 // the class reference is in the list of clients to check
                 if (newExpression.getClassReference() != null && newExpression.getClassReference().getQualifiedName().startsWith(RuleConfig.AZURE_PACKAGE_NAME) && RULE_CONFIG.getServicesToCheck().contains(classReference)) {
-                    this.holder.registerProblem(newExpression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    this.holder.registerProblem(newExpression, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             }
         }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/KustoQueriesWithTimeIntervalInQueryStringCheck.java

@@ -232,7 +232,7 @@ private void checkParameterNames(PsiMethodCallExpressionImpl methodCall) {
                 }
 
                 if (isAzureClient(methodCall)) {
-                    holder.registerProblem(methodCall, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"));
+                    holder.registerProblem(methodCall, RULE_CONFIG.getAntiPatternMessageMap().get("antiPatternMessage"), CustomTooltipOnHover.showRecommendationText(RULE_CONFIG.getRecommendationText().get("recommendationText"), RULE_CONFIG.getRecommendationLink().get("recommendationLink")));
                 }
             }
         }

PluginsAndFeatures/azure-toolkit-for-intellij/azure-intellij-plugin-azure-sdk/src/main/java/com/microsoft/azure/toolkit/intellij/azure/sdk/buildtool/RuleConfig.java

@@ -15,9 +15,12 @@ class RuleConfig {
     private final Map<String, String> antiPatternMessageMap;
     private final List<String> listedItemsToCheck;
 
+    private final Map<String, String> recommendationText;
+    private final Map<String, String> recommendationLink;
+
     static final String AZURE_PACKAGE_NAME = "com.azure";
 
-    static final RuleConfig EMPTY_RULE = new RuleConfig(Collections.emptyList(), Collections.emptyList(), Collections.emptyList(), Collections.emptyMap(), Collections.emptyList());
+    static final RuleConfig EMPTY_RULE = new RuleConfig(Collections.emptyList(), Collections.emptyList(), Collections.emptyList(), Collections.emptyMap(), Collections.emptyList(), Collections.emptyMap(), Collections.emptyMap());
 
     /**
      * Constructor for RuleConfig.
@@ -27,13 +30,17 @@ class RuleConfig {
      * @param servicesToCheck           List of services to check.
      * @param antiPatternMessageMap     Map of antipattern messages to display.
      * @param listedItemsToCheck List of items to check for.
+     * @param recommendationText Map of the Recommendation text for the anti-pattern.
+     * @param recommendationLink Map of the Recommendation link for the anti-pattern.
      */
-    RuleConfig(List<String> methodsToCheck, List<String> clientsToCheck, List<String> servicesToCheck, Map<String, String> antiPatternMessageMap, List<String> listedItemsToCheck) {
+    RuleConfig(List<String> methodsToCheck, List<String> clientsToCheck, List<String> servicesToCheck, Map<String, String> antiPatternMessageMap, List<String> listedItemsToCheck, Map<String, String> recommendationText, Map<String, String> recommendationLink) {
         this.methodsToCheck = methodsToCheck;
         this.clientsToCheck = clientsToCheck;
         this.servicesToCheck = servicesToCheck;
         this.antiPatternMessageMap = antiPatternMessageMap;
         this.listedItemsToCheck = listedItemsToCheck;
+        this.recommendationText = recommendationText;
+        this.recommendationLink = recommendationLink;
     }
 
     /**
@@ -95,4 +102,22 @@ Map<String, String> getAntiPatternMessageMap() {
     List<String> getListedItemsToCheck() {
         return listedItemsToCheck;
     }
+
+    /**
+     * This method returns the recommendation text
+     *
+     * @return Recommendation text
+     */
+    public Map<String, String> getRecommendationText() {
+        return recommendationText;
+    }
+
+    /**
+     * This method returns the recommendation link
+     *
+     * @return Recommendation link
+     */
+    public Map<String, String> getRecommendationLink() {
+        return recommendationLink;
+    }
 }