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.

Sign up for GitHub

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(experiments HogQL): add response attributes #25333

Merged
merged 3 commits into from
Oct 3, 2024
Merged

feat(experiments HogQL): add response attributes #25333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e61f9a
init
jurajmajerik Oct 2, 2024
294de04
Update UI snapshots for `chromium` (1)
github-actions[bot] Oct 2, 2024
b34a47b
Merge branch 'master' into experiments-hogql-cached-response
jurajmajerik Oct 3, 2024
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
108 changes: 108 additions & 0 deletions frontend/src/queries/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,114 @@
],
"type": "object"
},
"CachedExperimentFunnelQueryResponse": {
"additionalProperties": false,
"properties": {
"cache_key": {
"type": "string"
},
"cache_target_age": {
"format": "date-time",
"type": "string"
},
"calculation_trigger": {
"description": "What triggered the calculation of the query, leave empty if user/immediate",
"type": "string"
},
"insight": {
"const": "FUNNELS",
"type": "string"
},
"is_cached": {
"type": "boolean"
},
"last_refresh": {
"format": "date-time",
"type": "string"
},
"next_allowed_client_refresh": {
"format": "date-time",
"type": "string"
},
"query_status": {
"$ref": "#/definitions/QueryStatus",
"description": "Query status indicates whether next to the provided data, a query is still running."
},
"results": {
"additionalProperties": {
"$ref": "#/definitions/ExperimentVariantFunnelResult"
},
"type": "object"
},
"timezone": {
"type": "string"
}
},
"required": [
"cache_key",
"insight",
"is_cached",
"last_refresh",
"next_allowed_client_refresh",
"results",
"timezone"
],
"type": "object"
},
"CachedExperimentTrendQueryResponse": {
"additionalProperties": false,
"properties": {
"cache_key": {
"type": "string"
},
"cache_target_age": {
"format": "date-time",
"type": "string"
},
"calculation_trigger": {
"description": "What triggered the calculation of the query, leave empty if user/immediate",
"type": "string"
},
"insight": {
"const": "TRENDS",
"type": "string"
},
"is_cached": {
"type": "boolean"
},
"last_refresh": {
"format": "date-time",
"type": "string"
},
"next_allowed_client_refresh": {
"format": "date-time",
"type": "string"
},
"query_status": {
"$ref": "#/definitions/QueryStatus",
"description": "Query status indicates whether next to the provided data, a query is still running."
},
"results": {
"additionalProperties": {
"$ref": "#/definitions/ExperimentVariantTrendResult"
},
"type": "object"
},
"timezone": {
"type": "string"
}
},
"required": [
"cache_key",
"insight",
"is_cached",
"last_refresh",
"next_allowed_client_refresh",
"results",
"timezone"
],
"type": "object"
},
"CachedFunnelCorrelationResponse": {
"additionalProperties": false,
"properties": {
Expand Down
4 changes: 4 additions & 0 deletions frontend/src/queries/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1594,11 +1594,15 @@ export interface ExperimentTrendQueryResponse {
results: Record<string, ExperimentVariantTrendResult>
}

export type CachedExperimentTrendQueryResponse = CachedQueryResponse<ExperimentTrendQueryResponse>

export interface ExperimentFunnelQueryResponse {
insight: InsightType.FUNNELS
results: Record<string, ExperimentVariantFunnelResult>
}

export type CachedExperimentFunnelQueryResponse = CachedQueryResponse<ExperimentFunnelQueryResponse>

export interface ExperimentFunnelQuery extends DataNode<ExperimentFunnelQueryResponse> {
kind: NodeKind.ExperimentFunnelQuery
source: FunnelsQuery
Expand Down
3 changes: 3 additions & 0 deletions posthog/hogql_queries/experiments/experiment_funnel_query_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from posthog.models.experiment import Experiment
from ..insights.funnels.funnels_query_runner import FunnelsQueryRunner
from posthog.schema import (
CachedExperimentFunnelQueryResponse,
ExperimentFunnelQuery,
ExperimentFunnelQueryResponse,
ExperimentVariantFunnelResult,
Expand All @@ -16,6 +17,8 @@

class ExperimentFunnelQueryRunner(QueryRunner):
query: ExperimentFunnelQuery
response: ExperimentFunnelQueryResponse
cached_response: CachedExperimentFunnelQueryResponse

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
Expand Down
3 changes: 3 additions & 0 deletions posthog/hogql_queries/experiments/experiment_trend_query_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from posthog.schema import (
BaseMathType,
BreakdownFilter,
CachedExperimentTrendQueryResponse,
ChartDisplayType,
EventPropertyFilter,
EventsNode,
Expand All @@ -25,6 +26,8 @@

class ExperimentTrendQueryRunner(QueryRunner):
query: ExperimentTrendQuery
response: ExperimentTrendQueryResponse
cached_response: CachedExperimentTrendQueryResponse

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
Expand Down
40 changes: 40 additions & 0 deletions posthog/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1793,6 +1793,46 @@ class CachedEventsQueryResponse(BaseModel):
types: list[str]


class CachedExperimentFunnelQueryResponse(BaseModel):
model_config = ConfigDict(
extra="forbid",
)
cache_key: str
cache_target_age: Optional[AwareDatetime] = None
calculation_trigger: Optional[str] = Field(
default=None, description="What triggered the calculation of the query, leave empty if user/immediate"
)
insight: Literal["FUNNELS"] = "FUNNELS"
is_cached: bool
last_refresh: AwareDatetime
next_allowed_client_refresh: AwareDatetime
query_status: Optional[QueryStatus] = Field(
default=None, description="Query status indicates whether next to the provided data, a query is still running."
)
results: dict[str, ExperimentVariantFunnelResult]
timezone: str


class CachedExperimentTrendQueryResponse(BaseModel):
model_config = ConfigDict(
extra="forbid",
)
cache_key: str
cache_target_age: Optional[AwareDatetime] = None
calculation_trigger: Optional[str] = Field(
default=None, description="What triggered the calculation of the query, leave empty if user/immediate"
)
insight: Literal["TRENDS"] = "TRENDS"
is_cached: bool
last_refresh: AwareDatetime
next_allowed_client_refresh: AwareDatetime
query_status: Optional[QueryStatus] = Field(
default=None, description="Query status indicates whether next to the provided data, a query is still running."
)
results: dict[str, ExperimentVariantTrendResult]
timezone: str


class CachedFunnelCorrelationResponse(BaseModel):
model_config = ConfigDict(
extra="forbid",
Expand Down
Loading