We don't really want consumers consulting profile-able fields directly

Signed-off-by: itowlson <ivan.towlson@fermyon.com>

Author: itowlson

crates/build/src/lib.rs

@@ -77,6 +77,7 @@ pub async fn build(
             build_info.deployment_targets(),
             cache_root.clone(),
             &app_dir,
+            profile,
         )
         .await
         .context("unable to check if the application is compatible with deployment targets")?;
@@ -354,6 +355,7 @@ mod tests {
             &manifest.application.targets,
             None,
             manifest_file.parent().unwrap(),
+            None,
         )
         .await
         .context("unable to check if the application is compatible with deployment targets")

crates/build/src/manifest.rs

@@ -113,7 +113,7 @@ fn build_configs_from_manifest(
         .iter()
         .map(|(id, c)| ComponentBuildInfo {
             id: id.to_string(),
-            build: c.build_config(profile),
+            build: c.build(profile),
         })
         .collect()
 }

crates/doctor/src/wasm.rs

@@ -33,14 +33,14 @@ impl PatientWasm {
     }
 
     pub fn source_path(&self) -> Option<&Path> {
-        match &self.component.source {
+        match &self.component.source(None) {
             v2::ComponentSource::Local(path) => Some(Path::new(path)),
             _ => None,
         }
     }
 
     pub fn abs_source_path(&self) -> Option<PathBuf> {
-        match &self.component.source {
+        match &self.component.source(None) {
             v2::ComponentSource::Local(path) => {
                 // TODO: We probably need a doctor check to see if the path can be expanded!
                 // For now, fall back to the literal path.
@@ -54,7 +54,7 @@ impl PatientWasm {
     }
 
     pub fn has_build(&self) -> bool {
-        self.component.build.is_some()
+        self.component.build(None).is_some()
     }
 }
 

crates/environments/src/lib.rs

@@ -39,13 +39,14 @@ pub async fn validate_application_against_environment_ids(
     env_ids: &[TargetEnvironmentRef],
     cache_root: Option<std::path::PathBuf>,
     app_dir: &std::path::Path,
+    profile: Option<&str>,
 ) -> anyhow::Result<TargetEnvironmentValidation> {
     if env_ids.is_empty() {
         return Ok(Default::default());
     }
 
     let envs = TargetEnvironment::load_all(env_ids, cache_root, app_dir).await?;
-    validate_application_against_environments(application, &envs).await
+    validate_application_against_environments(application, &envs, profile).await
 }
 
 /// Validates *all* application components against the list of (realised) target enviroments. Each component must conform
@@ -55,6 +56,7 @@ pub async fn validate_application_against_environment_ids(
 async fn validate_application_against_environments(
     application: &ApplicationToValidate,
     envs: &[TargetEnvironment],
+    profile: Option<&str>,
 ) -> anyhow::Result<TargetEnvironmentValidation> {
     for trigger_type in application.trigger_types() {
         if let Some(env) = envs.iter().find(|e| !e.supports_trigger_type(trigger_type)) {
@@ -65,7 +67,7 @@ async fn validate_application_against_environments(
         }
     }
 
-    let components_by_trigger_type = application.components_by_trigger_type().await?;
+    let components_by_trigger_type = application.components_by_trigger_type(profile).await?;
 
     let mut errs = vec![];
 

crates/environments/src/loader.rs

@@ -67,6 +67,7 @@ impl ApplicationToValidate {
     fn component_source<'a>(
         &'a self,
         trigger: &'a spin_manifest::schema::v2::Trigger,
+        profile: Option<&str>,
     ) -> anyhow::Result<ComponentSource<'a>> {
         let component_spec = trigger
             .component
@@ -75,7 +76,7 @@ impl ApplicationToValidate {
         let (id, source, dependencies, service_chaining) = match component_spec {
             spin_manifest::schema::v2::ComponentSpec::Inline(c) => (
                 trigger.id.as_str(),
-                &c.source,
+                &c.source(profile),
                 &c.dependencies,
                 spin_loader::requires_service_chaining(c),
             ),
@@ -89,7 +90,7 @@ impl ApplicationToValidate {
                 };
                 (
                     id,
-                    &component.source,
+                    &component.source(profile),
                     &component.dependencies,
                     spin_loader::requires_service_chaining(component),
                 )
@@ -116,11 +117,12 @@ impl ApplicationToValidate {
 
     pub(crate) async fn components_by_trigger_type(
         &self,
+        profile: Option<&str>,
     ) -> anyhow::Result<Vec<(String, Vec<ComponentToValidate<'_>>)>> {
         use futures::FutureExt;
 
         let components_by_trigger_type_futs = self.triggers().map(|(ty, ts)| {
-            self.components_for_trigger(ts)
+            self.components_for_trigger(ts, profile)
                 .map(|css| css.map(|css| (ty.to_owned(), css)))
         });
         let components_by_trigger_type = try_join_all(components_by_trigger_type_futs)
@@ -132,16 +134,20 @@ impl ApplicationToValidate {
     async fn components_for_trigger<'a>(
         &'a self,
         triggers: &'a [spin_manifest::schema::v2::Trigger],
+        profile: Option<&str>,
     ) -> anyhow::Result<Vec<ComponentToValidate<'a>>> {
-        let component_futures = triggers.iter().map(|t| self.load_and_resolve_trigger(t));
+        let component_futures = triggers
+            .iter()
+            .map(|t| self.load_and_resolve_trigger(t, profile));
         try_join_all(component_futures).await
     }
 
     async fn load_and_resolve_trigger<'a>(
         &'a self,
         trigger: &'a spin_manifest::schema::v2::Trigger,
+        profile: Option<&str>,
     ) -> anyhow::Result<ComponentToValidate<'a>> {
-        let component = self.component_source(trigger)?;
+        let component = self.component_source(trigger, profile)?;
 
         let loader = ComponentSourceLoader::new(&self.wasm_loader);
 

crates/loader/src/local.rs

@@ -166,17 +166,22 @@ impl LocalLoader {
         let component_requires_service_chaining = requires_service_chaining(&component);
 
         let source = self
-            .load_component_source(id, component.source(self.profile.as_ref()).clone())
+            .load_component_source(id, component.source(self.profile()).clone())
             .await
-            .with_context(|| format!("Failed to load Wasm source {}", component.source))?;
+            .with_context(|| {
+                format!(
+                    "Failed to load Wasm source {}",
+                    component.source(self.profile())
+                )
+            })?;
 
         let metadata = ValuesMapBuilder::new()
+            .serializable("build", component.build(self.profile()))?
             .string("description", component.description)
             .string_array("allowed_outbound_hosts", allowed_outbound_hosts)
             .string_array("key_value_stores", component.key_value_stores)
             .string_array("databases", component.sqlite_databases)
             .string_array("ai_models", component.ai_models)
-            .serializable("build", component.build)?
             .take();
 
         let dependencies = self
@@ -548,6 +553,10 @@ impl LocalLoader {
             path: dest.into(),
         })
     }
+
+    fn profile(&self) -> Option<&str> {
+        self.profile.as_deref()
+    }
 }
 
 fn explain_file_mount_source_error(e: anyhow::Error, src: &Path) -> anyhow::Error {

crates/manifest/src/schema/v2.rs

@@ -298,7 +298,7 @@ pub struct Component {
     /// Example: `source = "bin/cart.wasm"`
     ///
     /// Learn more: https://spinframework.dev/writing-apps#the-component-source
-    pub source: ComponentSource,
+    pub(crate) source: ComponentSource,
     /// A human-readable description of the component.
     ///
     /// Example: `description = "Shopping cart"`
@@ -397,7 +397,7 @@ pub struct Component {
     ///
     /// Learn more: https://spinframework.dev/build
     #[serde(default, skip_serializing_if = "Option::is_none")]
-    pub build: Option<ComponentBuildConfig>,
+    pub(crate) build: Option<ComponentBuildConfig>,
     /// Settings for custom tools or plugins. Spin ignores this field.
     #[serde(default, skip_serializing_if = "Map::is_empty")]
     #[schemars(schema_with = "json_schema::map_of_toml_tables")]
@@ -414,9 +414,11 @@ pub struct Component {
     /// Learn more: https://spinframework.dev/writing-apps#using-component-dependencies
     #[serde(default, skip_serializing_if = "ComponentDependencies::is_empty")]
     pub dependencies: ComponentDependencies,
-    /// TODO: profile docs
+    /// Override values to use when building or running a named build profile.
+    ///
+    /// Example: `profile.debug.build.command = "npm run build-debug"`
     #[serde(default, skip_serializing_if = "Map::is_empty")]
-    pub profile: Map<String, ComponentProfileOverride>,
+    pub(crate) profile: Map<String, ComponentProfileOverride>,
 }
 
 /// Customisations for a Spin component in a non-default profile.
@@ -429,13 +431,13 @@ pub struct ComponentProfileOverride {
     ///
     /// Learn more: https://spinframework.dev/writing-apps#the-component-source
     #[serde(default, skip_serializing_if = "Option::is_none")]
-    pub source: Option<ComponentSource>,
+    source: Option<ComponentSource>,
 
     /// The command or commands for building the component in non-default profiles.
     /// If a component has no special build instructions for a profile, the
     /// default build command is used.
     #[serde(default, skip_serializing_if = "Option::is_none")]
-    pub build: Option<ComponentProfileBuildOverride>,
+    build: Option<ComponentProfileBuildOverride>,
 }
 
 /// Customisations for a Spin component build in a non-default profile.
@@ -448,7 +450,7 @@ pub struct ComponentProfileBuildOverride {
     /// Example: `build.command = "cargo build"`
     ///
     /// Learn more: https://spinframework.dev/build#setting-up-for-spin-build
-    pub command: super::common::Commands,
+    command: super::common::Commands,
 }
 
 impl Component {
@@ -470,7 +472,7 @@ impl Component {
     }
 
     /// The build configuration for the component
-    pub fn build_config(&self, profile: Option<impl AsRef<str>>) -> Option<ComponentBuildConfig> {
+    pub fn build(&self, profile: Option<&str>) -> Option<ComponentBuildConfig> {
         let build_config = self.build.clone();
         let build_profile = self.profile(profile).and_then(|o| o.build.as_ref());
 
@@ -491,8 +493,8 @@ impl Component {
         Some(build_config)
     }
 
-    /// TODO: docs! docs! docs!
-    pub fn source(&self, profile: Option<impl AsRef<str>>) -> &ComponentSource {
+    /// The source for the component Wasm binary (e.g. local file, registry reference, etc.).
+    pub fn source(&self, profile: Option<&str>) -> &ComponentSource {
         let profile_source = self.profile(profile).and_then(|o| o.source.as_ref());
 
         match profile_source {

src/commands/watch/filters.rs

@@ -90,7 +90,7 @@ impl FilterFactory for BuildFilterFactory {
         manifest_file: &Path,
         manifest_dir: &Path,
         manifest: &v2::AppManifest,
-        _profile: Option<&str>,
+        profile: Option<&str>,
     ) -> anyhow::Result<Arc<dyn Filterer>> {
         let mut filterers: Vec<Box<dyn Filterer>> =
             Vec::with_capacity(manifest.components.len() + 1);
@@ -101,7 +101,7 @@ impl FilterFactory for BuildFilterFactory {
         filterers.push(Box::new(manifest_filterer));
 
         for (cid, c) in &manifest.components {
-            if let Some(build_globs) = create_source_globs(cid.as_ref(), c) {
+            if let Some(build_globs) = create_source_globs(cid.as_ref(), c, profile) {
                 let build_filterer = globset_filter(manifest_dir, build_globs).await?;
                 filterers.push(Box::new(build_filterer));
             }
@@ -113,8 +113,8 @@ impl FilterFactory for BuildFilterFactory {
     }
 }
 
-fn create_source_globs(cid: &str, c: &v2::Component) -> Option<Vec<String>> {
-    let build = c.build.as_ref()?;
+fn create_source_globs(cid: &str, c: &v2::Component, profile: Option<&str>) -> Option<Vec<String>> {
+    let build = c.build(profile)?;
     if build.watch.is_empty() {
         eprintln!(
             "You haven't configured what to watch for the component: '{cid}'. Learn how to configure Spin watch at https://developer.fermyon.com/common/cli-reference#watch"

tests/integration.rs

@@ -1159,7 +1159,8 @@ route = "/..."
             .components
             .iter()
             .map(|(id, component)| {
-                let spin_manifest::schema::v2::ComponentSource::Local(file) = &component.source
+                let spin_manifest::schema::v2::ComponentSource::Local(file) =
+                    &component.source(None)
                 else {
                     panic!(
                         "{}.{}: source is not a file reference",