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
albertoventurini · Sep 12, 2023 · f20d96e · f20d96e
1 parent fece746
commit f20d96e
Show file tree

Hide file tree

Showing 25 changed files with 272 additions and 43 deletions.
diff --git a/...e/api/src/main/java/com/albertoventurini/graphdbplugin/database/api/GraphDatabaseApi.java b/...e/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();
 }
diff --git a/.../main/java/com/albertoventurini/graphdbplugin/database/api/data/GraphDatabaseVersion.java b/.../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);
+}
diff --git a/...c/main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/Neo4jBoltDatabase.java b/...c/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]);
+    }
 }
diff --git a/.../main/java/com/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jBoltNode.java b/.../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());
     }

diff --git a/...va/com/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jBoltRelationship.java b/...va/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) {

diff --git a/...om/albertoventurini/graphdbplugin/database/neo4j/bolt/data/Neo4jGraphDatabaseVersion.java b/...om/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);
+    }
+}
diff --git a/graph-database-plugin/src/main/resources/META-INF/plugin.xml b/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"/>

diff --git a/platform/src/main/java/icons/GraphIcons.java b/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;

diff --git a/testing/integration-neo4j/build.gradle b/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')

diff --git a/...dbplugin/test/integration/neo4j/tests/database/common/AbstractDataSourceMetadataTest.java b/...dbplugin/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) {

diff --git a/...ini/graphdbplugin/test/integration/neo4j/tests/database/neo4j/DataSourceMetadataTest.java b/...ini/graphdbplugin/test/integration/neo4j/tests/database/neo4j/DataSourceMetadataTest.java
@@ -6,6 +6,7 @@
  */
 package com.albertoventurini.graphdbplugin.test.integration.neo4j.tests.database.neo4j;
 
+import com.albertoventurini.graphdbplugin.database.neo4j.bolt.data.Neo4jGraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jMetadata;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jFunctionMetadata;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jProcedureMetadata;
@@ -39,4 +40,11 @@ public void testMetadataHaveRequiredProcedures() {
                         && p.signature().equals("db.labels() :: (label :: STRING?)")
                         && p.description().equals("List all available labels in the database.")));
     }
+
+    public void testGetVersion() {
+        var metadata = (Neo4jMetadata) getMetadata();
+        var version = (Neo4jGraphDatabaseVersion) metadata.version();
+        assertEquals(5, version.major());
+        assertEquals(2, version.minor());
+    }
 }
diff --git a/...m/albertoventurini/graphdbplugin/jetbrains/component/datasource/DataSourcesComponent.java b/...m/albertoventurini/graphdbplugin/jetbrains/component/datasource/DataSourcesComponent.java
@@ -57,9 +57,7 @@ public DataSourcesComponentState getState() {
     }
 
     public void refreshAllMetadata() {
-        getDataSourceContainer().getDataSources().forEach(d -> {
-            componentMetadata.getMetadata(d);
-        });
+        getDataSourceContainer().getDataSources().forEach(componentMetadata::updateMetadata);
     }
 //
 //    @NotNull

diff --git a/...i/graphdbplugin/jetbrains/component/datasource/metadata/DataSourcesComponentMetadata.java b/...i/graphdbplugin/jetbrains/component/datasource/metadata/DataSourcesComponentMetadata.java
@@ -12,6 +12,7 @@
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jMetadataBuilder;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j.Neo4jRelationshipTypeMetadata;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.state.DataSourceApi;
+import com.albertoventurini.graphdbplugin.jetbrains.database.VersionService;
 import com.albertoventurini.graphdbplugin.jetbrains.services.ExecutorService;
 import com.albertoventurini.graphdbplugin.jetbrains.ui.datasource.metadata.MetadataRetrieveEvent;
 import com.intellij.openapi.application.ApplicationManager;
@@ -31,16 +32,18 @@ public class DataSourcesComponentMetadata {
     private CypherMetadataProviderService cypherMetadataProviderService;
     private ExecutorService executorService;
     private MessageBus messageBus;
+    private VersionService versionService;
 
     public DataSourcesComponentMetadata(final Project project) {
         messageBus = project.getMessageBus();
         cypherMetadataProviderService = project.getService(CypherMetadataProviderService.class);
         executorService = ApplicationManager.getApplication().getService(ExecutorService.class);
+        versionService = project.getService(VersionService.class);
 
         handlers.put(DataSourceType.NEO4J_BOLT, new Neo4jMetadataBuilder());
     }
 
-    public CompletableFuture<Optional<DataSourceMetadata>> getMetadata(DataSourceApi dataSource) {
+    public CompletableFuture<Optional<DataSourceMetadata>> updateMetadata(DataSourceApi dataSource) {
         MetadataRetrieveEvent metadataRetrieveEvent = messageBus.syncPublisher(MetadataRetrieveEvent.METADATA_RETRIEVE_EVENT);
 
         metadataRetrieveEvent.startMetadataRefresh(dataSource);
@@ -84,5 +87,7 @@ private void updateNeo4jBoltMetadata(DataSourceApi dataSource, Neo4jMetadata met
         metadata.propertyKeys().forEach(container::addPropertyKey);
         metadata.procedures().forEach(p -> container.addProcedure(p.name(), p.signature(), p.description()));
         metadata.functions().forEach(f -> container.addFunction(f.name(), f.signature(), f.description()));
+
+        versionService.updatedVersion(dataSource, metadata.version());
     }
 }
diff --git a/...oventurini/graphdbplugin/jetbrains/component/datasource/metadata/neo4j/Neo4jMetadata.java b/...oventurini/graphdbplugin/jetbrains/component/datasource/metadata/neo4j/Neo4jMetadata.java
@@ -1,10 +1,12 @@
 package com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j;
 
+import com.albertoventurini.graphdbplugin.database.api.data.GraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.DataSourceMetadata;
 
 import java.util.*;
 
 public record Neo4jMetadata(
+        GraphDatabaseVersion version,
         List<Neo4jFunctionMetadata> functions,
         List<Neo4jProcedureMetadata> procedures,
         List<Neo4jConstraintMetadata> constraints,

diff --git a/...ini/graphdbplugin/jetbrains/component/datasource/metadata/neo4j/Neo4jMetadataBuilder.java b/...ini/graphdbplugin/jetbrains/component/datasource/metadata/neo4j/Neo4jMetadataBuilder.java
@@ -1,6 +1,8 @@
 package com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.neo4j;
 
 import com.albertoventurini.graphdbplugin.database.api.GraphDatabaseApi;
+import com.albertoventurini.graphdbplugin.database.api.data.GraphDatabaseVersion;
+import com.albertoventurini.graphdbplugin.database.neo4j.bolt.data.Neo4jGraphDatabaseVersion;
 import com.albertoventurini.graphdbplugin.database.neo4j.bolt.query.Neo4jBoltQueryResultRow;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.DataSourceMetadata;
 import com.albertoventurini.graphdbplugin.jetbrains.component.datasource.metadata.MetadataBuilder;
@@ -50,6 +52,7 @@ public DataSourceMetadata buildMetadata(DataSourceApi dataSource) {
         final var databaseManager = ApplicationManager.getApplication().getService(DatabaseManagerService.class);
         final GraphDatabaseApi db = databaseManager.getDatabaseFor(dataSource);
 
+        GraphDatabaseVersion version = new Neo4jGraphDatabaseVersion(0, 0, 0);
         final List<Neo4jIndexMetadata> indexes = new ArrayList<>();
         final List<Neo4jProcedureMetadata> procedures = new ArrayList<>();
         final List<Neo4jConstraintMetadata> constraints = new ArrayList<>();
@@ -60,15 +63,17 @@ public DataSourceMetadata buildMetadata(DataSourceApi dataSource) {
             procedures.addAll(getProcedures(db));
             constraints.addAll(getConstraints(db));
             functions.addAll(getFunctions(db));
+            version = db.getVersion();
         } catch (Exception e) {
-            LOG.warn("Unable to load indexes, constraints, procedures, or functions from the current database. Please upgrade to Neo4j 4.2+ to fix this.");
+            LOG.warn("Unable to load indexes, constraints, procedures, functions, or version from the current database. Please upgrade to Neo4j 4.2+ to fix this.");
         }
 
         final var propertyKeys = getPropertyKeys(db);
         final var labels = getLabels(db);
         final var relationshipTypes = getRelationshipTypes(db);
 
         return new Neo4jMetadata(
+                version,
                 functions,
                 procedures,
                 constraints,

diff --git a/...ains/src/main/java/com/albertoventurini/graphdbplugin/jetbrains/database/DiffService.java b/...ains/src/main/java/com/albertoventurini/graphdbplugin/jetbrains/database/DiffService.java
@@ -20,36 +20,42 @@
 public class DiffService {
 
     private final QueryExecutionService service;
+    private final VersionService versionService;
 
     public DiffService(Project project) {
-        this.service = new QueryExecutionService(project, project.getMessageBus());
+        service = new QueryExecutionService(project, project.getMessageBus());
+        versionService = project.getService(VersionService.class);
     }
 
     public void updateNode(DataSourceApi api, GraphEntity oldNode, GraphEntity newNode) {
-
-        String query = "MATCH (n) WHERE ID(n) = $id " +
-                diffLabels(oldNode.getTypes(), newNode.getTypes()) +
-                " SET n = $props" +
-                " RETURN n";
-        service.executeQuery(api, new ExecuteQueryPayload(query,
-                ImmutableMap.of(
-                        "id", Long.parseLong(oldNode.getId()),
-                        "props", newNode.getPropertyContainer().getProperties()),
-                null));
+        versionService.getVersion(api)
+                .thenAccept(version -> {
+                    String query = "MATCH (n) WHERE " + version.idFunction() + "(n) = $id " +
+                            diffLabels(oldNode.getTypes(), newNode.getTypes()) +
+                            " SET n = $props" +
+                            " RETURN n";
+                    service.executeQuery(api, new ExecuteQueryPayload(query,
+                            ImmutableMap.of(
+                                    "id", version.idToParameter(oldNode.getId()),
+                                    "props", newNode.getPropertyContainer().getProperties()),
+                            null));
+                });
     }
 
 
     public void updateRelationShip(DataSourceApi api, GraphEntity relationship,
                                    GraphEntity updatedRel) {
-
-        String query = "MATCH ()-[n]->() WHERE ID(n) = $id " +
-                " SET n = $props" +
-                " RETURN n";
-        service.executeQuery(api, new ExecuteQueryPayload(query,
-                ImmutableMap.of(
-                        "id", Long.parseLong(relationship.getId()),
-                        "props", updatedRel.getPropertyContainer().getProperties()),
-                null));
+        versionService.getVersion(api)
+                .thenAccept(version -> {
+                    String query = "MATCH ()-[n]->() WHERE " + version.idFunction() + "(n) = $id " +
+                            " SET n = $props" +
+                            " RETURN n";
+                    service.executeQuery(api, new ExecuteQueryPayload(query,
+                            ImmutableMap.of(
+                                    "id", version.idToParameter(relationship.getId()),
+                                    "props", updatedRel.getPropertyContainer().getProperties()),
+                            null));
+                });
     }
 
     public void saveNewNode(DataSourceApi api, GraphEntity newNode) {