Refactor metric logic to avoid duplication

Co-authored-by: Veselin Nikolov <veselin.nikolov@neotechnology.com>

Author: IoannisPanagiotas

algo/src/main/java/org/neo4j/gds/algorithms/community/BasicAlgorithmRunner.java

@@ -25,7 +25,6 @@
 import org.neo4j.gds.algorithms.AlgorithmComputationResult;
 import org.neo4j.gds.algorithms.AlgorithmMemoryEstimation;
 import org.neo4j.gds.algorithms.AlgorithmMemoryValidationService;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
 import org.neo4j.gds.api.DatabaseId;
 import org.neo4j.gds.api.GraphName;
 import org.neo4j.gds.api.User;
@@ -35,6 +34,7 @@
 import org.neo4j.gds.core.utils.progress.TaskRegistryFactory;
 import org.neo4j.gds.core.utils.warnings.UserLogRegistryFactory;
 import org.neo4j.gds.logging.Log;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
 
 import java.util.Optional;
 

algo/src/test/java/org/neo4j/gds/algorithms/community/BasicAlgorithmRunnerTest.java

@@ -21,10 +21,10 @@
 
 import org.junit.jupiter.api.Test;
 import org.neo4j.gds.Algorithm;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetric;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
 import org.neo4j.gds.compat.Neo4jProxy;
 import org.neo4j.gds.logging.Log;
+import org.neo4j.gds.metrics.ExecutionMetric;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
 
 import static org.assertj.core.api.Assertions.assertThatException;
 import static org.mockito.ArgumentMatchers.anyString;
@@ -39,7 +39,7 @@ class BasicAlgorithmRunnerTest {
 
     @Test
     void shouldRegisterAlgorithmMetricCountForSuccess() {
-        var algorithmMetricMock = mock(AlgorithmMetric.class);
+        var algorithmMetricMock = mock(ExecutionMetric.class);
         var algorithmMetricsServiceMock = mock(AlgorithmMetricsService.class);
         when(algorithmMetricsServiceMock.create(anyString())).thenReturn(algorithmMetricMock);
 
@@ -71,7 +71,7 @@ void shouldRegisterAlgorithmMetricCountForSuccess() {
 
     @Test
     void shouldRegisterAlgorithmMetricCountForFailure() {
-        var algorithmMetricMock = mock(AlgorithmMetric.class);
+        var algorithmMetricMock = mock(ExecutionMetric.class);
         var algorithmMetricsServiceMock = mock(AlgorithmMetricsService.class);
         when(algorithmMetricsServiceMock.create(anyString())).thenReturn(algorithmMetricMock);
 

executor/src/main/java/org/neo4j/gds/executor/ExecutionContext.java

@@ -21,8 +21,6 @@
 
 import org.jetbrains.annotations.Nullable;
 import org.neo4j.common.DependencyResolver;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
-import org.neo4j.gds.algorithms.metrics.PassthroughAlgorithmMetricRegistrar;
 import org.neo4j.gds.annotation.ValueClass;
 import org.neo4j.gds.api.AlgorithmMetaDataSetter;
 import org.neo4j.gds.api.CloseableResourceRegistry;
@@ -39,6 +37,8 @@
 import org.neo4j.gds.core.write.NodePropertyExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipStreamExporterBuilder;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
+import org.neo4j.gds.metrics.PassthroughExecutionMetricRegistrar;
 import org.neo4j.logging.Log;
 import org.neo4j.logging.NullLog;
 
@@ -179,7 +179,7 @@ public boolean isGdsAdmin() {
 
         @Override
         public AlgorithmMetricsService algorithmMetricsService() {
-            return new AlgorithmMetricsService(new PassthroughAlgorithmMetricRegistrar());
+            return new AlgorithmMetricsService(new PassthroughExecutionMetricRegistrar());
         }
 
         @Override

executor/src/main/java/org/neo4j/gds/executor/ProcedureExecutor.java

@@ -23,12 +23,12 @@
 import org.neo4j.gds.AlgorithmFactory;
 import org.neo4j.gds.GraphAlgorithmFactory;
 import org.neo4j.gds.GraphStoreAlgorithmFactory;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
 import org.neo4j.gds.api.Graph;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.config.AlgoBaseConfig;
 import org.neo4j.gds.core.utils.ProgressTimer;
 import org.neo4j.gds.core.utils.TerminationFlag;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
 
 import java.util.Map;
 import java.util.Optional;

executor/src/test/java/org/neo4j/gds/executor/MemoryEstimationExecutorTest.java

@@ -27,8 +27,6 @@
 import org.neo4j.gds.NodeProjections;
 import org.neo4j.gds.ProcedureCallContextReturnColumns;
 import org.neo4j.gds.RelationshipProjections;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
-import org.neo4j.gds.algorithms.metrics.PassthroughAlgorithmMetricRegistrar;
 import org.neo4j.gds.api.AlgorithmMetaDataSetter;
 import org.neo4j.gds.api.CloseableResourceRegistry;
 import org.neo4j.gds.api.DatabaseId;
@@ -44,6 +42,8 @@
 import org.neo4j.gds.core.utils.progress.EmptyTaskRegistryFactory;
 import org.neo4j.gds.core.utils.warnings.EmptyUserLogRegistryFactory;
 import org.neo4j.gds.gdl.GdlGraphs;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
+import org.neo4j.gds.metrics.PassthroughExecutionMetricRegistrar;
 import org.neo4j.gds.projection.GraphProjectFromStoreConfig;
 import org.neo4j.gds.test.TestAlgorithm;
 import org.neo4j.gds.test.TestAlgorithmResult;
@@ -87,7 +87,7 @@ void setup() throws Exception {
             .nodeLookup(NodeLookup.EMPTY)
             .modelCatalog(ModelCatalog.EMPTY)
             .isGdsAdmin(false)
-            .algorithmMetricsService(new AlgorithmMetricsService(new PassthroughAlgorithmMetricRegistrar()))
+            .algorithmMetricsService(new AlgorithmMetricsService(new PassthroughExecutionMetricRegistrar()))
             .build();
 
         memoryEstimationExecutor = new MemoryEstimationExecutor<>(

executor/src/test/java/org/neo4j/gds/executor/ProcedureExecutorTest.java

@@ -23,8 +23,6 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.neo4j.gds.ProcedureCallContextReturnColumns;
-import org.neo4j.gds.algorithms.metrics.AlgorithmMetricsService;
-import org.neo4j.gds.algorithms.metrics.PassthroughAlgorithmMetricRegistrar;
 import org.neo4j.gds.api.AlgorithmMetaDataSetter;
 import org.neo4j.gds.api.CloseableResourceRegistry;
 import org.neo4j.gds.api.GraphStore;
@@ -43,6 +41,8 @@
 import org.neo4j.gds.extension.GdlExtension;
 import org.neo4j.gds.extension.GdlGraph;
 import org.neo4j.gds.extension.Inject;
+import org.neo4j.gds.metrics.algorithms.AlgorithmMetricsService;
+import org.neo4j.gds.metrics.PassthroughExecutionMetricRegistrar;
 import org.neo4j.gds.utils.StringJoining;
 
 import java.util.HashSet;
@@ -138,7 +138,7 @@ private ExecutionContext executionContext(TaskStore taskStore) {
             .algorithmMetaDataSetter(AlgorithmMetaDataSetter.EMPTY)
             .nodeLookup(NodeLookup.EMPTY)
             .userLogRegistryFactory(EmptyUserLogRegistryFactory.INSTANCE)
-            .algorithmMetricsService(new AlgorithmMetricsService(new PassthroughAlgorithmMetricRegistrar()))
+            .algorithmMetricsService(new AlgorithmMetricsService(new PassthroughExecutionMetricRegistrar()))
             .build();
     }
 

…/algorithms/metrics/AlgorithmMetric.java …g/neo4j/gds/metrics/ExecutionMetric.javametrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/AlgorithmMetric.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetric.java metrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/AlgorithmMetric.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetric.java

@@ -17,14 +17,14 @@
  * 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.algorithms.metrics;
+package org.neo4j.gds.metrics;
 
-public abstract class AlgorithmMetric implements AutoCloseable {
+public abstract class ExecutionMetric implements AutoCloseable {
 
-    protected final String algorithm;
+    protected final String operation;
 
-    protected AlgorithmMetric(String algorithm) {
-        this.algorithm = algorithm;
+    protected ExecutionMetric(String operation) {
+        this.operation = operation;
     }
 
     public abstract void start();

…ms/metrics/AlgorithmMetricRegistrar.java …ds/metrics/ExecutionMetricRegistrar.javametrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/AlgorithmMetricRegistrar.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetricRegistrar.java metrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/AlgorithmMetricRegistrar.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetricRegistrar.java

@@ -17,10 +17,10 @@
  * 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.algorithms.metrics;
+package org.neo4j.gds.metrics;
 
-public interface AlgorithmMetricRegistrar {
+public interface ExecutionMetricRegistrar {
 
-    AlgorithmMetric create(String algorithm);
+    ExecutionMetric create(String algorithm);
 
 }

…/metrics/PassthroughAlgorithmMetric.java …/metrics/PassthroughExecutionMetric.javametrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/PassthroughAlgorithmMetric.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetric.java metrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/PassthroughAlgorithmMetric.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetric.java

@@ -17,12 +17,12 @@
  * 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.algorithms.metrics;
+package org.neo4j.gds.metrics;
 
-public final class PassthroughAlgorithmMetric extends AlgorithmMetric {
+public final class PassthroughExecutionMetric extends ExecutionMetric {
 
-    PassthroughAlgorithmMetric(String algorithm) {
-        super(algorithm);
+    PassthroughExecutionMetric(String operation) {
+        super(operation);
     }
 
     @Override

…PassthroughAlgorithmMetricRegistrar.java …PassthroughExecutionMetricRegistrar.javametrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/PassthroughAlgorithmMetricRegistrar.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetricRegistrar.java metrics-api/src/main/java/org/neo4j/gds/algorithms/metrics/PassthroughAlgorithmMetricRegistrar.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetricRegistrar.java

@@ -17,15 +17,15 @@
  * 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.algorithms.metrics;
+package org.neo4j.gds.metrics;
 
 /**
  * No-op metrics registrar; to be used when metrics are not enabled in Neo4j.
  */
-public class PassthroughAlgorithmMetricRegistrar implements AlgorithmMetricRegistrar {
+public class PassthroughExecutionMetricRegistrar implements ExecutionMetricRegistrar {
 
     @Override
-    public AlgorithmMetric create(String algorithm) {
-        return new PassthroughAlgorithmMetric(algorithm);
+    public ExecutionMetric create(String operation) {
+        return new PassthroughExecutionMetric(operation);
     }
 }