Skip to content

fix: validate-returns-empty-trait-list-if-persistence-false #5398

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

Closed
wants to merge 5 commits into from
Closed
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
4 changes: 1 addition & 3 deletions api/environments/sdk/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,5 @@ def save(self, **kwargs): # type: ignore[no-untyped-def]
def validate_traits(self, traits: typing.List[dict] = None): # type: ignore[no-untyped-def,type-arg,assignment]
request = self.context["request"]
if traits and not request.environment.trait_persistence_allowed(request):
raise serializers.ValidationError(
"Setting traits not allowed with client key."
)
return []
return traits
31 changes: 31 additions & 0 deletions api/tests/unit/environments/sdk/test_unit_sdk_serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,34 @@ def test_identify_with_traits_serializer__transient__identity_and_traits_not_per
# Then
assert not Identity.objects.filter(identifier=identity_identifier).exists()
assert not Trait.objects.filter(identity__identifier=identity_identifier).exists()


def test_identify_with_traits_serializer_validate_traits_returns_empty_list_when_persistence_not_allowed(
mocker: MockerFixture,
environment: Environment,
) -> None:
# Given
data = {
"identifier": "test_user",
"traits": [
{"trait_key": "key1", "trait_value": "value1"},
{"trait_key": "key2", "trait_value": "value2"},
],
}

environment.allow_client_traits = False
environment.save()

mock_request = mocker.MagicMock()
mock_request.environment = environment

serializer = IdentifyWithTraitsSerializer(
data=data, context={"environment": environment, "request": mock_request}
)

# When
serializer.is_valid()
validated_traits = serializer.validated_data.get("traits")

# Then
assert validated_traits == []