Get rid of fluttered build job output and color errors #374

ammernico · 2024-04-30T13:25:29Z

No description provided.

christophprokop · 2024-05-22T14:05:49Z

tested updated version, looks much better now - thanks!

Signed-off-by: Nico Steinle <nico.steinle@eviden.com>

This will minimize text flutter when building many packages ``` - before: [00:00:06] (100%): █████ | [endpoint-name/XXXXXXX XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX package-name package_version]: msg - after: [00:00:06] (100%): █████ | endpoint-name XXXXXXX XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ██ package_name package_version msg ^^^^^^^^^^^^^--- gets cut when longer than 6characters ^^--- colored build status block ``` Signed-off-by: Nico Steinle <nico.steinle@eviden.com>

The change to this specific formatting was requested by many users since it makes the output look cleaner Signed-off-by: Nico Steinle <nico.steinle@eviden.com>

primeos-work

I didn't test it yet but based on the diff the new format looks acceptable. Some of the format/color changes make a lot of sense but there are also some that I'm not really sure about. The implementation and commit messages require a bit of work though.

primeos-work · 2024-05-23T14:30:38Z

config.toml

@@ -12,7 +12,7 @@ compatibility = 1
 # fit a 80 or 100 character wide terminal!
 #
 # This is also the default if the setting is not present.
-progress_format = "[{elapsed_precise}] ({percent:>3}%): {bar:40.cyan/blue} | {msg}"
+progress_format = "{elapsed_precise} {percent:>3}% {bar:5.cyan/blue} | {msg}"


If we change the example here that we also should change the default (s. comment above):

butido/src/config/util.rs

Lines 14 to 17 in 0a15748

/// The default progress bar format

pub fn default_progress_format() -> String {

String::from("[{elapsed_precise}] ({percent:>3}%): {bar:40.cyan/blue} | {msg}")

}

primeos-work · 2024-05-23T14:34:39Z

src/endpoint/scheduler.rs

@@ -38,6 +38,8 @@ use crate::job::JobResource;
 use crate::job::RunnableJob;
 use crate::log::LogItem;

+pub const MAX_ENDPOINT_NAME_LENGTH: usize = 6;


We should try hard to avoid such magic constants. This one is especially a no-go as it depends on user defined endpoint names so we cannot simply cap the length to 6 here. One option would be to dynamically determine the max length by iterating over all configured endpoint names.

primeos-work · 2024-05-23T14:35:51Z

src/endpoint/scheduler.rs

@@ -371,7 +373,6 @@ struct LogReceiver<'a> {
 impl<'a> LogReceiver<'a> {
    async fn join(mut self) -> Result<String> {
        let mut success = None;
-


nit: Such unrelated changes should be avoided but it's kinda ok here.

primeos-work · 2024-05-23T14:36:23Z

src/endpoint/scheduler.rs

@@ -420,12 +421,12 @@ impl<'a> LogReceiver<'a> {
                    self.bar.set_position(u as u64);
                }
                LogItem::CurrentPhase(ref phasename) => {
-                    trace!("Setting bar phase to {}", phasename);


nit: Why drop the trace output?

primeos-work · 2024-05-23T14:51:03Z

src/endpoint/scheduler.rs

                        self.container_id_chrs,
                        self.job.uuid(),
+                        "██".yellow(),


Hm, what's the motivation behind this (cc @christophprokop)? Seems to be a "Full Block" Unicode character (https://www.compart.com/en/unicode/U+2588). I'm not sure if it's really a good idea to put Unicode characters in the source code and output. Theoretically we'd have to check if the language and terminal supports this but I guess we can make Unicode support a requirement nowadays.

primeos-work · 2024-05-23T16:21:21Z