Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

fix(api): profile and session filters work in every report

Carl-Gerhard Lindesvärddb61b2e7cb44
diff --git a/packages/core/src/modules/chart/sankey.service.ts b/packages/core/src/modules/chart/sankey.service.ts
index 6230a5f3a..603ba3dc3 100644
--- a/packages/core/src/modules/chart/sankey.service.ts
+++ b/packages/core/src/modules/chart/sankey.service.ts
@@ -86,7 +86,8 @@ interface TopEntry {
*/
export function getRawWhereClause(
type: 'events' | 'sessions',
- filters: IChartEventFilter[]
+ filters: IChartEventFilter[],
+ projectId?: string
): SqlFragment | null {
const where = getEventFiltersWhereClause(
filters.map((filter) => {
@@ -106,19 +107,21 @@ export function getRawWhereClause(
};
}
return filter;
- })
+ }),
+ projectId
);
return joinFilterClauses(where);
}
function toSankeyEvent(
- event: IChartEvent | undefined
+ event: IChartEvent | undefined,
+ projectId: string
): SankeyEvent | undefined {
return event
? {
name: event.name,
- whereClause: getRawWhereClause('events', event.filters),
+ whereClause: getRawWhereClause('events', event.filters, projectId),
}
: undefined;
}
@@ -178,8 +181,8 @@ export async function getSankey(
endDate,
steps,
mode,
- startEvent: toSankeyEvent(startEvent),
- endEvent: toSankeyEvent(endEvent),
+ startEvent: toSankeyEvent(startEvent, projectId),
+ endEvent: toSankeyEvent(endEvent, projectId),
include,
exclude,
};
diff --git a/packages/core/src/modules/chart/src/filter-where.ts b/packages/core/src/modules/chart/src/filter-where.ts
index 316b79455..9b32df668 100644
--- a/packages/core/src/modules/chart/src/filter-where.ts
+++ b/packages/core/src/modules/chart/src/filter-where.ts
@@ -28,6 +28,7 @@ import {
hasTypedCast,
isTypedOperator,
} from './filter-cast';
+import { buildFilterWhere } from './table-filter-where';
export type FilterTableScope = 'events' | 'sessions';
@@ -134,6 +135,28 @@ export function getEventFiltersWhereClause(
return;
}
+ // Profile and session filters compile to a subquery on the profile or
+ // session id, so they work in every chart without the query joining
+ // `profiles` or `sessions`.
+ if (
+ projectId &&
+ tableScope === 'events' &&
+ (name.startsWith('profile.') || name.startsWith('session.')) &&
+ !isWildcardPropertyKey(name)
+ ) {
+ const column = (field: string) =>
+ eventsAlias ? `${eventsAlias}.${field}` : field;
+ const compiled = buildFilterWhere([{ ...filter, name }], projectId, {
+ selfTable: 'events',
+ profileIdExpr: column('profile_id'),
+ sessionIdExpr: column('session_id'),
+ });
+ if (compiled.f0) {
+ where[id] = compiled.f0;
+ }
+ return;
+ }
+
// Handle group. prefixed filters (requires ARRAY JOIN + _g JOIN in query)
if (name.startsWith('group.') && projectId) {
const whereFrom = getGroupPropertySql(name);
diff --git a/packages/core/src/modules/chart/src/table-filter-where.ts b/packages/core/src/modules/chart/src/table-filter-where.ts
index 983f77a1b..45c8b022b 100644
--- a/packages/core/src/modules/chart/src/table-filter-where.ts
+++ b/packages/core/src/modules/chart/src/table-filter-where.ts
@@ -33,6 +33,11 @@ export interface FilterTableContext {
* by cohort + cross-table profile.* filters.
*/
profileIdExpr: string;
+ /**
+ * Expression on the outer row that yields its session id. Required for
+ * `session.*` filters on any table other than `sessions` itself.
+ */
+ sessionIdExpr?: string;
/**
* Expression on the outer row that yields the array of group ids. All three
* canonical tables expose a `groups Array(String)` column today.
@@ -385,9 +390,11 @@ function buildSessionClause(
projectId: string,
ctx: FilterTableContext
): SqlFragment | null {
- if (ctx.selfTable !== 'sessions') {
+ const onSessions = ctx.selfTable === 'sessions';
+ if (!(onSessions || ctx.sessionIdExpr)) {
return null;
}
+ const sessionId = onSessions ? sql`id` : sql.id(ctx.sessionIdExpr!);
const fieldName = filter.name.replace(/^session\./, '');
if (fieldName === 'performed_event') {
@@ -404,10 +411,22 @@ function buildSessionClause(
: sql.empty;
const members = sql`(SELECT DISTINCT session_id FROM ${sql.id(CHART_TABLE.events)} WHERE project_id = ${sql.string(projectId)} ${dateScope}AND name ${nameClause})`;
return filter.operator === 'isNot'
- ? sql`id NOT IN ${members}`
- : sql`id IN ${members}`;
+ ? sql`${sessionId} NOT IN ${members}`
+ : sql`${sessionId} IN ${members}`;
}
+ const clause = sessionColumnClause(filter, fieldName);
+ if (!clause || onSessions) {
+ return clause;
+ }
+ return sql`${sessionId} IN (SELECT id FROM ${sql.id(CHART_TABLE.sessions)} FINAL WHERE project_id = ${sql.string(projectId)} AND ${clause})`;
+}
+
+/** A `session.<column>` filter as a predicate on a sessions row. */
+function sessionColumnClause(
+ filter: IChartEventFilter,
+ fieldName: string
+): SqlFragment | null {
if (fieldName === 'is_bounce') {
if (filter.value.length === 0) {
return null;