Skip to content

fix: update provider method signatures to conform to specification #13

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 3 commits into from
Jun 2, 2025
Merged

fix: update provider method signatures to conform to specification #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5268e49
Update provider method signatures to conform to specification
matthewelwell Jun 2, 2025
9331854
Fixes
matthewelwell Jun 2, 2025
7cec778
Fix tests
matthewelwell Jun 2, 2025
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
50 changes: 25 additions & 25 deletions openfeature_flagsmith/provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,69 +43,69 @@ def get_metadata(self) -> Metadata:

def resolve_boolean_details(
self,
key: str,
flag_key: str,
default_value: bool,
evaluation_context: EvaluationContext = EvaluationContext(),
context: EvaluationContext = EvaluationContext(),
) -> FlagResolutionDetails[bool]:
return self._resolve(key, FlagType.BOOLEAN, default_value, evaluation_context)
return self._resolve(flag_key, FlagType.BOOLEAN, default_value, context)

def resolve_string_details(
self,
key: str,
flag_key: str,
default_value: str,
evaluation_context: EvaluationContext = EvaluationContext(),
context: EvaluationContext = EvaluationContext(),
) -> FlagResolutionDetails[str]:
return self._resolve(key, FlagType.STRING, default_value, evaluation_context)
return self._resolve(flag_key, FlagType.STRING, default_value, context)

def resolve_integer_details(
self,
key: str,
flag_key: str,
default_value: int,
evaluation_context: EvaluationContext = EvaluationContext(),
context: EvaluationContext = EvaluationContext(),
) -> FlagResolutionDetails[int]:
return self._resolve(key, FlagType.INTEGER, default_value, evaluation_context)
return self._resolve(flag_key, FlagType.INTEGER, default_value, context)

def resolve_float_details(
self,
key: str,
flag_key: str,
default_value: float,
evaluation_context: EvaluationContext = EvaluationContext(),
context: EvaluationContext = EvaluationContext(),
) -> FlagResolutionDetails[float]:
return self._resolve(key, FlagType.FLOAT, default_value, evaluation_context)
return self._resolve(flag_key, FlagType.FLOAT, default_value, context)

def resolve_object_details(
self,
key: str,
flag_key: str,
default_value: typing.Union[dict, list],
evaluation_context: EvaluationContext = EvaluationContext(),
context: EvaluationContext = EvaluationContext(),
) -> FlagResolutionDetails[typing.Union[dict, list]]:
return self._resolve(key, FlagType.OBJECT, default_value, evaluation_context)
return self._resolve(flag_key, FlagType.OBJECT, default_value, context)

def _resolve(
self,
key: str,
flag_key: str,
flag_type: FlagType,
default_value: typing.Any,
evaluation_context: EvaluationContext,
context: EvaluationContext,
) -> FlagResolutionDetails:
try:
flag = self._get_flags(evaluation_context).get_flag(key)
flag = self._get_flags(context).get_flag(flag_key)
except FlagsmithClientError as e:
raise FlagsmithProviderError(
error_code=ErrorCode.GENERAL,
error_message="An error occurred retrieving flags from Flagsmith client.",
) from e

if flag.is_default and not self.use_flagsmith_defaults:
raise FlagNotFoundError(error_message="Flag '%s' was not found." % key)
raise FlagNotFoundError(error_message="Flag '%s' was not found." % flag_key)

if flag_type == FlagType.BOOLEAN and not self.use_boolean_config_value:
return FlagResolutionDetails(value=flag.enabled)

if not (self.return_value_for_disabled_flags or flag.enabled):
raise FlagsmithProviderError(
error_code=ErrorCode.GENERAL,
error_message="Flag '%s' is not enabled." % key,
error_message="Flag '%s' is not enabled." % flag_key,
)

required_type = _BASIC_FLAG_TYPE_MAPPINGS.get(flag_type)
Expand All @@ -115,18 +115,18 @@ def _resolve(
try:
return FlagResolutionDetails(value=json.loads(flag.value))
except JSONDecodeError as e:
msg = "Unable to parse object from value for flag '%s'" % key
msg = "Unable to parse object from value for flag '%s'" % flag_key
raise ParseError(error_message=msg) from e

raise TypeMismatchError(
error_message="Value for flag '%s' is not of type '%s'"
% (key, flag_type.value)
% (flag_key, flag_type.value)
)

def _get_flags(self, evaluation_context: EvaluationContext = EvaluationContext()):
if targeting_key := evaluation_context.targeting_key:
def _get_flags(self, context: EvaluationContext = EvaluationContext()):
if targeting_key := context.targeting_key:
return self._client.get_identity_flags(
identifier=targeting_key,
traits=evaluation_context.attributes.get("traits", {}),
traits=context.attributes.get("traits", {}),
)
return self._client.get_environment_flags()
6 changes: 3 additions & 3 deletions tests/test_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,9 +302,9 @@ def test_identity_flags_are_used_if_targeting_key_provided(

# When
result = provider.resolve_string_details(
key=key,
flag_key=key,
default_value=default_value,
evaluation_context=EvaluationContext(
context=EvaluationContext(
targeting_key=targeting_key, attributes={"traits": traits}
),
)
Expand Down Expand Up @@ -332,7 +332,7 @@ def test_resolve_boolean_details_uses_enabled_when_use_boolean_config_value_is_f
)

# When
result = provider.resolve_boolean_details(key=key, default_value=False)
result = provider.resolve_boolean_details(flag_key=key, default_value=False)

# Then
assert result.value is True
Expand Down