[UqrhpreJ] CypherInitializer Cypher 25 support (#684)

neo4j · Nov 11, 2024 · fb158a2 · fb158a2
1 parent f0c8172
commit fb158a2
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 108 deletions.
diff --git a/common/src/main/java/apoc/util/LogsUtil.java b/common/src/main/java/apoc/util/LogsUtil.java
@@ -18,26 +18,34 @@
  */
 package apoc.util;
 
+import org.neo4j.configuration.Config;
+import org.neo4j.cypher.internal.PreParser;
 import org.neo4j.cypher.internal.ast.Statement;
-import org.neo4j.cypher.internal.ast.factory.neo4j.JavaCCParser;
 import org.neo4j.cypher.internal.ast.prettifier.DefaultExpressionStringifier;
 import org.neo4j.cypher.internal.ast.prettifier.ExpressionStringifier;
 import org.neo4j.cypher.internal.ast.prettifier.ExpressionStringifier$;
 import org.neo4j.cypher.internal.ast.prettifier.Prettifier;
+import org.neo4j.cypher.internal.config.CypherConfiguration;
+import org.neo4j.cypher.internal.parser.AstParserFactory$;
 import org.neo4j.cypher.internal.rewriting.rewriters.sensitiveLiteralReplacement;
 import org.neo4j.cypher.internal.util.OpenCypherExceptionFactory;
+import org.neo4j.cypher.internal.util.RecordingNotificationLogger;
+import scala.Option;
 
 public class LogsUtil {
-    private static OpenCypherExceptionFactory exceptionFactory = new OpenCypherExceptionFactory(scala.Option.empty());
-    private static ExpressionStringifier.Extension extension =
-            ExpressionStringifier.Extension$.MODULE$.simple((ExpressionStringifier$.MODULE$.failingExtender()));
-    private static ExpressionStringifier stringifier =
-            new DefaultExpressionStringifier(extension, false, false, false, false);
-    private static Prettifier prettifier = new Prettifier(stringifier, Prettifier.EmptyExtension$.MODULE$, true);
-
-    public static String sanitizeQuery(String query) {
+    public static String sanitizeQuery(Config config, String query) {
         try {
-            var statement = JavaCCParser.parse(query, exceptionFactory, null);
+            final var exceptionFactory = new OpenCypherExceptionFactory(scala.Option.empty());
+            final var extension =
+                    ExpressionStringifier.Extension$.MODULE$.simple((ExpressionStringifier$.MODULE$.failingExtender()));
+            final var stringifier = new DefaultExpressionStringifier(extension, false, false, false, false);
+            final var prettifier = new Prettifier(stringifier, Prettifier.EmptyExtension$.MODULE$, true);
+            var notifications = new RecordingNotificationLogger();
+            final var preParsed = new PreParser(CypherConfiguration.fromConfig(config)).preParse(query, notifications);
+            final var statement = AstParserFactory$.MODULE$
+                    .apply(preParsed.options().queryOptions().cypherVersion().actualVersion())
+                    .apply(preParsed.statement(), exceptionFactory, Option.apply(null))
+                    .singleStatement();
             var rewriter = sensitiveLiteralReplacement.apply(statement)._1;
             var res = (Statement) rewriter.apply(statement);
 

diff --git a/common/src/main/java/apoc/util/QueryUtil.java b/common/src/main/java/apoc/util/QueryUtil.java
diff --git a/core/src/main/java/apoc/cypher/CypherInitializer.java b/core/src/main/java/apoc/cypher/CypherInitializer.java
@@ -23,7 +23,6 @@
 import apoc.ApocConfig;
 import apoc.SystemLabels;
 import apoc.util.LogsUtil;
-import apoc.util.QueryUtil;
 import apoc.util.Util;
 import apoc.util.collection.Iterators;
 import apoc.version.Version;
@@ -34,6 +33,7 @@
 import org.apache.commons.configuration2.Configuration;
 import org.apache.commons.lang3.StringUtils;
 import org.neo4j.common.DependencyResolver;
+import org.neo4j.configuration.Config;
 import org.neo4j.dbms.api.DatabaseManagementService;
 import org.neo4j.graphdb.Label;
 import org.neo4j.graphdb.Node;
@@ -105,21 +105,18 @@ public void available() {
                         Configuration config = dependencyResolver
                                 .resolveDependency(ApocConfig.class)
                                 .getConfig();
-                        for (String query : collectInitializers(config)) {
-                            if (QueryUtil.isValidQuery(query)) {
-                                String sanitizedQuery = LogsUtil.sanitizeQuery(query);
-                                try {
-                                    // we need to apply a retry strategy here since in systemdb we potentially conflict
-                                    // with
-                                    // creating constraints which could cause our query to fail with a transient error.
-                                    Util.retryInTx(
-                                            userLog, db, tx -> Iterators.count(tx.execute(query)), 0, 5, retries -> {});
-                                    userLog.info("successfully initialized: " + sanitizedQuery);
-                                } catch (Exception e) {
-                                    userLog.error("error upon initialization, running: " + sanitizedQuery, e);
-                                }
-                            } else {
-                                userLog.error("error upon initialization, invalid query: " + query);
+                        for (final var query : collectInitializers(config)) {
+                            final var sanitizedQuery =
+                                    LogsUtil.sanitizeQuery(dependencyResolver.resolveDependency(Config.class), query);
+                            try {
+                                // we need to apply a retry strategy here since in systemdb we potentially conflict
+                                // with
+                                // creating constraints which could cause our query to fail with a transient error.
+                                Util.retryInTx(
+                                        userLog, db, tx -> Iterators.count(tx.execute(query)), 0, 5, retries -> {});
+                                userLog.info("successfully initialized: " + sanitizedQuery);
+                            } catch (Exception e) {
+                                userLog.error("error upon initialization, running: " + sanitizedQuery, e);
                             }
                         }
                     } catch (Exception e) {

diff --git a/core/src/test/java/apoc/util/LogsUtilTest.java b/core/src/test/java/apoc/util/LogsUtilTest.java
@@ -21,27 +21,29 @@
 import static org.junit.Assert.assertEquals;
 
 import org.junit.Test;
+import org.neo4j.configuration.Config;
 
 public class LogsUtilTest {
 
     @Test
     public void shouldRedactPasswords() {
-        String sanitized =
-                LogsUtil.sanitizeQuery("CREATE USER dummy IF NOT EXISTS SET PASSWORD 'pass12345' CHANGE NOT REQUIRED");
+        String sanitized = LogsUtil.sanitizeQuery(
+                Config.defaults(), "CREATE USER dummy IF NOT EXISTS SET PASSWORD 'pass12345' CHANGE NOT REQUIRED");
         assertEquals(sanitized, "CREATE USER dummy IF NOT EXISTS SET PASSWORD '******' CHANGE NOT REQUIRED");
     }
 
     @Test
     public void shouldReturnInputIfInvalidQuery() {
         String invalidQuery = "MATCH USER dummy IF NOT EXISTS SET PASSWORD 'pass12345' CHANGE NOT REQUIRED";
-        String sanitized = LogsUtil.sanitizeQuery(invalidQuery);
+        String sanitized = LogsUtil.sanitizeQuery(Config.defaults(), invalidQuery);
 
         assertEquals(sanitized, invalidQuery);
     }
 
     @Test
     public void whitespaceDeprecationSucceedsSanitization() {
         String sanitized = LogsUtil.sanitizeQuery(
+                Config.defaults(),
                 "CREATE USER dum\u0085my IF NOT EXISTS SET PASSWORD 'pass12345' CHANGE NOT REQUIRED");
         assertEquals(sanitized, "CREATE USER `dum\u0085my` IF NOT EXISTS SET PASSWORD '******' CHANGE NOT REQUIRED");
     }

diff --git a/core/src/test/java/apoc/util/QueryUtilTest.java b/core/src/test/java/apoc/util/QueryUtilTest.java