Do not log once global percentage exceeded 100 percent

neo4j · Sep 26, 2023 · c4f423b · c4f423b
1 parent 088a385
commit c4f423b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/...ress-tracking/src/main/java/org/neo4j/gds/core/utils/progress/BatchingProgressLogger.java b/...ress-tracking/src/main/java/org/neo4j/gds/core/utils/progress/BatchingProgressLogger.java
@@ -124,7 +124,7 @@ private synchronized void doLogPercentage(Supplier<String> msgFactory, long prog
         String message = msgFactory != NO_MESSAGE ? msgFactory.get() : null;
         progressCounter.add(progress);
         int nextPercentage = (int) ((progressCounter.sum() / (double) taskVolume) * 100);
-        if (globalPercentage < nextPercentage) {
+        if (globalPercentage < nextPercentage && globalPercentage < 100) {
             globalPercentage = nextPercentage;
             if (message == null || message.isEmpty()) {
                 logProgress(nextPercentage);

diff --git a/progress-tracking/src/test/java/org/neo4j/gds/core/utils/BatchingProgressLoggerTest.java b/progress-tracking/src/test/java/org/neo4j/gds/core/utils/BatchingProgressLoggerTest.java
@@ -182,6 +182,18 @@ void shouldLog100OnlyOnce() {
             .containsExactly("Test 100%");
     }
 
+    @Test
+    void shouldNotExceed100Percent() {
+        TestLog log = Neo4jProxy.testLog();
+        var testProgressLogger = new BatchingProgressLogger(log, Tasks.leaf("Test"), 1);
+        testProgressLogger.reset(1);
+        testProgressLogger.logProgress(1); // reaches 100 %
+        testProgressLogger.logProgress(1); // exceeds 100 %
+        assertThat(log.getMessages(TestLog.INFO))
+            .extracting(Extractors.removingThreadId())
+            .containsExactly("Test 100%");
+    }
+
     @Test
     void closesThreadLocal() {
         var logger = new BatchingProgressLogger(