make the log output faster, and add colors too #832

artoonie · 2024-05-08T20:47:10Z

Closes #831
Closes #830

The issue was that appending to the textarea used string concatenation, which required reading the entire log string and recreating it each time a new log message was added. That made each subsequent GUI run slower, and also explains why we didn't see this in the unit tests: it's only a GUI issue. It also caused the GUI to hang for a short bit of time each time a log message was added.

I replaced the TextArea with a ListView. This makes it trivial to do something that I've wanted for a while: colors for log levels. I can change the foreground or background color. I would appreciate feedback on how this looks:

Screenshot:

yezr · 2024-05-09T15:25:09Z

I love the colors. Side scroll totally works. My only nit is the line spacing. Is it possible to move the lines closer?

artoonie · 2024-05-10T19:19:05Z

demo.mov

Sounds good. I spruced up the style a little more:

Reduced line spacing
~~Decided to go back to word-wrap, but this is an easy change either way. I realize there's important info at the end of the line, and may be better to not force a scroll~~ this has changed after this demo video was made
Made the highlight reach across the whole line
Added the ability to "select" each row and have that row maintain its log severity color (row = a single log string, which may span multiple lines)
Added the ability to copy lines via right click

tarheel · 2024-05-19T21:31:34Z

The code changes seem pretty uncontroversial. Will let @yezr accept.

artoonie · 2024-05-27T23:19:10Z

From https://docs.oracle.com/javase/8/javafx/api/javafx/application/Platform.html#runLater-java.lang.Runnable-

NOTE: applications should avoid flooding JavaFX with too many pending Runnables. Otherwise, the application may become unresponsive. Applications are encouraged to batch up multiple operations into fewer runLater calls. Additionally, long-running operations should be done on a background thread where possible, freeing up the JavaFX Application Thread for GUI operations.

That was the cause of the GUI lag that has existed outside of this PR, but wasn't as noticeable until the new GUI's loading bar.

@tarheel there is a small final commit on this PR that fixes it -- it's important to get this right to avoid race conditions where the log output never updates. It's the first and only use of a synchronized block in the codebase. Can you take a quick look at commit 21dc086?

tarheel · 2024-05-29T17:15:13Z

src/main/java/network/brightspots/rcv/Logger.java

 import java.util.Date;
 import java.util.List;
+import java.util.concurrent.BlockingDeque;


unused? otherwise this seems fine to me!

yezr · 2024-05-30T17:08:46Z

nit: can we make the highlight apply only to the text instead of the entire line? In that example video when all of the visible lines have a background there is no contrast with the regular background so it maybe looks like the background is usually that color?

Everything else looks great! The quality of life stuff like right click copy is 🔥

artoonie · 2024-05-30T18:21:40Z

Happy to make that change! Just want to flag something first:

That's how it used to look here, but in almost all cases with an error, the error is only one severe surrounded by many infos, unlike the demo video I posted. I changed it from only highlighting the text to highlighting the entire line because it makes it easier to see at-a-glance when scrolling through the logs which lines had errors. It's especially helpful if you have sidescroll, since you might be scrolled over to the right and scrolling up, and if the error line is short you won't notice the error line at all, whereas if it's the full line you'll see it regardless of horizontal scroll.

In light of this reasoning, can you let me know if you still prefer it with only the text background highlighted?

Happy to share side-by-side screenshots, it's only one line of code difference between the two options.

yezr · 2024-05-30T20:48:39Z

Thanks for the context Armin. Let's keep the full line highlighting.

yezr

looks good to me!

* make the log output faster, and add colors too * spruce up the style * Issue 830: prevent lagging * remove unused import * re-enable and fix word wrap * better warning color --------- Co-authored-by: Armin Samii <[email protected]>

* new GUI modal: tabulation confirmation page * open in finder after tabulation; handle new file creation * handle edge casess: trim CSV ranking, handle moved config file * handle tabulation success/failure/in-progress states * lint * exclude spotbugs error * UI updates * three-step gui tabulation * don't allow change in ballot stats between loading and tabulating * gui improvements / timing * style updates * make the log output faster, and add colors too (#832) * make the log output faster, and add colors too * spruce up the style * Issue 830: prevent lagging * remove unused import * re-enable and fix word wrap * better warning color --------- Co-authored-by: Armin Samii <[email protected]> * comma-separate large number of ballots * Fixes unreliable usage of `.isEmpty()` for Strings in favor of `.isBlank()`; removes "please" from user comms per Google style; addresses nits, minor refactoring, and other clean-up. * address PR comments * only pop up tabulate window if validation passes * Update error message, other PR comments * Fixes bug with `buttonOpenResultsClicked` not opening window to correct location in Windows; fit and finish. * address PR comments * delete temp file on Tabulate Window close * Nits. * PR updates --------- Co-authored-by: Armin Samii <[email protected]> Co-authored-by: HEdingfield <[email protected]>

artoonie force-pushed the bugfix/issue-831_fix-log-output-slow branch from 253cc41 to c1dbaef Compare May 8, 2024 20:48

make the log output faster, and add colors too

66a89ef

artoonie force-pushed the bugfix/issue-831_fix-log-output-slow branch from c1dbaef to 66a89ef Compare May 8, 2024 22:08

artoonie mentioned this pull request May 8, 2024

new GUI modal: tabulation confirmation page #812

Merged

artoonie requested a review from yezr May 8, 2024 22:13

spruce up the style

1f6c97d

Issue 830: prevent lagging

21dc086

tarheel reviewed May 29, 2024

View reviewed changes

remove unused import

18e3db7

artoonie added 2 commits May 31, 2024 15:13

re-enable and fix word wrap

9b3b5f7

better warning color

0c2bb4e

yezr approved these changes May 31, 2024

View reviewed changes

artoonie merged commit bf032c7 into develop May 31, 2024
1 check passed

artoonie deleted the bugfix/issue-831_fix-log-output-slow branch May 31, 2024 19:35

This was referenced Jun 6, 2024

Multi-select UI log lines for copying #837

Closed

After selecting UI audit log line, losing focus makes it difficult to read #838

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

make the log output faster, and add colors too #832

make the log output faster, and add colors too #832

artoonie commented May 8, 2024 •

edited

Loading

yezr commented May 9, 2024

artoonie commented May 10, 2024 •

edited

Loading

tarheel commented May 19, 2024

artoonie commented May 27, 2024

tarheel May 29, 2024

yezr commented May 30, 2024 •

edited

Loading

artoonie commented May 30, 2024

yezr commented May 30, 2024

yezr left a comment

make the log output faster, and add colors too #832

make the log output faster, and add colors too #832

Conversation

artoonie commented May 8, 2024 • edited Loading

yezr commented May 9, 2024

artoonie commented May 10, 2024 • edited Loading

tarheel commented May 19, 2024

artoonie commented May 27, 2024

tarheel May 29, 2024

Choose a reason for hiding this comment

yezr commented May 30, 2024 • edited Loading

artoonie commented May 30, 2024

yezr commented May 30, 2024

yezr left a comment

Choose a reason for hiding this comment

artoonie commented May 8, 2024 •

edited

Loading

artoonie commented May 10, 2024 •

edited

Loading

yezr commented May 30, 2024 •

edited

Loading