umami/src/lib/prisma.ts

261 lines
6.4 KiB
TypeScript
Raw Normal View History

import { Prisma } from '@prisma/client';
2022-12-27 06:51:16 +01:00
import prisma from '@umami/prisma-client';
2022-08-26 07:04:32 +02:00
import moment from 'moment-timezone';
2022-12-27 06:51:16 +01:00
import { MYSQL, POSTGRESQL, getDatabaseType } from 'lib/db';
2024-04-03 02:06:06 +02:00
import { SESSION_COLUMNS, OPERATORS, DEFAULT_PAGE_SIZE } from './constants';
2023-08-04 22:18:30 +02:00
import { loadWebsite } from './load';
import { maxDate } from './date';
2023-08-10 22:26:33 +02:00
import { QueryFilters, QueryOptions, SearchFilter } from './types';
2024-04-03 02:06:06 +02:00
import { filtersToArray } from './params';
2022-08-28 06:38:35 +02:00
const MYSQL_DATE_FORMATS = {
minute: '%Y-%m-%d %H:%i:00',
hour: '%Y-%m-%d %H:00:00',
day: '%Y-%m-%d',
month: '%Y-%m-01',
year: '%Y-01-01',
};
const POSTGRESQL_DATE_FORMATS = {
minute: 'YYYY-MM-DD HH24:MI:00',
hour: 'YYYY-MM-DD HH24:00:00',
day: 'YYYY-MM-DD',
month: 'YYYY-MM-01',
year: 'YYYY-01-01',
};
2022-08-27 07:43:31 +02:00
2023-11-02 18:34:06 +01:00
function getAddIntervalQuery(field: string, interval: string): string {
2024-02-04 08:19:29 +01:00
const db = getDatabaseType();
2023-05-09 08:46:58 +02:00
if (db === POSTGRESQL) {
2023-11-02 18:34:06 +01:00
return `${field} + interval '${interval}'`;
2023-05-09 08:46:58 +02:00
}
if (db === MYSQL) {
2023-11-02 18:34:06 +01:00
return `DATE_ADD(${field}, interval ${interval})`;
2023-05-09 08:46:58 +02:00
}
}
2023-08-15 19:58:55 +02:00
function getDayDiffQuery(field1: string, field2: string): string {
2024-02-04 08:19:29 +01:00
const db = getDatabaseType();
2023-08-15 19:58:55 +02:00
if (db === POSTGRESQL) {
return `${field1}::date - ${field2}::date`;
}
if (db === MYSQL) {
2023-08-15 21:15:27 +02:00
return `DATEDIFF(${field1}, ${field2})`;
}
}
function getCastColumnQuery(field: string, type: string): string {
2024-02-04 08:19:29 +01:00
const db = getDatabaseType();
2023-08-15 21:15:27 +02:00
if (db === POSTGRESQL) {
return `${field}::${type}`;
}
if (db === MYSQL) {
return `${field}`;
2023-08-15 19:58:55 +02:00
}
}
2022-12-27 06:51:16 +01:00
function getDateQuery(field: string, unit: string, timezone?: string): string {
2023-07-25 08:06:16 +02:00
const db = getDatabaseType();
2022-08-26 07:04:32 +02:00
if (db === POSTGRESQL) {
if (timezone) {
return `to_char(date_trunc('${unit}', ${field} at time zone '${timezone}'), '${POSTGRESQL_DATE_FORMATS[unit]}')`;
}
return `to_char(date_trunc('${unit}', ${field}), '${POSTGRESQL_DATE_FORMATS[unit]}')`;
}
if (db === MYSQL) {
if (timezone) {
const tz = moment.tz(timezone).format('Z');
return `date_format(convert_tz(${field},'+00:00','${tz}'), '${MYSQL_DATE_FORMATS[unit]}')`;
}
return `date_format(${field}, '${MYSQL_DATE_FORMATS[unit]}')`;
}
}
2023-11-02 18:34:06 +01:00
function getTimestampDiffQuery(field1: string, field2: string): string {
2023-07-25 08:06:16 +02:00
const db = getDatabaseType();
2022-08-27 06:29:26 +02:00
if (db === POSTGRESQL) {
2023-11-02 18:34:06 +01:00
return `floor(extract(epoch from (${field2} - ${field1})))`;
2022-08-27 06:29:26 +02:00
}
if (db === MYSQL) {
2023-11-02 18:34:06 +01:00
return `timestampdiff(second, ${field1}, ${field2})`;
2022-08-27 06:29:26 +02:00
}
}
2024-03-27 01:31:16 +01:00
function mapFilter(column: string, operator: string, name: string, type: string = '') {
const db = getDatabaseType();
const like = db === POSTGRESQL ? 'ilike' : 'like';
const value = `{{${name}${type ? `::${type}` : ''}}}`;
switch (operator) {
2023-08-11 18:05:56 +02:00
case OPERATORS.equals:
2024-03-27 01:31:16 +01:00
return `${column} = ${value}`;
2023-08-11 18:05:56 +02:00
case OPERATORS.notEquals:
2024-03-27 01:31:16 +01:00
return `${column} != ${value}`;
2024-03-05 09:45:55 +01:00
case OPERATORS.contains:
2024-03-27 01:31:16 +01:00
return `${column} ${like} ${value}`;
case OPERATORS.doesNotContain:
2024-03-27 01:31:16 +01:00
return `${column} not ${like} ${value}`;
2023-08-11 18:05:56 +02:00
default:
return '';
}
}
function getFilterQuery(filters: QueryFilters = {}, options: QueryOptions = {}): string {
2024-04-03 02:06:06 +02:00
const query = filtersToArray(filters, options).reduce((arr, { name, column, operator }) => {
if (column) {
arr.push(`and ${mapFilter(column, operator, name)}`);
2022-08-26 07:04:32 +02:00
2024-04-03 02:06:06 +02:00
if (name === 'referrer') {
arr.push(
'and (website_event.referrer_domain != {{websiteDomain}} or website_event.referrer_domain is null)',
);
}
2023-08-04 09:51:52 +02:00
}
2022-08-26 07:04:32 +02:00
return arr;
}, []);
return query.join('\n');
}
2024-04-03 02:06:06 +02:00
function getFilterParams(filters: QueryFilters = {}) {
return filtersToArray(filters).reduce((obj, { name, operator, value }) => {
obj[name] = [OPERATORS.contains, OPERATORS.doesNotContain].includes(operator)
2024-03-27 01:31:16 +01:00
? `%${value}%`
: value;
2023-08-11 18:05:56 +02:00
return obj;
}, {});
}
2023-12-13 04:00:44 +01:00
async function parseFilters(
websiteId: string,
filters: QueryFilters = {},
options: QueryOptions = {},
) {
2023-08-04 22:18:30 +02:00
const website = await loadWebsite(websiteId);
2024-04-03 02:06:06 +02:00
const joinSession = Object.keys(filters).find(key => SESSION_COLUMNS.includes(key));
2023-08-04 22:18:30 +02:00
2023-07-25 23:54:56 +02:00
return {
2023-08-04 23:23:03 +02:00
joinSession:
2024-04-03 02:06:06 +02:00
options?.joinSession || joinSession
2023-08-04 23:23:03 +02:00
? `inner join session on website_event.session_id = session.session_id`
: '',
filterQuery: getFilterQuery(filters, options),
2023-08-04 22:18:30 +02:00
params: {
2024-04-03 02:06:06 +02:00
...getFilterParams(filters),
2023-08-04 22:18:30 +02:00
websiteId,
startDate: maxDate(filters.startDate, website?.resetAt),
2023-08-04 22:18:30 +02:00
websiteDomain: website.domain,
},
2023-07-25 23:54:56 +02:00
};
}
2023-07-25 08:06:16 +02:00
async function rawQuery(sql: string, data: object): Promise<any> {
const db = getDatabaseType();
const params = [];
2022-08-26 07:04:32 +02:00
if (db !== POSTGRESQL && db !== MYSQL) {
return Promise.reject(new Error('Unknown database.'));
}
2023-07-29 03:30:02 +02:00
2023-09-21 10:01:58 +02:00
const query = sql?.replaceAll(/\{\{\s*(\w+)(::\w+)?\s*}}/g, (...args) => {
2023-07-25 08:06:16 +02:00
const [, name, type] = args;
2024-03-26 06:51:10 +01:00
const value = data[name];
params.push(value);
2023-07-25 08:06:16 +02:00
return db === MYSQL ? '?' : `$${params.length}${type ?? ''}`;
});
2022-08-26 07:04:32 +02:00
2023-07-25 08:06:16 +02:00
return prisma.rawQuery(query, params);
2022-08-26 07:04:32 +02:00
}
2022-08-27 07:43:31 +02:00
2024-01-30 09:10:25 +01:00
async function pagedQuery<T>(model: string, criteria: T, filters: SearchFilter) {
2024-02-03 02:49:17 +01:00
const { page = 1, pageSize, orderBy, sortDescending = false } = filters || {};
const size = +pageSize || DEFAULT_PAGE_SIZE;
2023-08-10 22:26:33 +02:00
2024-01-30 09:10:25 +01:00
const data = await prisma.client[model].findMany({
...criteria,
...{
2024-02-03 02:49:17 +01:00
...(size > 0 && { take: +size, skip: +size * (page - 1) }),
2023-08-10 22:26:33 +02:00
...(orderBy && {
orderBy: [
{
[orderBy]: sortDescending ? 'desc' : 'asc',
2023-08-10 22:26:33 +02:00
},
],
}),
},
2024-01-30 09:10:25 +01:00
});
const count = await prisma.client[model].count({ where: (criteria as any).where });
2024-02-06 00:32:36 +01:00
return { data, count, page: +page, pageSize: size, orderBy };
2023-08-10 22:26:33 +02:00
}
2024-03-03 15:35:37 +01:00
function getQueryMode(): { mode?: Prisma.QueryMode } {
2023-08-15 19:57:25 +02:00
const db = getDatabaseType();
if (db === POSTGRESQL) {
2024-03-03 15:35:37 +01:00
return { mode: 'insensitive' };
2023-08-15 19:57:25 +02:00
}
2024-03-03 15:35:37 +01:00
return {};
2023-08-15 19:57:25 +02:00
}
2024-02-04 08:19:29 +01:00
function getSearchParameters(query: string, filters: { [key: string]: any }[]) {
if (!query) return;
const mode = getQueryMode();
const parseFilter = (filter: { [key: string]: any }) => {
const [[key, value]] = Object.entries(filter);
return {
[key]:
typeof value === 'string'
? {
[value]: query,
2024-03-03 15:35:37 +01:00
...mode,
2024-02-04 08:19:29 +01:00
}
: parseFilter(value),
};
};
const params = filters.map(filter => parseFilter(filter));
return {
AND: {
OR: params,
},
};
}
2022-08-27 07:43:31 +02:00
export default {
2022-12-27 06:51:16 +01:00
...prisma,
2023-11-02 18:34:06 +01:00
getAddIntervalQuery,
2023-08-15 21:15:27 +02:00
getCastColumnQuery,
2024-02-04 08:19:29 +01:00
getDayDiffQuery,
2022-08-27 07:43:31 +02:00
getDateQuery,
getFilterQuery,
2024-02-04 08:19:29 +01:00
getSearchParameters,
getTimestampDiffQuery,
2024-01-14 11:21:39 +01:00
getQueryMode,
2024-01-30 09:10:25 +01:00
pagedQuery,
2024-02-04 08:19:29 +01:00
parseFilters,
rawQuery,
2022-08-27 07:43:31 +02:00
};