Skip to content
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

Add triggers to filter #81

Merged
merged 4 commits into from
Sep 6, 2024
Merged
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
22 changes: 17 additions & 5 deletions src/epstats/server/req.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,18 +153,30 @@ class Filter(BaseModel):
Filter specification for data to evaluate.
"""

dimension: str = Field(..., title="Name of the dimension")

value: List[Any] = Field(..., title="List of possible values")

scope: FilterScope = Field(
...,
title="Scope of the filter",
description="Scope of the filter is either `exposure` or `goal`.",
)

dimension: Optional[str] = Field(None, title="Name of the dimension")

value: Optional[List[Any]] = Field(None, title="List of possible values")

goal: Optional[str] = Field(None, title="Specify goals if filter scope is `trigger`")

@model_validator(mode="after")
def check_trigger(self):
if self.scope == FilterScope.trigger:
if not self.goal:
raise ValueError("Goal is required for scope 'trigger'")
else:
if not (self.dimension and self.value):
raise ValueError("Dimension and value are required for this scope")
return self

def to_filter(self):
return EvFilter(self.dimension, self.value, self.scope)
return EvFilter(self.scope, self.dimension, self.value, self.goal)


class Experiment(BaseModel):
Expand Down
14 changes: 12 additions & 2 deletions src/epstats/toolkit/experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ class FilterScope(str, Enum):

exposure = "exposure"
goal = "goal"
trigger = "trigger"


@dataclass
Expand All @@ -120,9 +121,18 @@ class Filter:
Filter specification for data to evaluate.
"""

dimension: str
value: List[Any]
scope: FilterScope
dimension: Optional[str] = None
value: Optional[List[Any]] = None
goal: Optional[str] = None

def __post_init__(self):
if self.scope == FilterScope.trigger:
if not self.goal:
raise ValueError("Trigger scope requires goal")
else:
if not (self.dimension and self.value):
raise ValueError("Dimension and value are required for this scope")


class Experiment:
Expand Down
57 changes: 57 additions & 0 deletions tests/epstats/server/test_req.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,3 +257,60 @@ def test_validate_date_for_between_date_to_and_date_for():
json = resp.json()
assert json["detail"][0]["loc"][0] == "body"
assert json["detail"][0]["type"] == "value_error"


def test_filter_scope_trigger_empty_goal():
json_blob = {
"id": "test-trigger",
"control_variant": "a",
"variants": ["a", "b"],
"unit_type": "test_unit_type",
"filters": [
{"dimension": "element", "value": ["button-1"], "scope": "trigger"},
],
"metrics": [],
"checks": [],
}

resp = client.post("/evaluate", json=json_blob)
assert resp.status_code == 422
json = resp.json()
assert json["detail"][0]["loc"][0] == "body"
assert json["detail"][0]["type"] == "value_error"


def test_filter_scope_trigger_empty_dimension():
json_blob = {
"id": "test-trigger",
"control_variant": "a",
"variants": ["a", "b"],
"unit_type": "test_unit_type",
"filters": [
{"dimension": None, "value": [], "scope": "trigger", "goal": "view"},
],
"metrics": [],
"checks": [],
}

resp = client.post("/evaluate", json=json_blob)
assert resp.status_code == 200


def test_filter_scope_exposure_empty_dimension():
json_blob = {
"id": "test-trigger",
"control_variant": "a",
"variants": ["a", "b"],
"unit_type": "test_unit_type",
"filters": [
{"dimension": None, "value": [], "scope": "exposure"},
],
"metrics": [],
"checks": [],
}

resp = client.post("/evaluate", json=json_blob)
assert resp.status_code == 422
json = resp.json()
assert json["detail"][0]["loc"][0] == "body"
assert json["detail"][0]["type"] == "value_error"
2 changes: 1 addition & 1 deletion tests/epstats/toolkit/test_experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ def test_filter_scope_goal(dao, metrics, checks, unit_type):
[SrmCheck(1, "SRM", "count(test_unit_type.global.exposure)")],
unit_type=unit_type,
variants=["a", "b"],
filters=[Filter("element", ["button-1"], FilterScope.goal)],
filters=[Filter(FilterScope.goal, "element", ["button-1"])],
)
evaluate_experiment_agg(experiment, dao)

Expand Down
Loading