Migrate Python SDK to use V2 Randomization Endpoint (#13)

* Update to use new test data

* Use V2 Randomization Endpoint

* Log when no assigned variation

* Update GH action for tests

* remove conftest.py

* experiment_key -> flag_key

* bump version

Author: ploomiz

.github/workflows/test-and-lint-sdk.yml

@@ -60,6 +60,7 @@ jobs:
           python -m pip install --upgrade pip setuptools wheel
           python -m pip install -r requirements.txt
           python -m pip install -r requirements-test.txt
-      - name: "Run tox tests"
-        run: |
-          tox
+      - name: 'Set up GCP SDK to download test data'
+        uses: 'google-github-actions/setup-gcloud@v0'
+      - name: "Run tests"
+        run: make test

Makefile

@@ -0,0 +1,37 @@
+# Make settings - @see https://tech.davis-hansson.com/p/make/
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+
+# Log levels
+DEBUG := $(shell printf "\e[2D\e[35m")
+INFO  := $(shell printf "\e[2D\e[36m🔵 ")
+OK    := $(shell printf "\e[2D\e[32m🟢 ")
+WARN  := $(shell printf "\e[2D\e[33m🟡 ")
+ERROR := $(shell printf "\e[2D\e[31m🔴 ")
+END   := $(shell printf "\e[0m")
+
+.PHONY: default
+default: help
+
+## help - Print help message.
+.PHONY: help
+help: Makefile
+	@echo "usage: make <target>"
+	@sed -n 's/^##//p' $<
+
+## test-data
+testDataDir := test/test-data/
+.PHONY: test-data
+test-data:
+	rm -rf $(testDataDir)
+	mkdir -p $(testDataDir)
+	gsutil cp gs://sdk-test-data/rac-experiments-v2.json $(testDataDir)
+	gsutil cp -r gs://sdk-test-data/assignment-v2 $(testDataDir)
+
+.PHONY: test
+test: test-data
+	tox .

eppo_client/__init__.py

@@ -10,7 +10,7 @@
 from eppo_client.http_client import HttpClient, SdkParams
 from eppo_client.read_write_lock import ReadWriteLock
 
-__version__ = "1.0.4"
+__version__ = "1.1.0"
 
 __client: Optional[EppoClient] = None
 __lock = ReadWriteLock()

eppo_client/client.py

@@ -1,15 +1,15 @@
 import hashlib
 import datetime
 import logging
-from typing import List, Optional
+from typing import Optional
 from eppo_client.assignment_logger import AssignmentLogger
 from eppo_client.configuration_requestor import (
     ExperimentConfigurationDto,
     ExperimentConfigurationRequestor,
 )
 from eppo_client.constants import POLL_INTERVAL_MILLIS, POLL_JITTER_MILLIS
 from eppo_client.poller import Poller
-from eppo_client.rules import Rule, matches_any_rule
+from eppo_client.rules import find_matching_rule
 from eppo_client.shard import get_shard, is_in_shard_range
 from eppo_client.validation import validate_not_blank
 
@@ -32,47 +32,65 @@ def __init__(
         self.__poller.start()
 
     def get_assignment(
-        self, subject_key: str, experiment_key: str, subject_attributes=dict()
+        self, subject_key: str, flag_key: str, subject_attributes=dict()
     ) -> Optional[str]:
         """Maps a subject to a variation for a given experiment
         Returns None if the subject is not part of the experiment sample.
 
         :param subject_key: an identifier of the experiment subject, for example a user ID.
-        :param experiment_key: an experiment identifier
+        :param flag_key: an experiment or feature flag identifier
         :param subject_attributes: optional attributes associated with the subject, for example name and email.
         The subject attributes are used for evaluating any targeting rules tied to the experiment.
         """
         validate_not_blank("subject_key", subject_key)
-        validate_not_blank("experiment_key", experiment_key)
-        experiment_config = self.__config_requestor.get_configuration(experiment_key)
+        validate_not_blank("flag_key", flag_key)
+        experiment_config = self.__config_requestor.get_configuration(flag_key)
         override = self._get_subject_variation_override(experiment_config, subject_key)
         if override:
             return override
-        if (
-            experiment_config is None
-            or not experiment_config.enabled
-            or not self._subject_attributes_satisfy_rules(
-                subject_attributes, experiment_config.rules
+
+        if experiment_config is None or not experiment_config.enabled:
+            logger.info(
+                "[Eppo SDK] No assigned variation. No active experiment or flag for key: "
+                + flag_key
             )
-            or not self._is_in_experiment_sample(
-                subject_key, experiment_key, experiment_config
+            return None
+
+        matched_rule = find_matching_rule(subject_attributes, experiment_config.rules)
+        if matched_rule is None:
+            logger.info(
+                "[Eppo SDK] No assigned variation. Subject attributes do not match targeting rules: {0}".format(
+                    subject_attributes
+                )
             )
+            return None
+
+        allocation = experiment_config.allocations[matched_rule.allocation_key]
+        if not self._is_in_experiment_sample(
+            subject_key,
+            flag_key,
+            experiment_config.subject_shards,
+            allocation.percent_exposure,
         ):
+            logger.info(
+                "[Eppo SDK] No assigned variation. Subject is not part of experiment sample population"
+            )
             return None
+
         shard = get_shard(
-            "assignment-{}-{}".format(subject_key, experiment_key),
+            "assignment-{}-{}".format(subject_key, flag_key),
             experiment_config.subject_shards,
         )
         assigned_variation = next(
             (
-                variation.name
-                for variation in experiment_config.variations
+                variation.value
+                for variation in allocation.variations
                 if is_in_shard_range(shard, variation.shard_range)
             ),
             None,
         )
         assignment_event = {
-            "experiment": experiment_key,
+            "experiment": flag_key,
             "variation": assigned_variation,
             "subject": subject_key,
             "timestamp": datetime.datetime.utcnow().isoformat(),
@@ -84,13 +102,6 @@ def get_assignment(
             logger.error("[Eppo SDK] Error logging assignment event: " + str(e))
         return assigned_variation
 
-    def _subject_attributes_satisfy_rules(
-        self, subject_attributes: dict, rules: List[Rule]
-    ) -> bool:
-        if len(rules) == 0:
-            return True
-        return matches_any_rule(subject_attributes, rules)
-
     def _shutdown(self):
         """Stops all background processes used by the client
         Do not use the client after calling this method.
@@ -112,13 +123,11 @@ def _is_in_experiment_sample(
         self,
         subject: str,
         experiment_key: str,
-        experiment_config: ExperimentConfigurationDto,
+        subject_shards: int,
+        percent_exposure: float,
     ):
         shard = get_shard(
             "exposure-{}-{}".format(subject, experiment_key),
-            experiment_config.subject_shards,
-        )
-        return (
-            shard
-            <= experiment_config.percent_exposure * experiment_config.subject_shards
+            subject_shards,
         )
+        return shard <= percent_exposure * subject_shards

eppo_client/configuration_requestor.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Dict, List, Optional, cast
+from typing import Any, Dict, List, Optional, cast
 from eppo_client.base_model import SdkBaseModel
 from eppo_client.configuration_store import ConfigurationStore
 from eppo_client.http_client import HttpClient, HttpRequestError
@@ -12,20 +12,25 @@
 
 class VariationDto(SdkBaseModel):
     name: str
+    value: Any
     shard_range: ShardRange
 
 
+class AllocationDto(SdkBaseModel):
+    percent_exposure: float
+    variations: List[VariationDto]
+
+
 class ExperimentConfigurationDto(SdkBaseModel):
     subject_shards: int
-    percent_exposure: float
     enabled: bool
-    variations: List[VariationDto]
     name: Optional[str]
     overrides: Dict[str, str] = {}
     rules: List[Rule] = []
+    allocations: Dict[str, AllocationDto]
 
 
-RAC_ENDPOINT = "/randomized_assignment/config"
+RAC_ENDPOINT = "/randomized_assignment/v2/config"
 
 
 class ExperimentConfigurationRequestor:
@@ -46,9 +51,7 @@ def get_configuration(
 
     def fetch_and_store_configurations(self) -> Dict[str, ExperimentConfigurationDto]:
         try:
-            configs = cast(
-                dict, self.__http_client.get(RAC_ENDPOINT).get("experiments", {})
-            )
+            configs = cast(dict, self.__http_client.get(RAC_ENDPOINT).get("flags", {}))
             for exp_key, exp_config in configs.items():
                 configs[exp_key] = ExperimentConfigurationDto(**exp_config)
             self.__config_store.set_configurations(configs)

eppo_client/rules.py

@@ -23,14 +23,15 @@ class Condition(SdkBaseModel):
 
 
 class Rule(SdkBaseModel):
+    allocation_key: str
     conditions: List[Condition]
 
 
-def matches_any_rule(subject_attributes: dict, rules: List[Rule]):
+def find_matching_rule(subject_attributes: dict, rules: List[Rule]):
     for rule in rules:
         if matches_rule(subject_attributes, rule):
-            return True
-    return False
+            return rule
+    return None
 
 
 def matches_rule(subject_attributes: dict, rule: Rule):

requirements-test.txt

@@ -1,5 +1,4 @@
 tox
 pytest
 mypy
-google-cloud-storage
 httpretty