Migrate to using elementId (#84)

* Migrate to using elementId

The cypher function `id` has been deprecated since Neo4j 5.0.
This PR adds the capability of sniffing the DBMS version so that the DiffService
can write an update query that matches the server version.

Likewise has `entity.id()` in the driver been deprecated. The driver will set
`elementId` to `id.toString()` if the server does not provide it (4.4 and
before). Therefore, it's safe to always use `entity.elementId()` regardless of
the server version.

* Add integration test for fetching Neo4j version

* Fix test assertion: expected & actual position

Author: robsdedude

database/api/src/main/java/com/albertoventurini/graphdbplugin/database/api/GraphDatabaseApi.java

@@ -6,6 +6,7 @@
  */
 package com.albertoventurini.graphdbplugin.database.api;
 
+import com.albertoventurini.graphdbplugin.database.api.data.GraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.database.api.data.GraphMetadata;
 import com.albertoventurini.graphdbplugin.database.api.query.GraphQueryResult;
 
@@ -18,4 +19,6 @@ public interface GraphDatabaseApi {
     GraphQueryResult execute(String query, Map<String, Object> statementParameters);
 
     GraphMetadata metadata();
+
+    GraphDatabaseVersion getVersion();
 }

database/api/src/main/java/com/albertoventurini/graphdbplugin/database/api/data/GraphDatabaseVersion.java

@@ -0,0 +1,15 @@
+/**
+ * Copied and adapted from plugin
+ * <a href="https://github.com/neueda/jetbrains-plugin-graph-database-support">Graph Database Support</a>
+ * by Neueda Technologies, Ltd.
+ * Modified by Alberto Venturini, 2022
+ */
+package com.albertoventurini.graphdbplugin.database.api.data;
+
+public interface GraphDatabaseVersion {
+    String toString();
+
+    String idFunction();
+
+    Object idToParameter(String id);
+}

database/neo4j/src/main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/Neo4jBoltDatabase.java

@@ -7,9 +7,12 @@
 package com.albertoventurini.graphdbplugin.database.neo4j.bolt;
 
 import com.albertoventurini.graphdbplugin.database.api.GraphDatabaseApi;
+import com.albertoventurini.graphdbplugin.database.api.data.GraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.database.api.data.GraphMetadata;
 import com.albertoventurini.graphdbplugin.database.api.query.GraphQueryResult;
+import com.albertoventurini.graphdbplugin.database.neo4j.bolt.data.Neo4jGraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.database.neo4j.bolt.query.Neo4jBoltQueryResult;
+import com.albertoventurini.graphdbplugin.database.neo4j.bolt.query.Neo4jBoltQueryResultRow;
 import org.neo4j.driver.AuthToken;
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Driver;
@@ -21,14 +24,21 @@
 import org.neo4j.driver.exceptions.ClientException;
 
 import java.nio.channels.UnresolvedAddressException;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.Map;
+import java.util.stream.IntStream;
 
 /**
  * Communicates with Neo4j 3.0+ database using Bolt driver.
  */
 public class Neo4jBoltDatabase implements GraphDatabaseApi {
 
+    private static final String VERSION_QUERY = """
+            CALL dbms.components() YIELD versions
+            RETURN versions[0] AS version
+            """;
+
     private final String url;
     private final AuthToken auth;
     private final SessionConfig dbConfig;
@@ -110,4 +120,19 @@ public GraphQueryResult execute(String query, Map<String, Object> statementParam
     public GraphMetadata metadata() {
         throw new IllegalStateException("Not implemented");
     }
+
+    @Override
+    public GraphDatabaseVersion getVersion() {
+        var result = execute(VERSION_QUERY);
+        var row = result.getRows().get(0);
+        var neo4jRow = (Neo4jBoltQueryResultRow) row;
+        var rawVersion = neo4jRow.getValue("version").asString();
+        var parsedVersion = IntStream.concat(
+                Arrays.stream(rawVersion.split("\\.", 4))
+                        .limit(3)
+                        .mapToInt(Integer::parseInt),
+                IntStream.generate(() -> 0)
+        ).limit(3).toArray();
+        return new Neo4jGraphDatabaseVersion(parsedVersion[0], parsedVersion[1], parsedVersion[2]);
+    }
 }

database/neo4j/src/main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jBoltNode.java

@@ -21,7 +21,7 @@ public class Neo4jBoltNode implements GraphNode {
     private final List<String> types;
 
     public Neo4jBoltNode(Node value) {
-        this.id = String.valueOf(value.id());
+        this.id = String.valueOf(value.elementId());
         this.types = Iterables.asList(value.labels());
         this.propertyContainer = new Neo4jBoltPropertyContainer(value.asMap());
     }

database/neo4j/src/main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jBoltRelationship.java

@@ -26,12 +26,12 @@ public class Neo4jBoltRelationship implements GraphRelationship {
     private GraphNode endNode;
 
     public Neo4jBoltRelationship(Relationship rel) {
-        this.id = String.valueOf(rel.id());
+        this.id = String.valueOf(rel.elementId());
         this.types = Collections.singletonList(rel.type());
         this.propertyContainer = new Neo4jBoltPropertyContainer(rel.asMap());
 
-        this.startNodeId = String.valueOf(rel.startNodeId());
-        this.endNodeId = String.valueOf(rel.endNodeId());
+        this.startNodeId = String.valueOf(rel.startNodeElementId());
+        this.endNodeId = String.valueOf(rel.endNodeElementId());
     }
 
     public Neo4jBoltRelationship(String id, List<String> types, GraphPropertyContainer propertyContainer, String startNodeId, String endNodeId) {

database/neo4j/src/main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jGraphDatabaseVersion.java

@@ -0,0 +1,33 @@
+/**
+ * Copied and adapted from plugin
+ * <a href="https://github.com/neueda/jetbrains-plugin-graph-database-support">Graph Database Support</a>
+ * by Neueda Technologies, Ltd.
+ * Modified by Alberto Venturini, 2022
+ */
+package com.albertoventurini.graphdbplugin.database.neo4j.bolt.data;
+
+import com.albertoventurini.graphdbplugin.database.api.data.GraphDatabaseVersion;
+
+public record Neo4jGraphDatabaseVersion(int major, int minor, int patch) implements GraphDatabaseVersion {
+
+    @Override
+    public String toString() {
+        return "Neo4j/" + major + "." + minor + "." + patch;
+    }
+
+    @Override
+    public String idFunction() {
+        if (major >= 5) {
+            return "elementId";
+        }
+        return "id";
+    }
+
+    @Override
+    public Object idToParameter(String id) {
+        if (major >= 5) {
+            return id;
+        }
+        return Long.parseLong(id);
+    }
+}

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

@@ -130,6 +130,8 @@
                 serviceImplementation="com.albertoventurini.graphdbplugin.jetbrains.ui.datasource.DataSourcesView"/>
         <projectService
                 serviceImplementation="com.albertoventurini.graphdbplugin.jetbrains.ui.console.params.ParametersService"/>
+        <projectService
+                serviceImplementation="com.albertoventurini.graphdbplugin.jetbrains.database.VersionService"/>
 
         <scratch.rootType implementation="com.albertoventurini.graphdbplugin.jetbrains.ui.datasource.interactions.GraphDbEditorsConsoleRootType"/>
         <scratch.rootType implementation="com.albertoventurini.graphdbplugin.jetbrains.ui.console.params.ParameterRootType"/>

platform/src/main/java/icons/GraphIcons.java

@@ -27,6 +27,7 @@ public static final class Window {
     }
 
     public static final class Nodes {
+        public static final Icon VERSION = AllIcons.Actions.InlayGear;
         public static final Icon INDEX = AllIcons.Nodes.ResourceBundle;
         public static final Icon CONSTRAINT = AllIcons.Nodes.C_protected;
         public static final Icon LABEL = AllIcons.Nodes.Class;

testing/integration-neo4j/build.gradle

@@ -12,6 +12,7 @@ dependencies {
     testImplementation project(':graph-database-plugin')
     testImplementation project(':ui:jetbrains')
     testImplementation project(':language:cypher')
+    testImplementation project(':database:api')
     testImplementation project(':database:neo4j')
     testImplementation project(':testing:common')
     testImplementation project(':platform')

testing/integration-neo4j/src/test/java/com/albertoventurini/graphdbplugin/test/integration/neo4j/tests/database/common/AbstractDataSourceMetadataTest.java

@@ -7,11 +7,9 @@
 package com.albertoventurini.graphdbplugin.test.integration.neo4j.tests.database.common;
 
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.DataSourceMetadata;
-import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jProcedureMetadata;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.state.DataSourceApi;
 import com.albertoventurini.graphdbplugin.test.integration.neo4j.util.base.BaseIntegrationTest;
 
-import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
@@ -32,13 +30,13 @@ public void setUp() throws Exception {
     public abstract DataSourceApi getDataSource();
 
     public void testMetadataExists() throws ExecutionException, InterruptedException {
-        Optional<DataSourceMetadata> metadata = component().dataSourcesMetadata().getMetadata(getDataSource()).get();
+        Optional<DataSourceMetadata> metadata = component().dataSourcesMetadata().updateMetadata(getDataSource()).get();
         assertThat(metadata).isPresent();
     }
 
     protected DataSourceMetadata getMetadata() {
         try {
-            CompletableFuture<Optional<DataSourceMetadata>> futureMeta = component().dataSourcesMetadata().getMetadata(getDataSource());
+            CompletableFuture<Optional<DataSourceMetadata>> futureMeta = component().dataSourcesMetadata().updateMetadata(getDataSource());
             return futureMeta.get(30, TimeUnit.SECONDS)
                     .orElseThrow(() -> new IllegalStateException("Metadata should not be null"));
         } catch (InterruptedException | ExecutionException | TimeoutException e) {