Add triangle count to business facade

Author: IoannisPanagiotas

algorithms-compute-business-facade/src/main/java/org/neo4j/gds/community/CommunityComputeBusinessFacade.java

@@ -30,6 +30,7 @@
 import org.neo4j.gds.cliquecounting.CliqueCountingParameters;
 import org.neo4j.gds.collections.ha.HugeLongArray;
 import org.neo4j.gds.community.validation.ApproxMaxKCutValidation;
+import org.neo4j.gds.community.validation.TriangleCountGraphStoreValidation;
 import org.neo4j.gds.community.validation.UndirectedAndSeedableGraphStoreValidation;
 import org.neo4j.gds.conductance.ConductanceParameters;
 import org.neo4j.gds.conductance.ConductanceResult;
@@ -63,6 +64,8 @@
 import org.neo4j.gds.scc.SccParameters;
 import org.neo4j.gds.triangle.LocalClusteringCoefficientParameters;
 import org.neo4j.gds.triangle.LocalClusteringCoefficientResult;
+import org.neo4j.gds.triangle.TriangleCountParameters;
+import org.neo4j.gds.triangle.TriangleCountResult;
 
 import java.util.List;
 import java.util.Optional;
@@ -508,4 +511,35 @@ public <TR> CompletableFuture<TR> scc(
         ).thenApply(resultTransformerBuilder.build(graphResources));
     }
 
+    public <TR> CompletableFuture<TR> triangleCount(
+        GraphName graphName,
+        GraphParameters graphParameters,
+        Optional<String> relationshipProperty,
+        TriangleCountParameters parameters,
+        JobId jobId,
+        boolean logProgress,
+        ResultTransformerBuilder<TimedAlgorithmResult<TriangleCountResult>, TR> resultTransformerBuilder
+    ) {
+        // Fetch the Graph the algorithm will operate on
+        var graphResources = graphStoreCatalogService.fetchGraphResources(
+            graphName,
+            graphParameters,
+            relationshipProperty,
+            TriangleCountGraphStoreValidation.create(parameters.labelFilter()),
+            Optional.empty(),
+            user,
+            databaseId
+        );
+        var graph = graphResources.graph();
+
+        return computeFacade.triangleCount(
+            graph,
+            parameters,
+            jobId,
+            logProgress
+
+        ).thenApply(resultTransformerBuilder.build(graphResources));
+    }
+
+
 }

algorithms-compute-business-facade/src/main/java/org/neo4j/gds/community/validation/TriangleCountGraphStoreValidation.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.community.validation;
+
+import org.neo4j.gds.NodeLabel;
+import org.neo4j.gds.RelationshipType;
+import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.core.loading.validation.GraphStoreValidation;
+import org.neo4j.gds.core.loading.validation.UndirectedOnlyGraphStoreValidation;
+
+import java.util.Collection;
+import java.util.List;
+
+import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
+
+public final class TriangleCountGraphStoreValidation extends GraphStoreValidation {
+
+    private final UndirectedOnlyGraphStoreValidation undirectedOnlyGraphStoreValidation;
+    private final List<String> labelFilter;
+
+    public static TriangleCountGraphStoreValidation create(List<String> labelFilter){
+        return  new TriangleCountGraphStoreValidation(new UndirectedOnlyGraphStoreValidation("Triangle Counting"),labelFilter);
+    }
+    private TriangleCountGraphStoreValidation(
+        UndirectedOnlyGraphStoreValidation undirectedOnlyGraphStoreValidation,
+        List<String> labelFilter
+    ) {
+        this.undirectedOnlyGraphStoreValidation = undirectedOnlyGraphStoreValidation;
+        this.labelFilter = labelFilter;
+    }
+
+
+    @Override
+    protected void validateAlgorithmRequirements(
+        GraphStore graphStore,
+        Collection<NodeLabel> selectedLabels,
+        Collection<RelationshipType> selectedRelationshipTypes
+    ) {
+            undirectedOnlyGraphStoreValidation.validateAlgorithmRequirements(graphStore,selectedLabels,selectedRelationshipTypes);
+            validateLabelsExist(selectedLabels);
+    }
+
+
+    void validateLabelsExist(
+        Collection<NodeLabel> nodeLabels
+    ) {
+        for (String givenLabelString : labelFilter) {
+            var givenLabel = NodeLabel.of(givenLabelString);
+            if (!nodeLabels.contains(givenLabel)) {
+                throw new IllegalArgumentException(formatWithLocale(
+                    "TriangleCount requires the provided 'labelFilter' node label '%s' to be present in the graph.",
+                    givenLabel.name()
+                ));
+            }
+        }
+    }
+}

procedures/pushback-procedures-facade/src/test/java/org/neo4j/gds/community/validation/TriangleCountGraphStoreValidationTest.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.community.validation;
+
+import org.junit.jupiter.api.Test;
+import org.neo4j.gds.NodeLabel;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThatNoException;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+class TriangleCountGraphStoreValidationTest {
+
+    @Test
+    void shouldNotComplainForExistingLabels(){
+        var validation = TriangleCountGraphStoreValidation.create(List.of("A"));
+        assertThatNoException().isThrownBy(() -> validation.validateLabelsExist(List.of(NodeLabel.of("A"),NodeLabel.of("B"))));
+    }
+
+    @Test
+    void shouldComplainForMissingLabels(){
+        var validation = TriangleCountGraphStoreValidation.create(List.of("C"));
+        assertThatThrownBy(()-> validation.validateLabelsExist(List.of(NodeLabel.of("A"),NodeLabel.of("B"))))
+            .hasMessageContaining("TriangleCount requires the provided 'labelFilter' node label 'C' to be present in the graph");
+    }
+
+}