UX improvements (#122)

dwitry · web-flow · commit 865eaceea2f0 · 2019-08-09T15:01:26.000+03:00
* Go to query Graph and Table results from Log
* Open Table results when executing metadata actions if Console window is not open
diff --git a/platform/src/main/java/com/neueda/jetbrains/plugin/graphdb/platform/GraphConstants.java b/platform/src/main/java/com/neueda/jetbrains/plugin/graphdb/platform/GraphConstants.java
@@ -9,6 +9,13 @@ public final class GraphConstants {
 
     public static class ToolWindow {
         public static final String CONSOLE_TOOL_WINDOW = "Graph Database Console";
+
+        public static class Tabs {
+            public static final String LOG = "Log";
+            public static final String GRAPH = "Graph";
+            public static final String TABLE = "Table";
+            public static final String PARAMETERS = "Parameters";
+        }
     }
 
     public static class Actions {
diff --git a/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/GraphConsoleView.java b/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/GraphConsoleView.java
@@ -24,6 +24,7 @@
 import com.intellij.util.ui.UIUtil;
 import com.neueda.jetbrains.plugin.graphdb.database.api.query.GraphQueryResult;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.analytics.Analytics;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.OpenTabEvent;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryPlanEvent;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.graph.GraphPanel;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.log.LogPanel;
@@ -32,6 +33,7 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.status.ExecutionStatusBarWidget;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.table.TablePanel;
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants;
+import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants.ToolWindow.Tabs;
 import com.neueda.jetbrains.plugin.graphdb.visualization.services.LookAndFeelService;
 
 import javax.swing.*;
@@ -117,20 +119,22 @@ public void initToolWindow(Project project, ToolWindow toolWindow) {
             // Tabs
             consoleTabs.setFirstTabOffset(0);
             consoleTabs.addTab(new TabInfo(logTab)
-                    .setText("Log"));
+                .setText(Tabs.LOG));
             consoleTabs.addTab(new TabInfo(graphTab)
-                    .setText("Graph"));
+                .setText(Tabs.GRAPH));
             consoleTabs.addTab(new TabInfo(tableScrollPane)
-                    .setText("Table"));
+                .setText(Tabs.TABLE));
             consoleTabs.addTab(new TabInfo(parametersTab)
-                    .setText("Parameters"));
+                .setText(Tabs.PARAMETERS));
             consoleTabs.setSelectionChangeHandler((info, requestFocus, doChangeSelection) -> {
                 Analytics.event("console", "openTab[" + info.getText() + "]");
                 ActionCallback callback = doChangeSelection.run();
                 graphPanel.resetPan();
                 return callback;
             });
 
+            project.getMessageBus().connect().subscribe(OpenTabEvent.OPEN_TAB_TOPIC, this::selectTab);
+
             AtomicInteger tabId = new AtomicInteger(0);
             project.getMessageBus().connect().subscribe(QueryPlanEvent.QUERY_PLAN_EVENT,
                     (query, result) -> createNewQueryPlanTab(query, result, tabId.incrementAndGet()));
@@ -147,6 +151,17 @@ public void initToolWindow(Project project, ToolWindow toolWindow) {
         }
     }
 
+    private void selectTab(String name) {
+        for (TabInfo tab : consoleTabs.getTabs()) {
+            if (name.equals(tab.getText())) {
+                consoleTabs.select(tab, true);
+                return;
+            }
+        }
+
+        throw new IllegalArgumentException("No tab found with name: " + name);
+    }
+
     private void createUIComponents() {
         graphCanvas = new JPanel(new GridLayout(0, 1));
         consoleTabsPane = new JBTabsPaneImpl(null, SwingConstants.TOP, this);
diff --git a/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/event/OpenTabEvent.java b/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/event/OpenTabEvent.java
@@ -0,0 +1,10 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event;
+
+import com.intellij.util.messages.Topic;
+
+public interface OpenTabEvent {
+
+    Topic<OpenTabEvent> OPEN_TAB_TOPIC = Topic.create("GraphDatabaseConsole.OpenTabTopic", OpenTabEvent.class);
+
+    void openTab(String graph);
+}
diff --git a/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/GoToTabFilter.java b/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/GoToTabFilter.java
@@ -0,0 +1,76 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.log;
+
+import com.intellij.execution.filters.Filter;
+import com.intellij.execution.filters.HyperlinkInfo;
+import com.intellij.execution.ui.ConsoleView;
+import com.intellij.icons.AllIcons;
+import com.intellij.openapi.ui.popup.JBPopupFactory;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.OpenTabEvent;
+import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants.ToolWindow.Tabs;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.swing.*;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+public class GoToTabFilter implements Filter {
+    static final String GRAPH_TAB_LINK = "as Graph";
+    static final String TABLE_TAB_LINK = "as Table";
+
+    private ConsoleView log;
+
+    GoToTabFilter(ConsoleView log) {
+        this.log = log;
+    }
+
+    @Nullable
+    @Override
+    public Result applyFilter(@NotNull String textLine, int endPoint) {
+        List<ResultItem> links = Stream.of(
+            createLink(textLine, endPoint, GRAPH_TAB_LINK, Tabs.GRAPH),
+            createLink(textLine, endPoint, TABLE_TAB_LINK, Tabs.TABLE))
+            .filter(Optional::isPresent)
+            .map(Optional::get)
+            .collect(Collectors.toList());
+
+        return new Result(links);
+    }
+
+    private Optional<Result> createLink(String textLine, int endPoint, String linkText, String tabName) {
+        int startPoint = endPoint - textLine.length();
+
+        int tabLinkPos = textLine.lastIndexOf(linkText);
+        if (tabLinkPos > -1) {
+            HyperlinkInfo gotoTab = e -> {
+                if (log.getContentSize() - 1 == endPoint) {
+                    e.getMessageBus().syncPublisher(OpenTabEvent.OPEN_TAB_TOPIC).openTab(tabName);
+                } else {
+                    showPopup("Query results outdated", "Please run query again");
+                }
+            };
+
+            Result graphTabLink = new Result(
+                startPoint + tabLinkPos,
+                startPoint + tabLinkPos + linkText.length(),
+                gotoTab);
+
+            return Optional.of(graphTabLink);
+        }
+        return Optional.empty();
+    }
+
+    private void showPopup(String title, String text) {
+        JBPopupFactory.getInstance()
+            .createComponentPopupBuilder(
+                new JLabel(text,
+                    AllIcons.General.BalloonInformation,
+                    JLabel.LEFT),
+                log.getComponent())
+            .setTitle(title)
+            .createPopup()
+            .showInFocusCenter();
+    }
+}
diff --git a/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/LogPanel.java b/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/LogPanel.java
@@ -30,6 +30,8 @@ public void initialize(GraphConsoleView graphConsoleView, Project project) {
         log = TextConsoleBuilderFactory.getInstance()
                 .createBuilder(project)
                 .getConsole();
+        log.addMessageFilter(new GoToTabFilter(log));
+
         Disposer.register(graphConsoleView, log);
         graphConsoleView.getLogTab().add(log.getComponent(), BorderLayout.CENTER);
 
@@ -56,6 +58,14 @@ public void executionStarted(DataSourceApi dataSource, ExecuteQueryPayload paylo
             @Override
             public void resultReceived(ExecuteQueryPayload payload, GraphQueryResult result) {
                 info(String.format("Query executed in %sms. %s", result.getExecutionTimeMs(), result.getResultSummary()));
+                if (result.getRows().isEmpty()) {
+                    info("No results.");
+                } else {
+                    info(String.format("Got %s rows. View results: %s, %s",
+                        result.getRows().size(),
+                        GoToTabFilter.GRAPH_TAB_LINK,
+                        GoToTabFilter.TABLE_TAB_LINK));
+                }
                 newLine();
             }
 
diff --git a/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/datasource/metadata/actions/MetadataAction.java b/ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/datasource/metadata/actions/MetadataAction.java
@@ -3,15 +3,21 @@
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.wm.ToolWindow;
+import com.intellij.openapi.wm.ToolWindowManager;
 import com.intellij.util.messages.MessageBus;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.actions.execute.ExecuteQueryEvent;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.actions.execute.ExecuteQueryPayload;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.DataSourcesComponent;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.state.DataSourceApi;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.ConsoleToolWindow;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.OpenTabEvent;
 
 import javax.swing.*;
 import java.util.Optional;
 
+import static com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants.ToolWindow.*;
+
 public abstract class MetadataAction extends AnAction {
 
     private String data;
@@ -38,5 +44,11 @@ public void actionPerformed(AnActionEvent e) {
         Optional<DataSourceApi> dataSource = dataSourcesComponent.getDataSourceContainer().findDataSource(dataSourceUuid);
 
         dataSource.ifPresent(dataSourceApi -> executeQueryEvent.executeQuery(dataSourceApi, payload));
+
+        ToolWindow toolWindow = ToolWindowManager.getInstance(project).getToolWindow(CONSOLE_TOOL_WINDOW);
+        if (!toolWindow.isVisible()) {
+            ConsoleToolWindow.ensureOpen(project);
+            messageBus.syncPublisher(OpenTabEvent.OPEN_TAB_TOPIC).openTab(Tabs.TABLE);
+        }
     }
 }
