Remove clusteringCoefficient from triangleCount proc

We will write a new procedure to expose that metric instead

Co-authored-by: Veselin Nikolov <[email protected]>

Author: Mats-SX

algo/src/main/java/org/neo4j/graphalgo/triangle/TriangleCountWriteConfig.java

@@ -33,9 +33,6 @@
 @SuppressWarnings("immutables:subtype")
 public interface TriangleCountWriteConfig extends TriangleCountBaseConfig, WritePropertyConfig {
 
-    @Configuration.ConvertWith("org.apache.commons.lang3.StringUtils#trimToNull")
-    String clusteringCoefficientProperty();
-
     static TriangleCountWriteConfig of(
         String username,
         Optional<String> graphName,

proc/common/src/main/java/org/neo4j/graphalgo/WriteProc.java

@@ -24,13 +24,10 @@
 import org.neo4j.graphalgo.core.concurrency.Pools;
 import org.neo4j.graphalgo.core.utils.ProgressTimer;
 import org.neo4j.graphalgo.core.utils.TerminationFlag;
-import org.neo4j.graphalgo.core.write.ImmutableNodeProperty;
 import org.neo4j.graphalgo.core.write.NodePropertyExporter;
 import org.neo4j.graphalgo.core.write.PropertyTranslator;
 import org.neo4j.graphalgo.result.AbstractResultBuilder;
 
-import java.util.Collection;
-import java.util.List;
 import java.util.stream.Stream;
 
 public abstract class WriteProc<
@@ -73,20 +70,14 @@ private void writeToNeo(
                 .parallel(Pools.DEFAULT, writePropertyConfig.writeConcurrency())
                 .build();
 
-            exporter.write(nodePropertiesToWrite(computationResult));
+            exporter.write(
+                writePropertyConfig.writeProperty(),
+                computationResult.result(),
+                nodePropertyTranslator(computationResult)
+            );
 
             resultBuilder.withNodeCount(computationResult.graph().nodeCount());
             resultBuilder.withNodePropertiesWritten(exporter.propertiesWritten());
         }
     }
-
-    protected Collection<NodePropertyExporter.NodeProperty<?>> nodePropertiesToWrite(ComputationResult<ALGO, ALGO_RESULT, CONFIG> computationResult) {
-        return List.of(
-            ImmutableNodeProperty.of(
-                computationResult.config().writeProperty(),
-                computationResult.result(),
-                nodePropertyTranslator(computationResult)
-            )
-        );
-    }
 }

proc/community/src/main/java/org/neo4j/graphalgo/triangle/TriangleCountMutateProc.java

@@ -19,7 +19,6 @@
  */
 package org.neo4j.graphalgo.triangle;
 
-import org.jetbrains.annotations.Nullable;
 import org.neo4j.graphalgo.AlgorithmFactory;
 import org.neo4j.graphalgo.MutateProc;
 import org.neo4j.graphalgo.config.GraphCreateConfig;
@@ -105,30 +104,27 @@ protected AbstractResultBuilder<MutateResult> resultBuilder(ComputationResult<In
     }
 
     public static class MutateResult extends TriangleCountStatsProc.StatsResult {
+
+        public long nodePropertiesWritten;
         public long mutateMillis;
 
         public MutateResult(
+            long triangleCount,
+            long nodeCount,
+            long nodePropertiesWritten,
             long createMillis,
             long computeMillis,
-            long postProcessingMillis,
             long mutateMillis,
-            long nodeCount,
-            long triangleCount,
-            double averageClusteringCoefficient,
-            @Nullable Map<String, Object> communityDistribution,
             Map<String, Object> configuration
         ) {
             super(
+                triangleCount,
+                nodeCount,
                 createMillis,
                 computeMillis,
-                postProcessingMillis,
-                nodeCount,
-                triangleCount,
-                averageClusteringCoefficient,
-                communityDistribution,
                 configuration
             );
-
+            this.nodePropertiesWritten = nodePropertiesWritten;
             this.mutateMillis = mutateMillis;
         }
     }
@@ -145,14 +141,12 @@ static class TriangleCountMutateBuilder extends TriangleCountCompanion.TriangleC
         @Override
         protected MutateResult buildResult() {
             return new MutateResult(
+                triangleCount,
+                nodeCount,
+                nodePropertiesWritten,
                 createMillis,
                 computeMillis,
-                postProcessingDuration,
                 mutateMillis,
-                nodeCount,
-                triangleCount,
-                averageClusteringCoefficient,
-                communityHistogramOrNull(),
                 config.toMap()
             );
         }

proc/community/src/main/java/org/neo4j/graphalgo/triangle/TriangleCountStatsProc.java

@@ -19,7 +19,6 @@
  */
 package org.neo4j.graphalgo.triangle;
 
-import org.jetbrains.annotations.Nullable;
 import org.neo4j.graphalgo.AlgorithmFactory;
 import org.neo4j.graphalgo.StatsProc;
 import org.neo4j.graphalgo.config.GraphCreateConfig;
@@ -97,33 +96,23 @@ protected AlgorithmFactory<IntersectingTriangleCount, TriangleCountStatsConfig>
     }
 
     public static class StatsResult {
+        public final long triangleCount;
+        public final long nodeCount;
         public final long createMillis;
         public final long computeMillis;
-        public final long postProcessingMillis;
-        public final long nodeCount;
-        public final long triangleCount;
-        public final double averageClusteringCoefficient;
-        // TODO: should we retain this?
-        public final Map<String, Object> communityDistribution;
         public final Map<String, Object> configuration;
 
         public StatsResult(
+            long triangleCount,
+            long nodeCount,
             long createMillis,
             long computeMillis,
-            long postProcessingMillis,
-            long nodeCount,
-            long triangleCount,
-            double averageClusteringCoefficient,
-            @Nullable Map<String, Object> communityDistribution,
             Map<String, Object> configuration
         ) {
             this.createMillis = createMillis;
             this.computeMillis = computeMillis;
-            this.postProcessingMillis = postProcessingMillis;
             this.nodeCount = nodeCount;
-            this.averageClusteringCoefficient = averageClusteringCoefficient;
             this.triangleCount = triangleCount;
-            this.communityDistribution = communityDistribution;
             this.configuration = configuration;
         }
     }
@@ -140,13 +129,10 @@ static class TriangleCountStatsBuilder extends TriangleCountCompanion.TriangleCo
         @Override
         protected StatsResult buildResult() {
             return new StatsResult(
+                triangleCount,
+                nodeCount,
                 createMillis,
                 computeMillis,
-                postProcessingDuration,
-                nodeCount,
-                triangleCount,
-                averageClusteringCoefficient,
-                communityHistogramOrNull(),
                 config.toMap()
             );
         }

proc/community/src/main/java/org/neo4j/graphalgo/triangle/TriangleCountWriteProc.java

@@ -19,16 +19,11 @@
  */
 package org.neo4j.graphalgo.triangle;
 
-import org.jetbrains.annotations.Nullable;
 import org.neo4j.graphalgo.AlgorithmFactory;
 import org.neo4j.graphalgo.WriteProc;
 import org.neo4j.graphalgo.config.GraphCreateConfig;
 import org.neo4j.graphalgo.core.CypherMapWrapper;
 import org.neo4j.graphalgo.core.utils.paged.AllocationTracker;
-import org.neo4j.graphalgo.core.utils.paged.HugeAtomicLongArray;
-import org.neo4j.graphalgo.core.utils.paged.HugeDoubleArray;
-import org.neo4j.graphalgo.core.write.ImmutableNodeProperty;
-import org.neo4j.graphalgo.core.write.NodePropertyExporter;
 import org.neo4j.graphalgo.core.write.PropertyTranslator;
 import org.neo4j.graphalgo.result.AbstractResultBuilder;
 import org.neo4j.graphalgo.results.MemoryEstimateResult;
@@ -37,8 +32,6 @@
 import org.neo4j.procedure.Name;
 import org.neo4j.procedure.Procedure;
 
-import java.util.Collection;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -109,50 +102,25 @@ protected AbstractResultBuilder<WriteResult> resultBuilder(ComputationResult<Int
         );
     }
 
-    @Override
-    protected Collection<NodePropertyExporter.NodeProperty<?>> nodePropertiesToWrite(ComputationResult<IntersectingTriangleCount, IntersectingTriangleCount.TriangleCountResult, TriangleCountWriteConfig> computationResult) {
-        TriangleCountWriteConfig config = computationResult.config();
-        IntersectingTriangleCount.TriangleCountResult result = computationResult.result();
-
-        return List.of(
-            ImmutableNodeProperty.of(
-                config.writeProperty(),
-                result.localTriangles(),
-                HugeAtomicLongArray.Translator.INSTANCE
-            ),
-            ImmutableNodeProperty.of(
-                config.clusteringCoefficientProperty(),
-                result.localClusteringCoefficients(),
-                HugeDoubleArray.Translator.INSTANCE
-            )
-        );
-    }
-
     public static class WriteResult extends TriangleCountStatsProc.StatsResult {
 
-        public long writeMillis;
         public long nodePropertiesWritten;
+        public long writeMillis;
 
         public WriteResult(
+            long triangleCount,
+            long nodeCount,
+            long nodePropertiesWritten,
             long createMillis,
             long computeMillis,
             long writeMillis,
-            long postProcessingMillis,
-            long nodeCount,
-            long triangleCount,
-            double averageClusteringCoefficient,
-            long nodePropertiesWritten,
-            @Nullable Map<String, Object> communityDistribution,
             Map<String, Object> configuration
         ) {
             super(
+                triangleCount,
+                nodeCount,
                 createMillis,
                 computeMillis,
-                postProcessingMillis,
-                nodeCount,
-                triangleCount,
-                averageClusteringCoefficient,
-                communityDistribution,
                 configuration
             );
 
@@ -173,15 +141,12 @@ static class TriangleCountWriteBuilder extends TriangleCountCompanion.TriangleCo
         @Override
         protected WriteResult buildResult() {
             return new WriteResult(
+                triangleCount,
+                nodeCount,
+                nodePropertiesWritten,
                 createMillis,
                 computeMillis,
                 writeMillis,
-                postProcessingDuration,
-                nodeCount,
-                triangleCount,
-                averageClusteringCoefficient,
-                nodePropertiesWritten,
-                communityHistogramOrNull(),
                 config.toMap()
             );
         }

proc/community/src/test/java/org/neo4j/graphalgo/triangle/TriangleCountMutateProcTest.java

@@ -25,20 +25,17 @@
 import org.neo4j.graphalgo.GraphMutationTest;
 import org.neo4j.graphalgo.Orientation;
 import org.neo4j.graphalgo.RelationshipProjection;
-import org.neo4j.graphalgo.StoreLoaderBuilder;
-import org.neo4j.graphalgo.core.Aggregation;
 import org.neo4j.graphalgo.core.CypherMapWrapper;
-import org.neo4j.graphalgo.core.loading.NativeFactory;
 import org.neo4j.values.storable.NumberType;
 
+import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.lessThan;
+import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.isA;
 import static org.neo4j.graphalgo.ElementProjection.PROJECT_ALL;
 import static org.neo4j.graphalgo.RelationshipType.ALL_RELATIONSHIPS;
-import static org.neo4j.graphalgo.TestGraph.Builder.fromGdl;
-import static org.neo4j.graphalgo.TestSupport.assertGraphEquals;
 
 class TriangleCountMutateProcTest
     extends TriangleCountBaseProcTest<TriangleCountMutateConfig>
@@ -70,7 +67,7 @@ public String expectedMutatedGraph() {
     }
 
     @Test
-    void testMutate() {
+    void testMutateYields() {
         String query = GdsCypher
             .call()
             .withAnyLabel()
@@ -81,45 +78,17 @@ void testMutate() {
             .algo("triangleCount")
             .mutateMode()
             .addParameter("mutateProperty", mutateProperty())
-            .yields(
-                "createMillis",
-                "computeMillis",
-                "mutateMillis",
-                "postProcessingMillis",
-                "communityDistribution",
-                "configuration"
-            );
-
-        runQueryWithRowConsumer(
-            query,
-            row -> {
-                assertThat(-1L, lessThan(row.getNumber("createMillis").longValue()));
-                assertThat(-1L, lessThan(row.getNumber("computeMillis").longValue()));
-                assertThat(-1L, lessThan(row.getNumber("mutateMillis").longValue()));
-            }
-        );
-
-        var writeQuery = GdsCypher
-            .call()
-            .explicitCreation("g")
-            .algo("triangleCount")
-            .writeMode()
-            .addParameter("writeProperty", mutateProperty())
-            .addParameter("clusteringCoefficientProperty", "clusteringCoefficient")
             .yields();
 
-        runQuery(writeQuery);
-
-        var updatedGraph = new StoreLoaderBuilder().api(db)
-            .loadAnyLabel()
-            .loadAnyRelationshipType()
-            .globalOrientation(Orientation.UNDIRECTED)
-            .addNodeProperty(mutateProperty(), mutateProperty(), 42.0, Aggregation.NONE)
-            .build()
-            .graph(NativeFactory.class);
-
-        assertGraphEquals(fromGdl(expectedMutatedGraph()), updatedGraph);
-
+        assertCypherResult(query, List.of(Map.of(
+            "triangleCount", 1L,
+            "nodeCount", 3L,
+            "createMillis", greaterThan(-1L),
+            "computeMillis", greaterThan(-1L),
+            "configuration", isA(Map.class),
+            "mutateMillis", greaterThan(-1L),
+            "nodePropertiesWritten", 3L
+        )));
     }
 
     @Override
@@ -136,6 +105,4 @@ public TriangleCountMutateConfig createConfig(CypherMapWrapper mapWrapper) {
             mapWrapper
         );
     }
-
-
 }