Merge pull request #6692 from DarthMax/JOL_fix

Prevent memory size calculation from failing on certain JVMs

Author: knutwalker

doc/modules/ROOT/pages/graph-list.adoc

@@ -53,8 +53,8 @@ CALL gds.graph.list(
 | density                | Float    | Density of the graph.
 | creationTime           | Datetime | Time when the graph was projected.
 | modificationTime       | Datetime | Time when the graph was last modified.
-| sizeInBytes            | Integer  | Number of bytes used in the Java heap to store the graph.
-| memoryUsage            | String   | Human readable description of `sizeInBytes`.
+| sizeInBytes            | Integer  | Number of bytes used in the Java heap to store the graph. This feature is not supported on all JDKs and might return -1 instead.
+| memoryUsage            | String   | Human readable description of `sizeInBytes`. This feature is not supported on all JDKs and might return null instead.
 |===
 --
 

memory-usage/src/main/java/org/neo4j/gds/mem/MemoryUsage.java

@@ -298,7 +298,12 @@ public static long sizeOf(Object thing) {
         if (!VmInfoHolder.VM_INFO_AVAILABLE) {
             return -1L;
         }
-        return new GraphWalker().walk(thing).totalSize();
+
+        try {
+            return new GraphWalker().walk(thing).totalSize();
+        } catch (RuntimeException e) {
+            return -1;
+        }
     }
 
     /**

memory-usage/src/test/java/org/neo4j/gds/mem/MemoryUsageTest.java

@@ -0,0 +1,44 @@
+/*
+ * 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.mem;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.AssertionsForClassTypes.assertThatCode;
+
+class MemoryUsageTest {
+
+    @Test
+    void ofShouldNotFailIfJOLFails() {
+        assertThatCode(() -> MemoryUsage.sizeOf(new JOLMightFail())).doesNotThrowAnyException();
+    }
+
+    // The nested recursive ThreadLocal causes JOL to be unable to access some attributes of the class on the ZULU JVM
+    private static final class JOLMightFail {
+        private final ThreadLocal<JOLMightFail> threadLocal;
+
+        private JOLMightFail() {threadLocal = ThreadLocal.withInitial(() -> this);}
+
+        ThreadLocal<JOLMightFail> getThreadLocal() {
+            return threadLocal;
+        }
+    }
+
+}

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

@@ -86,7 +86,10 @@ static GraphInfo withMemoryUsage(
         GraphStore graphStore
     ) {
         var sizeInBytes = MemoryUsage.sizeOf(graphStore);
-        var memoryUsage = MemoryUsage.humanReadable(sizeInBytes);
+
+        var memoryUsage = sizeInBytes >= 0
+            ? MemoryUsage.humanReadable(sizeInBytes)
+            : null;
 
         return create(
             graphProjectConfig,