Skip to content

chore(config): Drop support for missing example configs #20550

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
bruceg merged 1 commit into from
May 23, 2024
Merged

chore(config): Drop support for missing example configs #20550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions lib/vector-config/src/component/description.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ use crate::{schema, Configurable, ConfigurableRef, GenerateError, Metadata};

#[derive(Debug, Snafu, Clone, PartialEq, Eq)]
pub enum ExampleError {
#[snafu(display("unable to create an example for this component"))]
MissingExample,

#[snafu(display("component '{}' does not exist", component_name))]
DoesNotExist { component_name: String },
}
Expand All @@ -23,7 +20,7 @@ pub struct ComponentDescription<T: ComponentMarker + Sized> {
description: &'static str,
label: &'static str,
logical_name: &'static str,
example_value: fn() -> Option<Value>,
example_value: fn() -> Value,
config: ConfigurableRef,
_component_type: PhantomData<T>,
}
Expand Down Expand Up @@ -53,7 +50,7 @@ where
description,
label,
logical_name,
example_value: || Some(C::generate_config()),
example_value: C::generate_config,
config: ConfigurableRef::new::<C>(),
_component_type: PhantomData,
}
Expand All @@ -72,7 +69,7 @@ where
.ok_or_else(|| ExampleError::DoesNotExist {
component_name: component_name.to_owned(),
})
.and_then(|t| (t.example_value)().ok_or(ExampleError::MissingExample))
.map(|t| (t.example_value)())
}

/// Gets a sorted list of all registered components of the given component type.
Expand Down
26 changes: 10 additions & 16 deletions src/generate.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use indexmap::IndexMap;
use serde::Serialize;
use toml::{map::Map, Value};
use vector_lib::configurable::component::{
ExampleError, SinkDescription, SourceDescription, TransformDescription,
SinkDescription, SourceDescription, TransformDescription,
};
use vector_lib::{buffers::BufferConfig, config::GlobalOptions, default_data_dir};

Expand Down Expand Up @@ -158,12 +158,10 @@ pub(crate) fn generate_example(
let mut example = match SourceDescription::example(&source_type) {
Ok(example) => example,
Err(err) => {
if err != ExampleError::MissingExample {
errs.push(format!(
"failed to generate source '{}': {}",
source_type, err
));
}
errs.push(format!(
"failed to generate source '{}': {}",
source_type, err
));
Value::Table(Map::new())
}
};
Expand Down Expand Up @@ -221,12 +219,10 @@ pub(crate) fn generate_example(
let mut example = match TransformDescription::example(&transform_type) {
Ok(example) => example,
Err(err) => {
if err != ExampleError::MissingExample {
errs.push(format!(
"failed to generate transform '{}': {}",
transform_type, err
));
}
errs.push(format!(
"failed to generate transform '{}': {}",
transform_type, err
));
Value::Table(Map::new())
}
};
Expand Down Expand Up @@ -273,9 +269,7 @@ pub(crate) fn generate_example(
let mut example = match SinkDescription::example(&sink_type) {
Ok(example) => example,
Err(err) => {
if err != ExampleError::MissingExample {
errs.push(format!("failed to generate sink '{}': {}", sink_type, err));
}
errs.push(format!("failed to generate sink '{}': {}", sink_type, err));
Value::Table(Map::new())
}
};
Expand Down