Introduce memory facade

Author: IoannisPanagiotas

proc/misc/build.gradle

@@ -11,6 +11,8 @@ dependencies {
     implementation project(':procedures-facade-api')
     implementation project(':proc-common')
     implementation project(':progress-tracking')
+    implementation project(':memory-facade')
+
 
     compileOnly openGds.jetbrains.annotations
 

proc/misc/src/main/java/org/neo4j/gds/memory/MemoryProc.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.memory;
+
+import org.neo4j.gds.procedures.operations.ProgressResult;
+import org.neo4j.procedure.Context;
+import org.neo4j.procedure.Description;
+import org.neo4j.procedure.Procedure;
+
+import java.util.stream.Stream;
+
+public class MemoryProc {
+    private static final String DESCRIPTION = "List memory for currently running tasks or stored graphs.";
+
+    @Context
+    public MemoryFacade facade;
+
+    @Procedure("gds.listMemory")
+    @Description(DESCRIPTION)
+    public Stream<ProgressResult> listMemory() {
+        return facade.operations().listProgress(jobId);
+    }
+}

procedures/integration/build.gradle

@@ -27,6 +27,8 @@ dependencies {
     implementation project(':legacy-cypher-projection')
     implementation project(':logging')
     implementation project(':memory-estimation')
+    implementation project(':memory-facade')
+
     implementation project(':memory-usage')
     implementation project(':metrics-api')
     implementation project(':model-catalog-api')

procedures/integration/src/main/java/org/neo4j/gds/procedures/integration/OpenGraphDataScienceExtensionBuilder.java

@@ -36,6 +36,7 @@
 import org.neo4j.gds.core.utils.warnings.UserLogRegistryFactory;
 import org.neo4j.gds.logging.Log;
 import org.neo4j.gds.mem.MemoryTracker;
+import org.neo4j.gds.memory.MemoryFacade;
 import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.gds.procedures.ExporterBuildersProviderService;
 import org.neo4j.gds.procedures.GraphDataScienceProcedures;
@@ -155,7 +156,9 @@ public static Triple<OpenGraphDataScienceExtensionBuilder, TaskRegistryFactorySe
 
         var componentRegistration = new ComponentRegistration(log, globalProcedures);
 
-        componentRegistration.registerComponent("GDS Memory Tracker", MemoryTracker.class, __ -> memoryTracker);
+        var memoryFacade = new MemoryFacade(memoryTracker);
+
+        componentRegistration.registerComponent("GDS Memory Facade", MemoryFacade.class, __ -> memoryFacade);
 
         var graphDataScienceProviderFactory = new GraphDataScienceProceduresProviderFactory(
             log,

procedures/memory-facade/build.gradle

@@ -0,0 +1,11 @@
+apply plugin: 'java-library'
+
+description = 'Neo4j Graph Data Science :: Memory Procedure Facade API'
+
+group = 'org.neo4j.gds'
+
+dependencies {
+
+    implementation project(':progress-tracking')
+
+}

procedures/memory-facade/src/main/java/org/neo4j/gds/memory/MemoryFacade.java

@@ -0,0 +1,53 @@
+/*
+ * 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.memory;
+
+import org.neo4j.gds.mem.MemoryTracker;
+import org.neo4j.gds.mem.UserEntityMemory;
+import org.neo4j.gds.mem.UserMemorySummary;
+
+import java.util.stream.Stream;
+
+public class MemoryFacade {
+
+    private final MemoryTracker memoryTracker;
+
+    public MemoryFacade(MemoryTracker memoryTracker){
+        this.memoryTracker = memoryTracker;
+    }
+
+    public Stream<UserEntityMemory> listUser(String user){
+        return   memoryTracker.listUser(user);
+    }
+
+    public Stream<UserEntityMemory> listAll(){
+        return  memoryTracker.listAll();
+    }
+
+    public UserMemorySummary memorySummary(String user){
+        return  memoryTracker.memorySummary(user);
+
+    }
+
+    public Stream<UserMemorySummary> memorySummary() {
+        return  memoryTracker.memorySummary();
+    }
+
+}