parameters panel for query parameters in json format (#22)

* parameters panel for query parameters in json format
* output used query paramters in Log panel
* add comment as initial content of parameters tab

Author: gdalecka

database/api/src/main/java/com/neueda/jetbrains/plugin/graphdb/database/api/GraphDatabaseApi.java

@@ -2,7 +2,11 @@
 
 import com.neueda.jetbrains.plugin.graphdb.database.api.query.GraphQueryResult;
 
+import java.util.Map;
+
 public interface GraphDatabaseApi {
 
     GraphQueryResult execute(String query);
+
+    GraphQueryResult execute(String query, Map<String, Object> statementParameters);
 }

database/neo4j/src/main/java/com/neueda/jetbrains/plugin/graphdb/database/neo4j/bolt/Neo4jBoltDatabase.java

@@ -3,9 +3,15 @@
 import com.neueda.jetbrains.plugin.graphdb.database.api.GraphDatabaseApi;
 import com.neueda.jetbrains.plugin.graphdb.database.api.query.GraphQueryResult;
 import com.neueda.jetbrains.plugin.graphdb.database.neo4j.bolt.query.Neo4jBoltQueryResult;
+import org.neo4j.driver.v1.AuthToken;
+import org.neo4j.driver.v1.AuthTokens;
+import org.neo4j.driver.v1.Driver;
+import org.neo4j.driver.v1.GraphDatabase;
+import org.neo4j.driver.v1.Record;
+import org.neo4j.driver.v1.Session;
+import org.neo4j.driver.v1.StatementResult;
 
-import org.neo4j.driver.v1.*;
-
+import java.util.Collections;
 import java.util.Map;
 
 /**
@@ -35,13 +41,18 @@ public Neo4jBoltDatabase(Neo4jBoltConfiguration configuration) {
 
     @Override
     public GraphQueryResult execute(String query) {
+        return execute(query, Collections.emptyMap());
+    }
+
+    @Override
+    public GraphQueryResult execute(String query, Map<String, Object> statementParameters) {
         try (Driver driver = GraphDatabase.driver(url, auth);
-             Session session = driver.session()) {
+            Session session = driver.session()) {
 
             Neo4jBoltBuffer buffer = new Neo4jBoltBuffer();
 
             long startTime = System.currentTimeMillis();
-            StatementResult statementResult = session.run(query);
+            StatementResult statementResult = session.run(query, statementParameters);
             buffer.addColumns(statementResult.keys());
 
             for (Record record : statementResult.list()) {

gradle.properties

@@ -10,3 +10,4 @@ versionMockito=1.10.19
 versionNeo4jJavaBoltDriver=1.1.0
 versionPrefuse=1.0.0
 versionGoogleAnalytics=1.1.2
+versionJacksonMapper=2.8.6

graph-database-support-plugin/src/main/resources/META-INF/plugin.xml

@@ -125,6 +125,8 @@
                         serviceImplementation="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.GraphConsoleView"/>
         <projectService serviceInterface="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.DataSourcesView"
                         serviceImplementation="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.DataSourcesView"/>
+        <projectService serviceInterface="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.params.ParametersService"
+                        serviceImplementation="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.params.ParametersService"/>
         <scratch.rootType implementation="com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.interactions.GraphDbEditorsConsoleRootType"/>
         <applicationConfigurable groupId="tools"
                                  instance="com.neueda.jetbrains.plugin.graphdb.jetbrains.configuration.GraphDatabaseSupportConfiguration"/>

ui/jetbrains/build.gradle

@@ -17,6 +17,9 @@ dependencies {
         exclude group: "org.slf4j", module: "jcl-over-slf4j"
     }
 
+    compile("com.fasterxml.jackson.core:jackson-core:$versionJacksonMapper")
+    compile("com.fasterxml.jackson.core:jackson-databind:$versionJacksonMapper")
+
     testCompile "junit:junit:$versionJunit"
     testCompile "org.assertj:assertj-core:$versionAssertj"
 }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/actions/execute/ExecuteQueryAction.java

@@ -4,6 +4,7 @@
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.CommonDataKeys;
+import com.intellij.openapi.components.ServiceManager;
 import com.intellij.openapi.editor.Caret;
 import com.intellij.openapi.editor.Editor;
 import com.intellij.openapi.project.Project;
@@ -18,13 +19,16 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.state.DataSourceApi;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.psi.PsiTraversalUtilities;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.ConsoleToolWindow;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryParametersRetrievalErrorEvent;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.params.ParametersService;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.util.NameUtil;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.util.Notifier;
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants;
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphLanguages;
 
-import java.awt.Component;
+import java.awt.*;
 import java.awt.event.KeyEvent;
+import java.util.Map;
 import java.util.Optional;
 
 public class ExecuteQueryAction extends AnAction {
@@ -80,7 +84,16 @@ public void actionPerformed(AnActionEvent e) {
             return;
         }
 
-        ExecuteQueryPayload executeQueryPayload = new ExecuteQueryPayload(content, editor);
+        Map<String, Object> parameters;
+        try {
+            ParametersService service = ServiceManager.getService(project, ParametersService.class);
+            parameters = service.getParameters();
+        } catch (Exception exception) {
+            sendParametersRetrievalErrorEvent(messageBus, exception, editor);
+            return;
+        }
+
+        ExecuteQueryPayload executeQueryPayload = new ExecuteQueryPayload(content, parameters, editor);
         ConsoleToolWindow.ensureOpen(project);
 
         if (virtualFile != null) {
@@ -125,4 +138,10 @@ private String getCypherStatement(PsiFile psiFile, Caret caret) {
             return element.getText();
         }
     }
+
+    private void sendParametersRetrievalErrorEvent(MessageBus messageBus, Exception exception, Editor editor) {
+        QueryParametersRetrievalErrorEvent event = messageBus
+                .syncPublisher(QueryParametersRetrievalErrorEvent.QUERY_PARAMETERS_RETRIEVAL_ERROR_EVENT_TOPIC);
+        event.handleError(exception, editor);
+    }
 }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/actions/execute/ExecuteQueryPayload.java

@@ -3,20 +3,27 @@
 import com.intellij.openapi.editor.Editor;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collections;
+import java.util.Map;
 import java.util.Optional;
 
 public class ExecuteQueryPayload {
 
     private final String content;
+
+    private final Map<String, Object> parameters;
+
     private final Editor editor;
 
     public ExecuteQueryPayload(String content) {
         this.content = content;
         this.editor = null;
+        this.parameters = Collections.emptyMap();
     }
 
-    public ExecuteQueryPayload(String content, Editor editor) {
+    public ExecuteQueryPayload(String content, Map<String, Object> parameters, Editor editor) {
         this.content = content;
+        this.parameters = parameters;
         this.editor = editor;
     }
 
@@ -25,6 +32,10 @@ public String getContent() {
         return content;
     }
 
+    public Map<String, Object> getParameters() {
+        return parameters;
+    }
+
     @NotNull
     public Optional<Editor> getEditor() {
         return Optional.ofNullable(editor);

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/database/QueryExecutionService.java

@@ -55,7 +55,7 @@ private synchronized void executeInBackground(DataSourceApi dataSource, ExecuteQ
         runningQuery = ApplicationManager.getApplication().executeOnPooledThread(() -> {
             try {
                 GraphDatabaseApi database = databaseManager.getDatabaseFor(dataSource);
-                GraphQueryResult result = database.execute(payload.getContent());
+                GraphQueryResult result = database.execute(payload.getContent(), payload.getParameters());
 
                 ApplicationManager.getApplication().invokeLater(() -> {
                     event.resultReceived(payload, result);

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/GraphConsoleView.form

@@ -92,6 +92,14 @@
               </component>
             </children>
           </scrollpane>
+          <grid id="d329c" binding="parametersTab" layout-manager="BorderLayout" hgap="0" vgap="0">
+            <constraints>
+              <tabbedpane title="Parameters"/>
+            </constraints>
+            <properties/>
+            <border type="none"/>
+            <children/>
+          </grid>
         </children>
       </tabbedpane>
       <component id="b903c" class="com.intellij.ui.tabs.impl.JBTabsImpl" binding="consoleTabs" custom-create="true">

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/GraphConsoleView.java

@@ -25,15 +25,14 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.analytics.Analytics;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.graph.GraphPanel;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.log.LogPanel;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.params.ParametersPanel;
 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.visualization.services.LookAndFeelService;
 
-import javax.swing.JPanel;
-import javax.swing.SwingConstants;
-import java.awt.BorderLayout;
-import java.awt.GridLayout;
+import javax.swing.*;
+import java.awt.*;
 
 public class GraphConsoleView implements Disposable {
 
@@ -56,6 +55,7 @@ public class GraphConsoleView implements Disposable {
     private JPanel entityDetailsScrollContent;
     private JPanel logTab;
     private JPanel graphTab;
+    private JPanel parametersTab;
     private JBTabbedPane defaultTabContainer;
     private JBSplitter graphSplitter;
 
@@ -64,13 +64,15 @@ public class GraphConsoleView implements Disposable {
     private TablePanel tablePanel;
     private GraphPanel graphPanel;
     private LogPanel logPanel;
+    private ParametersPanel parametersPanel;
 
     public GraphConsoleView() {
         initialized = false;
 
         tablePanel = new TablePanel();
         graphPanel = new GraphPanel();
         logPanel = new LogPanel();
+        parametersPanel = new ParametersPanel();
         lookAndFeelService = ServiceManager.getService(LookAndFeelService.class);
     }
 
@@ -95,6 +97,8 @@ public void initToolWindow(Project project, ToolWindow toolWindow) {
                     .setText("Graph"));
             consoleTabs.addTab(new TabInfo(tableScrollPane)
                     .setText("Table"));
+            consoleTabs.addTab(new TabInfo(parametersTab)
+                    .setText("Parameters"));
             consoleTabs.setSelectionChangeHandler((info, requestFocus, doChangeSelection) -> {
                 Analytics.event("console", "openTab[" + info.getText() + "]");
                 ActionCallback callback = doChangeSelection.run();
@@ -126,12 +130,14 @@ private void updateLookAndFeel() {
         entityDetailsScrollPane.setBorder(IdeBorderFactory.createEmptyBorder());
         logTab.setBorder(IdeBorderFactory.createEmptyBorder());
         graphTab.setBorder(IdeBorderFactory.createEmptyBorder());
+        parametersTab.setBorder(IdeBorderFactory.createEmptyBorder());
     }
 
     private void initializeUiComponents(Project project) {
         graphPanel.initialize(this, project);
         tablePanel.initialize(this, project);
         logPanel.initialize(this, project);
+        parametersPanel.initialize(this, project);
     }
 
     private void initializeWidgets(Project project) {
@@ -168,6 +174,10 @@ public JPanel getLogTab() {
         return logTab;
     }
 
+    public JPanel getParametersTab() {
+        return parametersTab;
+    }
+
     @Override
     public void dispose() {
     }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/event/QueryParametersRetrievalErrorEvent.java

@@ -0,0 +1,14 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event;
+
+import com.intellij.openapi.editor.Editor;
+import com.intellij.util.messages.Topic;
+
+public interface QueryParametersRetrievalErrorEvent {
+
+    Topic<QueryParametersRetrievalErrorEvent> QUERY_PARAMETERS_RETRIEVAL_ERROR_EVENT_TOPIC =
+            Topic.create("GraphDatabaseConsole.QueryParametersRetrievalErrorEventTopic", QueryParametersRetrievalErrorEvent.class);
+
+    String PARAMS_ERROR_COMMON_MSG = "Failed to retrieve query parameters";
+    void handleError(Exception exception, Editor editor);
+
+}

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/LogPanel.java

@@ -12,9 +12,13 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.state.DataSourceApi;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.GraphConsoleView;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryExecutionProcessEvent;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryParametersRetrievalErrorEvent;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.metadata.MetadataRetrieveEvent;
 
 import java.awt.*;
+import java.util.Map;
+
+import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryParametersRetrievalErrorEvent.*;
 
 public class LogPanel implements Disposable {
 
@@ -35,6 +39,10 @@ public void executionStarted(ExecuteQueryPayload payload) {
                 info("Executing query: ");
                 userInput(payload.getContent());
                 newLine();
+                if (!payload.getParameters().isEmpty()) {
+                    info("With parameters: ");
+                    printParametersMap(payload.getParameters());
+                }
             }
 
             @Override
@@ -80,12 +88,26 @@ public void metadataRefreshFailed(DataSourceApi nodeDataSource, Exception except
                 newLine();
             }
         });
+
+        messageBus.connect().subscribe(QueryParametersRetrievalErrorEvent.QUERY_PARAMETERS_RETRIEVAL_ERROR_EVENT_TOPIC,
+                (exception, editor) -> {
+                    error(PARAMS_ERROR_COMMON_MSG);
+                    printException(exception);
+                });
     }
 
     public void userInput(String message) {
         log.print(message, ConsoleViewContentType.USER_INPUT);
     }
 
+    public void printParametersMap(Map<String, Object> parameters) {
+        for (Map.Entry<String, Object> entry : parameters.entrySet()) {
+            String message = String.format("%s: %s", entry.getKey(), entry.getValue());
+            log.print(message, ConsoleViewContentType.USER_INPUT);
+            newLine();
+        }
+    }
+
     public void info(String message) {
         log.print(message, ConsoleViewContentType.NORMAL_OUTPUT);
     }