Add targetNodeFilter config

Author: jjaderberg

algo/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnBaseConfig.java

@@ -45,6 +45,12 @@ default List<Long> sourceNodeFilter() {
         return List.of();
     }
 
+    @Value.Default
+    @Configuration.LongRange(min = 0)
+    default List<Long> targetNodeFilter() {
+        return List.of();
+    }
+
     @Configuration.GraphStoreValidationCheck
     default void validateSourceNodeFilter(
         GraphStore graphStore,
@@ -66,4 +72,24 @@ default void validateSourceNodeFilter(
         }
     }
 
+    @Configuration.GraphStoreValidationCheck
+    default void validateTargetNodeFilter(
+        GraphStore graphStore,
+        Collection<NodeLabel> selectedLabels,
+        Collection<RelationshipType> selectedRelationshipTypes
+    ) {
+        var nodes = graphStore.nodes();
+        var missingNodes = targetNodeFilter()
+            .stream()
+            .filter(n -> nodes.toMappedNodeId(n) == IdMap.NOT_FOUND)
+            .collect(Collectors.toList());
+        if (!missingNodes.isEmpty()) {
+            throw new IllegalArgumentException(
+                formatWithLocale(
+                    "Invalid configuration value 'targetNodeFilter', the following nodes are missing from the graph: %s",
+                    missingNodes
+                )
+            );
+        }
+    }
 }

algo/src/test/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnBaseConfigTest.java

@@ -61,6 +61,22 @@ void shouldAcceptValidSourceNodeFilter() {
         );
     }
 
+    @Test
+    void shouldAcceptValidTargetNodeFilter() {
+        new FilteredKnnBaseConfigImpl(
+            CypherMapWrapper.create(
+                Map.of(
+                    "nodeProperties", List.of("dummy"),
+                    "targetNodeFilter", List.of(idFunction.of("a"))
+                )
+            )
+        ).validateSourceNodeFilter(
+            graphStore,
+            List.of(),
+            List.of()
+        );
+    }
+
     @Test
     void shouldRejectOutOfRangeSourceNodeFilter() {
         var outOfRangeNode = -1L;
@@ -77,6 +93,22 @@ void shouldRejectOutOfRangeSourceNodeFilter() {
             .hasMessage("Value for `sourceNodeFilter` was `" + outOfRangeNode + "`, but must be within the range [0, 9223372036854775807].");
     }
 
+    @Test
+    void shouldRejectOutOfRangeTargetNodeFilter() {
+        var outOfRangeNode = -1L;
+        assertThatThrownBy(
+            () -> new FilteredKnnBaseConfigImpl(
+                CypherMapWrapper.create(
+                    Map.of(
+                        "nodeProperties", List.of("dummy"),
+                        "targetNodeFilter", List.of(outOfRangeNode)
+                    )
+                )
+            )
+        ).isInstanceOf(IllegalArgumentException.class)
+            .hasMessage("Value for `targetNodeFilter` was `" + outOfRangeNode + "`, but must be within the range [0, 9223372036854775807].");
+    }
+
     @Test
     void shouldRejectSourceNodeFilterWithMissingNode() {
         //noinspection OptionalGetWithoutIsPresent
@@ -106,4 +138,34 @@ void shouldRejectSourceNodeFilterWithMissingNode() {
             .hasMessage(
                 "Invalid configuration value 'sourceNodeFilter', the following nodes are missing from the graph: [" + missingNode + "]");
     }
+
+    @Test
+    void shouldRejectTargetNodeFilterWithMissingNode() {
+        //noinspection OptionalGetWithoutIsPresent
+        var missingNode = new Random()
+            .longs(
+                0,
+                4_294_967_295L // a large-ish number that still fits in our id maps (Math.pow(2, 32) - 1)
+            ).filter(l -> !graphStore.nodes().contains(l))
+            .limit(1)
+            .findFirst()
+            .getAsLong();
+
+        assertThatThrownBy(
+            () -> new FilteredKnnBaseConfigImpl(
+                CypherMapWrapper.create(
+                    Map.of(
+                        "nodeProperties", List.of("dummy"),
+                        "targetNodeFilter", List.of(idFunction.of("a"), missingNode) // one existing, one missing
+                    )
+                )
+            ).validateTargetNodeFilter(
+                graphStore,
+                List.of(),
+                List.of()
+            )
+        ).isInstanceOf(IllegalArgumentException.class)
+            .hasMessage(
+                "Invalid configuration value 'targetNodeFilter', the following nodes are missing from the graph: [" + missingNode + "]");
+    }
 }