Skip to content
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
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "featurevisor"
version = "1.0.0"
version = "1.1.0"
edition = "2021"
rust-version = "1.74.0"
description = "Featurevisor SDK for Rust: feature flags, experiments, and remote configuration"
Expand Down
3 changes: 2 additions & 1 deletion src/child.rs
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ impl FeaturevisorChild {
context: Option<&Context>,
options: Option<&OverrideOptions>,
) -> Evaluation {
let (stored, _, sticky_variables) = self.options();
let (stored, sticky_features, sticky_variables) = self.options();
let mut merged = stored;
if let Some(context) = context {
merged.extend(context.clone());
Expand All @@ -427,6 +427,7 @@ impl FeaturevisorChild {
variable_key,
Some(&merged),
options,
sticky_features,
sticky_variables,
)
}
Expand Down
140 changes: 95 additions & 45 deletions src/cli/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,44 @@ fn compare_evaluation(
}
}

fn compare_global_variable_evaluation(
errors: &mut Vec<String>,
variable_key: &str,
assertion: &JsonValue,
evaluation: &crate::Evaluation,
child_index: Option<usize>,
) {
let prefix = child_index
.map(|index| format!("children[{index}]."))
.unwrap_or_default();
if let Some(expected) = assertion.get("expectedValue") {
let actual = evaluation
.variable_value
.as_ref()
.map(crate::VariableValue::to_json)
.unwrap_or(JsonValue::Null);
if actual != *expected {
errors.push(format!(
"{variable_key}: {prefix}expectedValue expected {expected}, got {actual}"
));
}
}
if let Some(expected) = assertion
.get("expectedEvaluation")
.and_then(JsonValue::as_object)
{
let actual = serde_json::to_value(evaluation).unwrap_or(JsonValue::Null);
for (key, expected_value) in expected {
let actual_value = actual.get(key).cloned().unwrap_or(JsonValue::Null);
if actual_value != *expected_value {
errors.push(format!(
"{variable_key}: {prefix}expectedEvaluation.{key} expected {expected_value}, got {actual_value}"
));
}
}
}
}

fn compare_evaluations(
errors: &mut Vec<String>,
feature_key: &str,
Expand Down Expand Up @@ -360,15 +398,12 @@ fn run_assertion(
}

if let Some(segment_key) = segment_key {
let datafile = base_datafile(datafiles, environment);
let Some(datafile) = datafile else {
return Err(format!(
"No datafile available for segment assertion {segment_key}"
));
};
let context = context_from_json(assertion.get("context"));
let mut segment_datafile = datafile.clone();
segment_datafile.segments = segments.clone();
let segment_datafile = crate::DatafileContent {
revision: "tester".to_string(),
segments: segments.clone(),
..Default::default()
};
let f = crate::create_featurevisor(FeaturevisorOptions {
datafile: Some(input(segment_datafile)),
context: Some(context.clone()),
Expand All @@ -383,32 +418,44 @@ fn run_assertion(
.get("expectedToMatch")
.and_then(JsonValue::as_bool)
.unwrap_or(false);
return if actual == expected {
let result = if actual == expected {
Ok(Vec::new())
} else {
Ok(vec![format!(
"{segment_key}: expected segment match {expected}, got {actual}"
)])
};
f.close();
return result;
}

if let Some(variable_key) = variable_key {
let selected_key = datafile_key(environment, target);
let datafile = datafiles
.get(&selected_key)
.or_else(|| base_datafile(datafiles, environment));
let datafile = datafiles.get(&selected_key);
let Some(datafile) = datafile else {
return Err(format!(
"No datafile available for variable assertion {variable_key}"
));
};
if options.common.show_datafile {
println!(
"{}",
serde_json::to_string_pretty(datafile).unwrap_or_default()
);
}
let f = crate::create_featurevisor(FeaturevisorOptions {
datafile: Some(input(datafile.clone())),
context: Some(context_from_json(assertion.get("context"))),
sticky_variables: assertion
.get("stickyVariables")
.and_then(|value| serde_json::from_value(value.clone()).ok()),
sticky_features: assertion
.get("stickyFeatures")
.and_then(|value| serde_json::from_value(value.clone()).ok()),
log_level: Some(log_level(options)),
modules: vec![Arc::new(AtModule {
at: assertion.get("at").and_then(JsonValue::as_f64),
})],
..Default::default()
});
let evaluation_options = OverrideOptions {
Expand All @@ -420,36 +467,50 @@ fn run_assertion(
};
let evaluation = f.evaluate_global_variable(variable_key, None, Some(&evaluation_options));
let mut errors = Vec::new();
if let Some(expected) = assertion.get("expectedValue") {
if evaluation
.variable_value
.as_ref()
.map(crate::VariableValue::to_json)
!= Some(expected.clone())
{
errors.push(format!(
"{variable_key}: expected value {expected}, got {:?}",
evaluation.variable_value
));
compare_global_variable_evaluation(&mut errors, variable_key, assertion, &evaluation, None);
if let Some(children) = assertion.get("children").and_then(JsonValue::as_array) {
for (child_index, child_assertion) in children.iter().enumerate() {
let child = f.spawn(
context_from_json(child_assertion.get("context")),
SpawnOptions {
sticky_features: child_assertion
.get("stickyFeatures")
.and_then(|value| serde_json::from_value(value.clone()).ok())
.or_else(|| Some(Default::default())),
sticky_variables: child_assertion
.get("stickyVariables")
.and_then(|value| serde_json::from_value(value.clone()).ok())
.or_else(|| Some(Default::default())),
},
);
let child_options = OverrideOptions {
default_variable_value: child_assertion
.get("defaultVariableValue")
.cloned()
.map(crate::VariableValue::from_json),
..Default::default()
};
let child_evaluation =
child.evaluate_global_variable(variable_key, None, Some(&child_options));
compare_global_variable_evaluation(
&mut errors,
variable_key,
child_assertion,
&child_evaluation,
Some(child_index),
);
child.close();
}
}
if let Some(expected) = assertion
.get("expectedEvaluation")
.and_then(JsonValue::as_object)
{
let actual = serde_json::to_value(&evaluation).unwrap_or(JsonValue::Null);
compare_evaluation(&mut errors, variable_key, "variable", expected, &actual);
}
f.close();
return Ok(errors);
}

let Some(feature_key) = feature_key else {
return Ok(vec!["test has no feature, segment, or variable".to_string()]);
};
let selected_key = datafile_key(environment, target);
let datafile = datafiles
.get(&selected_key)
.or_else(|| base_datafile(datafiles, environment));
let datafile = datafiles.get(&selected_key);
let Some(datafile) = datafile else {
return Err(format!(
"No datafile available for feature assertion {feature_key}"
Expand Down Expand Up @@ -516,6 +577,7 @@ fn run_assertion(
compare_variables(&mut errors, feature_key, assertion, &f);
compare_evaluations(&mut errors, feature_key, assertion, &f);
compare_children(&mut errors, feature_key, assertion, &f);
f.close();
Ok(errors)
}

Expand Down Expand Up @@ -575,18 +637,6 @@ fn project_segments(project: &Path) -> Result<HashMap<String, Segment>, String>
Ok(segments)
}

fn base_datafile<'a>(
datafiles: &'a HashMap<String, crate::DatafileContent>,
environment: Option<&str>,
) -> Option<&'a crate::DatafileContent> {
datafiles.get(&datafile_key(environment, None)).or_else(|| {
datafiles
.iter()
.find(|(key, _)| !key.contains("-target-"))
.map(|(_, value)| value)
})
}

pub fn run(options: TestOptions) -> Result<(), String> {
let project = project_path(&options.common.project_directory_path);
let key_pattern = compile_pattern("--keyPattern", options.key_pattern.as_deref())?;
Expand Down
60 changes: 51 additions & 9 deletions src/instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -856,23 +856,41 @@ impl Featurevisor {
context: Option<&Context>,
options: Option<&OverrideOptions>,
) -> Evaluation {
let sticky = self
let (sticky_features, sticky_variables) = self
.inner
.lock()
.map(|inner| inner.sticky_variables.clone())
.map(|inner| {
(
inner.sticky_features.clone(),
inner.sticky_variables.clone(),
)
})
.unwrap_or_default();
self.evaluate_global_variable_with_sticky(variable_key, context, options, sticky)
self.evaluate_global_variable_with_sticky(
variable_key,
context,
options,
sticky_features,
sticky_variables,
)
}

pub(crate) fn evaluate_global_variable_with_sticky(
&self,
variable_key: &str,
context: Option<&Context>,
options: Option<&OverrideOptions>,
sticky: StickyVariables,
sticky_features: StickyFeatures,
sticky_variables: StickyVariables,
) -> Evaluation {
match catch_unwind(AssertUnwindSafe(|| {
self.evaluate_global_variable_inner(variable_key, context, options, sticky)
self.evaluate_global_variable_inner(
variable_key,
context,
options,
sticky_features,
sticky_variables,
)
})) {
Ok(evaluation) => evaluation,
Err(error) => {
Expand Down Expand Up @@ -927,7 +945,8 @@ impl Featurevisor {
variable_key: &str,
context: Option<&Context>,
options: Option<&OverrideOptions>,
sticky: StickyVariables,
sticky_features: StickyFeatures,
sticky_variables: StickyVariables,
) -> Evaluation {
let (datafile, stored_context, _, _, _, modules, regex_cache) = self.snapshot();
let mut resolved_context = stored_context;
Expand Down Expand Up @@ -963,7 +982,7 @@ impl Featurevisor {
.clone()
.unwrap_or_else(|| variable_key.to_string());
let mut evaluation = self.empty_global_variable_evaluation(&resolved_key);
if let Some(value) = sticky.get(&resolved_key) {
if let Some(value) = sticky_variables.get(&resolved_key) {
evaluation.reason = EvaluationReason::Sticky;
evaluation.variable_value = Some(value.clone());
} else if let Some(variable) = datafile.variables.get(&resolved_key) {
Expand All @@ -972,6 +991,7 @@ impl Featurevisor {
variable.required_features.as_deref(),
&evaluation_options.context,
options,
&sticky_features,
);
if !requirements_match {
evaluation.reason = EvaluationReason::RequiredFeaturesUnmet;
Expand All @@ -986,6 +1006,7 @@ impl Featurevisor {
item.required_features.as_deref(),
&evaluation_options.context,
options,
&sticky_features,
) {
continue;
}
Expand Down Expand Up @@ -1054,6 +1075,7 @@ impl Featurevisor {
requirements: Option<&[crate::types::Required]>,
context: &Context,
options: Option<&OverrideOptions>,
sticky_features: &StickyFeatures,
) -> bool {
requirements.unwrap_or_default().iter().all(|required| {
let (key, enabled, variation) = match required {
Expand All @@ -1071,11 +1093,31 @@ impl Featurevisor {
(key.as_str(), true, Some(variation.as_str()))
}
};
if self.is_enabled(key, Some(context)) != enabled {
let enabled_evaluation = self.evaluate_child(
EvaluationType::Flag,
key,
None,
Some(context),
options,
sticky_features.clone(),
);
if (enabled_evaluation.enabled == Some(true)) != enabled {
return false;
}
variation.map_or(true, |expected| {
self.get_variation(key, Some(context), options).as_deref() == Some(expected)
let evaluation = self.evaluate_child(
EvaluationType::Variation,
key,
None,
Some(context),
options,
sticky_features.clone(),
);
evaluation
.variation_value
.or_else(|| evaluation.variation.map(|value| value.value))
.as_deref()
== Some(expected)
})
})
}
Expand Down
Loading