[DQL] Executed DQL services will now be grouped by tenant in the Services tab (#119)

* [DQL] Executed DQL services will now be grouped by tenant in the Services tab

This helps to easily execute the same query on multiple tenants and compare values

* [DQL] Fixing code reviews

* [DQL] Fixing error when executing run configuration

Author: dorian-krefft-dt

CHANGELOG.md

@@ -11,6 +11,7 @@
   - Adding predefined timeframes to the DQL execution toolbar (user can still define a custom one)
   - The DQL execution result will show an empty cell for a boolean column that had a `null` value (instead of the
     unchecked checkbox). This change helps to differentiate between `false` and `null` values.
+  - Executed DQL queries will now be grouped by the tenant they were executed on in the Services tab
 - The "Show DQL query" option when executing DQL will now try to show the parsed query instead of the raw one, if
   possible.
 - Adding support for "Expression DQL" file (with `.edql` extensions), which allows to define a DQL expression without

src/main/java/pl/thedeem/intellij/common/Icons.java

@@ -0,0 +1,9 @@
+package pl.thedeem.intellij.common;
+
+import com.intellij.openapi.util.IconLoader;
+
+import javax.swing.*;
+
+public interface Icons {
+    Icon DYNATRACE_LOGO = IconLoader.getIcon("/icons/dynatrace.png", Icons.class);
+}

src/main/java/pl/thedeem/intellij/common/IntelliJUtils.java

@@ -20,6 +20,7 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.project.ProjectUtil;
 import com.intellij.openapi.ui.Messages;
+import com.intellij.openapi.util.io.FileUtil;
 import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.openapi.vfs.VfsUtilCore;
 import com.intellij.openapi.vfs.VirtualFile;
@@ -88,6 +89,14 @@ public static void openRunConfiguration(@NotNull Project project) {
         return VfsUtilCore.getRelativePath(file, baseDir, '/');
     }
 
+    public static @Nullable VirtualFile getProjectRelativeFile(@NotNull String relativePath, @NotNull Project project) {
+        VirtualFile baseDir = ProjectUtil.guessProjectDir(project);
+        if (baseDir == null) {
+            return null;
+        }
+        return baseDir.findFileByRelativePath(FileUtil.toSystemIndependentName(relativePath));
+    }
+
     public static class StandardEditorCustomization implements EditorCustomization {
         @Override
         public void customize(@NotNull EditorEx editor) {

src/main/java/pl/thedeem/intellij/common/StandardItemPresentation.java

@@ -2,6 +2,7 @@
 
 import com.intellij.navigation.ItemPresentation;
 import com.intellij.psi.PsiElement;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import javax.swing.*;
@@ -11,11 +12,11 @@ public class StandardItemPresentation implements ItemPresentation {
     private final PsiElement element;
     private final Icon icon;
 
-    public StandardItemPresentation(String name, Icon icon) {
+    public StandardItemPresentation(@NotNull String name, @Nullable Icon icon) {
         this(name, null, icon);
     }
 
-    public StandardItemPresentation(String name, PsiElement element, Icon icon) {
+    public StandardItemPresentation(@NotNull String name, @Nullable PsiElement element, @Nullable Icon icon) {
         this.name = name;
         this.element = element;
         this.icon = icon;

src/main/java/pl/thedeem/intellij/common/components/ResizableTextField.java

@@ -0,0 +1,124 @@
+package pl.thedeem.intellij.common.components;
+
+import com.intellij.icons.AllIcons;
+import com.intellij.openapi.ui.JBMenuItem;
+import com.intellij.openapi.ui.JBPopupMenu;
+import com.intellij.ui.DocumentAdapter;
+import com.intellij.ui.JBColor;
+import com.intellij.ui.components.JBTextField;
+import com.intellij.util.ui.JBUI;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import pl.thedeem.intellij.dql.DQLBundle;
+import pl.thedeem.intellij.dql.DQLUtil;
+
+import javax.swing.border.Border;
+import javax.swing.event.DocumentEvent;
+import javax.swing.text.AbstractDocument;
+import javax.swing.text.AttributeSet;
+import javax.swing.text.BadLocationException;
+import javax.swing.text.DocumentFilter;
+import java.awt.*;
+
+public class ResizableTextField extends JBTextField {
+    private final static int TEXT_FIELD_MIN_WIDTH = 75;
+    private final static int TEXT_FIELD_MAX_WIDTH = 400;
+
+    public ResizableTextField() {
+        getDocument().addDocumentListener(new DocumentAdapter() {
+            @Override
+            protected void textChanged(@NotNull DocumentEvent documentEvent) {
+                resizeToFit();
+            }
+        });
+    }
+
+    public void resizeToFit() {
+        String text = getText();
+        FontMetrics fm = getFontMetrics(getFont());
+
+        int textWidth = fm.stringWidth(text + "WW");
+        int newWidth = Math.max(JBUI.scale(TEXT_FIELD_MIN_WIDTH), Math.min(JBUI.scale(TEXT_FIELD_MAX_WIDTH), textWidth));
+
+        Dimension dim = new Dimension(newWidth, getPreferredSize().height);
+        setPreferredSize(dim);
+        setMinimumSize(dim);
+
+        Container parent = getParent();
+        if (parent != null) {
+            parent.revalidate();
+            parent.repaint();
+        }
+    }
+
+    public static @NotNull ResizableTextField createStandardField(@Nullable String placeholder, @Nullable String tooltip) {
+        ResizableTextField result = new ResizableTextField();
+        result.setToolTipText(tooltip);
+        result.getEmptyText().setText(placeholder);
+        result.setPreferredSize(new Dimension(result.getPreferredSize().width, JBUI.scale(25)));
+        result.resizeToFit();
+        return result;
+    }
+
+    public static @NotNull ResizableTextField createTimeField(@Nullable String placeholder, @Nullable String tooltip) {
+        ResizableTextField result = createStandardField(placeholder, tooltip);
+        Border defaultBorder = result.getBorder();
+        result.getDocument().addDocumentListener(new DocumentAdapter() {
+            @Override
+            protected void textChanged(@NotNull DocumentEvent documentEvent) {
+                String error = validateTime(result.getText());
+                if (error != null) {
+                    result.setToolTipText(error);
+                    result.setBorder(JBUI.Borders.compound(JBUI.Borders.customLineBottom(JBColor.RED), defaultBorder));
+                } else {
+                    result.setToolTipText(tooltip);
+                    result.setBorder(defaultBorder);
+                }
+                result.revalidate();
+                result.repaint();
+            }
+        });
+
+        JBPopupMenu popupMenu = new JBPopupMenu();
+        JBMenuItem currentTimestampAction = new JBMenuItem(DQLBundle.message("components.queryExecution.actions.getCurrentTimestamp"));
+        currentTimestampAction.setIcon(AllIcons.General.Inline_edit);
+        currentTimestampAction.setBorder(ComponentsUtils.DEFAULT_BORDER);
+        currentTimestampAction.addActionListener(e -> result.setText(DQLUtil.getCurrentTimeTimestamp()));
+        popupMenu.add(currentTimestampAction);
+        result.setComponentPopupMenu(popupMenu);
+        return result;
+    }
+
+    public static @NotNull ResizableTextField createNumericField(@Nullable String placeholder, @Nullable String tooltip) {
+        ResizableTextField result = createStandardField(placeholder, tooltip);
+        ((AbstractDocument) result.getDocument()).setDocumentFilter(new NumericFilter());
+        return result;
+    }
+
+    private static @Nullable String validateTime(@NotNull String time) throws IllegalArgumentException {
+        try {
+            DQLUtil.parseUserTime(time.trim());
+            return null;
+        } catch (IllegalArgumentException ex) {
+            return DQLBundle.message("components.queryRange.invalidDate", ex.getMessage());
+        }
+    }
+
+    private static class NumericFilter extends DocumentFilter {
+        @Override
+        public void insertString(FilterBypass fb, int offset, String string, AttributeSet attr)
+                throws BadLocationException {
+            if (string.matches("-?\\d*")) {
+                super.insertString(fb, offset, string, attr);
+            }
+        }
+
+        @Override
+        public void replace(FilterBypass fb, int offset, int length, String text, AttributeSet attrs)
+                throws BadLocationException {
+            if (text.matches("-?\\d*")) {
+                super.replace(fb, offset, length, text, attrs);
+            }
+        }
+    }
+}

src/main/java/pl/thedeem/intellij/common/components/SimpleDataProviderPanel.java

@@ -0,0 +1,7 @@
+package pl.thedeem.intellij.common.components;
+
+import com.intellij.openapi.actionSystem.UiDataProvider;
+import com.intellij.util.ui.components.BorderLayoutPanel;
+
+public abstract class SimpleDataProviderPanel extends BorderLayoutPanel implements UiDataProvider {
+}

src/main/java/pl/thedeem/intellij/common/services/ManagedService.java

@@ -0,0 +1,13 @@
+package pl.thedeem.intellij.common.services;
+
+import com.intellij.execution.services.ServiceViewDescriptor;
+import com.intellij.openapi.Disposable;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+public interface ManagedService extends ServiceViewDescriptor, Disposable {
+    @NotNull String getServiceId();
+
+    @NotNull List<ManagedServiceGroup> getParentGroups();
+}

src/main/java/pl/thedeem/intellij/common/services/ManagedServiceGroup.java

@@ -0,0 +1,7 @@
+package pl.thedeem.intellij.common.services;
+
+import com.intellij.execution.services.ServiceViewDescriptor;
+import com.intellij.openapi.Disposable;
+
+public interface ManagedServiceGroup extends ServiceViewDescriptor, Disposable {
+}

src/main/java/pl/thedeem/intellij/common/services/ManagedServiceViewContributor.java

@@ -0,0 +1,38 @@
+package pl.thedeem.intellij.common.services;
+
+import com.intellij.execution.services.ServiceViewDescriptor;
+import com.intellij.execution.services.ServiceViewGroupingContributor;
+import com.intellij.execution.services.SimpleServiceViewDescriptor;
+import com.intellij.openapi.project.Project;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Unmodifiable;
+import pl.thedeem.intellij.common.Icons;
+
+import java.util.List;
+
+public class ManagedServiceViewContributor implements ServiceViewGroupingContributor<ManagedService, ManagedServiceGroup> {
+    @Override
+    public @NotNull ServiceViewDescriptor getViewDescriptor(@NotNull Project project) {
+        return new SimpleServiceViewDescriptor("Dynatrace Query Language Services", Icons.DYNATRACE_LOGO);
+    }
+
+    @Override
+    public @NotNull @Unmodifiable List<ManagedService> getServices(@NotNull Project project) {
+        return ProjectServicesManager.getInstance(project).getRegisteredServices();
+    }
+
+    @Override
+    public @NotNull ServiceViewDescriptor getServiceDescriptor(@NotNull Project project, @NotNull ManagedService service) {
+        return service;
+    }
+
+    @Override
+    public @NotNull List<ManagedServiceGroup> getGroups(@NotNull ManagedService managedService) {
+        return managedService.getParentGroups();
+    }
+
+    @Override
+    public @NotNull ServiceViewDescriptor getGroupDescriptor(@NotNull ManagedServiceGroup group) {
+        return group;
+    }
+}

src/main/java/pl/thedeem/intellij/common/services/ProjectServicesManager.java

@@ -0,0 +1,66 @@
+package pl.thedeem.intellij.common.services;
+
+import com.intellij.execution.services.ServiceEventListener;
+import com.intellij.execution.services.ServiceEventListener.ServiceEvent;
+import com.intellij.execution.services.ServiceViewManager;
+import com.intellij.openapi.Disposable;
+import com.intellij.openapi.components.Service;
+import com.intellij.openapi.project.Project;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Predicate;
+
+@Service(Service.Level.PROJECT)
+public final class ProjectServicesManager implements Disposable {
+    private final List<ManagedService> children;
+
+    private final Project project;
+
+    public ProjectServicesManager(@NotNull Project project) {
+        this.project = project;
+        this.children = new ArrayList<>();
+    }
+
+    public static @NotNull ProjectServicesManager getInstance(@NotNull Project project) {
+        return project.getService(ProjectServicesManager.class);
+    }
+
+    public @NotNull List<ManagedService> getRegisteredServices() {
+        return children;
+    }
+
+    @Override
+    public void dispose() {
+        for (ManagedService service : children) {
+            service.dispose();
+        }
+        children.clear();
+    }
+
+    public <T extends ManagedService> void registerService(@NotNull T service) {
+        unregisterService(service);
+        children.add(service);
+        project.getMessageBus().syncPublisher(ServiceEventListener.TOPIC).handle(
+                ServiceEventListener.ServiceEvent.createServiceAddedEvent(service, ManagedServiceViewContributor.class, null)
+        );
+        ServiceViewManager instance = ServiceViewManager.getInstance(project);
+        instance.select(service, ManagedServiceViewContributor.class, true, true);
+    }
+
+    public <T extends ManagedService> void unregisterService(@NotNull T service) {
+        ManagedService existing = children.stream().filter(e -> e.equals(service)).findFirst().orElse(null);
+        if (existing != null) {
+            existing.dispose();
+            children.remove(existing);
+            project.getMessageBus().syncPublisher(ServiceEventListener.TOPIC).handle(
+                    ServiceEvent.createEvent(ServiceEventListener.EventType.SERVICE_REMOVED, existing, ManagedServiceViewContributor.class)
+            );
+        }
+    }
+
+    public @NotNull List<ManagedService> find(@NotNull Predicate<? super ManagedService> filter) {
+        return children.stream().filter(filter).toList();
+    }
+}