Add clique counting in business facade

Author: IoannisPanagiotas

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

@@ -25,9 +25,12 @@
 import org.neo4j.gds.api.User;
 import org.neo4j.gds.approxmaxkcut.ApproxMaxKCutParameters;
 import org.neo4j.gds.approxmaxkcut.ApproxMaxKCutResult;
+import org.neo4j.gds.cliqueCounting.CliqueCountingResult;
+import org.neo4j.gds.cliquecounting.CliqueCountingParameters;
 import org.neo4j.gds.community.validation.ApproxMaxKCutValidation;
 import org.neo4j.gds.core.JobId;
 import org.neo4j.gds.core.loading.GraphStoreCatalogService;
+import org.neo4j.gds.core.loading.validation.UndirectedOnlyGraphStoreValidation;
 import org.neo4j.gds.result.TimedAlgorithmResult;
 import org.neo4j.gds.results.ResultTransformerBuilder;
 
@@ -85,4 +88,35 @@ public <TR> CompletableFuture<TR> approxMaxKCut(
 
         ).thenApply(resultTransformerBuilder.build(graphResources));
     }
+
+    public <TR> CompletableFuture<TR> cliqueCounting(
+        GraphName graphName,
+        GraphParameters graphParameters,
+        Optional<String> relationshipProperty,
+        CliqueCountingParameters parameters,
+        JobId jobId,
+        boolean logProgress,
+        ResultTransformerBuilder<TimedAlgorithmResult<CliqueCountingResult>, TR> resultTransformerBuilder
+    ) {
+        // Fetch the Graph the algorithm will operate on
+        var graphResources = graphStoreCatalogService.fetchGraphResources(
+            graphName,
+            graphParameters,
+            relationshipProperty,
+            new UndirectedOnlyGraphStoreValidation("Clique Counting"),
+            Optional.empty(),
+            user,
+            databaseId
+        );
+        var graph = graphResources.graph();
+
+        return computeFacade.cliqueCounting(
+            graph,
+            parameters,
+            jobId,
+            logProgress
+
+        ).thenApply(resultTransformerBuilder.build(graphResources));
+    }
+
 }

core/src/main/java/org/neo4j/gds/core/loading/validation/UndirectedOnlyGraphStoreValidation.java

@@ -0,0 +1,58 @@
+/*
+ * 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.core.loading.validation;
+
+import org.neo4j.gds.NodeLabel;
+import org.neo4j.gds.RelationshipType;
+import org.neo4j.gds.api.GraphStore;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
+
+public final class UndirectedOnlyGraphStoreValidation extends GraphStoreValidation {
+
+    private final String algorithm;
+
+    public UndirectedOnlyGraphStoreValidation(String algorithm) {this.algorithm = algorithm;}
+
+    @Override
+    public void validateAlgorithmRequirements(
+        GraphStore graphStore,
+        Collection<NodeLabel> selectedLabels,
+        Collection<RelationshipType> selectedRelationshipTypes
+    ) {
+        validateOnlyUndirected(graphStore,selectedRelationshipTypes);
+    }
+
+    void validateOnlyUndirected(GraphStore graphStore,Collection<RelationshipType> selectedRelationshipTypes ){
+        if (!graphStore.schema().filterRelationshipTypes(Set.copyOf(selectedRelationshipTypes)).isUndirected()) {
+            throw new IllegalArgumentException(formatWithLocale(
+                "%s requires relationship projections to be UNDIRECTED. " +
+                    "Selected relationships `%s` are not all undirected.",
+                algorithm,
+                selectedRelationshipTypes.stream().map(RelationshipType::name).collect(Collectors.toSet())
+            ));
+        }
+    }
+
+}

core/src/test/java/org/neo4j/gds/core/loading/validation/UndirectedOnlyGraphStoreValidationTest.java

@@ -0,0 +1,71 @@
+/*
+ * 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.core.loading.validation;
+
+import org.junit.jupiter.api.Test;
+import org.neo4j.gds.RelationshipType;
+import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.api.schema.GraphSchema;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThatNoException;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.ArgumentMatchers.anySet;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class UndirectedOnlyGraphStoreValidationTest {
+
+    @Test
+    void shouldNotThrowForUndirectedSchema() {
+        var graphStore = mock(GraphStore.class);
+        var schema = mock(GraphSchema.class);
+        var schema2 = mock(GraphSchema.class);
+        when(schema2.isUndirected()).thenReturn(true);
+        when(graphStore.schema()).thenReturn(schema);
+        when(schema.filterRelationshipTypes(anySet())).thenReturn(schema2);
+
+        var validation = new UndirectedOnlyGraphStoreValidation("foo");
+        assertThatNoException().isThrownBy(() -> validation.validateOnlyUndirected(
+            graphStore,
+            List.of(RelationshipType.of("REL1"))
+        ));
+
+    }
+
+    @Test
+    void shouldThrowForDirectedSchema() {
+        var graphStore = mock(GraphStore.class);
+        var schema = mock(GraphSchema.class);
+        var schema2 = mock(GraphSchema.class);
+        when(schema2.isUndirected()).thenReturn(false);
+        when(graphStore.schema()).thenReturn(schema);
+        when(schema.filterRelationshipTypes(anySet())).thenReturn(schema2);
+
+
+        var validation = new UndirectedOnlyGraphStoreValidation("foo");
+        assertThatThrownBy(() -> validation.validateOnlyUndirected(graphStore, List.of(RelationshipType.of("REL1"))))
+            .hasMessageContaining("foo requires relationship projections to be UNDIRECTED. " +
+                "Selected relationships `[REL1]` are not all undirected");
+
+    }
+
+}