`forest-cli snapshot export` bugs up the terminal

[jdjaustin]

Describe the bug

To Reproduce Steps to reproduce the behavior:

1. Run forest
2. Run forest-cli snapshot export in another terminal window
3. Upon successful export, the export path is displayed in the format Snapshot located at <PATH>. In MacOS, the terminal displays a garbage % at the end of this path and properly displays the terminal prompt in a new line. In Ubuntu (in a droplet's GUI with a fresh install of both rustup and Forest), the export path collides with the new terminal prompt (which is not displayed on a new line). In both OSes, resizing the terminal window after export results in garbage duplication of characters. While not certain that this is related to the progress bar, resizing the terminal window during snapshot export also results in both duplication of the progress bar and random garbage (duplicated characters) displayed in the terminal.

Log output

Log Output

paste log output...

Expected behaviour

Snapshot export completes successfully, reports status with export path, and restores terminal prompt in a new line with no buggy behavior.

Screenshots

Environment (please complete the following information):

• OS:
• Rust version(e.g. rustc --version)
• Branch/commit

Other information and links

[lemmih]

Relevant code:

forest/src/cli/subcommands/snapshot_cmd.rs

Lines 127 to 130 in caac08f

	bar.lock().await.finish_println(&format!(
	"Export completed. Snapshot located at {}",
	out.display()
	));

The naming is somewhat confusing but finish_println does not print a newline at the end of the string. It prints a newline before the string. We either add a newline at the end or switch to indicatif. @jdjaustin, how about you add the newline?

[jdjaustin]

Adding the newline resolved the issue with the garbled output after snapshot export, but the issue with resizing the window while displaying a progress bar remained, and using indicatif did not fix that either. However, this issue also occurs during snapshot import in both Forest and Lotus, and it appears to be a fairly commonly reported problem among other terminal apps, so I think we can close this issue with the newline fix.

[lemmih]

Adding the newline resolved the issue with the garbled output after snapshot export, but the issue with resizing the window while displaying a progress bar remained, and using indicatif did not fix that either. However, this issue also occurs during snapshot import in both Forest and Lotus, and it appears to be a fairly commonly reported problem among other terminal apps, so I think we can close this issue with the newline fix.

Right, that's just how terminals are.