transient identifier based on traits, enforce transient traits for all identities, improve typing

Author: khvn26

api/environments/identities/traits/fields.py

@@ -1,11 +1,13 @@
 import logging
+from typing import Any
 
 from rest_framework import serializers
 
 from environments.identities.traits.constants import (
     ACCEPTED_TRAIT_VALUE_TYPES,
     TRAIT_STRING_VALUE_MAX_LENGTH,
 )
+from environments.sdk.types import SDKTraitValueData
 from features.value_types import STRING
 
 logger = logging.getLogger(__name__)
@@ -16,7 +18,7 @@ class TraitValueField(serializers.Field):
     Custom field to extract the type of the field on deserialization.
     """
 
-    def to_internal_value(self, data):
+    def to_internal_value(self, data: Any) -> SDKTraitValueData:
         data_type = type(data).__name__
 
         if data_type not in ACCEPTED_TRAIT_VALUE_TYPES:
@@ -28,7 +30,7 @@ def to_internal_value(self, data):
             )
         return {"type": data_type, "value": data}
 
-    def to_representation(self, value):
+    def to_representation(self, value: Any) -> Any:
         return_value = value.get("value") if isinstance(value, dict) else value
 
         if return_value is None:

api/environments/sdk/services.py

@@ -1,5 +1,6 @@
-import uuid
+import hashlib
 from itertools import chain
+from operator import itemgetter
 from typing import TypeAlias
 
 from django.utils import timezone
@@ -18,15 +19,16 @@ def get_transient_identity_and_traits(
 ) -> IdentityAndTraits:
     """
     Get a transient `Identity` instance with a randomly generated identifier.
+    All traits are marked as transient.
     """
     return (
         (
             identity := _get_transient_identity(
                 environment=environment,
-                identifier=str(uuid.uuid4()),
+                identifier=get_transient_identifier(sdk_trait_data),
             )
         ),
-        identity.generate_traits(sdk_trait_data, persist=False),
+        identity.generate_traits(_ensure_transient(sdk_trait_data), persist=False),
     )
 
 
@@ -41,8 +43,7 @@ def get_identified_transient_identity_and_traits(
     combined with incoming traits provided to `sdk_trait_data` argument.
     All traits constructed from `sdk_trait_data` are marked as transient.
     """
-    for sdk_trait_data_item in sdk_trait_data:
-        sdk_trait_data_item["transient"] = True
+    sdk_trait_data = _ensure_transient(sdk_trait_data)
     if identity := Identity.objects.filter(
         environment=environment,
         identifier=identifier,
@@ -89,6 +90,16 @@ def get_persisted_identity_and_traits(
     )
 
 
+def get_transient_identifier(sdk_trait_data: list[SDKTraitData]) -> str:
+    return hashlib.sha256(
+        "".join(
+            f'{trait["trait_key"]}{trait["trait_value"]["value"]}'
+            for trait in sorted(sdk_trait_data, key=itemgetter("trait_key"))
+        ).encode(),
+        usedforsecurity=False,
+    ).hexdigest()
+
+
 def _get_transient_identity(
     environment: Environment,
     identifier: str,
@@ -98,3 +109,9 @@ def _get_transient_identity(
         environment=environment,
         identifier=identifier,
     )
+
+
+def _ensure_transient(sdk_trait_data: list[SDKTraitData]) -> list[SDKTraitData]:
+    for sdk_trait_data_item in sdk_trait_data:
+        sdk_trait_data_item["transient"] = True
+    return sdk_trait_data

api/environments/sdk/types.py

@@ -3,7 +3,12 @@
 from typing_extensions import NotRequired
 
 
+class SDKTraitValueData(typing.TypedDict):
+    type: str
+    value: str
+
+
 class SDKTraitData(typing.TypedDict):
     trait_key: str
-    trait_value: typing.Any
+    trait_value: SDKTraitValueData
     transient: NotRequired[bool]

api/tests/integration/environments/identities/test_integration_identities.py

@@ -1,11 +1,11 @@
+import hashlib
 import json
 from typing import Any, Generator
 from unittest import mock
 
 import pytest
 from django.urls import reverse
 from pytest_lazyfixture import lazy_fixture
-from pytest_mock import MockerFixture
 from rest_framework import status
 from rest_framework.test import APIClient
 
@@ -236,12 +236,13 @@ def existing_identity_identifier_data(
 
 
 @pytest.fixture
-def transient_random_identifier(
-    mocker: MockerFixture,
+def transient_identifier(
+    segment_condition_property: str,
+    segment_condition_value: str,
 ) -> Generator[str, None, None]:
-    uuid_mock = mocker.patch("environments.sdk.services.uuid", autospec=True)
-    uuid_mock.uuid4.return_value = identifier = "1199c22c-4dcb-4505-9857-5db5f258469c"
-    yield identifier
+    return hashlib.sha256(
+        f"avalue_a{segment_condition_property}{segment_condition_value}".encode()
+    ).hexdigest()
 
 
 @pytest.mark.parametrize(
@@ -263,17 +264,15 @@ def transient_random_identifier(
         pytest.param({"identifier": "unseen"}, "unseen", id="new-identifier"),
         pytest.param(
             {"identifier": ""},
-            lazy_fixture("transient_random_identifier"),
+            lazy_fixture("transient_identifier"),
             id="blank-identifier",
         ),
         pytest.param(
             {"identifier": None},
-            lazy_fixture("transient_random_identifier"),
+            lazy_fixture("transient_identifier"),
             id="null-identifier",
         ),
-        pytest.param(
-            {}, lazy_fixture("transient_random_identifier"), id="missing-identifier"
-        ),
+        pytest.param({}, lazy_fixture("transient_identifier"), id="missing-identifier"),
     ],
 )
 def test_get_feature_states_for_identity__segment_match_expected(
@@ -303,7 +302,8 @@ def test_get_feature_states_for_identity__segment_match_expected(
                     {
                         "trait_key": segment_condition_property,
                         "trait_value": segment_condition_value,
-                    }
+                    },
+                    {"trait_key": "a", "trait_value": "value_a"},
                 ],
             }
         ),