Refactored filter logic.

lib/clickhouse.ts

@@ -1,9 +1,10 @@
 import { ClickHouse } from 'clickhouse';
 import dateFormat from 'dateformat';
 import debug from 'debug';
-import { FILTER_IGNORED } from 'lib/constants';
 import { CLICKHOUSE } from 'lib/db';
 import { getEventDataType } from './eventData';
+import { WebsiteMetricFilter } from './types';
+import { FILTER_COLUMNS } from './constants';
 
 export const CLICKHOUSE_DATE_FORMATS = {
   minute: '%Y-%m-%d %H:%M:00',
@@ -104,55 +105,14 @@ function getEventDataFilterQuery(
   return query.join('\n');
 }
 
-function getFilterQuery(filters = {}, params = {}, field: string) {
+function getFilterQuery(filters = {}, params = {}) {
   const query = Object.keys(filters).reduce((arr, key) => {
     const filter = filters[key];
 
-    if (filter === undefined || filter === FILTER_IGNORED) {
-      return arr;
-    }
-
-    if (key === field) {
-      return arr;
-    }
-
-    switch (key) {
-      case 'url':
-        arr.push(`and url_path = {${key}:String}`);
-        params[key] = filter;
-        break;
-      case 'pageTitle':
-      case 'os':
-      case 'browser':
-      case 'device':
-      case 'subdivision1':
-      case 'subdivision2':
-      case 'city':
-      case 'country':
-        arr.push(`and ${key} = {${key}:String}`);
-        params[key] = filter;
-        break;
-
-      case 'eventName':
-        arr.push(`and event_name = {${key}:String}`);
-        params[key] = filter;
-        break;
-
-      case 'referrer':
-        arr.push(`and referrer_domain= {${key}:String}`);
-        params[key] = filter;
-        break;
-
-      case 'domain':
-        arr.push(`and referrer_domain NOT ILIKE {${key}:String}`);
-        arr.push(`and referrer_domain NOT ILIKE '/%'`);
-        params[key] = `%://${filter}/%`;
-        break;
-
-      case 'query':
-        arr.push(`and url_query= {${key}:String}`);
-        params[key] = filter;
-        break;
+    if (filter !== undefined) {
+      const column = FILTER_COLUMNS[key] || key;
+      arr.push(`and ${column} = {${key}:String}`);
+      params[key] = decodeURIComponent(filter);
     }
 
     return arr;
@@ -161,34 +121,9 @@ function getFilterQuery(filters = {}, params = {}, field: string) {
   return query.join('\n');
 }
 
-function parseFilters(filters: any = {}, params: any = {}, field?: string) {
-  const {
-    domain,
-    url,
-    eventUrl,
-    referrer,
-    pageTitle,
-    os,
-    browser,
-    device,
-    country,
-    subdivision1,
-    subdivision2,
-    city,
-    eventName,
-    query,
-  } = filters;
-
-  const pageviewFilters = { domain, url, referrer, query, pageTitle };
-  const sessionFilters = { os, browser, device, country, subdivision1, subdivision2, city };
-  const eventFilters = { url: eventUrl, eventName };
-
+function parseFilters(filters: WebsiteMetricFilter = {}, params: any = {}) {
   return {
-    pageviewFilters,
-    sessionFilters,
-    eventFilters,
-    event: { eventName },
-    filterQuery: getFilterQuery(filters, params, field),
+    filterQuery: getFilterQuery(filters, params),
   };
 }
 

lib/constants.ts

@@ -27,12 +27,33 @@ export const UI_LAYOUT_BODY = 'ui-layout-body';
 
 export const FILTER_COMBINED = 'filter-combined';
 export const FILTER_RAW = 'filter-raw';
-export const FILTER_IGNORED = 'filter-ignored';
 export const FILTER_DAY = 'filter-day';
 export const FILTER_RANGE = 'filter-range';
 export const FILTER_REFERRERS = 'filter-referrers';
 export const FILTER_PAGES = 'filter-pages';
 
+export const EVENT_COLUMNS = ['url', 'referrer', 'title', 'query', 'event'];
+
+export const SESSION_COLUMNS = [
+  'browser',
+  'os',
+  'device',
+  'screen',
+  'country',
+  'language',
+  'subdivision1',
+  'subdivision2',
+  'city',
+];
+
+export const FILTER_COLUMNS = {
+  url: 'url_path',
+  referrer: 'referrer_domain',
+  title: 'page_title',
+  query: 'url_query',
+  event: 'event_name',
+};
+
 export const EVENT_TYPE = {
   pageView: 1,
   customEvent: 2,

lib/prisma.ts

@@ -1,8 +1,8 @@
 import prisma from '@umami/prisma-client';
 import moment from 'moment-timezone';
 import { MYSQL, POSTGRESQL, getDatabaseType } from 'lib/db';
-import { FILTER_IGNORED } from 'lib/constants';
 import { getEventDataType } from './eventData';
+import { FILTER_COLUMNS } from './constants';
 
 const MYSQL_DATE_FORMATS = {
   minute: '%Y-%m-%d %H:%i:00',
@@ -106,55 +106,14 @@ function getEventDataFilterQuery(
   return query.join('\n');
 }
 
-function getFilterQuery(filters = {}, params = [], field: string): string {
+function getFilterQuery(filters = {}, params = []): string {
   const query = Object.keys(filters).reduce((arr, key) => {
     const filter = filters[key];
 
-    if (filter === undefined || filter === FILTER_IGNORED) {
-      return arr;
-    }
-
-    if (key === field) {
-      return arr;
-    }
-
-    switch (key) {
-      case 'url':
-        arr.push(`and url_path=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
-      case 'os':
-      case 'pageTitle':
-      case 'browser':
-      case 'device':
-      case 'subdivision1':
-      case 'subdivision2':
-      case 'city':
-      case 'country':
-        arr.push(`and ${key}=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
-
-      case 'eventName':
-        arr.push(`and event_name=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
-
-      case 'referrer':
-        arr.push(`and referrer_domain=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
-
-      case 'domain':
-        arr.push(`and referrer_domain not like $${params.length + 1}`);
-        arr.push(`and referrer_domain not like '/%'`);
-        params.push(`%://${filter}/%`);
-        break;
-
-      case 'query':
-        arr.push(`and url_query=$${params.length + 1}`);
-        params.push(decodeURIComponent(filter));
-        break;
+    if (filter !== undefined) {
+      const column = FILTER_COLUMNS[key] || key;
+      arr.push(`and ${column}=$${params.length + 1}`);
+      params.push(decodeURIComponent(filter));
     }
 
     return arr;
@@ -166,40 +125,16 @@ function getFilterQuery(filters = {}, params = [], field: string): string {
 function parseFilters(
   filters: { [key: string]: any } = {},
   params = [],
-  field?: string,
   sessionKey = 'session_id',
 ) {
-  const {
-    domain,
-    url,
-    eventUrl,
-    referrer,
-    pageTitle,
-    os,
-    browser,
-    device,
-    country,
-    subdivision1,
-    subdivision2,
-    city,
-    eventName,
-    query,
-  } = filters;
-
-  const pageviewFilters = { domain, url, referrer, query, pageTitle };
-  const sessionFilters = { os, browser, device, country, subdivision1, subdivision2, city };
-  const eventFilters = { url: eventUrl, eventName };
+  const { os, browser, device, country, subdivision1, subdivision2, city } = filters;
 
   return {
-    pageviewFilters,
-    sessionFilters,
-    eventFilters,
-    event: { eventName },
     joinSession:
       os || browser || device || country || subdivision1 || subdivision2 || city
         ? `inner join session on website_event.${sessionKey} = session.${sessionKey}`
         : '',
-    filterQuery: getFilterQuery(filters, params, field),
+    filterQuery: getFilterQuery(filters, params),
   };
 }
 

lib/query.ts

@@ -0,0 +1,19 @@
+import cache from 'lib/cache';
+import { getWebsite } from 'queries';
+import { Website } from './types';
+
+export async function loadWebsite(websiteId: string): Promise<Website> {
+  let website;
+
+  if (cache.enabled) {
+    website = await cache.fetchWebsite(websiteId);
+  } else {
+    website = await getWebsite({ id: websiteId });
+  }
+
+  if (!website || website.deletedAt) {
+    return null;
+  }
+
+  return website;
+}

lib/types.ts

@@ -69,6 +69,22 @@ export interface WebsiteMetric {
   y: number;
 }
 
+export interface WebsiteMetricFilter {
+  domain?: string;
+  url?: string;
+  referrer?: string;
+  title?: string;
+  query?: string;
+  event?: string;
+  os?: string;
+  browser?: string;
+  device?: string;
+  country?: string;
+  subdivision1?: string;
+  subdivision2?: string;
+  city?: string;
+}
+
 export interface WebsiteEventMetric {
   x: string;
   t: string;