[NOID] fixes #3349: Can not create custom procedure with void return …

…type using apoc.custom.declareProcedure (#3356)
neo4j-contrib · Jan 17, 2023 · 15f78a6 · 15f78a6
1 parent acebcdc
commit 15f78a6
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 4 deletions.
diff --git a/apoc-core b/apoc-core
diff --git a/extended/src/main/java/apoc/custom/CypherProcedures.java b/extended/src/main/java/apoc/custom/CypherProcedures.java
@@ -166,14 +166,16 @@ private void validateProcedure(String statement, List<FieldSignature> input, Lis
     private void checkMode(QueryExecutionType.QueryType queryType, Mode mode) {
         Map<QueryExecutionType.QueryType, Mode> map = Map.of(QueryExecutionType.QueryType.WRITE, Mode.WRITE,
                 QueryExecutionType.QueryType.READ_ONLY, Mode.READ,
-                QueryExecutionType.QueryType.READ_WRITE, Mode.WRITE);
+                QueryExecutionType.QueryType.READ_WRITE, Mode.WRITE,
+                QueryExecutionType.QueryType.DBMS, Mode.DBMS,
+                QueryExecutionType.QueryType.SCHEMA_WRITE, Mode.SCHEMA);
 
         if (!map.get(queryType).equals(mode)) {
             throw new RuntimeException(String.format("The query execution type is %s, but you provided mode %s.\n" +
                             "Supported modes are %s",
                     queryType.name(), 
                     mode.name(), 
-                    map.values().stream().sorted().collect(Collectors.toList()).toString()));
+                    map.values().stream().sorted().collect(Collectors.toList())));
         }
     }
 

diff --git a/extended/src/main/java/apoc/custom/CypherProceduresHandler.java b/extended/src/main/java/apoc/custom/CypherProceduresHandler.java
@@ -289,6 +289,7 @@ private String serializeSignatures(List<FieldSignature> signatures) {
 
     public static List<FieldSignature> deserializeSignatures(String s) {
         List<Map<String, Object>> mapped = Util.fromJson(s, List.class);
+        if (mapped.isEmpty()) return ProcedureSignature.VOID;
         return mapped.stream().map(map -> {
             String typeString = (String) map.get("type");
             if (typeString.endsWith("?")) {

diff --git a/extended/src/test/java/apoc/custom/CypherProceduresTest.java b/extended/src/test/java/apoc/custom/CypherProceduresTest.java
@@ -17,13 +17,15 @@
 import org.neo4j.graphdb.Node;
 import org.neo4j.graphdb.QueryExecutionException;
 import org.neo4j.graphdb.Transaction;
+import org.neo4j.procedure.builtin.BuiltInDbmsProcedures;
 import org.neo4j.test.rule.DbmsRule;
 import org.neo4j.test.rule.ImpermanentDbmsRule;
 
 import java.time.LocalDateTime;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import static apoc.custom.CypherProceduresHandler.FUNCTION;
 import static apoc.custom.CypherProceduresHandler.PROCEDURE;
@@ -48,9 +50,10 @@ public class CypherProceduresTest  {
     @Rule
     public ExpectedException thrown = ExpectedException.none();
 
+
     @Before
     public void setup() {
-        TestUtil.registerProcedure(db, CypherProcedures.class);
+        TestUtil.registerProcedure(db, CypherProcedures.class, BuiltInDbmsProcedures.class);
     }
 
     @AfterAll
@@ -584,6 +587,36 @@ public void testIssue2032() {
         assertProcedureFails(String.format(SIGNATURE_SYNTAX_ERROR, procedureSignature), 
                 "call apoc.custom.declareProcedure('" + procedureSignature + "','RETURN $first + $s AS answer')");
     }
+
+    @Test
+    public void testIssue3349() {
+        String procedure = """
+                CALL apoc.custom.declareProcedure(
+                  'retFunctionNames() :: (name :: STRING)',
+                  'call dbms.listConfig() YIELD name RETURN name',
+                  'DBMS'
+                );""";
+        db.executeTransactionally(procedure);
+        List<String> functions = db.executeTransactionally("CALL custom.retFunctionNames()", Map.of(), result -> result
+                .stream()
+                .map(m -> (String) m.get("name"))
+                .collect(Collectors.toList()));
+        assertFalse(functions.isEmpty());
+
+
+        String procedureVoid = "CALL apoc.custom.declareProcedure(\n" +
+                "  'setTxMetadata(meta :: MAP) :: VOID',\n" +
+                "  '\n" +
+                "      CALL tx.setMetaData($meta)" +
+                "  ',\n" +
+                "  'DBMS'\n" +
+                ");";
+        db.executeTransactionally(procedureVoid);
+        // This should run without exception
+        db.executeTransactionally("CALL custom.setTxMetadata($meta)", Map.of(
+                "meta", Map.of("foo", "bar")
+        ));
+    }
 
 
     private void assertProcedureFails(String expectedMessage, String query) {