-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
feat(hogql): automatic event and person property types #14795
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
from typing import Dict, Set | ||
|
||
from posthog.hogql import ast | ||
from posthog.hogql.context import HogQLContext | ||
from posthog.hogql.parser import parse_expr | ||
from posthog.hogql.visitor import CloningVisitor, TraversingVisitor | ||
|
||
|
||
def resolve_property_types(node: ast.Expr, context: HogQLContext = None) -> ast.Expr: | ||
from posthog.models import PropertyDefinition | ||
|
||
# find all properties | ||
property_finder = PropertyFinder() | ||
property_finder.visit(node) | ||
|
||
# fetch them | ||
event_property_values = ( | ||
PropertyDefinition.objects.filter( | ||
name__in=property_finder.event_properties, | ||
team_id=context.team_id, | ||
type__in=[None, PropertyDefinition.Type.EVENT], | ||
).values_list("name", "property_type") | ||
if property_finder.event_properties | ||
else [] | ||
) | ||
event_properties = {name: property_type for name, property_type in event_property_values if property_type} | ||
|
||
person_property_values = ( | ||
PropertyDefinition.objects.filter( | ||
name__in=property_finder.person_properties, | ||
team_id=context.team_id, | ||
type=PropertyDefinition.Type.PERSON, | ||
).values_list("name", "property_type") | ||
if property_finder.person_properties | ||
else [] | ||
) | ||
person_properties = {name: property_type for name, property_type in person_property_values if property_type} | ||
|
||
# swap them out | ||
if len(event_properties) == 0 and len(person_properties) == 0: | ||
return node | ||
property_swapper = PropertySwapper(event_properties=event_properties, person_properties=person_properties) | ||
return property_swapper.visit(node) | ||
|
||
|
||
class PropertyFinder(TraversingVisitor): | ||
def __init__(self): | ||
super().__init__() | ||
self.person_properties: Set[str] = set() | ||
self.event_properties: Set[str] = set() | ||
|
||
def visit_property_ref(self, node: ast.PropertyRef): | ||
if node.parent.name == "properties": | ||
if isinstance(node.parent.table, ast.BaseTableRef): | ||
table = node.parent.table.resolve_database_table().hogql_table() | ||
if table == "persons": | ||
self.person_properties.add(node.name) | ||
if table == "events": | ||
self.event_properties.add(node.name) | ||
|
||
|
||
class PropertySwapper(CloningVisitor): | ||
def __init__(self, event_properties: Dict[str, str], person_properties: Dict[str, str]): | ||
super().__init__(clear_refs=False) | ||
self.event_properties = event_properties | ||
self.person_properties = person_properties | ||
|
||
def visit_field(self, node: ast.Field): | ||
ref = node.ref | ||
if isinstance(ref, ast.PropertyRef) and ref.parent.name == "properties": | ||
if isinstance(ref.parent.table, ast.BaseTableRef): | ||
table = ref.parent.table.resolve_database_table().hogql_table() | ||
if table == "persons": | ||
if ref.name in self.person_properties: | ||
return self._add_type_to_string_field(node, self.person_properties[ref.name]) | ||
if table == "events": | ||
if ref.name in self.event_properties: | ||
return self._add_type_to_string_field(node, self.event_properties[ref.name]) | ||
return node | ||
|
||
def _add_type_to_string_field(self, node: ast.Field, type: str): | ||
if type == "DateTime": | ||
return ast.Call(name="toDateTime", args=[node]) | ||
if type == "Numeric": | ||
return ast.Call(name="toFloat", args=[node]) | ||
if type == "Boolean": | ||
return parse_expr("{node} = 'true'", {"node": node}) | ||
return node |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
from django.test import override_settings | ||
|
||
from posthog.hogql.context import HogQLContext | ||
from posthog.hogql.parser import parse_select | ||
from posthog.hogql.printer import print_ast | ||
from posthog.models import PropertyDefinition | ||
from posthog.test.base import BaseTest | ||
|
||
|
||
class TestPropertyTypes(BaseTest): | ||
def setUp(self): | ||
super().setUp() | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, | ||
type=PropertyDefinition.Type.EVENT, | ||
name="$screen_height", | ||
defaults={"property_type": "Numeric"}, | ||
) | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, | ||
type=PropertyDefinition.Type.EVENT, | ||
name="$screen_width", | ||
defaults={"property_type": "Numeric"}, | ||
) | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, type=PropertyDefinition.Type.EVENT, name="bool", defaults={"property_type": "Boolean"} | ||
) | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, type=PropertyDefinition.Type.PERSON, name="tickets", defaults={"property_type": "Numeric"} | ||
) | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, | ||
type=PropertyDefinition.Type.PERSON, | ||
name="provided_timestamp", | ||
defaults={"property_type": "DateTime"}, | ||
) | ||
PropertyDefinition.objects.get_or_create( | ||
team=self.team, | ||
type=PropertyDefinition.Type.PERSON, | ||
name="$initial_browser", | ||
defaults={"property_type": "String"}, | ||
) | ||
|
||
def test_resolve_property_types_event(self): | ||
printed = self._print_select( | ||
"select properties.$screen_width * properties.$screen_height, properties.bool from events" | ||
) | ||
expected = ( | ||
"SELECT multiply(" | ||
"toFloat64OrNull(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_0)s), '^\"|\"$', '')), " | ||
"toFloat64OrNull(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_1)s), '^\"|\"$', ''))), " | ||
"equals(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_2)s), '^\"|\"$', ''), %(hogql_val_3)s) " | ||
f"FROM events WHERE equals(team_id, {self.team.pk}) LIMIT 65535" | ||
) | ||
self.assertEqual(printed, expected) | ||
|
||
def test_resolve_property_types_perosn(self): | ||
mariusandra marked this conversation as resolved.
Show resolved
Hide resolved
|
||
printed = self._print_select( | ||
"select properties.tickets, properties.provided_timestamp, properties.$initial_browser from persons" | ||
) | ||
expected = ( | ||
"SELECT toFloat64OrNull(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_0)s), '^\"|\"$', '')), " | ||
"parseDateTimeBestEffort(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_1)s), '^\"|\"$', '')), " | ||
"replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_2)s), '^\"|\"$', '') " | ||
f"FROM person WHERE equals(team_id, {self.team.pk}) LIMIT 65535" | ||
) | ||
self.assertEqual(printed, expected) | ||
|
||
@override_settings(PERSON_ON_EVENTS_OVERRIDE=False) | ||
def test_resolve_property_types_combined(self): | ||
printed = self._print_select("select properties.$screen_width * person.properties.tickets from events") | ||
expected = ( | ||
"SELECT multiply(" | ||
"toFloat64OrNull(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_1)s), '^\"|\"$', '')), " | ||
"toFloat64OrNull(events__pdi__person.properties___tickets)) FROM events INNER JOIN " | ||
"(SELECT argMax(person_distinct_id2.person_id, version) AS person_id, distinct_id FROM person_distinct_id2 " | ||
f"WHERE equals(team_id, {self.team.pk}) GROUP BY distinct_id HAVING equals(argMax(is_deleted, version), 0)) AS events__pdi " | ||
"ON equals(events.distinct_id, events__pdi.distinct_id) INNER JOIN (SELECT " | ||
"argMax(replaceRegexpAll(JSONExtractRaw(properties, %(hogql_val_0)s), '^\"|\"$', ''), version) AS properties___tickets, " | ||
f"id FROM person WHERE equals(team_id, {self.team.pk}) GROUP BY id HAVING equals(argMax(is_deleted, version), 0)) AS events__pdi__person " | ||
f"ON equals(events__pdi.person_id, events__pdi__person.id) WHERE equals(team_id, {self.team.pk}) LIMIT 65535" | ||
) | ||
self.assertEqual(printed, expected) | ||
|
||
def _print_select(self, select: str): | ||
expr = parse_select(select) | ||
return print_ast(expr, HogQLContext(team_id=self.team.pk, enable_select_queries=True), "clickhouse") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be quicker for me to ask than figure it out #Lazy
How often do we call this?
Might be early-optimizing but the property types change infrequently so we can cache seen properties relatively aggressively. Makes me wonder how well our tracing covers this code 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will just be called once per query in most cases. In case of non-hogql insights, it'll be called once per filter. This is where caching could make the biggest difference, but I didn't feel like overoptimising yet.