Skip to content

feat!: Support transient identities and traits #23

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
merged 2 commits into from
Oct 3, 2024
Merged

feat!: Support transient identities and traits #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
396af5b
feat: Support transient identities and traits
khvn26 Oct 3, 2024
f6d0f87
fix typo
khvn26 Oct 3, 2024
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
25 changes: 19 additions & 6 deletions src/flagsmith/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use flagsmith_flag_engine::identities::{Identity, Trait};
use flagsmith_flag_engine::segments::evaluator::get_identity_segments;
use flagsmith_flag_engine::segments::Segment;
use log::debug;
use models::SDKTrait;
use reqwest::header::{self, HeaderMap};
use serde_json::json;
use std::collections::HashMap;
Expand Down Expand Up @@ -195,15 +196,26 @@ impl Flagsmith {
pub fn get_identity_flags(
&self,
identifier: &str,
traits: Option<Vec<Trait>>,
traits: Option<Vec<SDKTrait>>,
transient: Option<bool>,
) -> Result<Flags, error::Error> {
let data = self.datastore.lock().unwrap();
let traits = traits.unwrap_or(vec![]);
if data.environment.is_some() {
let environment = data.environment.as_ref().unwrap();
return self.get_identity_flags_from_document(environment, &data.identities_with_overrides_by_identifier, identifier, traits);
let engine_traits: Vec<Trait> = traits.into_iter().map(|t| t.into()).collect();
return self.get_identity_flags_from_document(
environment,
&data.identities_with_overrides_by_identifier,
identifier,
engine_traits,
);
}
return self.default_handler_if_err(self.get_identity_flags_from_api(identifier, traits));
return self.default_handler_if_err(self.get_identity_flags_from_api(
identifier,
traits,
transient.unwrap_or(false),
));
}
// Returns a list of segments that the given identity is part of
pub fn get_identity_segments(
Expand Down Expand Up @@ -298,11 +310,12 @@ impl Flagsmith {
fn get_identity_flags_from_api(
&self,
identifier: &str,
traits: Vec<Trait>,
traits: Vec<SDKTrait>,
transient: bool,
) -> Result<Flags, error::Error> {
let method = reqwest::Method::POST;

let json = json!({"identifier":identifier, "traits": traits});
let json = json!({"identifier":identifier, "traits": traits, "transient": transient});
let response = get_json_response(
&self.client,
method,
Expand Down Expand Up @@ -586,7 +599,7 @@ mod tests {

// Then
let flags = _flagsmith.get_environment_flags();
let identity_flags = _flagsmith.get_identity_flags("overridden-id", None);
let identity_flags = _flagsmith.get_identity_flags("overridden-id", None, None);
assert_eq!(flags.unwrap().get_feature_value_as_string("some_feature").unwrap().to_owned(), "some-value");
assert_eq!(identity_flags.unwrap().get_feature_value_as_string("some_feature").unwrap().to_owned(), "some-overridden-value");
}
Expand Down
40 changes: 40 additions & 0 deletions src/flagsmith/models.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
use crate::flagsmith::analytics::AnalyticsProcessor;
use core::f64;
use flagsmith_flag_engine::features::FeatureState;
use flagsmith_flag_engine::identities::Trait;
use flagsmith_flag_engine::types::{FlagsmithValue, FlagsmithValueType};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::error;
Expand Down Expand Up @@ -156,6 +158,44 @@ impl Flags {
}
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct SDKTrait {
pub trait_key: String,
pub trait_value: FlagsmithValue,
#[serde(default)]
pub transient: bool,
}

impl SDKTrait {
pub fn new(trait_key: String, trait_value: FlagsmithValue) -> SDKTrait {
return SDKTrait {
trait_key: trait_key,
trait_value: trait_value,
transient: Default::default(),
};
}
pub fn new_with_transient(
trait_key: String,
trait_value: FlagsmithValue,
transient: bool,
) -> Self {
return SDKTrait {
trait_key: trait_key,
trait_value: trait_value,
transient: transient,
};
}
}

impl From<SDKTrait> for Trait {
fn from(t: SDKTrait) -> Self {
Self {
trait_key: t.trait_key,
trait_value: t.trait_value,
}
}
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down
153 changes: 136 additions & 17 deletions tests/integration_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use flagsmith::flagsmith::models::SDKTrait;
use flagsmith::flagsmith::offline_handler;
use flagsmith::{Flagsmith, FlagsmithOptions};
use flagsmith_flag_engine::identities::Trait;
Expand Down Expand Up @@ -136,7 +137,7 @@ fn test_offline_mode() {
// When
let env_flags = flagsmith.get_environment_flags().unwrap().all_flags();
let identity_flags = flagsmith
.get_identity_flags("test_identity", None)
.get_identity_flags("test_identity", None, None)
.unwrap()
.all_flags();

Expand Down Expand Up @@ -175,7 +176,7 @@ fn test_offline_handler_is_used_if_request_fails(mock_server: MockServer) {
// When
let env_flags = flagsmith.get_environment_flags().unwrap().all_flags();
let identity_flags = flagsmith
.get_identity_flags("test_identity", None)
.get_identity_flags("test_identity", None, None)
.unwrap()
.all_flags();

Expand Down Expand Up @@ -223,7 +224,7 @@ fn test_get_identity_flags_uses_local_environment_when_available(

// Then
let all_flags = flagsmith
.get_identity_flags("test_identity", None)
.get_identity_flags("test_identity", None, None)
.unwrap()
.all_flags();
assert_eq!(all_flags.len(), 1);
Expand All @@ -249,7 +250,8 @@ fn test_get_identity_flags_calls_api_when_no_local_environment_no_traits(
.header("X-Environment-Key", ENVIRONMENT_KEY)
.json_body(serde_json::json!({
"identifier": identifier,
"traits": []
"traits": [],
"transient": false,
}));
then.status(200).json_body(identities_json);
});
Expand All @@ -263,7 +265,7 @@ fn test_get_identity_flags_calls_api_when_no_local_environment_no_traits(
// When

let all_flags = flagsmith
.get_identity_flags(identifier, None)
.get_identity_flags(identifier, None, None)
.unwrap()
.all_flags();

Expand Down Expand Up @@ -296,7 +298,8 @@ fn test_get_identity_flags_calls_api_when_no_local_environment_with_traits(
.header("content-type", "application/json")
.json_body(serde_json::json!({
"identifier": identifier,
"traits": [{"trait_key":trait_key, "trait_value": trait_value}]
"traits": [{"trait_key":trait_key, "trait_value": trait_value, "transient": false}],
"transient": false,
}));
then.status(200).json_body(identities_json);
});
Expand All @@ -308,15 +311,15 @@ fn test_get_identity_flags_calls_api_when_no_local_environment_with_traits(
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let traits = vec![Trait {
trait_key: trait_key.to_string(),
trait_value: FlagsmithValue {
let traits = vec![SDKTrait::new(
trait_key.to_string(),
FlagsmithValue {
value: trait_value.to_string(),
value_type: FlagsmithValueType::String,
},
}];
)];
let all_flags = flagsmith
.get_identity_flags(identifier, Some(traits))
.get_identity_flags(identifier, Some(traits), None)
.unwrap()
.all_flags();

Expand All @@ -332,6 +335,113 @@ fn test_get_identity_flags_calls_api_when_no_local_environment_with_traits(
api_mock.assert();
}

#[rstest]
fn test_get_identity_flags_calls_api_when_no_local_environment_with_transient_traits(
mock_server: MockServer,
identities_json: serde_json::Value,
) {
// Given
let identifier = "test_identity";
let trait_key = "trait_key1";
let trait_value = "trait_value1";
let transient_trait_key = "trait_key2";

let api_mock = mock_server.mock(|when, then| {
when.method(POST)
.path("/api/v1/identities/")
.header("X-Environment-Key", ENVIRONMENT_KEY)
.header("content-type", "application/json")
.json_body(serde_json::json!({
"identifier": identifier,
"traits": [
{"trait_key":trait_key, "trait_value": trait_value, "transient": false},
{"trait_key":transient_trait_key, "trait_value": trait_value, "transient": true},
],
"transient": false,
}));
then.status(200).json_body(identities_json);
});
let url = mock_server.url("/api/v1/");
let flagsmith_options = FlagsmithOptions {
api_url: url,
..Default::default()
};
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let traits = vec![
SDKTrait::new(
trait_key.to_string(),
FlagsmithValue {
value: trait_value.to_string(),
value_type: FlagsmithValueType::String,
},
),
SDKTrait::new_with_transient(
transient_trait_key.to_string(),
FlagsmithValue {
value: trait_value.to_string(),
value_type: FlagsmithValueType::String,
},
true,
),
];
flagsmith
.get_identity_flags(identifier, Some(traits), None)
.unwrap()
.all_flags();

// Then
api_mock.assert();
}

#[rstest]
fn test_get_identity_flags_calls_api_when_no_local_environment_with_transient_identity(
mock_server: MockServer,
identities_json: serde_json::Value,
) {
// Given
let identifier = "test_identity";
let trait_key = "trait_key1";
let trait_value = "trai_value1";

let api_mock = mock_server.mock(|when, then| {
when.method(POST)
.path("/api/v1/identities/")
.header("X-Environment-Key", ENVIRONMENT_KEY)
.header("content-type", "application/json")
.json_body(serde_json::json!({
"identifier": identifier,
"traits": [{"trait_key":trait_key, "trait_value": trait_value, "transient": false}],
"transient": true,
}));
then.status(200).json_body(identities_json);
});
let url = mock_server.url("/api/v1/");
let flagsmith_options = FlagsmithOptions {
api_url: url,
..Default::default()
};
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let traits = vec![SDKTrait::new(
trait_key.to_string(),
FlagsmithValue {
value: trait_value.to_string(),
value_type: FlagsmithValueType::String,
},
)];
flagsmith
.get_identity_flags(identifier, Some(traits), Some(true))
.unwrap()
.all_flags();

// Then
api_mock.assert();
}


#[rstest]
fn test_default_flag_is_not_used_when_environment_flags_returned(
mock_server: MockServer,
Expand Down Expand Up @@ -414,7 +524,8 @@ fn test_default_flag_is_not_used_when_identity_flags_returned(
.header("X-Environment-Key", ENVIRONMENT_KEY)
.json_body(serde_json::json!({
"identifier": identifier,
"traits": []
"traits": [],
"transient": false,
}));
then.status(200).json_body(identities_json);
});
Expand All @@ -427,7 +538,9 @@ fn test_default_flag_is_not_used_when_identity_flags_returned(
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let flags = flagsmith.get_identity_flags(identifier, None).unwrap();
let flags = flagsmith
.get_identity_flags(identifier, None, None)
.unwrap();
let flag = flags.get_flag(fixtures::FEATURE_1_NAME).unwrap();
// Then
assert_eq!(flag.feature_name, fixtures::FEATURE_1_NAME);
Expand Down Expand Up @@ -455,7 +568,8 @@ fn test_default_flag_is_used_when_no_matching_identity_flags_returned(
.header("X-Environment-Key", ENVIRONMENT_KEY)
.json_body(serde_json::json!({
"identifier": identifier,
"traits": []
"traits": [],
"transient": false,
}));
then.status(200).json_body(identities_json);
});
Expand All @@ -468,7 +582,9 @@ fn test_default_flag_is_used_when_no_matching_identity_flags_returned(
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let flags = flagsmith.get_identity_flags(identifier, None).unwrap();
let flags = flagsmith
.get_identity_flags(identifier, None, None)
.unwrap();
let flag = flags.get_flag("feature_that_does_not_exists").unwrap();
// Then
assert_eq!(flag.is_default, true);
Expand Down Expand Up @@ -526,7 +642,8 @@ fn test_default_flags_are_used_if_api_error_and_default_flag_handler_given_for_i
.header("X-Environment-Key", ENVIRONMENT_KEY)
.json_body(serde_json::json!({
"identifier": identifier,
"traits": []
"traits": [],
"transient": false,
}));
then.status(200).json_body({});
});
Expand All @@ -539,7 +656,9 @@ fn test_default_flags_are_used_if_api_error_and_default_flag_handler_given_for_i
let flagsmith = Flagsmith::new(ENVIRONMENT_KEY.to_string(), flagsmith_options);

// When
let flags = flagsmith.get_identity_flags(identifier, None).unwrap();
let flags = flagsmith
.get_identity_flags(identifier, None, None)
.unwrap();
let flag = flags.get_flag("feature_that_does_not_exists").unwrap();
// Then
assert_eq!(flag.is_default, true);
Expand Down
Loading