watson/umami
1
0
Fork 0
mirror of https://github.com/umami-software/umami.git synced 2026-02-08 22:57:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Insights report filtering.

Browse source
This commit is contained in:
Mike Cao 2023-08-11 09:05:56 -07:00
parent 45888fabe6
commit 9436efabc0
12 changed files with 134 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

36
lib/clickhouse.ts
View file

@ -3,7 +3,7 @@ import dateFormat from 'dateformat';
import debug from 'debug';
import { CLICKHOUSE } from 'lib/db';
import { QueryFilters, QueryOptions } from './types';
import { FILTER_COLUMNS } from './constants';
import { FILTER_COLUMNS, OPERATORS } from './constants';
import { loadWebsite } from './load';
import { maxDate } from './date';
@ -63,17 +63,29 @@ function getDateFormat(date) {
return `'${dateFormat(date, 'UTC:yyyy-mm-dd HH:MM:ss')}'`;
}
function mapFilter(column, operator, name) {
switch (operator) {
case OPERATORS.equals:
return `${column} = {${name}:String}`;
case OPERATORS.notEquals:
return `${column} != {${name}:String}`;
default:
return '';
}
}
function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {}) {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
const column = FILTER_COLUMNS[key] ?? options?.columns?.[key];
const query = Object.keys(filters).reduce((arr, name) => {
const value = filters[name];
const operator = value?.filter ?? OPERATORS.equals;
const column = FILTER_COLUMNS[name] ?? options?.columns?.[name];
if (filter !== undefined && column) {
arr.push(`and ${column} = {${key}:String}`);
}
if (value !== undefined && column) {
arr.push(`and ${mapFilter(column, operator, name)}`);
if (key === 'referrer') {
arr.push('and referrer_domain != {websiteDomain:String}');
if (name === 'referrer') {
arr.push('and referrer_domain != {websiteDomain:String}');
}
}
return arr;
@ -82,11 +94,7 @@ function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {})
return query.join('\n');
}
async function parseFilters(
websiteId: string,
filters: QueryFilters & { [key: string]: any } = {},
options?: QueryOptions,
) {
async function parseFilters(websiteId: string, filters: QueryFilters = {}, options?: QueryOptions) {
const website = await loadWebsite(websiteId);
return {

23
lib/constants.ts
View file

@ -76,6 +76,23 @@ export const DATA_TYPE = {
array: 5,
} as const;
export const OPERATORS = {
equals: 'eq',
notEquals: 'neq',
set: 's',
notSet: 'ns',
contains: 'c',
doesNotContain: 'dnc',
true: 't',
false: 'f',
greaterThan: 'gt',
lessThan: 'lt',
greaterThanEquals: 'gte',
lessThanEquals: 'lte',
before: 'bf',
after: 'af',
} as const;
export const DATA_TYPES = {
[DATA_TYPE.string]: 'string',
[DATA_TYPE.number]: 'number',
@ -84,6 +101,12 @@ export const DATA_TYPES = {
[DATA_TYPE.array]: 'array',
};
export const REPORT_TYPES = {
funnel: 'funnel',
insights: 'insights',
retention: 'retention',
} as const;
export const REPORT_PARAMETERS = {
fields: 'fields',
filters: 'filters',

44
lib/prisma.ts
View file

@ -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, SESSION_COLUMNS } from './constants';
import { FILTER_COLUMNS, SESSION_COLUMNS, OPERATORS } from './constants';
import { loadWebsite } from './load';
import { maxDate } from './date';
import { QueryFilters, QueryOptions } from './types';
@ -67,15 +67,27 @@ function getTimestampIntervalQuery(field: string): string {
}
}
function mapFilter(column, operator, name) {
switch (operator) {
case OPERATORS.equals:
return `${column} = {{${name}}}`;
case OPERATORS.notEquals:
return `${column} != {{${name}}}`;
default:
return '';
}
}
function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {}): string {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
const column = FILTER_COLUMNS[key] ?? options?.columns?.[key];
const query = Object.keys(filters).reduce((arr, name) => {
const value = filters[name];
const operator = value?.filter ?? OPERATORS.equals;
const column = FILTER_COLUMNS[name] ?? options?.columns?.[name];
if (filter !== undefined && column) {
arr.push(`and ${column}={{${key}}}`);
if (value !== undefined && column) {
arr.push(`and ${mapFilter(column, operator, name)}`);
if (key === 'referrer') {
if (name === 'referrer') {
arr.push(
'and (website_event.referrer_domain != {{websiteDomain}} or website_event.referrer_domain is null)',
);
@ -88,11 +100,17 @@ function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {}):
return query.join('\n');
}
async function parseFilters(
websiteId,
filters: QueryFilters & { [key: string]: any } = {},
options: QueryOptions = {},
) {
function normalizeFilters(filters = {}) {
return Object.keys(filters).reduce((obj, key) => {
const value = filters[key];
obj[key] = value?.value ?? value;
return obj;
}, {});
}
async function parseFilters(websiteId, filters: QueryFilters = {}, options: QueryOptions = {}) {
const website = await loadWebsite(websiteId);
return {
@ -102,7 +120,7 @@ async function parseFilters(
: '',
filterQuery: getFilterQuery(filters, options),
params: {
...filters,
...normalizeFilters(filters),
websiteId,
startDate: maxDate(filters.startDate, website.resetAt),
websiteDomain: website.domain,