def test_funnel_exclusions_invalid_params(self):
filters = {
"events": [
{
"id": "user signed up",
"type": "events",
"order": 0
},
{
"id": "paid",
"type": "events",
"order": 1
},
{
"id": "blah",
"type": "events",
"order": 2
},
],
"insight":
INSIGHT_FUNNELS,
"funnel_window_days":
14,
"exclusions": [
{
"id": "x",
"type": "events",
"funnel_from_step": 1,
"funnel_to_step": 1
},
],
}
filter = Filter(data=filters)
self.assertRaises(
ValidationError,
lambda: ClickhouseFunnelUnordered(filter, self.team).run())
# partial windows not allowed for unordered
filter = filter.with_data({
"exclusions": [{
"id": "x",
"type": "events",
"funnel_from_step": 0,
"funnel_to_step": 1
}]
})
self.assertRaises(
ValidationError,
lambda: ClickhouseFunnelUnordered(filter, self.team).run())
def test_single_event_unordered_funnel(self):
filter = Filter(
data={
"insight": INSIGHT_FUNNELS,
"events": [
{
"id": "user signed up",
"order": 0
},
],
"date_from": "2021-05-01 00:00:00",
"date_to": "2021-05-07 23:59:59",
})
funnel = ClickhouseFunnelUnordered(filter, self.team)
person1_stopped_after_signup = _create_person(
distinct_ids=["stopped_after_signup1"], team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_signup1",
timestamp="2021-05-02 00:00:00")
person2_stopped_after_one_pageview = _create_person(
distinct_ids=["stopped_after_pageview1"], team_id=self.team.pk)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_pageview1",
timestamp="2021-05-02 00:00:00")
_create_event(
team=self.team,
event="user signed up",
distinct_id="stopped_after_pageview1",
timestamp="2021-05-02 01:00:00",
)
result = funnel.run()
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[0]["count"], 2)
def test_advanced_funnel_multiple_exclusions_between_steps(self):
filters = {
"events": [
{
"id": "user signed up",
"type": "events",
"order": 0
},
{
"id": "$pageview",
"type": "events",
"order": 1
},
{
"id": "insight viewed",
"type": "events",
"order": 2
},
{
"id": "invite teammate",
"type": "events",
"order": 3
},
{
"id": "pageview2",
"type": "events",
"order": 4
},
],
"date_from":
"2021-05-01 00:00:00",
"date_to":
"2021-05-14 00:00:00",
"insight":
INSIGHT_FUNNELS,
"exclusions": [
{
"id": "x",
"type": "events",
"funnel_from_step": 0,
"funnel_to_step": 4
},
{
"id": "y",
"type": "events",
"funnel_from_step": 0,
"funnel_to_step": 4
},
],
}
person1 = _create_person(distinct_ids=["person1"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person1",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person1",
timestamp="2021-05-01 02:00:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="person1",
timestamp="2021-05-01 03:00:00")
_create_event(team=self.team,
event="insight viewed",
distinct_id="person1",
timestamp="2021-05-01 04:00:00")
_create_event(team=self.team,
event="y",
distinct_id="person1",
timestamp="2021-05-01 04:30:00")
_create_event(team=self.team,
event="invite teammate",
distinct_id="person1",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="pageview2",
distinct_id="person1",
timestamp="2021-05-01 06:00:00")
person2 = _create_person(distinct_ids=["person2"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person2",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="y",
distinct_id="person2",
timestamp="2021-05-01 01:30:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="person2",
timestamp="2021-05-01 02:00:00")
_create_event(team=self.team,
event="insight viewed",
distinct_id="person2",
timestamp="2021-05-01 04:00:00")
_create_event(team=self.team,
event="y",
distinct_id="person2",
timestamp="2021-05-01 04:30:00")
_create_event(team=self.team,
event="invite teammate",
distinct_id="person2",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person2",
timestamp="2021-05-01 05:30:00")
_create_event(team=self.team,
event="pageview2",
distinct_id="person2",
timestamp="2021-05-01 06:00:00")
person3 = _create_person(distinct_ids=["person3"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person3",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person3",
timestamp="2021-05-01 01:30:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="person3",
timestamp="2021-05-01 02:00:00")
_create_event(team=self.team,
event="insight viewed",
distinct_id="person3",
timestamp="2021-05-01 04:00:00")
_create_event(team=self.team,
event="invite teammate",
distinct_id="person3",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person3",
timestamp="2021-05-01 05:30:00")
_create_event(team=self.team,
event="pageview2",
distinct_id="person3",
timestamp="2021-05-01 06:00:00")
person4 = _create_person(distinct_ids=["person4"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person4",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="person4",
timestamp="2021-05-01 02:00:00")
_create_event(team=self.team,
event="insight viewed",
distinct_id="person4",
timestamp="2021-05-01 04:00:00")
_create_event(team=self.team,
event="invite teammate",
distinct_id="person4",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="pageview2",
distinct_id="person4",
timestamp="2021-05-01 06:00:00")
person5 = _create_person(distinct_ids=["person5"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person5",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person5",
timestamp="2021-05-01 01:30:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="person5",
timestamp="2021-05-01 02:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person5",
timestamp="2021-05-01 02:30:00")
_create_event(team=self.team,
event="insight viewed",
distinct_id="person5",
timestamp="2021-05-01 04:00:00")
_create_event(team=self.team,
event="y",
distinct_id="person5",
timestamp="2021-05-01 04:30:00")
_create_event(team=self.team,
event="invite teammate",
distinct_id="person5",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person5",
timestamp="2021-05-01 05:30:00")
_create_event(team=self.team,
event="pageview2",
distinct_id="person5",
timestamp="2021-05-01 06:00:00")
filter = Filter(data=filters)
funnel = ClickhouseFunnelUnordered(filter, self.team)
result = funnel.run()
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[0]["count"], 5)
self.assertEqual(result[1]["count"], 2)
self.assertEqual(result[2]["count"], 1)
self.assertEqual(result[3]["count"], 1)
self.assertEqual(result[4]["count"], 1)
self.assertCountEqual(
self._get_people_at_step(filter, 1),
[
person1.uuid, person2.uuid, person3.uuid, person4.uuid,
person5.uuid
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 2),
[person1.uuid, person4.uuid],
)
self.assertCountEqual(
self._get_people_at_step(filter, 3),
[person4.uuid],
)
self.assertCountEqual(
self._get_people_at_step(filter, 4),
[person4.uuid],
)
self.assertCountEqual(
self._get_people_at_step(filter, 5),
[person4.uuid],
)
def test_funnel_exclusions_full_window(self):
filters = {
"events": [
{
"id": "user signed up",
"type": "events",
"order": 0
},
{
"id": "paid",
"type": "events",
"order": 1
},
],
"insight":
INSIGHT_FUNNELS,
"funnel_window_days":
14,
"date_from":
"2021-05-01 00:00:00",
"date_to":
"2021-05-14 00:00:00",
"exclusions": [
{
"id": "x",
"type": "events",
"funnel_from_step": 0,
"funnel_to_step": 1
},
],
}
filter = Filter(data=filters)
funnel = ClickhouseFunnelUnordered(filter, self.team)
# event 1
person1 = _create_person(distinct_ids=["person1"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person1",
timestamp="2021-05-01 01:00:00")
_create_event(team=self.team,
event="paid",
distinct_id="person1",
timestamp="2021-05-01 02:00:00")
# event 2
person2 = _create_person(distinct_ids=["person2"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person2",
timestamp="2021-05-01 03:00:00")
_create_event(team=self.team,
event="x",
distinct_id="person2",
timestamp="2021-05-01 03:30:00")
_create_event(team=self.team,
event="paid",
distinct_id="person2",
timestamp="2021-05-01 04:00:00")
# event 3
person3 = _create_person(distinct_ids=["person3"],
team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="person3",
timestamp="2021-05-01 05:00:00")
_create_event(team=self.team,
event="paid",
distinct_id="person3",
timestamp="2021-05-01 06:00:00")
result = funnel.run()
self.assertEqual(len(result), 2)
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[0]["count"], 3)
self.assertEqual(result[1]["name"], "paid")
self.assertEqual(result[1]["count"], 2)
self.assertCountEqual(
self._get_people_at_step(filter, 1),
[person1.uuid, person2.uuid, person3.uuid],
)
self.assertCountEqual(
self._get_people_at_step(filter, 2),
[person1.uuid, person3.uuid],
)
def test_basic_unordered_funnel_conversion_times(self):
filter = Filter(
data={
"insight":
INSIGHT_FUNNELS,
"events": [
{
"id": "user signed up",
"order": 0
},
{
"id": "$pageview",
"order": 1
},
{
"id": "insight viewed",
"order": 2
},
],
"date_from":
"2021-05-01 00:00:00",
"date_to":
"2021-05-07 23:59:59",
"funnel_window_days":
"1",
})
funnel = ClickhouseFunnelUnordered(filter, self.team)
person1_stopped_after_signup = _create_person(
distinct_ids=["stopped_after_signup1"], team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_signup1",
timestamp="2021-05-02 00:00:00")
person2_stopped_after_one_pageview = _create_person(
distinct_ids=["stopped_after_pageview1"], team_id=self.team.pk)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_pageview1",
timestamp="2021-05-02 00:00:00")
_create_event(
team=self.team,
event="user signed up",
distinct_id="stopped_after_pageview1",
timestamp="2021-05-02 01:00:00",
)
person3_stopped_after_insight_view = _create_person(
distinct_ids=["stopped_after_insightview"], team_id=self.team.pk)
_create_event(
team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview",
timestamp="2021-05-02 00:00:00",
)
_create_event(
team=self.team,
event="user signed up",
distinct_id="stopped_after_insightview",
timestamp="2021-05-02 02:00:00",
)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview",
timestamp="2021-05-02 04:00:00")
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview",
timestamp="2021-05-03 00:00:00")
_create_event(
team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview",
timestamp="2021-05-03 03:00:00",
)
_create_event(
team=self.team,
event="user signed up",
distinct_id="stopped_after_insightview",
timestamp="2021-05-03 06:00:00",
)
# Person 3 completes the funnel 2 times:
# First time: 2 hours + 2 hours = total 4 hours.
# Second time: 3 hours + 3 hours = total 6 hours.
result = funnel.run()
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[1]["name"], "$pageview")
self.assertEqual(result[2]["name"], "insight viewed")
self.assertEqual(result[0]["count"], 3)
self.assertEqual(result[1]["average_conversion_time"], 6300)
# 1 hour for Person 2, (2+3)/2 hours for Person 3, total = 3.5 hours, average = 3.5/2 = 1.75 hours
self.assertEqual(result[2]["average_conversion_time"], 9000)
# (2+3)/2 hours for Person 3 = 2.5 hours
self.assertCountEqual(
self._get_people_at_step(filter, 1),
[
person1_stopped_after_signup.uuid,
person2_stopped_after_one_pageview.uuid,
person3_stopped_after_insight_view.uuid,
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 2),
[
person2_stopped_after_one_pageview.uuid,
person3_stopped_after_insight_view.uuid
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 3),
[person3_stopped_after_insight_view.uuid],
)
def test_funnel_step_breakdown_event_single_person_events_with_multiple_properties(
self):
# overriden from factory
filters = {
"events": [{
"id": "sign up",
"order": 0
}, {
"id": "play movie",
"order": 1
}],
"insight":
INSIGHT_FUNNELS,
"date_from":
"2020-01-01",
"date_to":
"2020-01-08",
"funnel_window_days":
7,
"breakdown_type":
"event",
"breakdown":
"$browser",
}
filter = Filter(data=filters)
funnel = ClickhouseFunnelUnordered(filter, self.team)
# event
person1 = _create_person(distinct_ids=["person1"],
team_id=self.team.pk)
_create_event(
team=self.team,
event="sign up",
distinct_id="person1",
properties={
"key": "val",
"$browser": "Chrome"
},
timestamp="2020-01-01T12:00:00Z",
)
_create_event(
team=self.team,
event="sign up",
distinct_id="person1",
properties={
"key": "val",
"$browser": "Safari"
},
timestamp="2020-01-02T13:00:00Z",
)
_create_event(
team=self.team,
event="play movie",
distinct_id="person1",
properties={
"key": "val",
"$browser": "Safari"
},
timestamp="2020-01-02T14:00:00Z",
)
result = funnel.run()
self.assertEqual(
result[0],
[
{
"action_id": "sign up",
"name": "sign up",
"order": 0,
"people": [],
"count": 1,
"type": "events",
"average_conversion_time": None,
"median_conversion_time": None,
"breakdown": "Chrome",
},
{
"action_id": "play movie",
"name": "play movie",
"order": 1,
"people": [],
"count": 0,
"type": "events",
"average_conversion_time": None,
"median_conversion_time": None,
"breakdown": "Chrome",
},
],
)
self.assertCountEqual(self._get_people_at_step(filter, 1, "Chrome"),
[person1.uuid])
self.assertCountEqual(self._get_people_at_step(filter, 2, "Chrome"),
[])
self.assertEqual(
result[1],
[
{
"action_id": "sign up",
"name": "sign up",
"order": 0,
"people": [],
"count": 1,
"type": "events",
"average_conversion_time": None,
"median_conversion_time": None,
"breakdown": "Safari",
},
{
"action_id": "play movie",
"name": "play movie",
"order": 1,
"people": [],
"count": 1,
"type": "events",
"average_conversion_time": 3600,
"median_conversion_time": 3600,
"breakdown": "Safari",
},
],
)
self.assertCountEqual(self._get_people_at_step(filter, 1, "Safari"),
[person1.uuid])
self.assertCountEqual(self._get_people_at_step(filter, 2, "Safari"),
[person1.uuid])
def test_big_multi_step_unordered_funnel(self):
filter = Filter(
data={
"insight":
INSIGHT_FUNNELS,
"events": [
{
"id": "user signed up",
"order": 0
},
{
"id": "$pageview",
"order": 1
},
{
"id": "insight viewed",
"order": 2
},
{
"id": "crying",
"order": 3
},
],
})
funnel = ClickhouseFunnelUnordered(filter, self.team)
person1_stopped_after_signup = _create_person(
distinct_ids=["stopped_after_signup1"], team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_signup1")
person2_stopped_after_one_pageview = _create_person(
distinct_ids=["stopped_after_pageview1"], team_id=self.team.pk)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_pageview1")
_create_event(team=self.team,
event="crying",
distinct_id="stopped_after_pageview1")
person3_stopped_after_insight_view = _create_person(
distinct_ids=["stopped_after_insightview"], team_id=self.team.pk)
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_insightview")
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview")
_create_event(team=self.team,
event="blaah blaa",
distinct_id="stopped_after_insightview")
_create_event(team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview")
person4_stopped_after_insight_view_reverse_order = _create_person(
distinct_ids=["stopped_after_insightview2"], team_id=self.team.pk)
_create_event(team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview2")
_create_event(team=self.team,
event="crying",
distinct_id="stopped_after_insightview2")
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_insightview2")
person5_stopped_after_insight_view_random = _create_person(
distinct_ids=["stopped_after_insightview3"], team_id=self.team.pk)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview3")
_create_event(team=self.team,
event="user signed up",
distinct_id="stopped_after_insightview3")
_create_event(team=self.team,
event="crying",
distinct_id="stopped_after_insightview3")
_create_event(team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview3")
person6_did_only_insight_view = _create_person(
distinct_ids=["stopped_after_insightview4"], team_id=self.team.pk)
_create_event(team=self.team,
event="blaah blaa",
distinct_id="stopped_after_insightview4")
_create_event(team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview4")
person7_did_only_pageview = _create_person(
distinct_ids=["stopped_after_insightview5"], team_id=self.team.pk)
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview5")
_create_event(team=self.team,
event="blaah blaa",
distinct_id="stopped_after_insightview5")
person8_didnot_signup = _create_person(
distinct_ids=["stopped_after_insightview6"], team_id=self.team.pk)
_create_event(team=self.team,
event="insight viewed",
distinct_id="stopped_after_insightview6")
_create_event(team=self.team,
event="$pageview",
distinct_id="stopped_after_insightview6")
result = funnel.run()
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[0]["count"], 8)
self.assertEqual(result[1]["name"], "$pageview")
self.assertEqual(result[1]["count"], 5)
self.assertEqual(result[2]["name"], "insight viewed")
self.assertEqual(result[2]["count"], 3)
self.assertEqual(result[3]["name"], "crying")
self.assertEqual(result[3]["count"], 1)
self.assertCountEqual(
self._get_people_at_step(filter, 1),
[
person1_stopped_after_signup.uuid,
person2_stopped_after_one_pageview.uuid,
person3_stopped_after_insight_view.uuid,
person4_stopped_after_insight_view_reverse_order.uuid,
person5_stopped_after_insight_view_random.uuid,
person6_did_only_insight_view.uuid,
person7_did_only_pageview.uuid,
person8_didnot_signup.uuid,
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 2),
[
person2_stopped_after_one_pageview.uuid,
person3_stopped_after_insight_view.uuid,
person4_stopped_after_insight_view_reverse_order.uuid,
person5_stopped_after_insight_view_random.uuid,
person8_didnot_signup.uuid,
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 3),
[
person3_stopped_after_insight_view.uuid,
person4_stopped_after_insight_view_reverse_order.uuid,
person5_stopped_after_insight_view_random.uuid,
],
)
self.assertCountEqual(
self._get_people_at_step(filter, 4),
[
person5_stopped_after_insight_view_random.uuid,
],
)
def test_unordered_funnel_with_groups(self):
GroupTypeMapping.objects.create(team=self.team,
group_type="organization",
group_type_index=0)
GroupTypeMapping.objects.create(team=self.team,
group_type="company",
group_type_index=1)
create_group(team_id=self.team.pk,
group_type_index=0,
group_key="org:5",
properties={"industry": "finance"})
create_group(team_id=self.team.pk,
group_type_index=0,
group_key="org:6",
properties={"industry": "technology"})
create_group(team_id=self.team.pk,
group_type_index=1,
group_key="company:1",
properties={})
create_group(team_id=self.team.pk,
group_type_index=1,
group_key="company:2",
properties={})
filters = {
"events": [
{
"id": "user signed up",
"type": "events",
"order": 0
},
{
"id": "paid",
"type": "events",
"order": 1
},
],
"insight":
INSIGHT_FUNNELS,
"aggregation_group_type_index":
0,
"date_from":
"2020-01-01",
"date_to":
"2020-01-14",
}
filter = Filter(data=filters, team=self.team)
funnel = ClickhouseFunnelUnordered(filter, self.team)
_create_person(distinct_ids=["user_1"], team_id=self.team.pk)
_create_event(
team=self.team,
event="user signed up",
distinct_id="user_1",
timestamp="2020-01-03T14:00:00Z",
properties={"$group_0": "org:5"},
)
# different person, same group, so should count as step two in funnel
_create_person(distinct_ids=["user_2"], team_id=self.team.pk)
_create_event(
team=self.team,
event="paid",
distinct_id="user_2",
timestamp="2020-01-02T14:00:00Z",
properties={"$group_0": "org:5"},
)
# same person, different group, so should count as different step 1 in funnel
_create_event(
team=self.team,
event="user signed up",
distinct_id="user_1",
timestamp="2020-01-10T14:00:00Z",
properties={"$group_0": "org:6"},
)
result = funnel.run()
self.assertEqual(result[0]["name"], "user signed up")
self.assertEqual(result[0]["count"], 2)
self.assertEqual(result[1]["name"], "paid")
self.assertEqual(result[1]["count"], 1)