Skip to content

Commit

Permalink
Read from new category count model
Browse files Browse the repository at this point in the history
  • Loading branch information
@rowanseymour
rowanseymour committed Jan 10, 2025
1 parent c899105 commit bc2540c
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 250 deletions.
7 changes: 3 additions & 4 deletions temba/flows/models.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -395,21 +395,20 @@ def get_category_counts(self):
results_by_key = {r["key"]: r for r in self.metadata["results"]}

counts = (
self.category_counts.filter(result_key__in=results_by_key)
.values("result_key", "category_name")
self.result_counts.filter(result__in=results_by_key)
.values("result", "category")
.annotate(total=Sum("count"))
)

# organize into dict of results keys to dicts of category names to counts
counts_by_key = defaultdict(dict)
for count in counts:
counts_by_key[count["result_key"]][count["category_name"]] = count["total"]
counts_by_key[count["result"]][count["category"]] = count["total"]

results = []
for result_key, result in results_by_key.items():
category_counts = counts_by_key.get(result_key, {})

# TODO maybe we shouldn't store All Responses in the first place
if not category_counts or (len(category_counts) == 1 and "All Responses" in category_counts):
continue

Expand Down
258 changes: 52 additions & 206 deletions temba/flows/tests/test_flow.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
from temba.contacts.models import URN, ContactField, ContactGroup
from temba.flows.models import (
Flow,
FlowCategoryCount,
FlowRun,
FlowSession,
FlowStart,
FlowStartCount,
Expand Down Expand Up @@ -346,215 +344,63 @@ def assertCount(counts, result_key, category_name, truth):
self.assertEqual(category["count"], truth)
self.assertTrue(found)

favorites = self.get_flow("favorites_v13")
flow_nodes = favorites.get_definition()["nodes"]
color_prompt = flow_nodes[0]
color_other = flow_nodes[1]
color_split = flow_nodes[2]
beer_prompt = flow_nodes[3]
beer_split = flow_nodes[5]
name_prompt = flow_nodes[6]
name_split = flow_nodes[7]

# add in some fake data
for i in range(0, 10):
contact = self.create_contact("Contact %d" % i, phone="+120655530%d" % i)
(
MockSessionWriter(contact, favorites)
.visit(color_prompt)
.send_msg("What is your favorite color?", self.channel)
.visit(color_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "blue"))
.set_result("Color", "blue", "Blue", "blue")
.visit(beer_prompt)
.send_msg("Good choice, I like Blue too! What is your favorite beer?", self.channel)
.visit(beer_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "primus"))
.set_result("Beer", "primus", "Primus", "primus")
.visit(name_prompt)
.send_msg("Lastly, what is your name?", self.channel)
.visit(name_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "russell"))
.set_result("Name", "russell", "All Responses", "russell")
.complete()
.save()
)

for i in range(0, 5):
contact = self.create_contact("Contact %d" % i, phone="+120655531%d" % i)
(
MockSessionWriter(contact, favorites)
.visit(color_prompt)
.send_msg("What is your favorite color?", self.channel)
.visit(color_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "red"))
.set_result("Color", "red", "Red", "red")
.visit(beer_prompt)
.send_msg("Good choice, I like Red too! What is your favorite beer?", self.channel)
.visit(beer_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "primus"))
.set_result("Beer", "primus", "Primus", "primus")
.visit(name_prompt)
.send_msg("Lastly, what is your name?", self.channel)
.visit(name_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "earl"))
.set_result("Name", "earl", "All Responses", "earl")
.complete()
.save()
)

# test update flow values
for i in range(0, 5):
contact = self.create_contact("Contact %d" % i, phone="+120655532%d" % i)
(
MockSessionWriter(contact, favorites)
.visit(color_prompt)
.send_msg("What is your favorite color?", self.channel)
.visit(color_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "orange"))
.set_result("Color", "orange", "Other", "orange")
.visit(color_other)
.send_msg("I don't know that one, try again please.", self.channel)
.visit(color_split)
.wait()
.save()
.resume(msg=self.create_incoming_msg(contact, "green"))
.set_result("Color", "green", "Green", "green")
.visit(beer_prompt)
.send_msg("Good choice, I like Green too! What is your favorite beer?", self.channel)
.visit(beer_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "skol"))
.set_result("Beer", "skol", "Skol", "skol")
.visit(name_prompt)
.send_msg("Lastly, what is your name?", self.channel)
.visit(name_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "bobby"))
.set_result("Name", "bobby", "All Responses", "bobby")
.complete()
.save()
)

counts = favorites.get_category_counts()

assertCount(counts, "color", "Blue", 10)
assertCount(counts, "color", "Red", 5)
assertCount(counts, "beer", "Primus", 15)
flow = self.create_flow("Favorites")
flow.metadata = {
"results": [
{"key": "color", "name": "Color", "categories": ["Red", "Blue", "Green", "Other"]},
{"key": "beer", "name": "Beer", "categories": ["Primus" "Mutzig", "Turbo King", "Skol", "Other"]},
{"key": "name", "name": "Name", "categories": ["All Responses"]},
]
}
flow.save(update_fields=("metadata",))

flow.result_counts.create(result="color", category="Blue", count=10)
flow.result_counts.create(result="beer", category="Primus", count=10)
flow.result_counts.create(result="name", category="All Responses", count=10)

flow.result_counts.create(result="color", category="Red", count=5)
flow.result_counts.create(result="beer", category="Primus", count=5)
flow.result_counts.create(result="name", category="All Responses", count=5)

flow.result_counts.create(result="color", category="Other", count=5)
flow.result_counts.create(result="color", category="Other", count=-5)
flow.result_counts.create(result="color", category="Green", count=5)
flow.result_counts.create(result="beer", category="Skol", count=5)
flow.result_counts.create(result="name", category="All Responses", count=5)

# categories can be empty (e.g. set_run_result)
flow.result_counts.create(result="color", category="", count=5)

# name shouldn't be included since it's open ended
self.assertNotIn('"name": "Name"', json.dumps(counts))

# five oranges went back and became greens
assertCount(counts, "color", "Other", 0)
assertCount(counts, "color", "Green", 5)

# now remap the uuid for our color node
flow_json = favorites.get_definition()
flow_json = json.loads(json.dumps(flow_json).replace(color_split["uuid"], str(uuid4())))
flow_nodes = flow_json["nodes"]
color_prompt = flow_nodes[0]
color_other = flow_nodes[1]
color_split = flow_nodes[2]

favorites.save_revision(self.admin, flow_json)

# send a few more runs through our updated flow
for i in range(0, 3):
contact = self.create_contact("Contact %d" % i, phone="+120655533%d" % i)
(
MockSessionWriter(contact, favorites)
.visit(color_prompt)
.send_msg("What is your favorite color?", self.channel)
.visit(color_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "red"))
.set_result("Color", "red", "Red", "red")
.visit(beer_prompt)
.send_msg("Good choice, I like Red too! What is your favorite beer?", self.channel)
.visit(beer_split)
.wait()
.resume(msg=self.create_incoming_msg(contact, "turbo"))
.set_result("Beer", "turbo", "Turbo King", "turbo")
.visit(name_prompt)
.wait()
.save()
)

# should now have three more reds
counts = favorites.get_category_counts()
assertCount(counts, "color", "Red", 8)
assertCount(counts, "beer", "Turbo King", 3)

# now delete the color split and repoint nodes to the beer split
flow_json["nodes"].pop(2)
for node in flow_json["nodes"]:
for exit in node["exits"]:
if exit.get("destination_uuid") == color_split["uuid"]:
exit["destination_uuid"] = beer_split["uuid"]

favorites.save_revision(self.admin, flow_json)

# now the color counts have been removed, but beer is still there
counts = favorites.get_category_counts()
self.assertEqual(["beer"], [c["key"] for c in counts])
assertCount(counts, "beer", "Turbo King", 3)
expected = [
{
"key": "color",
"name": "Color",
"categories": [
{"name": "", "count": 5, "pct": 0.2},
{"name": "Blue", "count": 10, "pct": 0.4},
{"name": "Green", "count": 5, "pct": 0.2},
{"name": "Other", "count": 0, "pct": 0.0},
{"name": "Red", "count": 5, "pct": 0.2},
],
"total": 25,
},
{
"key": "beer",
"name": "Beer",
"categories": [
{"name": "Primus", "count": 15, "pct": 0.75},
{"name": "Skol", "count": 5, "pct": 0.25},
],
"total": 20,
},
]
self.assertEqual(expected, flow.get_category_counts())

# make sure it still works after ze squashings
self.assertEqual(76, FlowCategoryCount.objects.all().count())
# check no change after squashing
squash_flow_counts()
self.assertEqual(9, FlowCategoryCount.objects.all().count())
counts = favorites.get_category_counts()
assertCount(counts, "beer", "Turbo King", 3)

# test tostring
str(FlowCategoryCount.objects.all().first())

# and if we delete our runs, things zero out
for run in FlowRun.objects.all():
run.delete()

counts = favorites.get_category_counts()
assertCount(counts, "beer", "Turbo King", 0)

def test_category_counts_with_null_categories(self):
flow = self.get_flow("color_v13")
flow_nodes = flow.get_definition()["nodes"]
color_prompt = flow_nodes[0]
color_split = flow_nodes[4]

msg = self.create_incoming_msg(self.contact, "blue")
run = (
MockSessionWriter(self.contact, flow)
.visit(color_prompt)
.send_msg("What is your favorite color?", self.channel)
.visit(color_split)
.wait()
.resume(msg=msg)
.set_result("Color", "blue", "Blue", "blue")
.complete()
.save()
).session.runs.get()

FlowCategoryCount.objects.get(category_name="Blue", result_name="Color", result_key="color", count=1)

# get our run and clear the category
run = FlowRun.objects.get(flow=flow, contact=self.contact)
results = run.results
del results["color"]["category"]
results["color"]["created_on"] = timezone.now()
run.save(update_fields=["results", "modified_on"])

# should have added a negative one now
self.assertEqual(2, FlowCategoryCount.objects.filter(category_name="Blue", result_name="Color").count())
FlowCategoryCount.objects.get(category_name="Blue", result_name="Color", result_key="color", count=-1)
self.assertEqual(expected, flow.get_category_counts())

def test_start_counts(self):
# create start for 10 contacts
Expand Down
32 changes: 4 additions & 28 deletions temba/flows/tests/test_flowcrudl.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1402,34 +1402,10 @@ def test_category_counts(self):
flow1.metadata["results"] = [{"key": "color", "name": "Color"}, {"key": "beer", "name": "Beer"}]
flow1.save(update_fields=("metadata",))

flow1.category_counts.create(
node_uuid="9b00751c-0d46-4e5f-86b1-7ccfae76ea10",
result_key="color",
result_name="Color",
category_name="Red",
count=3,
)
flow1.category_counts.create(
node_uuid="9b00751c-0d46-4e5f-86b1-7ccfae76ea10",
result_key="color",
result_name="Color",
category_name="Blue",
count=2,
)
flow1.category_counts.create(
node_uuid="9b00751c-0d46-4e5f-86b1-7ccfae76ea10",
result_key="color",
result_name="Color",
category_name="Other",
count=1,
)
flow1.category_counts.create(
node_uuid="300fd49b-c69d-4e8c-aba9-b6036d0b83d9",
result_key="beer",
result_name="Beer",
category_name="Primus",
count=7,
)
flow1.result_counts.create(result="color", category="Red", count=3)
flow1.result_counts.create(result="color", category="Blue", count=2)
flow1.result_counts.create(result="color", category="Other", count=1)
flow1.result_counts.create(result="beer", category="Primus", count=7)

response = self.assertReadFetch(counts_url, [self.user, self.editor, self.admin])
self.assertEqual(
Expand Down
12 changes: 0 additions & 12 deletions temba/flows/tests/test_run.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,6 @@ def _check_deletion(self, by_archiver: bool, expected: dict, session_completed=T
else:
run.delete() # delete_from_counts updated to true

cat_counts = {c["key"]: c for c in flow.get_category_counts()}

self.assertEqual(2, len(cat_counts))
self.assertEqual(expected["red_count"], cat_counts["color"]["categories"][0]["count"])
self.assertEqual(expected["primus_count"], cat_counts["color"]["categories"][0]["count"])

self.assertEqual(expected["start_count"], FlowStartCount.get_count(start))
self.assertEqual(expected["run_count"], flow.get_run_stats())

Expand All @@ -260,8 +254,6 @@ def test_delete_by_user_with_complete_session(self, mock_queue_interrupt):
self._check_deletion(
by_archiver=False,
expected={
"red_count": 0,
"primus_count": 0,
"start_count": 1, # unchanged
"run_count": {
"total": 0,
Expand All @@ -284,8 +276,6 @@ def test_delete_by_user_without_complete_session(self, mock_queue_interrupt):
self._check_deletion(
by_archiver=False,
expected={
"red_count": 0,
"primus_count": 0,
"start_count": 1, # unchanged
"run_count": {
"total": 0,
Expand All @@ -309,8 +299,6 @@ def test_delete_by_archiver(self, mock_queue_interrupt):
self._check_deletion(
by_archiver=True,
expected={
"red_count": 1,
"primus_count": 1,
"start_count": 1, # unchanged
"run_count": { # unchanged
"total": 1,
Expand Down

0 comments on commit bc2540c

Please sign in to comment.