Support neo4j 6.0

Author: FlorentinD

changelog.md

@@ -15,3 +15,4 @@
 - Add support for PyArrow 21.0.0
 - Drop support for PyArrow 17.0
 - Support numpy 1.24.0
+- Add support for neo4j 6.0

graphdatascience/error/cypher_warning_handler.py

@@ -1,3 +1,4 @@
+import re
 import warnings
 from functools import wraps
 from typing import Any, Callable, TypeVar, cast
@@ -27,6 +28,13 @@ def wrapper(self: CallerBase, *args: Any, **kwargs: Any) -> Any:
                 message=r"The query used a deprecated function. \('id'.*",
             )
 
+            # with neo4j driver 6.0.0
+            warnings.filterwarnings(
+                "ignore",
+                message=r"warn: feature deprecated with replacement\. id is deprecated. It is replaced by elementId or consider using an application-generated id\."
+                ,
+            )
+
             return func(self, *args, **kwargs)
 
         return cast(F, wrapper)

graphdatascience/query_runner/neo4j_query_runner.py

@@ -196,14 +196,12 @@ def run_cypher(
             df = result.to_df()
 
             if self._NEO4J_DRIVER_VERSION < SemanticVersion(5, 0, 0):
-                self._last_bookmarks = [session.last_bookmark()]
+                self._last_bookmarks = [session.last_bookmark()]  # type: ignore
             else:
                 self._last_bookmarks = session.last_bookmarks()
 
-            notifications = result.consume().notifications
-            if notifications:
-                for notification in notifications:
-                    self._forward_cypher_warnings(notification)
+            result_summary = result.consume()
+            self._handle_notifications(result_summary)
 
             return df
 
@@ -321,7 +319,21 @@ def encrypted(self) -> bool:
     def driver_config(self) -> dict[str, Any]:
         return self._config
 
-    def _forward_cypher_warnings(self, notification: dict[str, Any]) -> None:
+    def _handle_notifications(self, result_summary: neo4j.ResultSummary) -> None:
+        if self._NEO4J_DRIVER_VERSION < SemanticVersion(6, 0, 0):
+            notifications = result_summary.notifications
+            if notifications:
+                for notification in notifications:
+                    self._forward_cypher_notification(notification)
+        if self._NEO4J_DRIVER_VERSION >= SemanticVersion(6, 0, 0):
+            status_objects = result_summary.gql_status_objects
+            for status in status_objects:
+                if status.raw_classification == "DEPRECATION" and not re.match(
+                    r".*returned by the procedure.*", status.status_description
+                ):
+                    warnings.warn(DeprecationWarning(status.status_description))
+
+    def _forward_cypher_notification(self, notification: dict[str, Any]) -> None:
         # (see https://neo4j.com/docs/status-codes/current/notifications/ for more details)
         severity = notification["severity"]
         if severity == "WARNING":
@@ -434,7 +446,7 @@ def _verify_connectivity(
                         category=neo4j.ExperimentalWarning,
                         message=r"^The configuration may change in the future.$",
                     )
-                else:
+                elif self._NEO4J_DRIVER_VERSION < SemanticVersion(6, 0, 0):
                     warnings.filterwarnings(
                         "ignore",
                         category=neo4j.ExperimentalWarning,
@@ -443,6 +455,13 @@ def _verify_connectivity(
                             "They might be changed or removed in any future version without prior notice.$"
                         ),
                     )
+                else:
+                    warnings.filterwarnings(
+                        "ignore",
+                        category=neo4j.warnings.PreviewWarning,
+                        message=(r"^Passing key-word arguments to verify_connectivity\(\) is a preview feature.*"),
+                    )
+
                 self._driver.verify_connectivity(database=database)
                 break
             except neo4j.exceptions.DriverError as e:
@@ -478,6 +497,8 @@ def __configure_warnings_filter(self) -> None:
         warnings.filterwarnings("ignore", message=r".*The procedure has a deprecated field.*by 'gds.*")
         # neo4j driver 4.4
         warnings.filterwarnings("ignore", message=r".*The query used a deprecated field from a procedure.*by 'gds.*")
+        # neo4j driver 6.0
+        warnings.filterwarnings("ignore", message=r".*returned by the procedure.* is deprecated.*")
 
     class ConnectivityRetriesConfig(NamedTuple):
         max_retries: int = 600

graphdatascience/tests/integration/conftest.py

@@ -131,6 +131,13 @@ def is_neo4j_44(gds: GraphDataScience) -> bool:
         return False
 
 
+def id_warning_pattern() -> str:
+    if neo4j.__version__.startswith("5."):
+        return r".*The query used a deprecated function.*[`']id[`'].*"
+    else:
+        return r".*id is deprecated. It is replaced by elementId or consider using an application-generated id.*"
+
+
 @pytest.fixture(autouse=True)
 def clean_up(gds: GraphDataScience) -> Generator[None, None, None]:
     yield

graphdatascience/tests/integration/test_error_handling.py

@@ -1,11 +1,12 @@
 from typing import Generator
 
+import neo4j
 import pytest
 from neo4j import Driver, GraphDatabase
 
 from graphdatascience import GraphDataScience
 from graphdatascience.server_version.server_version import ServerVersion
-from graphdatascience.tests.integration.conftest import AUTH, URI, is_neo4j_44
+from graphdatascience.tests.integration.conftest import AUTH, URI, id_warning_pattern, is_neo4j_44
 
 GRAPH_NAME = "g"
 
@@ -207,7 +208,7 @@ def test_forward_server_side_warning(gds: GraphDataScience) -> None:
     if is_neo4j_44(gds):
         return
 
-    with pytest.raises(Warning, match="The query used a deprecated function.*[`']id[`'].*"):
+    with pytest.raises(Warning, match=id_warning_pattern()):
         gds.run_cypher("MATCH (n) RETURN id(n)")
 
 
@@ -219,7 +220,7 @@ def test_forward_driver_configured_warning(warning_driver: Driver) -> None:
     if is_neo4j_44(gds):
         return
 
-    with pytest.raises(Warning, match="The query used a deprecated function.*[`']id[`'].*"):
+    with pytest.raises(Warning, match=id_warning_pattern()):
         gds.run_cypher("MATCH (n) RETURN id(n)")
 
 

graphdatascience/tests/integration/test_graph_ops.py

@@ -9,7 +9,7 @@
 from graphdatascience.query_runner.arrow_query_runner import ArrowQueryRunner
 from graphdatascience.query_runner.query_runner import QueryRunner
 from graphdatascience.server_version.server_version import ServerVersion
-from graphdatascience.tests.integration.conftest import AUTH, DB, URI, is_neo4j_44
+from graphdatascience.tests.integration.conftest import AUTH, DB, URI, id_warning_pattern, is_neo4j_44
 
 GRAPH_NAME = "g"
 
@@ -844,7 +844,7 @@ def test_graph_relationships_stream_without_arrow(gds_without_arrow: GraphDataSc
     else:
         result = gds_without_arrow.beta.graph.relationships.stream(G, ["REL", "REL2"])
 
-    warnings.filterwarnings("ignore", category=DeprecationWarning, message="The query used a deprecated function")
+    warnings.filterwarnings("ignore", category=DeprecationWarning, message=id_warning_pattern())
     expected = gds_without_arrow.run_cypher(
         "MATCH (n)-[r]->(m) RETURN id(n) AS src_id, id(m) AS trg_id, type(r) AS rel_type"
     )

graphdatascience/tests/integration/test_model_ops.py

@@ -321,6 +321,7 @@ def test_missing_model_drop(gds: GraphDataScience) -> None:
 
 @pytest.mark.model_store_location
 @pytest.mark.filterwarnings("ignore: The query used a deprecated procedure.")
+@pytest.mark.filterwarnings("ignore: feature deprecated with replacement")
 def test_deprecated_model_Functions_still_work(gds: GraphDataScience, gs_model: GraphSageModel) -> None:
     gds.beta.model.list()
     gds.alpha.model.store(gs_model)

graphdatascience/tests/integration/test_system_ops.py

@@ -70,6 +70,7 @@ def test_list_defaults(gds: GraphDataScience) -> None:
 
 
 @pytest.mark.filterwarnings("ignore: The query used a deprecated procedure")
+@pytest.mark.filterwarnings("ignore: feature deprecated with replacement")
 @pytest.mark.enterprise
 @pytest.mark.skip_on_aura
 def test_alpha_backup(gds: GraphDataScience) -> None:
@@ -88,6 +89,7 @@ def test_backup(gds: GraphDataScience) -> None:
 
 
 @pytest.mark.filterwarnings("ignore: The query used a deprecated procedure")
+@pytest.mark.filterwarnings("ignore: feature deprecated with replacement")
 @pytest.mark.enterprise
 @pytest.mark.skip_on_aura
 def test_alpha_restore(gds: GraphDataScience) -> None:
@@ -106,6 +108,7 @@ def test_restore(gds: GraphDataScience) -> None:
 
 
 @pytest.mark.filterwarnings("ignore: The query used a deprecated procedure")
+@pytest.mark.filterwarnings("ignore: .*feature deprecated with replacement.")
 @pytest.mark.compatible_with(min_inclusive=ServerVersion(2, 5, 0))
 def test_deprecated_endpoints(gds: GraphDataScience) -> None:
     gds.beta.listProgress()

requirements/base/base.txt

@@ -1,5 +1,5 @@
 multimethod >= 1.0, < 3.0
-neo4j >= 4.4.12, < 6.0
+neo4j >= 4.4.12, < 7.0
 numpy < 2.4
 pandas >= 1.0, < 3.0
 pyarrow >= 17.0, < 22.0