Skip to content

Fix indicatif prog bar #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 8, 2024
Merged

Fix indicatif prog bar #359

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2d2e211
start progress bar changes for resource list call
tgauth Mar 8, 2024
f50e88d
add progress bar changes for config commands
tgauth Mar 8, 2024
295e590
fix typos
tgauth Mar 8, 2024
eb4b2e7
Merge branch 'main' into fix-indicatif-prog-bar
tgauth Mar 8, 2024
a35e799
Merge branch 'main' into fix-indicatif-prog-bar
tgauth Mar 8, 2024
0903eda
remove span names
tgauth Mar 8, 2024
5e28f94
remove unnecessary drops
tgauth Mar 8, 2024
a4c247d
Merge branch 'main' into fix-indicatif-prog-bar
SteveL-MSFT Mar 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dsc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ clap_complete = { version = "4.4" }
crossterm = { version = "0.27" }
ctrlc = { version = "3.4.0" }
dsc_lib = { path = "../dsc_lib" }
indicatif = { version = "0.17" }
jsonschema = "0.17"
path-absolutize = { version = "3.1.1" }
schemars = { version = "0.8.12" }
Expand Down
1 change: 1 addition & 0 deletions dsc_lib/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ thiserror = "1.0"
chrono = "0.4.26"
security_context_lib = { path = "../security_context_lib" }
tracing = "0.1.37"
tracing-indicatif = { version = "0.3.6" }
tree-sitter = "0.20"
tree-sitter-dscexpression = { path = "../tree-sitter-dscexpression" }

Expand Down
58 changes: 33 additions & 25 deletions dsc_lib/src/configure/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ use self::config_doc::{Configuration, DataType, Metadata, SecurityContextKind};
use self::depends_on::get_resource_invocation_order;
use self::config_result::{ConfigurationGetResult, ConfigurationSetResult, ConfigurationTestResult, ConfigurationExportResult};
use self::contraints::{check_length, check_number_limits, check_allowed_values};
use indicatif::{ProgressBar, ProgressStyle};
use indicatif::ProgressStyle;
use security_context_lib::{SecurityContext, get_security_context};
use serde_json::{Map, Value};
use std::collections::HashMap;
use std::time::Duration;
use tracing::{debug, trace};
use std::{collections::HashMap, mem};
use tracing::{debug, trace, warn_span, Span};
use tracing_indicatif::span_ext::IndicatifSpanExt;

pub mod context;
pub mod config_doc;
Expand Down Expand Up @@ -135,13 +135,13 @@ fn escape_property_values(properties: &Map<String, Value>) -> Result<Option<Map<
Ok(Some(result))
}

fn get_progress_bar(len: u64) -> Result<ProgressBar, DscError> {
let pb = ProgressBar::new(len);
pb.enable_steady_tick(Duration::from_millis(120));
pb.set_style(ProgressStyle::with_template(
fn get_progress_bar_span(len: u64) -> Result<Span, DscError> {
let pb_span = warn_span!("progress bar");
pb_span.pb_set_style(&ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] [{bar:40.cyan/blue}] {pos:>7}/{len:7} {msg:.yellow}"
)?);
Ok(pb)
pb_span.pb_set_length(len);
Ok(pb_span)
}

fn add_metadata(kind: &Kind, mut properties: Option<Map<String, Value>> ) -> Result<String, DscError> {
Expand Down Expand Up @@ -226,10 +226,11 @@ impl Configurator {
let config = self.validate_config()?;
let mut result = ConfigurationGetResult::new();
let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
let pb = get_progress_bar(resources.len() as u64)?;
let pb_span = get_progress_bar_span(resources.len() as u64)?;
let pb_span_enter = pb_span.enter();
for resource in resources {
pb.inc(1);
pb.set_message(format!("Get '{}'", resource.name));
Span::current().pb_inc(1);
pb_span.pb_set_message(format!("Get '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(&resource.properties)?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
Expand All @@ -246,7 +247,8 @@ impl Configurator {
result.results.push(resource_result);
}

pb.finish_with_message("Get configuration completed");
mem::drop(pb_span_enter);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this needed explicitly? I would expect both to be dropped when going out of scope

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's needed within the config functions but I removed it from resource list

mem::drop(pb_span);
Ok(result)
}

Expand All @@ -264,10 +266,11 @@ impl Configurator {
let config = self.validate_config()?;
let mut result = ConfigurationSetResult::new();
let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
let pb = get_progress_bar(resources.len() as u64)?;
let pb_span = get_progress_bar_span(resources.len() as u64)?;
let pb_span_enter = pb_span.enter();
for resource in resources {
pb.inc(1);
pb.set_message(format!("Set '{}'", resource.name));
Span::current().pb_inc(1);
pb_span.pb_set_message(format!("Set '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(&resource.properties)?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
Expand All @@ -284,7 +287,8 @@ impl Configurator {
result.results.push(resource_result);
}

pb.finish_with_message("Set configuration completed");
mem::drop(pb_span_enter);
mem::drop(pb_span);
Ok(result)
}

Expand All @@ -302,10 +306,11 @@ impl Configurator {
let config = self.validate_config()?;
let mut result = ConfigurationTestResult::new();
let resources = get_resource_invocation_order(&config, &mut self.statement_parser, &self.context)?;
let pb = get_progress_bar(resources.len() as u64)?;
let pb_span = get_progress_bar_span(resources.len() as u64)?;
let pb_span_enter = pb_span.enter();
for resource in resources {
pb.inc(1);
pb.set_message(format!("Test '{}'", resource.name));
Span::current().pb_inc(1);
pb_span.pb_set_message(format!("Test '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(&resource.properties)?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
return Err(DscError::ResourceNotFound(resource.resource_type));
Expand All @@ -322,7 +327,8 @@ impl Configurator {
result.results.push(resource_result);
}

pb.finish_with_message("Test configuration completed");
mem::drop(pb_span_enter);
mem::drop(pb_span);
Ok(result)
}

Expand All @@ -346,10 +352,11 @@ impl Configurator {
let mut result = ConfigurationExportResult::new();
let mut conf = config_doc::Configuration::new();

let pb = get_progress_bar(config.resources.len() as u64)?;
let pb_span = get_progress_bar_span(config.resources.len() as u64)?;
let pb_span_enter = pb_span.enter();
for resource in config.resources {
pb.inc(1);
pb.set_message(format!("Export '{}'", resource.name));
Span::current().pb_inc(1);
pb_span.pb_set_message(format!("Export '{}'", resource.name).as_str());
let properties = self.invoke_property_expressions(&resource.properties)?;
let Some(dsc_resource) = self.discovery.find_resource(&resource.resource_type.to_lowercase()) else {
return Err(DscError::ResourceNotFound(resource.resource_type.clone()));
Expand All @@ -360,7 +367,8 @@ impl Configurator {
}

result.result = Some(conf);
pb.finish_with_message("Export configuration completed");
mem::drop(pb_span_enter);
mem::drop(pb_span);
Ok(result)
}

Expand Down
54 changes: 24 additions & 30 deletions dsc_lib/src/discovery/command_discovery.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@ use crate::dscresources::dscresource::{DscResource, ImplementedAs};
use crate::dscresources::resource_manifest::{import_manifest, Kind, ResourceManifest};
use crate::dscresources::command_resource::invoke_command;
use crate::dscerror::DscError;
use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use indicatif::ProgressStyle;
use std::collections::BTreeMap;
use std::env;
use std::ffi::OsStr;
use std::fs::File;
use std::io::BufReader;
use std::mem;
use std::path::Path;
use std::time::Duration;
use tracing::{debug, error, trace, warn};
use tracing::{debug, error, trace, warn, warn_span, Span};
use tracing_indicatif::span_ext::IndicatifSpanExt;

pub struct CommandDiscovery {
}
Expand All @@ -31,25 +32,18 @@ impl CommandDiscovery {
debug!("Searching for resources: {:?}", required_resource_types);
let return_all_resources = required_resource_types.len() == 1 && required_resource_types[0] == "*";

let multi_progress_bar = MultiProgress::new();
let pb = multi_progress_bar.add(
let pb_span = warn_span!("progress bar");
if return_all_resources {
let pb = ProgressBar::new(1);
pb.enable_steady_tick(Duration::from_millis(120));
pb.set_style(ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] {msg:.yellow}"
)?);
pb
} else {
let pb = ProgressBar::new(required_resource_types.len() as u64);
pb.enable_steady_tick(Duration::from_millis(120));
pb.set_style(ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] [{bar:40.cyan/blue}] {pos:>7}/{len:7} {msg:.yellow}"
)?);
pb
}
);
pb.set_message("Searching for resources");
pb_span.pb_set_style(&ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] {msg:.yellow}"
)?);
} else {
pb_span.pb_set_style(&ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] [{bar:40.cyan/blue}] {pos:>7}/{len:7} {msg:.yellow}"
)?);
}
pb_span.pb_set_message("Searching for resources");
let pb_span_enter = pb_span.enter();

let mut resources: BTreeMap<String, DscResource> = BTreeMap::new();
let mut adapter_resources: Vec<String> = Vec::new();
Expand Down Expand Up @@ -128,7 +122,7 @@ impl CommandDiscovery {
{
remaining_required_resource_types.retain(|x| *x != resource.type_name.to_lowercase());
debug!("Found {} in {}", &resource.type_name, path.display());
pb.inc(1);
Span::current().pb_inc(1);
resources.insert(resource.type_name.to_lowercase(), resource);
if remaining_required_resource_types.is_empty()
{
Expand All @@ -140,18 +134,17 @@ impl CommandDiscovery {
}
}
}

debug!("Found {} matching non-adapter resources", resources.len() - adapter_resources.len());

// now go through the adapter resources and add them to the list of resources
for adapter in adapter_resources {
debug!("Enumerating resources for adapter {}", adapter);
let pb_adapter = multi_progress_bar.add(ProgressBar::new(1));
pb_adapter.enable_steady_tick(Duration::from_millis(120));
pb_adapter.set_style(ProgressStyle::with_template(
let pb_adapter_span = warn_span!("adapter");
pb_adapter_span.pb_set_style(&ProgressStyle::with_template(
"{spinner:.green} [{elapsed_precise:.cyan}] {msg:.white}"
)?);
pb_adapter.set_message(format!("Enumerating resources for adapter {adapter}"));
pb_adapter_span.pb_set_message(format!("Enumerating resources for adapter {adapter}").as_str());
let pb_adapter_enter = pb_adapter_span.enter();
let adapter_resource = resources.get(&adapter).unwrap();
let adapter_type_name = adapter_resource.type_name.clone();
let manifest = import_manifest(adapter_resource.manifest.clone().unwrap())?;
Expand Down Expand Up @@ -222,12 +215,13 @@ impl CommandDiscovery {
}
};
}
pb_adapter.finish_with_message(format!("Done with {adapter}"));
mem::drop(pb_adapter_enter);
mem::drop(pb_adapter_span);

debug!("Adapter '{}' listed {} matching resources", adapter_type_name, adapter_resources_count);
}

pb.finish_with_message("Discovery complete");
mem::drop(pb_span_enter);
mem::drop(pb_span);
Ok(resources)
}
}
Expand Down