Enhance console window with regard to log messages #25

maarzt · 2017-05-29T13:00:25Z

Add features to the scijava console window:

Text filtering to quickly search stdout, stderr and log messages.
Filtering of log messages by source and level.
Use colors to distinguish log messages from stdout and stderr.

Class LoggingPanel can be used by comprehensive plug ins to show only a subset of log messages related to them.

This pull request depends on scijava/scijava-common#255

ctrueden

Thanks for filing this. Will you be around during the Learnathon? If so, that might be a great time to get this and scijava/scijava-common#255 finally merged.

ctrueden · 2017-06-05T21:46:14Z

pom.xml

@@ -106,6 +107,7 @@ Wisconsin-Madison.</license.copyrightOwners>
 		<dependency>
 			<groupId>org.scijava</groupId>
 			<artifactId>scijava-common</artifactId>
+			<version>2.64.1-SNAPSHOT</version>


This commit should be labeled WIP since it adds a SNAPSHOT dependency. All such dependencies must be purged from history before they merge to master.

Also, it is better to use <scijava-common.version>2.64.1-SNAPSHOT</scijava-common.version> in the <properties> instead of hardcoding the <version> in the <dependencies> section. The former allows overriding the version in various circumstances such as the SciJava melting pot script, whereas the latter bakes in the version into the dependency hierarchy in an immutable way.

👍 Next time I will do it that way. Thanks for the advices!

maarzt · 2017-06-07T08:39:12Z

Yes, I will be at the Learnathon too. Would be great if we get this done there.

ctrueden

Some miscellaneous comments!

ctrueden · 2017-09-23T14:48:52Z

src/test/java/org/scijava/ui/swing/console/SwingConsolePaneBenchmark.java

@@ -59,8 +59,7 @@ public static void main(final String[] args) throws Exception {
 		final Context context = new Context();
 		context.service(UIService.class).showUI();

-		System.out.print("Hello ");
-		System.err.println("world!");
+		System.out.println("Hello world!");


Why did you combine these? It does not seem related to the stated purpose of this commit. It also reduces the effectiveness of the manual test, since the console pane is supposed to handle line fragments gracefully.

Now the test is as it was before. I changed it in the past, because I handled line fragments differently.

ctrueden · 2017-09-23T14:51:28Z

src/main/java/org/scijava/ui/swing/console/ConsolePanel.java

+ * @author Matthias Arzt
+ */
+@IgnoreAsCallingClass
+public class ConsolePanel extends JPanel implements OutputListener


I find this naming very confusing. Now we have a ConsolePanel class which is actually Swing-specific (but does not have Swing in its class name) which is a field of SwingConsolePane.

ctrueden · 2017-09-23T14:51:57Z

src/main/java/org/scijava/ui/swing/console/ConsolePanel.java

+import org.scijava.ui.swing.StaticSwingUtils;
+
+/**
+ * LoggingPanel can display log message and console output as a list, and


This class is not called LoggingPanel, but ConsolePanel, so I guess the javadoc should be adjusted... assuming we keep things structured this way.

ctrueden · 2017-09-23T14:55:24Z

src/main/java/org/scijava/ui/swing/console/LoggingPanel.java

- * LoggingPanel implements {@link LogListener} and {@link OutputListener}, that
- * way it can receive log message and console output from {@link LogService},
- * {@link Logger} and {@link org.scijava.console.ConsoleService}
+ * {@link LoggingPanel} can displays log messages, and provides convenient ways


can displays should be can display

ctrueden · 2017-09-23T14:57:25Z

src/main/java/org/scijava/ui/swing/console/LoggingPanel.java

+import org.scijava.ui.swing.StaticSwingUtils;
+
+/**
+ * LoggingPanel can display log message and console output as a list, and


I don't understand why this was added as a copy...?

ctrueden · 2017-09-23T14:58:18Z

src/main/java/org/scijava/ui/swing/console/LogFormatter.java

+		final PrintWriter printer = new PrintWriter(sw);
+
+		printWithBrackets(printer, message.time().toString());
+		printWithBrackets(printer, LogLevel.prefix(message.level()));


I'd like to discuss this LogLevel.prefix method. The idea of "prefix" previously included the brackets and trailing space, but now no longer does, and this discrepancy concerns me.

ctrueden · 2017-09-23T15:00:37Z

src/main/java/org/scijava/ui/swing/console/LogSourcesPanel.java

+ *
+ * @author Matthias Arzt
+ */
+class LogSourcesPanel extends JPanel {


Would this be OK instead as a private inner class of LoggingPanel? I like to avoid non-public classes as outer classes.

We could make ItemTextPane, TextFilterField and LogSourcesPanel inner classes of LoggingPanel, but this would result in files with more that 1k lines. For me such file is a pain to read and a barrier to fully understand the code. Package-private classes are not nice, but if they can be tested separately and code becomes more readable, than I prefer them. And I don't want them to be public, so that changes can be made without breaking code.

OK, no problem, you're right. Let's stick with package-private outer classes then.

ctrueden · 2017-09-23T15:02:12Z

src/test/java/org/scijava/ui/swing/console/LoggingDemo.java

@@ -0,0 +1,99 @@
+package org.scijava.ui.swing.console;


Missing license header.

ctrueden · 2017-09-23T15:08:36Z

src/main/java/org/scijava/ui/swing/console/ConcurrentExpandableList.java

@@ -0,0 +1,79 @@
+package org.scijava.ui.swing.console;


Missing license header.

SwingConsolePane is responsible for lazy initialization and showing the console window at correct time. ConsolePanel is responsible for holding a text area to show console output. ConsolePanel will become a starting point for implementing a LoggingPanel.

At this point LoggingPanel is basically a copy of ConsolPanel. But it will envole to something very different. Features like filtering messages by log source, level and text, and options for message formatting will be added.

This requiers to actually store and log messages that are received by LoggingPanel, in correct order and with meta data. (LogRecorder is used for this purpose.) Whenever the user changes the text to filter for, it is neccessary to reprocess and redisplay the recorded log messages. This might require to much time to be processed in the swing thread, therefore the new class ItemTextPane is introduced. It can display an expanding list of items, and uses and worker thread when the list is replaced.

Now LoggingPanel can be used to record and show the calling class of the log messages.

maarzt · 2017-09-24T17:21:07Z

I implemented all the changes we discussed.
Now, the code is ready for review / discussion / merge again.

ctrueden · 2017-09-24T20:09:26Z

Thank you very much! 🍻

maarzt · 2017-09-24T21:57:02Z

Incredible, it happened! Cool! Thank you too 🍻

ctrueden reviewed Jun 5, 2017

View reviewed changes

maarzt force-pushed the log-revamp branch 4 times, most recently from 4d4ac55 to 450d7be Compare September 22, 2017 22:32

ctrueden reviewed Sep 23, 2017

View reviewed changes

maarzt force-pushed the log-revamp branch from e122b6d to 7860172 Compare September 24, 2017 16:00

maarzt added 3 commits September 24, 2017 18:43

Add LoggingPanel to show LogMessages separatly

26bb777

At this point LoggingPanel is basically a copy of ConsolPanel. But it will envole to something very different. Features like filtering messages by log source, level and text, and options for message formatting will be added.

LoggingPanel: use colors to visualize log levels

7f29f63

maarzt force-pushed the log-revamp branch from 7860172 to ccbc6f1 Compare September 24, 2017 16:52

maarzt added 7 commits September 24, 2017 18:55

LoggingPanel: add gui for text filtering

9e67b24

LoggingPanel: add popup menu for copy and clear

4f568eb

LoggingPanel: add gui to filter log messages by source and level

2fdb44a

LoggingPanel: add "Settings" to LoggingPanel's popup menu

cf6496f

Now LoggingPanel can be used to record and show the calling class of the log messages.

SwingConsolePane: Store settings for log formatting in PrefService

6fbd881

Add LoggingDemo to demonstrate LoggingPanel and SwingConsolePane

30f7e6a

maarzt force-pushed the log-revamp branch from ccbc6f1 to 30f7e6a Compare September 24, 2017 16:55

ctrueden merged commit 221d3c6 into scijava:master Sep 24, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance console window with regard to log messages #25

Enhance console window with regard to log messages #25

maarzt commented May 29, 2017 •

edited

Loading

ctrueden left a comment

ctrueden Jun 5, 2017

ctrueden Jun 5, 2017

maarzt Jun 7, 2017

maarzt commented Jun 7, 2017

ctrueden left a comment

ctrueden Sep 23, 2017

maarzt Sep 24, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

maarzt Sep 24, 2017

ctrueden Sep 24, 2017

ctrueden Sep 23, 2017

ctrueden Sep 23, 2017

maarzt commented Sep 24, 2017

ctrueden commented Sep 24, 2017

maarzt commented Sep 24, 2017

Enhance console window with regard to log messages #25

Enhance console window with regard to log messages #25

Conversation

maarzt commented May 29, 2017 • edited Loading

ctrueden left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maarzt commented Jun 7, 2017

ctrueden left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maarzt commented Sep 24, 2017

ctrueden commented Sep 24, 2017

maarzt commented Sep 24, 2017

maarzt commented May 29, 2017 •

edited

Loading