Merge pull request #10317 from FlorentinD/cypher-surface/graph-producing-endpoints

cypher surface/graph producing endpoints

Author: FlorentinD

applications/graph-store-catalog-results/src/main/java/org/neo4j/gds/applications/graphstorecatalog/GraphGenerationStats.java

@@ -22,25 +22,29 @@
 import java.util.Map;
 
 public class GraphGenerationStats {
-    public String name;
-    public long nodes;
-    public long relationships;
-    @SuppressWarnings("WeakerAccess")
-    public long generateMillis;
-    @SuppressWarnings("WeakerAccess")
-    public Long relationshipSeed;
-    public double averageDegree;
-    public Object relationshipDistribution;
-    public Object relationshipProperty;
+    public final String name;
+    public final long nodes;
+    public final long relationships;
+    public final long generateMillis;
+    public final Long relationshipSeed;
+    public final double averageDegree;
+    public final Object relationshipDistribution;
+    public final Object relationshipProperty;
 
-    GraphGenerationStats(
+    public GraphGenerationStats(
         String graphName,
+        long nodes,
+        long relationships,
+        long generateMillis,
         double averageDegree,
         String relationshipDistribution,
         Map<String, Object> relationshipProperty,
         Long relationshipSeed
     ) {
         this.name = graphName;
+        this.nodes = nodes;
+        this.relationships = relationships;
+        this.generateMillis = generateMillis;
         this.averageDegree = averageDegree;
         this.relationshipDistribution = relationshipDistribution;
         this.relationshipProperty = relationshipProperty;

applications/graph-store-catalog-results/src/main/java/org/neo4j/gds/applications/graphstorecatalog/RandomWalkSamplingResult.java

@@ -19,22 +19,6 @@
  */
 package org.neo4j.gds.applications.graphstorecatalog;
 
-import org.neo4j.gds.core.loading.GraphProjectResult;
-
-public class RandomWalkSamplingResult extends GraphProjectResult {
-    public final String fromGraphName;
-    public final long startNodeCount;
-
-    RandomWalkSamplingResult(
-        String graphName,
-        String fromGraphName,
-        long nodeCount,
-        long relationshipCount,
-        long startNodeCount,
-        long projectMillis
-    ) {
-        super(graphName, nodeCount, relationshipCount, projectMillis);
-        this.fromGraphName = fromGraphName;
-        this.startNodeCount = startNodeCount;
-    }
+public record RandomWalkSamplingResult(String graphName, String fromGraphName, long nodeCount, long relationshipCount,
+                                       long startNodeCount, long projectMillis) {
 }

applications/graph-store-catalog/src/main/java/org/neo4j/gds/applications/graphstorecatalog/GenerateGraphApplication.java

@@ -19,6 +19,7 @@
  */
 package org.neo4j.gds.applications.graphstorecatalog;
 
+import org.apache.commons.lang3.mutable.MutableLong;
 import org.neo4j.gds.api.DatabaseId;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.api.schema.Direction;
@@ -71,15 +72,11 @@ private GraphGenerationStats generateGraph(
         long averageDegree,
         RandomGraphGeneratorConfig config
     ) {
-        var stats = new GraphGenerationStats(
-            name,
-            averageDegree,
-            config.relationshipDistribution().name(),
-            config.relationshipProperty(),
-            config.relationshipSeed()
-        );
+        var generateMillis = new MutableLong();
+        var nodes = 0L;
+        var relationships = 0L;
 
-        try (ProgressTimer ignored = ProgressTimer.start(time -> stats.generateMillis = time)) {
+        try (ProgressTimer ignored = ProgressTimer.start(generateMillis::setValue)) {
             RandomGraphGenerator generator = initializeGraphGenerator(config);
 
             HugeGraph graph = generator.generate();
@@ -95,13 +92,22 @@ private GraphGenerationStats generateGraph(
                 config.readConcurrency()
             );
 
-            stats.nodes = graphStore.nodeCount();
-            stats.relationships = graphStore.relationshipCount();
+            nodes = graphStore.nodeCount();
+            relationships = graphStore.relationshipCount();
 
             graphStoreCatalogService.set(config, graphStore);
         }
 
-        return stats;
+        return new GraphGenerationStats(
+            name,
+            nodes,
+            relationships,
+            generateMillis.longValue(),
+            averageDegree,
+            config.relationshipDistribution().name(),
+            config.relationshipProperty(),
+            config.relationshipSeed()
+        );
     }
 
     static RandomGraphGenerator initializeGraphGenerator(RandomGraphGeneratorConfig config) {

applications/graph-store-catalog/src/test/java/org/neo4j/gds/applications/graphstorecatalog/GraphSamplingApplicationTest.java

@@ -126,7 +126,7 @@ void shouldSampleRWR(Map<String, Object> mapConfiguration, long expectedNodeCoun
             RWR
         );
 
-        assertThat(result.nodeCount).isEqualTo(expectedNodeCount);
+        assertThat(result.nodeCount()).isEqualTo(expectedNodeCount);
 
         assertThat(
             GraphStoreCatalog.exists(
@@ -166,7 +166,7 @@ void shouldSampleCNARW(Map<String, Object> mapConfiguration, long expectedNodeCo
             CNARW
         );
 
-        assertThat(result.nodeCount).isEqualTo(expectedNodeCount);
+        assertThat(result.nodeCount()).isEqualTo(expectedNodeCount);
         assertThat(
             GraphStoreCatalog.exists(
                 user.getUsername(),
@@ -215,7 +215,7 @@ void shouldUseSingleStartNodeRWR(double samplingRatio, long expectedStartNodeCou
             RWR
         );
 
-        assertThat(result.startNodeCount).isEqualTo(expectedStartNodeCount);
+        assertThat(result.startNodeCount()).isEqualTo(expectedStartNodeCount);
 
         assertThat(
             GraphStoreCatalog.exists(
@@ -259,7 +259,7 @@ void shouldUseSingleStartNodeCNARW(double samplingRatio, long expectedStartNodeC
             CNARW
         );
 
-        assertThat(result.startNodeCount).isEqualTo(expectedStartNodeCount);
+        assertThat(result.startNodeCount()).isEqualTo(expectedStartNodeCount);
 
         assertThat(
             GraphStoreCatalog.exists(

proc/catalog/src/main/java/org/neo4j/gds/catalog/AlphaGraphSampleProc.java

@@ -0,0 +1,54 @@
+/*
+ * 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.catalog;
+
+import org.neo4j.gds.applications.graphstorecatalog.RandomWalkSamplingResult;
+import org.neo4j.gds.procedures.GraphDataScienceProcedures;
+import org.neo4j.procedure.Context;
+import org.neo4j.procedure.Description;
+import org.neo4j.procedure.Internal;
+import org.neo4j.procedure.Name;
+import org.neo4j.procedure.Procedure;
+
+import java.util.Map;
+import java.util.stream.Stream;
+
+import static org.neo4j.gds.catalog.GraphCatalogProcedureConstants.RWR_DESCRIPTION;
+import static org.neo4j.procedure.Mode.READ;
+
+public class AlphaGraphSampleProc {
+    @Context
+    public GraphDataScienceProcedures facade;
+
+    @Internal
+    @Deprecated(forRemoval = true)
+    @Procedure(name = "gds.alpha.graph.sample.rwr", mode = READ, deprecatedBy = "gds.graph.sample.rwr")
+    @Description(RWR_DESCRIPTION)
+    public Stream<RandomWalkSamplingResult> sampleRandomWalkWithRestartsAlpha(
+        @Name(value = "graphName") String graphName,
+        @Name(value = "fromGraphName") String fromGraphName,
+        @Name(value = "configuration", defaultValue = "{}") Map<String, Object> configuration
+    ) {
+        facade.deprecatedProcedures().called("gds.alpha.graph.sample.rwr");
+        facade.log()
+            .warn("Procedure `gds.alpha.graph.sample.rwr` has been deprecated, please use `gds.graph.sample.rwr`.");
+        return facade.graphCatalog().sampleRandomWalkWithRestarts(graphName, fromGraphName, configuration);
+    }
+}

proc/catalog/src/main/java/org/neo4j/gds/catalog/GraphSampleProc.java

@@ -19,12 +19,11 @@
  */
 package org.neo4j.gds.catalog;
 
-import org.neo4j.gds.applications.graphstorecatalog.RandomWalkSamplingResult;
 import org.neo4j.gds.applications.algorithms.machinery.MemoryEstimateResult;
+import org.neo4j.gds.applications.graphstorecatalog.RandomWalkSamplingResult;
 import org.neo4j.gds.procedures.GraphDataScienceProcedures;
 import org.neo4j.procedure.Context;
 import org.neo4j.procedure.Description;
-import org.neo4j.procedure.Internal;
 import org.neo4j.procedure.Name;
 import org.neo4j.procedure.Procedure;
 
@@ -51,22 +50,6 @@ public Stream<RandomWalkSamplingResult> sampleRandomWalkWithRestarts(
         return facade.graphCatalog().sampleRandomWalkWithRestarts(graphName, fromGraphName, configuration);
     }
 
-    @Internal
-    @Deprecated(forRemoval = true)
-    @Procedure(name = "gds.alpha.graph.sample.rwr", mode = READ, deprecatedBy = "gds.graph.sample.rwr")
-    @Description(RWR_DESCRIPTION)
-    public Stream<RandomWalkSamplingResult> sampleRandomWalkWithRestartsAlpha(
-        @Name(value = "graphName") String graphName,
-        @Name(value = "fromGraphName") String fromGraphName,
-        @Name(value = "configuration", defaultValue = "{}") Map<String, Object> configuration
-    ) {
-        facade.deprecatedProcedures().called("gds.alpha.graph.sample.rwr");
-        facade.log()
-            .warn("Procedure `gds.alpha.graph.sample.rwr` has been deprecated, please use `gds.graph.sample.rwr`.");
-        return sampleRandomWalkWithRestarts(graphName, fromGraphName, configuration);
-    }
-
-
     @SuppressWarnings("unused")
     @Procedure(name = "gds.graph.sample.cnarw", mode = READ)
     @Description(CNARW_DESCRIPTION)

subgraph-filtering/src/main/java/org/neo4j/gds/beta/filter/GraphFilterResult.java

@@ -19,25 +19,6 @@
  */
 package org.neo4j.gds.beta.filter;
 
-import org.neo4j.gds.core.loading.GraphProjectResult;
-
-public class GraphFilterResult extends GraphProjectResult {
-    public final String fromGraphName;
-    public final String nodeFilter;
-    public final String relationshipFilter;
-
-    public GraphFilterResult(
-        String graphName,
-        String fromGraphName,
-        String nodeFilter,
-        String relationshipFilter,
-        long nodeCount,
-        long relationshipCount,
-        long projectMillis
-    ) {
-        super(graphName, nodeCount, relationshipCount, projectMillis);
-        this.fromGraphName = fromGraphName;
-        this.nodeFilter = nodeFilter;
-        this.relationshipFilter = relationshipFilter;
-    }
+public record GraphFilterResult(String graphName, String fromGraphName, String nodeFilter, String relationshipFilter,
+                                long nodeCount, long relationshipCount, long projectMillis) {
 }