Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Split out session query.
Mike Cao449795100006
diff --git a/components/layout/AppLayout.js b/components/layout/AppLayout.jsindex 989128f9e..7ab74351b 100644--- a/components/layout/AppLayout.js+++ b/components/layout/AppLayout.js@@ -2,9 +2,7 @@ import { Container } from 'react-basics';import Head from 'next/head';import NavBar from 'components/layout/NavBar';import UpdateNotice from 'components/common/UpdateNotice';-import useRequireLogin from 'hooks/useRequireLogin';-import useConfig from 'hooks/useConfig';-import { CURRENT_VERSION } from 'lib/constants';+import { useRequireLogin, useConfig } from 'hooks';import styles from './AppLayout.module.css';export function AppLayout({ title, children }) {@@ -16,7 +14,7 @@ export function AppLayout({ title, children }) {}return (- <div className={styles.layout} data-app-version={CURRENT_VERSION}>+ <div className={styles.layout}><UpdateNotice user={user} config={config} /><Head><title>{title ? `${title} | umami` : 'umami'}</title>diff --git a/lib/clickhouse.ts b/lib/clickhouse.tsindex b3dc2c48b..d294110c9 100644--- a/lib/clickhouse.ts+++ b/lib/clickhouse.ts@@ -61,14 +61,13 @@ function getDateFormat(date) {return `'${dateFormat(date, 'UTC:yyyy-mm-dd HH:MM:ss')}'`;}-function getFilterQuery(filters = {}, params = {}) {+function getFilterQuery(filters = {}) {const query = Object.keys(filters).reduce((arr, key) => {const filter = filters[key];if (filter !== undefined) {const column = FILTER_COLUMNS[key] || key;arr.push(`and ${column} = {${key}:String}`);- params[key] = decodeURIComponent(filter);}return arr;@@ -77,9 +76,9 @@ function getFilterQuery(filters = {}, params = {}) {return query.join('\n');}-function parseFilters(filters: WebsiteMetricFilter = {}, params: any = {}) {+function parseFilters(filters: WebsiteMetricFilter = {}) {return {- filterQuery: getFilterQuery(filters, params),+ filterQuery: getFilterQuery(filters),};}diff --git a/lib/prisma.ts b/lib/prisma.tsindex 08309e311..0a52dd7e8 100644--- a/lib/prisma.ts+++ b/lib/prisma.ts@@ -1,7 +1,7 @@import prisma from '@umami/prisma-client';import moment from 'moment-timezone';import { MYSQL, POSTGRESQL, getDatabaseType } from 'lib/db';-import { FILTER_COLUMNS } from './constants';+import { FILTER_COLUMNS, SESSION_COLUMNS } from './constants';const MYSQL_DATE_FORMATS = {minute: '%Y-%m-%d %H:%i:00',@@ -64,14 +64,13 @@ function getTimestampIntervalQuery(field: string): string {}}-function getFilterQuery(filters = {}, params = []): string {+function getFilterQuery(filters = {}): string {const query = Object.keys(filters).reduce((arr, key) => {const filter = filters[key];if (filter !== undefined) {const column = FILTER_COLUMNS[key] || key;arr.push(`and ${column}={{${key}}}`);- params.push(decodeURIComponent(filter));}return arr;@@ -80,19 +79,12 @@ function getFilterQuery(filters = {}, params = []): string {return query.join('\n');}-function parseFilters(- filters: { [key: string]: any } = {},- params = [],- sessionKey = 'session_id',-) {- const { os, browser, device, country, region, city } = filters;-+function parseFilters(filters: { [key: string]: any } = {}) {return {- joinSession:- os || browser || device || country || region || city- ? `inner join session on website_event.${sessionKey} = session.${sessionKey}`- : '',- filterQuery: getFilterQuery(filters, params),+ joinSession: Object.keys(filters).find(key => SESSION_COLUMNS[key])+ ? `inner join session on website_event.session_id = session.session_id`+ : '',+ filterQuery: getFilterQuery(filters),};}diff --git a/pages/api/websites/[id]/metrics.ts b/pages/api/websites/[id]/metrics.tsindex 37a046916..fa0b75541 100644--- a/pages/api/websites/[id]/metrics.ts+++ b/pages/api/websites/[id]/metrics.ts@@ -68,7 +68,7 @@ export default async (filters[type] = undefined;- let data = await getSessionMetrics(websiteId, {+ const data = await getSessionMetrics(websiteId, {startDate,endDate,column,@@ -88,7 +88,7 @@ export default async (}}- data = Object.values(combined);+ return ok(res, Object.values(combined));}return ok(res, data);diff --git a/pages/api/websites/[id]/pageviews.ts b/pages/api/websites/[id]/pageviews.tsindex 453c6733c..810854a75 100644--- a/pages/api/websites/[id]/pageviews.ts+++ b/pages/api/websites/[id]/pageviews.ts@@ -6,6 +6,7 @@ import { canViewWebsite } from 'lib/auth';import { useAuth, useCors } from 'lib/middleware';import { getPageviewStats } from 'queries';import { parseDateRangeQuery } from 'lib/query';+import { getSessionStats } from '../../../../queries/analytics/sessions/getSessionStats';export interface WebsitePageviewRequestQuery {id: string;@@ -62,7 +63,6 @@ export default async (endDate,timezone,unit,- count: '*',filters: {url,referrer,@@ -75,14 +75,14 @@ export default async (city,},}),- getPageviewStats(websiteId, {+ getSessionStats(websiteId, {startDate,endDate,timezone,unit,- count: 'distinct website_event.',filters: {url,+ referrer,title,os,browser,diff --git a/queries/analytics/pageviews/getPageviewMetrics.ts b/queries/analytics/pageviews/getPageviewMetrics.tsindex 1032540b8..a5da178af 100644--- a/queries/analytics/pageviews/getPageviewMetrics.ts+++ b/queries/analytics/pageviews/getPageviewMetrics.ts@@ -84,6 +84,7 @@ async function clickhouseQuery(const { rawQuery, parseFilters } = clickhouse;const website = await loadWebsite(websiteId);const params = {+ ...filters,websiteId,startDate: maxDate(startDate, website.resetAt),endDate,@@ -98,7 +99,7 @@ async function clickhouseQuery(params.domain = website.domain;}- const { filterQuery } = parseFilters(filters, params);+ const { filterQuery } = parseFilters(filters);return rawQuery(`diff --git a/queries/analytics/pageviews/getPageviewStats.ts b/queries/analytics/pageviews/getPageviewStats.tsindex f6d4158c9..6d702993b 100644--- a/queries/analytics/pageviews/getPageviewStats.ts+++ b/queries/analytics/pageviews/getPageviewStats.ts@@ -10,9 +10,19 @@ export interface PageviewStatsCriteria {endDate: Date;timezone?: string;unit?: string;- count?: string;- filters: object;- sessionKey?: string;+ filters: {+ url?: string;+ referrer?: string;+ title?: string;+ browser?: string;+ os?: string;+ device?: string;+ screen?: string;+ language?: string;+ country?: string;+ region?: string;+ city?: string;+ };}export async function getPageviewStats(@@ -25,15 +35,7 @@ export async function getPageviewStats(}async function relationalQuery(websiteId: string, criteria: PageviewStatsCriteria) {- const {- startDate,- endDate,- timezone = 'utc',- unit = 'day',- count = '*',- filters = {},- sessionKey = 'session_id',- } = criteria;+ const { startDate, endDate, timezone = 'utc', unit = 'day', filters = {} } = criteria;const { getDateQuery, parseFilters, rawQuery } = prisma;const website = await loadWebsite(websiteId);const { filterQuery, joinSession } = parseFilters(filters);@@ -42,7 +44,7 @@ async function relationalQuery(websiteId: string, criteria: PageviewStatsCriteri`select${getDateQuery('website_event.created_at', unit, timezone)} x,- count(${count !== '*' ? `${count}${sessionKey}` : count}) y+ count(*) yfrom website_event${joinSession}where website_event.website_id = {{websiteId::uuid}}@@ -52,24 +54,17 @@ async function relationalQuery(websiteId: string, criteria: PageviewStatsCriterigroup by 1`,{+ ...filters,websiteId,startDate: maxDate(startDate, website.resetAt),endDate,eventType: EVENT_TYPE.pageView,- ...filters,},);}async function clickhouseQuery(websiteId: string, criteria: PageviewStatsCriteria) {- const {- startDate,- endDate,- timezone = 'UTC',- unit = 'day',- count = '*',- filters = {},- } = criteria;+ const { startDate, endDate, timezone = 'UTC', unit = 'day', filters = {} } = criteria;const { parseFilters, rawQuery, getDateStringQuery, getDateQuery } = clickhouse;const website = await loadWebsite(websiteId);const { filterQuery } = parseFilters(filters);@@ -82,7 +77,7 @@ async function clickhouseQuery(websiteId: string, criteria: PageviewStatsCriterifrom (select${getDateQuery('created_at', unit, timezone)} as t,- count(${count !== '*' ? 'distinct session_id' : count}) as y+ count(*) as yfrom website_eventwhere website_id = {websiteId:UUID}and created_at between {startDate:DateTime} and {endDate:DateTime}diff --git a/queries/analytics/sessions/getSessionMetrics.ts b/queries/analytics/sessions/getSessionMetrics.tsindex aec2d8f13..2512b06ce 100644--- a/queries/analytics/sessions/getSessionMetrics.ts+++ b/queries/analytics/sessions/getSessionMetrics.ts@@ -28,8 +28,8 @@ async function relationalQuery(return rawQuery(`select ${column} x, count(*) y- from session as x- where x.session_id in (+ from session as s+ where s.session_id in (select website_event.session_idfrom website_eventjoin website@@ -38,7 +38,7 @@ async function relationalQuery(where website.website_id = {{websiteId::uuid}}and website_event.created_at between {{startDate}} and {{endDate}}${filterQuery}- )+ ) as tgroup by 1order by 2 desclimit 100`,@@ -64,7 +64,7 @@ async function clickhouseQuery(`select${column} x, count(distinct session_id) y- from website_event as x+ from website_eventwhere website_id = {websiteId:UUID}and created_at between {startDate:DateTime} and {endDate:DateTime}and event_type = {eventType:UInt32}diff --git a/queries/analytics/sessions/getSessionStats.ts b/queries/analytics/sessions/getSessionStats.tsnew file mode 100644index 000000000..966fd91ff--- /dev/null+++ b/queries/analytics/sessions/getSessionStats.ts@@ -0,0 +1,98 @@+import clickhouse from 'lib/clickhouse';+import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';+import prisma from 'lib/prisma';+import { EVENT_TYPE } from 'lib/constants';+import { loadWebsite } from 'lib/load';+import { maxDate } from 'lib/date';++export interface SessionStatsCriteria {+ startDate: Date;+ endDate: Date;+ timezone?: string;+ unit?: string;+ filters: {+ url?: string;+ referrer?: string;+ title?: string;+ browser?: string;+ os?: string;+ device?: string;+ screen?: string;+ language?: string;+ country?: string;+ region?: string;+ city?: string;+ };+}++export async function getSessionStats(+ ...args: [websiteId: string, criteria: SessionStatsCriteria]+) {+ return runQuery({+ [PRISMA]: () => relationalQuery(...args),+ [CLICKHOUSE]: () => clickhouseQuery(...args),+ });+}++async function relationalQuery(websiteId: string, criteria: SessionStatsCriteria) {+ const { startDate, endDate, timezone = 'utc', unit = 'day', filters = {} } = criteria;+ const { getDateQuery, parseFilters, rawQuery } = prisma;+ const website = await loadWebsite(websiteId);+ const { filterQuery, joinSession } = parseFilters(filters);++ return rawQuery(+ `+ select+ ${getDateQuery('website_event.created_at', unit, timezone)} x,+ count(distinct website_event.session_id) y+ from website_event+ ${joinSession}+ where website_event.website_id = {{websiteId::uuid}}+ and website_event.created_at between {{startDate}} and {{endDate}}+ and event_type = {{eventType}}+ ${filterQuery}+ group by 1+ `,+ {+ ...filters,+ websiteId,+ startDate: maxDate(startDate, website.resetAt),+ endDate,+ eventType: EVENT_TYPE.pageView,+ },+ );+}++async function clickhouseQuery(websiteId: string, criteria: SessionStatsCriteria) {+ const { startDate, endDate, timezone = 'UTC', unit = 'day', filters = {} } = criteria;+ const { parseFilters, rawQuery, getDateStringQuery, getDateQuery } = clickhouse;+ const website = await loadWebsite(websiteId);+ const { filterQuery } = parseFilters(filters);++ return rawQuery(+ `+ select+ ${getDateStringQuery('g.t', unit)} as x,+ g.y as y+ from (+ select+ ${getDateQuery('created_at', unit, timezone)} as t,+ count(distinct session_id) as y+ from website_event+ where website_id = {websiteId:UUID}+ and created_at between {startDate:DateTime} and {endDate:DateTime}+ and event_type = {eventType:UInt32}+ ${filterQuery}+ group by t+ ) as g+ order by t+ `,+ {+ ...filters,+ websiteId,+ startDate: maxDate(startDate, website.resetAt),+ endDate,+ eventType: EVENT_TYPE.pageView,+ },+ );+}