Implement param resolution by passing a map

soerenreichardt · soerenreichardt · commit a6d371540d30 · 2022-05-19T10:04:35.000+02:00
diff --git a/core/src/main/java/org/neo4j/gds/config/GraphProjectFromGraphConfig.java b/core/src/main/java/org/neo4j/gds/config/GraphProjectFromGraphConfig.java
@@ -26,6 +26,8 @@
 import org.neo4j.gds.concurrency.ConcurrencyValidatorService;
 import org.neo4j.gds.core.CypherMapWrapper;
 
+import java.util.Map;
+
 
 @ValueClass
 @Configuration
@@ -53,6 +55,12 @@ default int concurrency() {
         return ConcurrencyConfig.DEFAULT_CONCURRENCY;
     }
 
+    @Value.Default
+    @Value.Parameter(false)
+    default Map<String, Object> parameterMap() {
+        return Map.of();
+    }
+
     @Value.Check
     default void validateReadConcurrency() {
         ConcurrencyValidatorService.validator().validate(concurrency(), "concurrency", ConcurrencyConfig.CONCURRENCY_LIMITATION);
diff --git a/proc/catalog/src/test/java/org/neo4j/gds/catalog/GraphProjectSubgraphProcTest.java b/proc/catalog/src/test/java/org/neo4j/gds/catalog/GraphProjectSubgraphProcTest.java
@@ -41,7 +41,7 @@
 class GraphProjectSubgraphProcTest extends BaseProcTest {
 
     @Neo4jGraph
-    public static final String DB = "CREATE (a:A)-[:REL]->(b:B)";
+    public static final String DB = "CREATE (a:A)-[:REL { weight: 42.0 }]->(b:B)";
 
     @BeforeEach
     void setup() throws Exception {
@@ -51,7 +51,8 @@ void setup() throws Exception {
             .graphProject()
             .withNodeLabel("A")
             .withNodeLabel("B")
-            .withAnyRelationshipType()
+            .withRelationshipType("REL")
+            .withRelationshipProperty("weight")
             .yields()
         );
     }
@@ -155,12 +156,19 @@ void throwsOnSemanticNodeError() {
 
     @Test
     void throwsOnSemanticRelationshipError() {
-        var subGraphQuery = "CALL gds.beta.graph.project.subgraph('subgraph', 'graph', 'true', 'r:BAR AND r.weight > 42')";
+        var subGraphQuery = "CALL gds.beta.graph.project.subgraph('subgraph', 'graph', 'true', 'r:BAR AND r.prop > 42')";
 
         assertThatThrownBy(() -> runQuery(subGraphQuery))
             .getRootCause()
             .isInstanceOf(SemanticErrors.class)
-            .hasMessageContaining("Unknown property `weight`.")
+            .hasMessageContaining("Unknown property `prop`.")
             .hasMessageContaining("Unknown relationship type `BAR`.");
     }
+
+    @Test
+    void shouldResolveParameters() {
+        var subGraphQuery = "CALL gds.beta.graph.project.subgraph('subgraph', 'graph', 'true', 'r:REL AND r.weight > $weight', { parameterMap: { weight: $weight } })";
+
+        runQuery(subGraphQuery, Map.of("weight", 42));
+    }
 }
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/GraphStoreFilter.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/GraphStoreFilter.java
@@ -93,6 +93,7 @@ public static GraphStore filter(
                 graphStore,
                 expressions.nodeExpression(),
                 config.concurrency(),
+                config.parameterMap(),
                 executorService,
                 progressTracker
             );
@@ -103,6 +104,7 @@ public static GraphStore filter(
                 inputNodes,
                 filteredNodes.idMap(),
                 config.concurrency(),
+                config.parameterMap(),
                 executorService,
                 progressTracker
             );
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/NodesFilter.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/NodesFilter.java
@@ -44,6 +44,7 @@
 import org.neo4j.gds.core.utils.progress.tasks.ProgressTracker;
 
 import java.util.Iterator;
+import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.ExecutorService;
 import java.util.function.Function;
@@ -61,6 +62,7 @@ static FilteredNodes filterNodes(
         GraphStore inputGraphStore,
         Expression expression,
         int concurrency,
+        Map<String, Object> parameterMap,
         ExecutorService executorService,
         ProgressTracker progressTracker
     ) {
@@ -79,6 +81,7 @@ static FilteredNodes filterNodes(
         var tasks = NodeFilterTask.of(
             inputGraphStore,
             expression,
+            parameterMap,
             partitions,
             nodesBuilder,
             progressTracker
@@ -247,6 +250,7 @@ private static final class NodeFilterTask implements Runnable {
         static Iterator<NodeFilterTask> of(
             GraphStore inputGraphStore,
             Expression expression,
+            Map<String, Object> parameterMap,
             Iterator<Partition> partitions,
             NodesBuilder nodesBuilder,
             ProgressTracker progressTracker
@@ -261,6 +265,7 @@ protected NodeFilterTask fetch() {
                     return new NodeFilterTask(
                         partitions.next(),
                         expression,
+                        parameterMap,
                         inputGraphStore,
                         nodesBuilder,
                         progressTracker
@@ -272,6 +277,7 @@ protected NodeFilterTask fetch() {
         private NodeFilterTask(
             Partition partition,
             Expression expression,
+            Map<String, Object> parameterMap,
             GraphStore inputGraphStore,
             NodesBuilder nodesBuilder,
             ProgressTracker progressTracker
@@ -280,7 +286,7 @@ private NodeFilterTask(
             this.expression = expression;
             this.inputGraphStore = inputGraphStore;
             this.nodesBuilder = nodesBuilder;
-            this.nodeContext = new EvaluationContext.NodeEvaluationContext(inputGraphStore);
+            this.nodeContext = new EvaluationContext.NodeEvaluationContext(inputGraphStore, parameterMap);
             this.progressTracker = progressTracker;
         }
 
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/RelationshipsFilter.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/RelationshipsFilter.java
@@ -67,6 +67,7 @@ static FilteredRelationships filterRelationships(
         IdMap inputNodes,
         IdMap outputNodes,
         int concurrency,
+        Map<String, Object> parameterMap,
         ExecutorService executorService,
         ProgressTracker progressTracker
     ) {
@@ -85,6 +86,7 @@ static FilteredRelationships filterRelationships(
                 outputNodes,
                 relType,
                 concurrency,
+                parameterMap,
                 executorService,
                 progressTracker
             );
@@ -140,6 +142,7 @@ private static FilteredRelationship filterRelationshipType(
         IdMap outputNodes,
         RelationshipType relType,
         int concurrency,
+        Map<String, Object> parameterMap,
         ExecutorService executorService,
         ProgressTracker progressTracker
     ) {
@@ -172,6 +175,7 @@ private static FilteredRelationship filterRelationshipType(
                 outputNodes,
                 relationshipsBuilder,
                 relType,
+                parameterMap,
                 propertyIndices,
                 progressTracker
             ),
@@ -217,6 +221,7 @@ private RelationshipFilterTask(
             IdMap outputNodes,
             RelationshipsBuilder relationshipsBuilder,
             RelationshipType relType,
+            Map<String, Object> parameterMap,
             Map<String, Integer> propertyIndices,
             ProgressTracker progressTracker
         ) {
@@ -227,7 +232,7 @@ private RelationshipFilterTask(
             this.outputNodes = outputNodes;
             this.relationshipsBuilder = relationshipsBuilder;
             this.relType = relType;
-            this.evaluationContext = new EvaluationContext.RelationshipEvaluationContext(propertyIndices);
+            this.evaluationContext = new EvaluationContext.RelationshipEvaluationContext(propertyIndices, parameterMap);
             this.progressTracker = progressTracker;
         }
 
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/AstFactoryAdapter.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/AstFactoryAdapter.java
@@ -323,11 +323,6 @@ public Expression oldParameter(InputPosition p, Expression.LeafExpression.Variab
         throw new UnsupportedOperationException();
     }
 
-    @Override
-    public Expression newParameter(InputPosition p, Expression.LeafExpression.Variable v) {
-        throw new UnsupportedOperationException();
-    }
-
     @Override
     public NULL newSingleQuery(List<NULL> nulls) {
         throw new UnsupportedOperationException();
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/EvaluationContext.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/EvaluationContext.java
@@ -32,6 +32,16 @@
 
 public abstract class EvaluationContext {
 
+    private final Map<String, Object> parameterMap;
+
+    protected EvaluationContext(Map<String, Object> parameterMap) {
+        this.parameterMap = parameterMap;
+    }
+
+    double resolveParameter(String parameterName) {
+        return ((Number) this.parameterMap.get(parameterName)).doubleValue();
+    }
+
     abstract double getProperty(String propertyKey, ValueType propertyType);
 
     abstract boolean hasLabelsOrTypes(List<String> labelsOrTypes);
@@ -41,7 +51,11 @@ public static class NodeEvaluationContext extends EvaluationContext {
         private final GraphStore graphStore;
         private long nodeId;
 
-        public NodeEvaluationContext(GraphStore graphStore) {
+        public NodeEvaluationContext(
+            GraphStore graphStore,
+            Map<String, Object> parameterMap
+        ) {
+            super(parameterMap);
             this.graphStore = graphStore;
         }
 
@@ -80,7 +94,11 @@ public static class RelationshipEvaluationContext extends EvaluationContext {
 
         private final ObjectIntMap<String> propertyIndices;
 
-        public RelationshipEvaluationContext(Map<String, Integer> propertyIndices) {
+        public RelationshipEvaluationContext(
+            Map<String, Integer> propertyIndices,
+            Map<String, Object> parameterMap
+        ) {
+            super(parameterMap);
             this.propertyIndices = new ObjectIntScatterMap<>();
             propertyIndices.forEach(this.propertyIndices::put);
         }
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/Expression.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/Expression.java
@@ -198,6 +198,24 @@ default double evaluate(EvaluationContext context) {
             }
 
         }
+
+        @ValueClass
+        interface NewParameter extends UnaryExpression {
+
+            @Value.Derived
+            @Override
+            default double evaluate(EvaluationContext context) {
+                return context.resolveParameter(((LeafExpression.Variable) in()).name());
+            }
+
+            @Override
+            default ValidationContext validate(ValidationContext context) {
+                if (!(in() instanceof LeafExpression.Variable)) {
+                    throw new IllegalStateException();
+                }
+                return context;
+            }
+        }
     }
 
     interface BinaryExpression extends Expression {
diff --git a/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/GdsAstFactory.java b/subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/expression/GdsAstFactory.java
@@ -41,6 +41,14 @@ public Expression.LeafExpression.Variable newVariable(InputPosition p, String na
         return ImmutableVariable.builder().name(name).build();
     }
 
+
+    @Override
+    public Expression newParameter(
+        InputPosition p, Expression.LeafExpression.Variable v
+    ) {
+        return ImmutableNewParameter.of(v.valueType(), v);
+    }
+
     @Override
     public Expression.Literal.DoubleLiteral newDouble(InputPosition p, String image) {
         return ImmutableDoubleLiteral.builder().value(Double.parseDouble(image)).build();
diff --git a/subgraph-filtering/src/test/java/org/neo4j/gds/beta/filter/expression/EvaluationContextTest.java b/subgraph-filtering/src/test/java/org/neo4j/gds/beta/filter/expression/EvaluationContextTest.java
@@ -77,7 +77,7 @@ void nodeEvaluationContextPositive(
         ValueType valueType,
         List<String> expectedLabels
     ) {
-        var context = new EvaluationContext.NodeEvaluationContext(graphStore);
+        var context = new EvaluationContext.NodeEvaluationContext(graphStore, Map.of());
         context.init(idFunction.of(variable));
         assertThat(context.getProperty(propertyKey, valueType)).isEqualTo(expectedValue);
         assertThat(context.hasLabelsOrTypes(expectedLabels)).isTrue();
@@ -93,22 +93,22 @@ private static Stream<Arguments> nodesNegative() {
     @ParameterizedTest
     @MethodSource("nodesNegative")
     void nodeEvaluationContextNegative(String variable, List<String> unExpectedLabels) {
-        var context = new EvaluationContext.NodeEvaluationContext(graphStore);
+        var context = new EvaluationContext.NodeEvaluationContext(graphStore, Map.of());
         context.init(idFunction.of(variable));
         assertThat(context.hasLabelsOrTypes(unExpectedLabels)).isFalse();
     }
 
     @Test
     void relationshipEvaluationContextPositive() {
-        var context = new EvaluationContext.RelationshipEvaluationContext(Map.of("baz", 0));
+        var context = new EvaluationContext.RelationshipEvaluationContext(Map.of("baz", 0), Map.of());
         context.init("REL", new double[]{84});
         assertThat(context.getProperty("baz", ValueType.DOUBLE)).isEqualTo(84);
         assertThat(context.hasLabelsOrTypes(List.of("REL"))).isTrue();
     }
 
     @Test
     void relationshipEvaluationContextNegative() {
-        var context = new EvaluationContext.RelationshipEvaluationContext(Map.of());
+        var context = new EvaluationContext.RelationshipEvaluationContext(Map.of(), Map.of());
         context.init("REL");
         assertThat(context.hasLabelsOrTypes(List.of("BAR"))).isFalse();
     }
diff --git a/subgraph-filtering/src/test/java/org/neo4j/gds/beta/filter/expression/ExpressionEvaluatorTest.java b/subgraph-filtering/src/test/java/org/neo4j/gds/beta/filter/expression/ExpressionEvaluatorTest.java
@@ -380,7 +380,7 @@ void hasLabelsOrTypes(Iterable<String> actual, Collection<String> requested, boo
         assertThat(expr.evaluate(evaluationContext) == TRUE).isEqualTo(expected);
     }
 
-    private static final EvaluationContext EMPTY_EVALUATION_CONTEXT = new EvaluationContext() {
+    private static final EvaluationContext EMPTY_EVALUATION_CONTEXT = new EvaluationContext(Map.of()) {
         @Override
         double getProperty(String propertyKey, ValueType valueType) {
             throw new UnsupportedOperationException();
@@ -395,6 +395,8 @@ boolean hasLabelsOrTypes(List<String> labelsOrTypes) {
     @ValueClass
     static class TestContext extends EvaluationContext {
 
+        TestContext() {super(Map.of());}
+
         @Value.Default
         public String propertyKey() {
             return "";
