Skip to content
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.

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

fix(manifest): support kebab case labels #2300

Merged
merged 1 commit into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 2 additions & 14 deletions crates/manifest/src/compat.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,6 @@ pub fn v1_to_v2_app(manifest: v1::AppManifestV1) -> Result<v2::AppManifest, Erro
.map(|(key, var)| Ok((id_from_string(key)?, var)))
.collect::<Result<_, Error>>()?;

let key_value_stores = component
.key_value_stores
.into_iter()
.map(id_from_string)
.collect::<Result<_, Error>>()?;

let sqlite_databases = component
.sqlite_databases
.into_iter()
.map(id_from_string)
.collect::<Result<_, Error>>()?;

let ai_models = component
.ai_models
.into_iter()
Expand All @@ -79,8 +67,8 @@ pub fn v1_to_v2_app(manifest: v1::AppManifestV1) -> Result<v2::AppManifest, Erro
environment: component.environment,
files: component.files,
exclude_files: component.exclude_files,
key_value_stores,
sqlite_databases,
key_value_stores: component.key_value_stores,
sqlite_databases: component.sqlite_databases,
ai_models,
build: component.build,
tool: Default::default(),
Expand Down
124 changes: 118 additions & 6 deletions crates/manifest/src/schema/v2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,20 @@ pub struct Component {
/// `allowed_outbound_hosts = ["redis://myredishost.com:6379"]`
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub(crate) allowed_outbound_hosts: Vec<String>,
/// `key_value_stores = ["default"]`
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub key_value_stores: Vec<SnakeId>,
/// `sqlite_databases = ["default"]`
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub sqlite_databases: Vec<SnakeId>,
/// `key_value_stores = ["default", "my-store"]`
#[serde(
default,
with = "kebab_or_snake_case",
skip_serializing_if = "Vec::is_empty"
)]
pub key_value_stores: Vec<String>,
/// `sqlite_databases = ["default", "my-database"]`
#[serde(
default,
with = "kebab_or_snake_case",
skip_serializing_if = "Vec::is_empty"
)]
pub sqlite_databases: Vec<String>,
/// `ai_models = ["llama2-chat"]`
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub ai_models: Vec<KebabId>,
Expand All @@ -139,6 +147,42 @@ pub struct Component {
pub tool: Map<String, toml::Table>,
}

mod kebab_or_snake_case {
use serde::{Deserialize, Serialize};
pub use spin_serde::{KebabId, SnakeId};
pub fn serialize<S>(value: &[String], serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::ser::Serializer,
{
if value.iter().all(|s| {
KebabId::try_from(s.clone()).is_ok() || SnakeId::try_from(s.to_owned()).is_ok()
}) {
value.serialize(serializer)
} else {
Err(serde::ser::Error::custom(
"expected kebab-case or snake_case",
))
}
}

pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<String>, D::Error>
where
D: serde::Deserializer<'de>,
{
let value = toml::Value::deserialize(deserializer)?;
let list: Vec<String> = Vec::deserialize(value).map_err(serde::de::Error::custom)?;
if list.iter().all(|s| {
KebabId::try_from(s.clone()).is_ok() || SnakeId::try_from(s.to_owned()).is_ok()
}) {
Ok(list)
} else {
Err(serde::de::Error::custom(
"expected kebab-case or snake_case",
))
}
}
}

impl Component {
/// Combine `allowed_outbound_hosts` with the deprecated `allowed_http_hosts` into
/// one array all normalized to the syntax of `allowed_outbound_hosts`.
Expand Down Expand Up @@ -265,6 +309,74 @@ mod tests {
.unwrap();
}

#[test]
fn deserializing_labels() {
kate-goldenring marked this conversation as resolved.
Show resolved Hide resolved
AppManifest::deserialize(toml! {
spin_manifest_version = 2
[application]
name = "trigger-configs"
[[trigger.fake]]
something = "something else"
[component.fake]
source = "dummy"
key_value_stores = ["default", "snake_case", "kebab-case"]
sqlite_databases = ["default", "snake_case", "kebab-case"]
})
.unwrap();
}

#[test]
fn deserializing_labels_fails_for_non_kebab_or_snake() {
assert!(AppManifest::deserialize(toml! {
spin_manifest_version = 2
[application]
name = "trigger-configs"
[[trigger.fake]]
something = "something else"
[component.fake]
source = "dummy"
key_value_stores = ["b@dlabel"]
})
.is_err());
}

fn get_test_component_with_labels(labels: Vec<String>) -> Component {
Component {
source: ComponentSource::Local("dummy".to_string()),
description: "".to_string(),
variables: Map::new(),
environment: Map::new(),
files: vec![],
exclude_files: vec![],
allowed_http_hosts: vec![],
allowed_outbound_hosts: vec![],
key_value_stores: labels.clone(),
sqlite_databases: labels,
ai_models: vec![],
build: None,
tool: Map::new(),
}
}

#[test]
fn serialize_labels() {
let stores = vec![
"default".to_string(),
"snake_case".to_string(),
"kebab-case".to_string(),
];
let component = get_test_component_with_labels(stores.clone());
let serialized = toml::to_string(&component).unwrap();
let deserialized = toml::from_str::<Component>(&serialized).unwrap();
assert_eq!(deserialized.key_value_stores, stores);
}

#[test]
fn serialize_labels_fails_for_non_kebab_or_snake() {
let component = get_test_component_with_labels(vec!["camelCase".to_string()]);
assert!(toml::to_string(&component).is_err());
}

#[test]
fn test_valid_snake_ids() {
for valid in ["default", "mixed_CASE_words", "letters1_then2_numbers345"] {
Expand Down
Loading