Merge pull request #9702 from lassewesth/rena

renaming side effect timing

Author: lassewesth

applications/algorithms/machinery/src/main/java/org/neo4j/gds/applications/algorithms/machinery/AlgorithmProcessingTimings.java

@@ -25,11 +25,11 @@
 public class AlgorithmProcessingTimings {
     public final long preProcessingMillis;
     public final long computeMillis;
-    public final long mutateOrWriteMillis;
+    public final long sideEffectMillis; // rename
 
-    AlgorithmProcessingTimings(long preProcessingMillis, long computeMillis, long mutateOrWriteMillis) {
+    AlgorithmProcessingTimings(long preProcessingMillis, long computeMillis, long sideEffectMillis) {
         this.preProcessingMillis = preProcessingMillis;
         this.computeMillis = computeMillis;
-        this.mutateOrWriteMillis = mutateOrWriteMillis;
+        this.sideEffectMillis = sideEffectMillis;
     }
 }

applications/algorithms/machinery/src/main/java/org/neo4j/gds/applications/algorithms/machinery/AlgorithmProcessingTimingsBuilder.java

@@ -29,7 +29,7 @@ class AlgorithmProcessingTimingsBuilder {
     // timings
     protected long preProcessingMillis = NOT_AVAILABLE;
     protected long computeMillis = NOT_AVAILABLE;
-    protected long mutateOrWriteMillis = NOT_AVAILABLE;
+    protected long sideEffectMillis = NOT_AVAILABLE; // rename
 
     public void withPreProcessingMillis(long preProcessingMillis) {
         this.preProcessingMillis = preProcessingMillis;
@@ -39,15 +39,15 @@ public void withComputeMillis(long computeMillis) {
         this.computeMillis = computeMillis;
     }
 
-    public void withMutateOrWriteMillis(long mutateOrWriteMillis) {
-        this.mutateOrWriteMillis = mutateOrWriteMillis;
+    public void withSideEffectMillis(long sideEffectMillis) {
+        this.sideEffectMillis = sideEffectMillis;
     }
 
     AlgorithmProcessingTimings build() {
         return new AlgorithmProcessingTimings(
             preProcessingMillis,
             computeMillis,
-            mutateOrWriteMillis
+            sideEffectMillis
         );
     }
 }

applications/algorithms/machinery/src/main/java/org/neo4j/gds/applications/algorithms/machinery/DefaultAlgorithmProcessingTemplate.java

@@ -293,7 +293,7 @@ private <RESULT_FROM_ALGORITHM, METADATA> Optional<METADATA> processSideEffect(
     ) {
         if (sideEffect.isEmpty()) return Optional.empty();
 
-        try (var ignored = ProgressTimer.start(timingsBuilder::withMutateOrWriteMillis)) {
+        try (var ignored = ProgressTimer.start(timingsBuilder::withSideEffectMillis)) { // rename
             return sideEffect.get().process(graphResources, result);
         }
     }

applications/algorithms/machinery/src/test/java/org/neo4j/gds/applications/algorithms/machinery/DefaultAlgorithmProcessingTemplateTest.java

@@ -78,7 +78,7 @@ void shouldDoFourStepProcess() {
                 assertThat(result).hasValue("some result");
                 assertThat(timings.preProcessingMillis).isGreaterThan(-1);
                 assertThat(timings.computeMillis).isGreaterThan(-1);
-                assertThat(timings.mutateOrWriteMillis).isGreaterThan(-1);
+                assertThat(timings.sideEffectMillis).isGreaterThan(-1);
                 assertThat(metadata).hasValue("metadata from some side effect");
 
                 return "some rendered result";
@@ -129,7 +129,7 @@ void shouldSkipSideEffect() {
                 assertThat(result).hasValue("some other result");
                 assertThat(timings.preProcessingMillis).isGreaterThan(-1);
                 assertThat(timings.computeMillis).isGreaterThan(-1);
-                assertThat(timings.mutateOrWriteMillis).isEqualTo(-1); // no side effect, no timing
+                assertThat(timings.sideEffectMillis).isEqualTo(-1); // no side effect, no timing
                 assertThat(metadata).isEmpty();
 
                 return "some other rendered result";

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/AlphaHarmonicCentralityResultBuilderForWriteMode.java

@@ -59,7 +59,7 @@ public Stream<AlphaHarmonicWriteResult> build(
             graph.nodeCount(),
             timings.preProcessingMillis,
             timings.computeMillis,
-            timings.mutateOrWriteMillis,
+            timings.sideEffectMillis,
             configuration.writeProperty(),
             centralityDistributionAndTiming.getLeft()
         );

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/ArticulationPointsResultBuilderForWriteMode.java

@@ -48,7 +48,7 @@ public Stream<ArticulationPointsWriteResult> build(
             new ArticulationPointsWriteResult(
                 bitSet.cardinality(),
                 metadata.map(NodePropertiesWritten::value).orElseThrow(),
-                timings.mutateOrWriteMillis,
+                timings.sideEffectMillis,
                 timings.computeMillis,
                 configuration.toMap()
             )

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/CelfResultBuilderForWriteMode.java

@@ -47,7 +47,7 @@ public Stream<CELFWriteResult> build(
 
         return Stream.of(
             new CELFWriteResult(
-                timings.mutateOrWriteMillis,
+                timings.sideEffectMillis,
                 nodePropertiesWritten.orElseThrow().value(),
                 timings.computeMillis,
                 celfResult.totalSpread(),

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/GenericCentralityResultBuilderForWriteMode.java

@@ -55,7 +55,7 @@ <CONFIGURATION extends ConcurrencyConfig & ToMapConvertible> CentralityWriteResu
             timings.preProcessingMillis,
             timings.computeMillis,
             centralityDistributionAndTiming.getRight(),
-            timings.mutateOrWriteMillis,
+            timings.sideEffectMillis,
             centralityDistributionAndTiming.getLeft(),
             configurationMap
         );

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/PageRankResultBuilderForWriteMode.java

@@ -65,7 +65,7 @@ public Stream<PageRankWriteResult> build(
             timings.preProcessingMillis,
             timings.computeMillis,
             pageRankDistribution.postProcessingMillis,
-            timings.mutateOrWriteMillis,
+            timings.sideEffectMillis,
             metadata.orElseThrow().value(),
             configurationMap
         );

procedures/algorithms-facade/src/main/java/org/neo4j/gds/procedures/algorithms/centrality/stubs/ArticulationPointsResultBuilderForMutateMode.java

@@ -46,7 +46,7 @@ public ArticulationPointsMutateResult build(
         return new ArticulationPointsMutateResult(
                 bitSet.cardinality(),
                 metadata.map(NodePropertiesWritten::value).orElseThrow(),
-                timings.mutateOrWriteMillis,
+                timings.sideEffectMillis,
                 timings.computeMillis,
                 configuration.toMap()
         );