Using arguments to deliver information about Progress

Author: JaroslavTulach

distribution/lib/Standard/Base/0.0.0-dev/src/Logging.enso

@@ -1,5 +1,6 @@
 import project.Any.Any
 import project.Data.Text.Text
+import project.Data.Vector.Vector
 import project.Data.Numbers.Integer
 import project.Meta
 import project.Nothing.Nothing
@@ -14,12 +15,7 @@ Any.log_message : Text -> Log_Level -> Any
 Any.log_message self ~message:Text level:Log_Level=Log_Level.Info =
     type_name = self.to Meta.Type . qualified_name
     logger = LoggerFactory.getLogger type_name
-    case level of
-        Log_Level.Finest -> logger.trace message
-        Log_Level.Fine -> logger.debug message
-        Log_Level.Info -> logger.info message
-        Log_Level.Warning -> logger.warn message
-        Log_Level.Severe -> logger.error message
+    log_impl logger message level []
     self
 
 ## Infrastructure for reporting logs and progress of computations.
@@ -33,7 +29,7 @@ Any.log_message self ~message:Text level:Log_Level=Log_Level.Info =
    together and will report it as a whole to a
    [progress displaying facility](https://github.com/enso-org/enso/pull/12126).
 type Progress
-    private Running label:Text max:Integer
+    private Running label:Text max:Integer logger
 
     ## Performs provided `action` while reporting its progress.
 
@@ -49,8 +45,9 @@ type Progress
        - action: function performing the computation while reporting its `Progress`
 
     run label:Text up_to:Integer action:(Progress->Any) -> Any =
-        progress = Progress.Running label (up_to.max 1)
-        progress.log_message progress.label+"@"+up_to.to_text Log_Level.Finest # TBD
+        logger = LoggerFactory.getLogger (Progress.to Meta.Type . qualified_name)
+        progress = Progress.Running label (up_to.max 1) logger
+        log_impl logger "INIT {}:{}@{}" Log_Level.Finest [progress, progress.label, progress.max]
         res = action progress
         progress.advance up_to
         res
@@ -68,7 +65,7 @@ type Progress
 
     advance self amount:Integer=1 -> Progress =
         add = if amount>=0 then amount else 0
-        self.log_message self.label+"+"+add.to_text Log_Level.Finest # TBD
+        log_impl self.logger "ADVANCE {}+{}" Log_Level.Finest [self, add]
         self
 
     ## Provides additional human readable detail of the status of the computation.
@@ -80,9 +77,12 @@ type Progress
        The self value.
 
     log self detail:Text -> Progress =
-        self.log_message self.label+":"+detail Log_Level.Finest #TBD
+        log_impl self.logger "LOG {}:{}" Log_Level.Finest [self, detail]
         self
 
+    ## Simple name of the progress
+    to_text self = "Progress"
+
 ## PRIVATE
 type Log_Level
     ## Finest (Trace) level log message.
@@ -99,3 +99,17 @@ type Log_Level
 
     ## Severe level log message.
     Severe
+
+private log_impl logger ~message:Text level:Log_Level args:Vector =
+    builder = case level of
+        Log_Level.Finest -> logger.atTrace
+        Log_Level.Fine -> logger.atDebug
+        Log_Level.Info -> logger.atInfo
+        Log_Level.Warning -> logger.atWarn
+        Log_Level.Severe -> logger.atError
+
+    builder.setMessage message
+    args.each a->
+        builder.addArgument a
+
+    builder.log

engine/runtime-integration-tests/src/test/java/org/enso/interpreter/runtime/progress/ProgressTest.java

@@ -1,6 +1,7 @@
 package org.enso.interpreter.runtime.progress;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 
 import java.util.stream.Collectors;
 import org.enso.common.MethodNames;
@@ -67,12 +68,20 @@ public void advanceMultipleTimes() throws Exception {
               assertEquals("Only two", 2.0, r1.asDouble(), 0.001);
             });
     assertEquals("One time: " + oneTimeLog, 4, oneTimeLog.size());
-    assertEquals("geometric sequence@1", oneTimeLog.get(0).getMessage());
+    assertEquals("INIT {}:{}@{}", oneTimeLog.get(0).getMessage());
+    var progressHandle = oneTimeLog.get(0).getArguments().get(0);
+    assertEquals("geometric sequence", oneTimeLog.get(0).getArguments().get(1));
+    assertEquals(1L, oneTimeLog.get(0).getArguments().get(2));
+    assertEquals("LOG {}:{}", oneTimeLog.get(1).getMessage());
+    assertEquals(progressHandle, oneTimeLog.get(0).getArguments().get(0));
     assertEquals(
-        "geometric sequence:About to compute geometric sequence for 1",
-        oneTimeLog.get(1).getMessage());
-    assertEquals("geometric sequence:We have the result 2.0", oneTimeLog.get(2).getMessage());
-    assertEquals("geometric sequence+1", oneTimeLog.get(3).getMessage());
+        "About to compute geometric sequence for 1", oneTimeLog.get(1).getArguments().get(1));
+    assertEquals("LOG {}:{}", oneTimeLog.get(2).getMessage());
+    assertEquals(progressHandle, oneTimeLog.get(2).getArguments().get(0));
+    assertEquals("We have the result 2.0", oneTimeLog.get(2).getArguments().get(1));
+    assertEquals("ADVANCE {}+{}", oneTimeLog.get(3).getMessage());
+    assertEquals(progressHandle, oneTimeLog.get(0).getArguments().get(0));
+    assertEquals(1L, oneTimeLog.get(3).getArguments().get(1));
 
     var r2 = geom.execute(2, 2.0, 0.5);
     assertEquals("Three", 3.0, r2.asDouble(), 0.001);
@@ -131,17 +140,21 @@ private void performExistingProgressFromJavaWith(Object acc) {
             });
 
     assertEquals("Seven messsages " + msgs, 7, msgs.size());
-    var txt = msgs.stream().map(ObservedMessage::getMessage).collect(Collectors.joining("\n"));
+    var txt =
+        msgs.stream().map(ObservedMessage::getFormattedMessage).collect(Collectors.joining("\n"));
+
+    assertTrue("Initialization first", msgs.get(0).getMessage().startsWith("INIT "));
+
     assertEquals(
         "Initialize five steps. Then five `advance` calls and finally advance to finish.",
         """
-        from 0 to 5@5
-        from 0 to 5+1
-        from 0 to 5+1
-        from 0 to 5+1
-        from 0 to 5+1
-        from 0 to 5+1
-        from 0 to 5+5""",
+        INIT Progress:from 0 to 5@5
+        ADVANCE Progress+1
+        ADVANCE Progress+1
+        ADVANCE Progress+1
+        ADVANCE Progress+1
+        ADVANCE Progress+1
+        ADVANCE Progress+5""",
         txt);
   }