Add Projection metric registrar

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

Author: IoannisPanagiotas

metrics-api/src/main/java/org/neo4j/gds/projections/PassthroughProjectionMetric.java

@@ -0,0 +1,36 @@
+/*
+ * 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.projections;
+
+public final class PassthroughProjectionMetric extends ProjectionMetric {
+
+    PassthroughProjectionMetric(String projectionMode) {
+        super(projectionMode);
+    }
+
+    @Override
+    public void start() {}
+
+    @Override
+    public void failed() {}
+
+    @Override
+    public void close() {}
+}

metrics-api/src/main/java/org/neo4j/gds/projections/PassthroughProjectionMetricRegistrar.java

@@ -0,0 +1,31 @@
+/*
+ * 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.projections;
+
+/**
+ * No-op metrics registrar; to be used when metrics are not enabled in Neo4j.
+ */
+public class PassthroughProjectionMetricRegistrar implements ProjectionMetricRegistrar {
+
+    @Override
+    public ProjectionMetric create(String projectionMode) {
+        return new PassthroughProjectionMetric(projectionMode);
+    }
+}

metrics-api/src/main/java/org/neo4j/gds/projections/ProjectionMetric.java

@@ -0,0 +1,36 @@
+/*
+ * 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.projections;
+
+public abstract class ProjectionMetric implements AutoCloseable {
+
+    protected final String projectionMode;
+
+    protected ProjectionMetric(String projectionMode) {
+        this.projectionMode = projectionMode;
+    }
+
+    public abstract void start();
+
+    public abstract void failed();
+
+    @Override
+    public abstract void close();
+}

metrics-api/src/main/java/org/neo4j/gds/projections/ProjectionMetricRegistrar.java

@@ -0,0 +1,25 @@
+/*
+ * 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.projections;
+
+public interface ProjectionMetricRegistrar {
+
+    ProjectionMetric create(String projectionMode);
+}

metrics-api/src/main/java/org/neo4j/gds/projections/ProjectionMetricsService.java

@@ -0,0 +1,40 @@
+/*
+ * 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.projections;
+
+public class ProjectionMetricsService {
+
+    private final ProjectionMetricRegistrar metricRegistrar;
+
+    public ProjectionMetricsService(ProjectionMetricRegistrar metricRegistrar) {
+        this.metricRegistrar = metricRegistrar;
+    }
+
+    public ProjectionMetric createNative() {
+        return metricRegistrar.create("native");
+    }
+    public ProjectionMetric createCypher() {
+        return metricRegistrar.create("cypher");
+    }
+    public ProjectionMetric createCypherV2() {
+        return metricRegistrar.create("cypherV2");
+    }
+
+}

metrics-api/src/test/java/org/neo4j/gds/projections/ProjectionMetricsServiceTest.java

@@ -0,0 +1,75 @@
+/*
+ * 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.projections;
+
+import org.junit.jupiter.api.Test;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyNoMoreInteractions;
+
+class ProjectionMetricsServiceTest {
+
+    @Test
+    void shouldCreateNativeProjectionMetric() {
+        // given
+        var registrarMock = mock(ProjectionMetricRegistrar.class);
+        var metricsService = new ProjectionMetricsService(registrarMock);
+
+        // when
+        metricsService.createNative();
+
+        // then
+        verify(registrarMock, times(1)).create("native");
+        verifyNoMoreInteractions(registrarMock);
+    }
+
+    @Test
+    void shouldCreateCypherProjectionMetric() {
+        // given
+        var registrarMock = mock(ProjectionMetricRegistrar.class);
+        var metricsService = new ProjectionMetricsService(registrarMock);
+
+        // when
+        metricsService.createCypher();
+
+        // then
+        verify(registrarMock, times(1)).create("cypher");
+        verifyNoMoreInteractions(registrarMock);
+    }
+
+    @Test
+    void shouldCreateCypherV2ProjectionMetric() {
+        // given
+        var registrarMock = mock(ProjectionMetricRegistrar.class);
+        var metricsService = new ProjectionMetricsService(registrarMock);
+
+        // when
+        metricsService.createCypherV2();
+
+        // then
+        verify(registrarMock, times(1)).create("cypherV2");
+        verifyNoMoreInteractions(registrarMock);
+    }
+
+
+
+}