Merge pull request #12 from CSC207-2022F-UofT/feat-progress-bar

[+] Progress Bar

Author: MstrPikachu

README.md

@@ -9,6 +9,28 @@ Final Project for CSC207
 * [Repo in CSC207 Organization](https://github.com/CSC207-2022F-UofT/mcpm)
 * [File Server Backend](https://mcpm.hydev.org)
 
+## Development
+
+### Run a specific class in an external terminal
+
+This is very useful to test terminal operations since the Gradle running environment isn't a tty, and IntelliJ IDEA's built-in terminal barely supports Xterm escape sequences.
+
+For this, I've set up a custom gradle task `printCp` that will print out the classpath needed to run the classes with dependencies. It will print in stderr instead of stdout in order for bash to easily separate out the classpath. You can obtain the classpath in a bash variable by:
+
+`cp="$(./gradlew classes testClasses printCp 2>&1 > /dev/null)" && echo "$cp"`
+
+(Unfortunately since Windows doesn't support Bash, you'll need to use a Bash-compatible environment on Windows, either cygwin / git bash or WSL)
+
+Then, you can run your class with:
+
+`java19 -cp "$cp" org.hydev.mcpm.<class>`
+
+For example, you can test the progress bar with:
+
+`java19 -cp "$cp" org.hydev.mcpm.client.interaction.ProgressBar`
+
+If you don't have JDK 19 installed or if you don't know where it's installed, you can use our JDK downloader tool to download a local version of JDK 19 without installing on the system. (TODO: Add tutorial after merging PR #8)
+
 ## Brainstorm
 
 Server file/endpoint structure:

build.gradle

@@ -40,6 +40,9 @@ dependencies {
     // https://mvnrepository.com/artifact/org.jetbrains/annotations
     implementation 'org.jetbrains:annotations:16.0.1'
 
+    // https://mvnrepository.com/artifact/org.fusesource.jansi/jansi
+    implementation 'org.fusesource.jansi:jansi:2.4.0'
+
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
 }
@@ -72,6 +75,13 @@ if (hasProperty('buildScan')) {
     }
 }
 
+task printCp {
+    doLast {
+        System.err.println sourceSets.main.runtimeClasspath.asPath
+    }
+}
+
 test {
     useJUnitPlatform()
+    testLogging.showStandardStreams = true
 }

src/main/java/org/hydev/mcpm/client/interaction/ProgressBar.java

@@ -1,14 +1,36 @@
 package org.hydev.mcpm.client.interaction;
 
+import org.fusesource.jansi.AnsiConsole;
+import org.hydev.mcpm.utils.ConsoleUtils;
+
+import java.io.PrintStream;
+import java.util.*;
+
+import static java.lang.String.format;
+import static org.fusesource.jansi.internal.CLibrary.STDOUT_FILENO;
+import static org.fusesource.jansi.internal.CLibrary.isatty;
+import static org.hydev.mcpm.utils.GeneralUtils.safeSleep;
+
 /**
- * TODO: Write a description for this class!
+ * Terminal progress bar based on Xterm escape codes
  *
  * @author Azalea (https://github.com/hykilpikonna)
  * @since 2022-09-27
  */
 public class ProgressBar implements AutoCloseable
 {
+    private final ConsoleUtils cu;
     private final ProgressBarTheme theme;
+    private final PrintStream out;
+    private int cols;
+
+    private final List<ProgressRow> activeBars;
+
+    private long lastUpdate;
+
+    private double frameDelay;
+
+    private final boolean istty;
 
     /**
      * Create and initialize a progress bar
@@ -18,61 +40,118 @@ public class ProgressBar implements AutoCloseable
     public ProgressBar(ProgressBarTheme theme)
     {
         this.theme = theme;
-        this.init();
-    }
+        this.out = System.out;
+        this.cu = new ConsoleUtils(this.out);
+        this.activeBars = new ArrayList<>();
+        this.cols = AnsiConsole.getTerminalWidth();
 
-    /**
-     * Initialize the progress bar (print the first line)
-     */
-    public void init()
-    {
-        // TODO: Implement this
-        throw new UnsupportedOperationException("TODO");
+        // Default to 70-char width if the width can't be detected (like in a non-tty output)
+        if (this.cols == 0) this.cols = 70;
+
+        // Last update time
+        this.lastUpdate = System.nanoTime();
+
+        // Default frame delay is 0.01666 (60 fps)
+        this.frameDelay = 1 / 60d;
+
+        // Check if output is a TTY. If not, change frame rate to 0.5 fps to avoid spamming a log.
+        this.istty = isatty(STDOUT_FILENO) == 0;
+        if (istty) this.frameDelay = 1 / 0.5;
     }
 
     /**
      * Append a progress bar at the end
      *
-     * @return Unique identifier of the progress bar
+     * @param bar Row of the progress bar
+     * @return bar for fluent access
      */
-    public String appendBar()
+    public ProgressRow appendBar(ProgressRow bar)
     {
-        // TODO: Implement this
-        throw new UnsupportedOperationException("TODO");
+        this.activeBars.add(bar);
+        bar.setPb(this);
+
+        out.println();
+        update();
+        return bar;
     }
 
-    /**
-     * Set progress for a bar
-     *
-     * @param id Unique identifier
-     * @param progress Progress as a ratio in range 0-1
-     */
-    public void setBar(String id, float progress)
+    protected void update()
+    {
+        // Check time to limit for framerate (default 60fps)
+        // Performance of the update heavily depends on the terminal's escape code handling
+        // implementation, so frequent updates will degrade performance on a bad terminal
+        var curTime = System.nanoTime();
+        if ((curTime - lastUpdate) / 1e9d < frameDelay) return;
+        lastUpdate = curTime;
+
+        forceUpdate();
+    }
+
+    private void forceUpdate()
     {
-        // TODO: Implement this
-        throw new UnsupportedOperationException("TODO");
+        // Roll back to the first line
+        if (istty) cu.curUp(activeBars.size());
+        activeBars.forEach(bar -> out.println(bar.toString(theme, cols)));
     }
 
     /**
      * Finish a progress bar
      *
-     * @param id Unique identifier of the progress bar
+     * @param bar Progress bar
      */
-    public void finishBar(String id)
+    public void finishBar(ProgressRow bar)
     {
-        // TODO: Implement this
-        throw new UnsupportedOperationException("TODO");
+        if (!activeBars.contains(bar)) return;
+
+        forceUpdate();
+        this.activeBars.remove(bar);
     }
 
     /**
      * Finalize and close the progress bar (print the final line)
-     *
-     * @throws Exception e
      */
     @Override
-    public void close() throws Exception
+    public void close()
+    {
+    }
+
+    public ProgressBar setFrameDelay(double frameDelay)
+    {
+        this.frameDelay = frameDelay;
+        return this;
+    }
+
+    /**
+     * Set frame rate in the unit of frames per second
+     *
+     * @param fps FPS
+     * @return Self for fluent access
+     */
+    public ProgressBar setFps(int fps)
+    {
+        this.frameDelay = 1d / fps;
+        return this;
+    }
+
+    public List<ProgressRow> getActiveBars()
     {
-        // TODO: Implement this
-        throw new UnsupportedOperationException("TODO");
+        return activeBars;
+    }
+
+    public static void main(String[] args)
+    {
+        try (var b = new ProgressBar(ProgressBarTheme.ASCII_THEME))
+        {
+            var all = new ArrayList<ProgressRow>();
+            for (int i = 0; i < 1300; i++)
+            {
+                if (i < 1000 && i % 100 == 0)
+                    all.add(b.appendBar(new ProgressRow(300).unit("MB").desc(format("File %s.tar.gz", all.size()))).descLen(30));
+                all.forEach(a -> a.increase(1));
+                safeSleep(3);
+            }
+
+            System.out.println("Done");
+        }
     }
 }

src/main/java/org/hydev/mcpm/client/interaction/ProgressBarTheme.java

@@ -12,14 +12,16 @@
  * @since 2022-09-27
  */
 public record ProgressBarTheme(
-    String ipr,
     String done,
-    int iprLen,
-    int doneLen
+    String ipr,
+    String prefix,
+    String suffix,
+    int doneLen,
+    int iprLen
 )
 {
-    public static final ProgressBarTheme ASCII_THEME = new ProgressBarTheme("#", "-", 1, 1);
-    public static final ProgressBarTheme CLASSIC_THEME = new ProgressBarTheme("█", ".", 1, 1);
-    public static final ProgressBarTheme EMOJI_THEME = new ProgressBarTheme("✅", "🕑", 2, 2);
-    public static final ProgressBarTheme FLOWER_THEME = new ProgressBarTheme("🌸", "🥀", 2, 2);
+    public static final ProgressBarTheme ASCII_THEME = new ProgressBarTheme("#", "-", "[", "]", 1, 1);
+    public static final ProgressBarTheme CLASSIC_THEME = new ProgressBarTheme("█", ".", "", "", 1, 1);
+    public static final ProgressBarTheme EMOJI_THEME = new ProgressBarTheme("✅", "🕑", "", "", 2, 2);
+    public static final ProgressBarTheme FLOWER_THEME = new ProgressBarTheme("🌸", "🥀", "", "", 2, 2);
 }