chore(config): begin laying out primitives for programmatically querying schema (vectordotdev#17130)

Author: tobz

Cargo.lock

@@ -87,6 +87,7 @@ members = [
   ".",
   "lib/codecs",
   "lib/dnsmsg-parser",
+  "lib/docs-renderer",
   "lib/enrichment",
   "lib/fakedata",
   "lib/file-source",

Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "docs-renderer"
+version = "0.1.0"
+authors = ["Vector Contributors <[email protected]>"]
+edition = "2021"
+publish = false
+
+[dependencies]
+anyhow = { version = "1.0.66", default-features = false, features = ["std"] }
+serde = { version = "1.0", default-features = false }
+serde_json = { version = "1.0", default-features = false, features = ["std"] }
+snafu = { version = "0.7.4", default-features = false }
+tracing = { version = "0.1.34", default-features = false }
+tracing-subscriber = { version = "0.3.16", default-features = false, features = ["ansi", "env-filter", "fmt", "json", "registry", "tracing-log"] }
+vector-config = { path = "../vector-config" }
+vector-config-common = { path = "../vector-config-common" }

lib/docs-renderer/Cargo.toml

@@ -0,0 +1,82 @@
+mod renderer;
+
+use std::collections::HashMap;
+
+use crate::renderer::SchemaRenderer;
+use anyhow::{Context, Result};
+use tracing::debug;
+use vector_config::schema::parser::{component::ComponentSchema, query::SchemaQuerier};
+use vector_config_common::constants::{self, ComponentType};
+
+fn main() -> Result<()> {
+    let querier = SchemaQuerier::from_schema("/tmp/vector-config-schema.json")
+        .context("Failed to create querier from given schema file path.")?;
+
+    let base_component_types = &[
+        ComponentType::Source,
+        ComponentType::Transform,
+        ComponentType::Sink,
+    ];
+    for base_component_type in base_component_types {
+        // Find the base component schema for the component type itself, which is analogous to
+        // `SourceOuter`, `SinkOuter`, etc. We render the schema for that separately as it's meant
+        // to be common across components of the same type, etc.
+        let base_component_schema = querier
+            .query()
+            .with_custom_attribute_kv(
+                constants::DOCS_META_COMPONENT_BASE_TYPE,
+                base_component_type,
+            )
+            .run_single()?;
+
+        debug!(
+            "Got base component schema for component type '{}'.",
+            base_component_type.as_str()
+        );
+
+        // Find all component schemas of the same component type.
+        let maybe_component_schemas = querier
+            .query()
+            .with_custom_attribute_kv(constants::DOCS_META_COMPONENT_TYPE, base_component_type)
+            .run()
+            .into_iter()
+            .map(ComponentSchema::try_from)
+            .collect::<Result<Vec<_>, _>>()?;
+
+        debug!(
+            "Found {} component schema(s) for component type '{}'.",
+            maybe_component_schemas.len(),
+            base_component_type.as_str()
+        );
+
+        let mut rendered_component_schemas = HashMap::new();
+
+        // Render the base component schema.
+        let base_component_schema_renderer = SchemaRenderer::new(&querier, base_component_schema);
+        let rendered_base_component_schema =
+            base_component_schema_renderer.render().context(format!(
+                "Failed to render the base component schema for component type '{}'.",
+                base_component_type.as_str()
+            ))?;
+        rendered_component_schemas.insert(
+            format!("base/{}", base_component_type.as_str()),
+            rendered_base_component_schema,
+        );
+
+        // Render each of the component schemas for this component type.
+        for component_schema in maybe_component_schemas {
+            let component_name = component_schema.component_name().to_string();
+            let component_schema_renderer = SchemaRenderer::new(&querier, component_schema);
+            let rendered_component_schema = component_schema_renderer.render().context(format!(
+                "Failed to render the '{}' component schema.",
+                component_name
+            ))?;
+            rendered_component_schemas.insert(
+                format!("{}s/base/{}", base_component_type.as_str(), component_name),
+                rendered_component_schema,
+            );
+        }
+    }
+
+    Ok(())
+}